Method: Google::Cloud::PubSub::V1::PullRequest#return_immediately

Defined in:
proto_docs/google/pubsub/v1/pubsub.rb

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

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.



748
749
750
751
 
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 748

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