Class: Google::Apis::PubsubV1beta2::PullRequest

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

Overview

Request for the Pull method.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ PullRequest

Returns a new instance of PullRequest.



541
542
543
 
# File 'generated/google/apis/pubsub_v1beta2/classes.rb', line 541

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

Instance Attribute Details

#max_messages ⇒ Fixnum

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

Returns:

  • (Fixnum) 


539
540
541
 
# File 'generated/google/apis/pubsub_v1beta2/classes.rb', line 539

def max_messages
  @max_messages
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) 


532
533
534
 
# File 'generated/google/apis/pubsub_v1beta2/classes.rb', line 532

def return_immediately
  @return_immediately
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



546
547
548
549
 
# File 'generated/google/apis/pubsub_v1beta2/classes.rb', line 546

def update!(**args)
  @return_immediately = args[:return_immediately] unless args[:return_immediately].nil?
  @max_messages = args[:max_messages] unless args[:max_messages].nil?
end