class Google::Apis::PubsubV1::PullRequest
Request for the `Pull` method.
Attributes
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. Corresponds to the JSON property `maxMessages` @return [Fixnum]
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. Corresponds to the JSON property `returnImmediately` @return [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 to `true` is discouraged because it adversely impacts the performance of `Pull` operations. We recommend that users do not set this field. Corresponds to the JSON property `returnImmediately` @return [Boolean]
Public Class Methods
# File lib/google/apis/pubsub_v1/classes.rb, line 770 def initialize(**args) update!(**args) end
Public Instance Methods
Update properties of this object
# File lib/google/apis/pubsub_v1/classes.rb, line 775 def update!(**args) @max_messages = args[:max_messages] if args.key?(:max_messages) @return_immediately = args[:return_immediately] if args.key?(:return_immediately) end