Class: Google::Apis::PubsubV1::PullRequest

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

Overview

Request for the Pull method.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ PullRequest

Returns a new instance of PullRequest



287
288
289
 
# File 'generated/google/apis/pubsub_v1/classes.rb', line 287

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) 


285
286
287
 
# File 'generated/google/apis/pubsub_v1/classes.rb', line 285

def max_messages
  @max_messages
end

#return_immediately ⇒ Boolean Also known as: return_immediately?

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. 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) 


278
279
280
 
# File 'generated/google/apis/pubsub_v1/classes.rb', line 278

def return_immediately
  @return_immediately
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



292
293
294
295
 
# File 'generated/google/apis/pubsub_v1/classes.rb', line 292

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