Class: Google::Cloud::PubSub::V1::PullRequest

Inherits:
Object
  • Object
show all
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

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.

Returns:

  • (::Integer) —

    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.



1313
1314
1315
1316
 
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 1313

class PullRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#return_immediately ⇒ ::Boolean

Deprecated.

This field is deprecated and may be removed in the next major version update.

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.

Returns:

  • (::Boolean) —

    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.



1313
1314
1315
1316
 
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 1313

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

Returns:

  • (::String) —

    Required. The subscription from which messages should be pulled. Format is projects/{project}/subscriptions/{sub}.



1313
1314
1315
1316
 
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 1313

class PullRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end