Method: googleapis.pubsub.v1.projects.subscriptions.modifyAckDeadline

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.

Arguments

Parameters
subscription

string

Required. The name of the subscription. Format is projects/{project}/subscriptions/{sub}.
body

object (ModifyAckDeadlineRequest)

Required.

Raised exceptions

Exceptions
ConnectionError In case of a network problem (such as DNS failure or refused connection).
HttpError If the response status is >= 400 (excluding 429 and 503).
TimeoutError If a long-running operation takes longer to finish than the specified timeout limit.
TypeError If an operation or function receives an argument of the wrong type.
ValueError If an operation or function receives an argument of the right type but an inappropriate value. For example, a negative timeout.

Response

If successful, the response will be empty.

Subworkflow snippet

Some fields might be optional or required. To identify required fields, refer to the API documentation.

YAML

- modifyAckDeadline:
    call: googleapis.pubsub.v1.projects.subscriptions.modifyAckDeadline
    args:
        subscription: ...
        body:
            ackDeadlineSeconds: ...
            ackIds: ...
    result: modifyAckDeadlineResult

JSON

[
  {
    "modifyAckDeadline": {
      "call": "googleapis.pubsub.v1.projects.subscriptions.modifyAckDeadline",
      "args": {
        "subscription": "...",
        "body": {
          "ackDeadlineSeconds": "...",
          "ackIds": "..."
        }
      },
      "result": "modifyAckDeadlineResult"
    }
  }
]