projects

Changed on

Pulls messages from the server.

post/v1/{+subscription}:pull

Request

  • Base URL: https://pubsub.googleapis.com
  • URL: https://pubsub.googleapis.com/v1/{+subscription}:pull
  • Auth: one of:
    • OAuth 2 (implicit, authorization URL https://accounts.google.com/o/oauth2/auth, scopes: https://www.googleapis.com/auth/cloud-platform) and OAuth 2 (authorization code, authorization URL https://accounts.google.com/o/oauth2/auth, token URL https://accounts.google.com/o/oauth2/token, scopes: https://www.googleapis.com/auth/cloud-platform)
    • OAuth 2 (implicit, authorization URL https://accounts.google.com/o/oauth2/auth, scopes: https://www.googleapis.com/auth/pubsub) and OAuth 2 (authorization code, authorization URL https://accounts.google.com/o/oauth2/auth, token URL https://accounts.google.com/o/oauth2/token, scopes: https://www.googleapis.com/auth/pubsub)

Path parameters

subscriptionstring required

Required. The subscription from which messages should be pulled. Format is projects/{project}/subscriptions/{sub}.

Request body

maxMessagesinteger

Required. The maximum number of messages to return for this request. Must be a positive integer. The Pub/Sub system may return fewer than the number specified.

returnImmediatelyboolean

Optional. If this field set to true, the system will respond immediately even if it there are no messages available to return in the Pull response. Otherwise, the system may wait (for a bounded amount of time) until at least one message is available, rather than returning no messages. Warning: setting this field to true is discouraged because it adversely impacts the performance of Pull operations. We recommend that users do not set this field.

Response

Successful response

Changes

  • 9261d704ec11Revision changes
    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was added to the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was added to the endpoint's security scheme Oauth2c

    • info

      the security scope https://www.googleapis.com/auth/pubsub was removed from the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/pubsub was removed from the endpoint's security scheme Oauth2c

  • 1dcd206a852fRevision changes
    • breaking

      removed the request body

    • breaking

      removed the media type */* for the response with the status

    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was added to the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was added to the endpoint's security scheme Oauth2c

    • info

      the security scope https://www.googleapis.com/auth/pubsub was removed from the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/pubsub was removed from the endpoint's security scheme Oauth2c