Reference documentation and code samples for the Cloud Pub/Sub V1 API class Google::Cloud::PubSub::V1::PullRequest.
Request for the Pull
method.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#max_messages
def max_messages() -> ::Integer
Returns
- (::Integer) — 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.
#max_messages=
def max_messages=(value) -> ::Integer
Parameter
- value (::Integer) — 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
- (::Integer) — 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.
#return_immediately
def return_immediately() -> ::Boolean
Returns
-
(::Boolean) — 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 totrue
is discouraged because it adversely impacts the performance ofPull
operations. We recommend that users do not set this field.
#return_immediately=
def return_immediately=(value) -> ::Boolean
Parameter
-
value (::Boolean) — 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 totrue
is discouraged because it adversely impacts the performance ofPull
operations. We recommend that users do not set this field.
Returns
-
(::Boolean) — 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 totrue
is discouraged because it adversely impacts the performance ofPull
operations. We recommend that users do not set this field.
#subscription
def subscription() -> ::String
Returns
-
(::String) — Required. The subscription from which messages should be pulled.
Format is
projects/{project}/subscriptions/{sub}
.
#subscription=
def subscription=(value) -> ::String
Parameter
-
value (::String) — Required. The subscription from which messages should be pulled.
Format is
projects/{project}/subscriptions/{sub}
.
Returns
-
(::String) — Required. The subscription from which messages should be pulled.
Format is
projects/{project}/subscriptions/{sub}
.