Cloud PubSub V1 Client - Class PullRequest (2.8.2)

Reference documentation and code samples for the Cloud PubSub V1 Client class PullRequest.

Request for the Pull method.

Generated from protobuf message google.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 is `projects/{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 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.
`↳ 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 is projects/{project}/subscriptions/{sub}.

Returns
Type	Description
`string`

setSubscription

Required. The subscription from which messages should be pulled.

Format is projects/{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 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.

Returns
Type	Description
`bool`

setReturnImmediately

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.

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 is `projects/{project}/subscriptions/{sub}`. Please see SubscriberClient::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 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.
`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.

Returns
Type	Description
`PullRequest`

static::buildFromSubscriptionMaxMessages

Parameters
Name	Description
`subscription`	`string` Required. The subscription from which messages should be pulled. Format is `projects/{project}/subscriptions/{sub}`. Please see SubscriberClient::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.

Returns
Type	Description
`PullRequest`