Class: Google::Apis::PubsubV1beta1a::PullRequest

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



475
476
477
 
# File 'generated/google/apis/pubsub_v1beta1a/classes.rb', line 475

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

Instance Attribute Details

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


467
468
469
 
# File 'generated/google/apis/pubsub_v1beta1a/classes.rb', line 467

def return_immediately
  @return_immediately
end

#subscription ⇒ String

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

Returns:

  • (String) 


473
474
475
 
# File 'generated/google/apis/pubsub_v1beta1a/classes.rb', line 473

def subscription
  @subscription
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



480
481
482
483
 
# File 'generated/google/apis/pubsub_v1beta1a/classes.rb', line 480

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