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

Pulls messages from the server. The server may return UNAVAILABLE if there are too many concurrent pull requests pending for the given subscription.

Arguments

Parameters
subscription	string Required. The subscription from which messages should be pulled. Format is projects/{project}/subscriptions/{sub}.
body	object (PullRequest) 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 contains an instance of PullResponse.

Subworkflow snippet

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

YAML

- pull:
    call: googleapis.pubsub.v1.projects.subscriptions.pull
    args:
        subscription: ...
        body:
            maxMessages: ...
            returnImmediately: ...
    result: pullResult

JSON

[
  {
    "pull": {
      "call": "googleapis.pubsub.v1.projects.subscriptions.pull",
      "args": {
        "subscription": "...",
        "body": {
          "maxMessages": "...",
          "returnImmediately": "..."
        }
      },
      "result": "pullResult"
    }
  }
]