Reference documentation and code samples for the Cloud PubSub V1 Client class PullRequest.
Request for thePullmethod.
Generated from protobuf messagegoogle.pubsub.v1.PullRequest
Namespace
Google \ Cloud \ PubSub \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ subscription
string
Required. The subscription from which messages should be pulled. Format isprojects/{project}/subscriptions/{sub}.
↳ return_immediately
bool
Optional. If this field set to true, the system will respond immediately even if it there are no messages available to return in thePullresponse. 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 totrueis discouraged because it adversely impacts the performance ofPulloperations. We recommend that users do not set this field.
↳ max_messages
int
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.
getSubscription
Required. The subscription from which messages should be pulled.
Format isprojects/{project}/subscriptions/{sub}.
Returns
Type
Description
string
setSubscription
Required. The subscription from which messages should be pulled.
Format isprojects/{project}/subscriptions/{sub}.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getReturnImmediately
Optional. If this field set to true, the system will respond immediately
even if it there are no messages available to return in thePullresponse. 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 totrueis discouraged because it adversely
impacts the performance ofPulloperations. We recommend that users do
not set this field.
Returns
Type
Description
bool
setReturnImmediately
Optional. If this field set to true, the system will respond immediately
even if it there are no messages available to return in thePullresponse. 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 totrueis discouraged because it adversely
impacts the performance ofPulloperations. We recommend that users do
not set this field.
Parameter
Name
Description
var
bool
Returns
Type
Description
$this
getMaxMessages
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.
Returns
Type
Description
int
setMaxMessages
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.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
static::build
Parameters
Name
Description
subscription
string
Required. The subscription from which messages should be pulled.
Format isprojects/{project}/subscriptions/{sub}. Please seeSubscriberClient::subscriptionName()for help formatting this field.
returnImmediately
bool
Optional. If this field set to true, the system will respond immediately
even if it there are no messages available to return in thePullresponse. 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 totrueis discouraged because it adversely
impacts the performance ofPulloperations. We recommend that users do
not set this field.
maxMessages
int
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.
Required. The subscription from which messages should be pulled.
Format isprojects/{project}/subscriptions/{sub}. Please seeSubscriberClient::subscriptionName()for help formatting this field.
maxMessages
int
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Cloud PubSub V1 Client - Class PullRequest (2.13.2)\n\nVersion latestkeyboard_arrow_down\n\n- [2.13.2 (latest)](/php/docs/reference/cloud-pubsub/latest/V1.PullRequest)\n- [2.13.1](/php/docs/reference/cloud-pubsub/2.13.1/V1.PullRequest)\n- [2.12.0](/php/docs/reference/cloud-pubsub/2.12.0/V1.PullRequest)\n- [2.11.3](/php/docs/reference/cloud-pubsub/2.11.3/V1.PullRequest)\n- [2.10.1](/php/docs/reference/cloud-pubsub/2.10.1/V1.PullRequest)\n- [2.9.1](/php/docs/reference/cloud-pubsub/2.9.1/V1.PullRequest)\n- [2.8.2](/php/docs/reference/cloud-pubsub/2.8.2/V1.PullRequest)\n- [2.7.0](/php/docs/reference/cloud-pubsub/2.7.0/V1.PullRequest)\n- [2.6.0](/php/docs/reference/cloud-pubsub/2.6.0/V1.PullRequest)\n- [2.5.2](/php/docs/reference/cloud-pubsub/2.5.2/V1.PullRequest)\n- [2.4.0](/php/docs/reference/cloud-pubsub/2.4.0/V1.PullRequest)\n- [2.3.0](/php/docs/reference/cloud-pubsub/2.3.0/V1.PullRequest)\n- [2.2.1](/php/docs/reference/cloud-pubsub/2.2.1/V1.PullRequest)\n- [2.1.2](/php/docs/reference/cloud-pubsub/2.1.2/V1.PullRequest)\n- [1.50.0](/php/docs/reference/cloud-pubsub/1.50.0/V1.PullRequest)\n- [1.49.0](/php/docs/reference/cloud-pubsub/1.49.0/V1.PullRequest)\n- [1.48.0](/php/docs/reference/cloud-pubsub/1.48.0/V1.PullRequest)\n- [1.47.0](/php/docs/reference/cloud-pubsub/1.47.0/V1.PullRequest)\n- [1.46.5](/php/docs/reference/cloud-pubsub/1.46.5/V1.PullRequest)\n- [1.45.2](/php/docs/reference/cloud-pubsub/1.45.2/V1.PullRequest)\n- [1.44.0](/php/docs/reference/cloud-pubsub/1.44.0/V1.PullRequest)\n- [1.43.2](/php/docs/reference/cloud-pubsub/1.43.2/V1.PullRequest)\n- [1.42.1](/php/docs/reference/cloud-pubsub/1.42.1/V1.PullRequest)\n- [1.41.3](/php/docs/reference/cloud-pubsub/1.41.3/V1.PullRequest)\n- [1.40.1](/php/docs/reference/cloud-pubsub/1.40.1/V1.PullRequest)\n- [1.39.3](/php/docs/reference/cloud-pubsub/1.39.3/V1.PullRequest) \nReference documentation and code samples for the Cloud PubSub V1 Client class PullRequest.\n\nRequest for the `Pull` method.\n\nGenerated from protobuf message `google.pubsub.v1.PullRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ PubSub \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getSubscription\n\nRequired. The subscription from which messages should be pulled.\n\nFormat is `projects/{project}/subscriptions/{sub}`.\n\n### setSubscription\n\nRequired. The subscription from which messages should be pulled.\n\nFormat is `projects/{project}/subscriptions/{sub}`.\n\n### getReturnImmediately\n\nOptional. If this field set to true, the system will respond immediately\neven if it there are no messages available to return in the `Pull`\nresponse. Otherwise, the system may wait (for a bounded amount of time)\nuntil at least one message is available, rather than returning no messages.\n\nWarning: setting this field to `true` is discouraged because it adversely\nimpacts the performance of `Pull` operations. We recommend that users do\nnot set this field.\n\n### setReturnImmediately\n\nOptional. If this field set to true, the system will respond immediately\neven if it there are no messages available to return in the `Pull`\nresponse. Otherwise, the system may wait (for a bounded amount of time)\nuntil at least one message is available, rather than returning no messages.\n\nWarning: setting this field to `true` is discouraged because it adversely\nimpacts the performance of `Pull` operations. We recommend that users do\nnot set this field.\n\n### getMaxMessages\n\nRequired. The maximum number of messages to return for this request. Must\nbe a positive integer. The Pub/Sub system may return fewer than the number\nspecified.\n\n### setMaxMessages\n\nRequired. The maximum number of messages to return for this request. Must\nbe a positive integer. The Pub/Sub system may return fewer than the number\nspecified.\n\n### static::build\n\n### static::buildFromSubscriptionMaxMessages"]]
