modifyAckDeadline method

Future<Empty> modifyAckDeadline(
  1. ModifyAckDeadlineRequest request,
  2. String subscription, {
  3. String? $fields,
})

Modifies the ack deadline for a specific message.

This method is useful to indicate that more time is needed to process a message by the subscriber, or to make the message available for redelivery if the processing was interrupted. Note that this does not modify the subscription-level ackDeadlineSeconds used for subsequent messages.

request - The metadata request object.

Request parameters:

subscription - Required. The name of the subscription. Format is projects/{project}/subscriptions/{sub}. Value must have pattern ^projects/\[^/\]+/subscriptions/\[^/\]+$.

$fields - Selector specifying which fields to include in a partial response.

Completes with a Empty.

Completes with a commons.ApiRequestError if the API endpoint returned an error.

If the used http.Client completes with an error when making a REST call, this method will complete with the same error.

Implementation

async.Future<Empty> modifyAckDeadline(
  ModifyAckDeadlineRequest request,
  core.String subscription, {
  core.String? $fields,
}) async {
  final body_ = convert.json.encode(request);
  final queryParams_ = <core.String, core.List<core.String>>{
    if ($fields != null) 'fields': [$fields],
  };

  final url_ =
      'v1/' + core.Uri.encodeFull('$subscription') + ':modifyAckDeadline';

  final response_ = await _requester.request(
    url_,
    'POST',
    body: body_,
    queryParams: queryParams_,
  );
  return Empty.fromJson(response_ as core.Map<core.String, core.dynamic>);
}