Class: Google::Apis::PubsubV1beta1a::PullBatchRequest

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/pubsub_v1beta1a/classes.rb,
generated/google/apis/pubsub_v1beta1a/representations.rb,
generated/google/apis/pubsub_v1beta1a/representations.rb

Overview

Request for the PullBatch method.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ PullBatchRequest

Returns a new instance of PullBatchRequest.



410
411
412
 
# File 'generated/google/apis/pubsub_v1beta1a/classes.rb', line 410

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#max_events ⇒ Fixnum

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

Returns:

  • (Fixnum) 


393
394
395
 
# File 'generated/google/apis/pubsub_v1beta1a/classes.rb', line 393

def max_events
  @max_events
end

#return_immediately ⇒ Boolean Also known as: return_immediately?

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

Returns:

  • (Boolean) 


402
403
404
 
# File 'generated/google/apis/pubsub_v1beta1a/classes.rb', line 402

def return_immediately
  @return_immediately
end

#subscription ⇒ String

The subscription from which messages should be pulled. Corresponds to the JSON property subscription

Returns:

  • (String) 


408
409
410
 
# File 'generated/google/apis/pubsub_v1beta1a/classes.rb', line 408

def subscription
  @subscription
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



415
416
417
418
419
 
# File 'generated/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