Class: Google::Pubsub::V1::PullRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/pubsub/v1/doc/google/pubsub/v1/pubsub.rb

Overview

Request for the +Pull+ method.

Instance Attribute Summary collapse

Instance Attribute Details

#max_messages ⇒ Integer

Returns The maximum number of messages returned for this request. The Pub/Sub system may return fewer than the number specified.

Returns:

  • (Integer) —

    The maximum number of messages returned for this request. The Pub/Sub system may return fewer than the number specified.



288
 
# File 'lib/google/cloud/pubsub/v1/doc/google/pubsub/v1/pubsub.rb', line 288

class PullRequest; end

#return_immediately ⇒ true, false

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

Returns:

  • (true, false) —

    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.



288
 
# File 'lib/google/cloud/pubsub/v1/doc/google/pubsub/v1/pubsub.rb', line 288

class PullRequest; end

#subscription ⇒ String

Returns The subscription from which messages should be pulled. Format is +projects/project/subscriptions/sub+.

Returns:

  • (String) —

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



288
 
# File 'lib/google/cloud/pubsub/v1/doc/google/pubsub/v1/pubsub.rb', line 288

class PullRequest; end