class Google::Apis::PubsubV1::PullRequest

Request for the `Pull` method.

Attributes

max_messages[RW]

The maximum number of messages returned for this request. The Pub/Sub system may return fewer than the number specified. Corresponds to the JSON property `maxMessages` @return [Fixnum]

return_immediately[RW]

If this is specified as true the system will respond immediately even if it is not able to return a message in the `Pull` response. Otherwise the system is allowed to wait until at least one message is available rather than returning no messages. The client may cancel the request if it does not wish to wait any longer for the response. Corresponds to the JSON property `returnImmediately` @return [Boolean]

return_immediately?[RW]

If this is specified as true the system will respond immediately even if it is not able to return a message in the `Pull` response. Otherwise the system is allowed to wait until at least one message is available rather than returning no messages. The client may cancel the request if it does not wish to wait any longer for the response. Corresponds to the JSON property `returnImmediately` @return [Boolean]

Public Class Methods

new(**args) click to toggle source
# File generated/google/apis/pubsub_v1/classes.rb, line 543
def initialize(**args)
   update!(**args)
end

Public Instance Methods

update!(**args) click to toggle source

Update properties of this object

# File generated/google/apis/pubsub_v1/classes.rb, line 548
def update!(**args)
  @return_immediately = args[:return_immediately] if args.key?(:return_immediately)
  @max_messages = args[:max_messages] if args.key?(:max_messages)
end