class Google::Apis::PubsubV1beta1a::PullBatchRequest

Request for the PullBatch method.

Attributes

max_events[RW]

The maximum number of PubsubEvents returned for this request. The Pub/Sub system may return fewer than the number of events specified. Corresponds to the JSON property `maxEvents` @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]

subscription[RW]

The subscription from which messages should be pulled. Corresponds to the JSON property `subscription` @return [String]

Public Class Methods

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

Public Instance Methods

update!(**args) click to toggle source

Update properties of this object

# File lib/google/apis/pubsub_v1beta1a/classes.rb, line 415
def update!(**args)
  @max_events = args[:max_events] if args.key?(:max_events)
  @return_immediately = args[:return_immediately] if args.key?(:return_immediately)
  @subscription = args[:subscription] if args.key?(:subscription)
end