Class: Google::Cloud::PubSub::V1::PullRequest
- Inherits:
-
Object
- Object
- Google::Cloud::PubSub::V1::PullRequest
- Extended by:
- Protobuf::MessageExts::ClassMethods
- Includes:
- Protobuf::MessageExts
- Defined in:
- proto_docs/google/pubsub/v1/pubsub.rb
Overview
Request for the Pull
method.
Instance Attribute Summary collapse
-
#max_messages ⇒ ::Integer
Required.
-
#return_immediately ⇒ ::Boolean
Optional.
-
#subscription ⇒ ::String
Required.
Instance Attribute Details
#max_messages ⇒ ::Integer
Returns Required. The maximum number of messages to return for this request. Must be a positive integer. The Pub/Sub system may return fewer than the number specified.
735 736 737 738 |
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 735 class PullRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#return_immediately ⇒ ::Boolean
Returns Optional. 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.
Warning: setting this field to true
is discouraged because it adversely
impacts the performance of Pull
operations. We recommend that users do
not set this field.
735 736 737 738 |
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 735 class PullRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#subscription ⇒ ::String
Returns Required. The subscription from which messages should be pulled.
Format is projects/{project}/subscriptions/{sub}
.
735 736 737 738 |
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 735 class PullRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |