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
Methods
__construct
Constructor.
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}
.
Generated from protobuf field string subscription = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {
string
setSubscription
Required. The subscription from which messages should be pulled.
Format is projects/{project}/subscriptions/{sub}
.
Generated from protobuf field string subscription = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {
var
string
$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.
Generated from protobuf field bool return_immediately = 2 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
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 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.
Generated from protobuf field bool return_immediately = 2 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
var
bool
$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.
Generated from protobuf field int32 max_messages = 3 [(.google.api.field_behavior) = REQUIRED];
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.
Generated from protobuf field int32 max_messages = 3 [(.google.api.field_behavior) = REQUIRED];
var
int
$this
