Class: Google::Apis::PubsubV1::PullRequest
- Inherits:
-
Object
- Object
- Google::Apis::PubsubV1::PullRequest
- 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
-
#max_messages ⇒ Fixnum
The maximum number of messages returned for this request.
-
#return_immediately ⇒ Boolean
(also: #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.
Instance Method Summary collapse
-
#initialize(**args) ⇒ PullRequest
constructor
A new instance of PullRequest.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ PullRequest
Returns a new instance of PullRequest
512 513 514 |
# File 'generated/google/apis/pubsub_v1/classes.rb', line 512 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
499 500 501 |
# File 'generated/google/apis/pubsub_v1/classes.rb', line 499 def @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
509 510 511 |
# File 'generated/google/apis/pubsub_v1/classes.rb', line 509 def return_immediately @return_immediately end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
517 518 519 520 |
# File 'generated/google/apis/pubsub_v1/classes.rb', line 517 def update!(**args) @max_messages = args[:max_messages] if args.key?(:max_messages) @return_immediately = args[:return_immediately] if args.key?(:return_immediately) end |