Cloud Pub/Sub API - Class Google::Cloud::PubSub::Subscription::List (v2.15.2)

Reference documentation and code samples for the Cloud Pub/Sub API class Google::Cloud::PubSub::Subscription::List.

Subscription::List is a special case Array with additional values.

Inherits

  • Array

Methods

#all

def all(request_limit: nil, &block) { |subscription| ... } -> Enumerator

Retrieves remaining results by repeatedly invoking #next until #next? returns false. Calls the given block once for each result, which is passed as the argument to the block.

An Enumerator is returned if no block is given.

This method will make repeated API calls until all remaining results are retrieved. (Unlike #each, for example, which merely iterates over the results returned by a single API call.) Use with caution.

Parameter
  • request_limit (Integer) (defaults to: nil) — The upper limit of API requests to make to load all subscriptions. Default is no limit.
Yields
  • (subscription) — The block for accessing each subscription.
Yield Parameter
Returns
  • (Enumerator)
Examples

Iterating each subscription by passing a block:

require "google/cloud/pubsub"

pubsub = Google::Cloud::PubSub.new

subscriptions = pubsub.subscriptions
subscriptions.all do |subscription|
  puts subscription.name
end

Using the enumerator by not passing a block:

require "google/cloud/pubsub"

pubsub = Google::Cloud::PubSub.new

subscriptions = pubsub.subscriptions
all_names = subscriptions.all.map do |subscription|
  subscription.name
end

Limit the number of API calls made:

require "google/cloud/pubsub"

pubsub = Google::Cloud::PubSub.new

subscriptions = pubsub.subscriptions
subscriptions.all(request_limit: 10) do |subscription|
  puts subscription.name
end

#next

def next() -> Subscription::List

Retrieve the next page of subscriptions.

Returns
Example 
require "google/cloud/pubsub"

pubsub = Google::Cloud::PubSub.new

subscriptions = pubsub.subscriptions
if subscriptions.next?
  next_subscriptions = subscriptions.next
end

#next?

def next?() -> Boolean

Whether there a next page of subscriptions.

Returns
  • (Boolean)
Example 
require "google/cloud/pubsub"

pubsub = Google::Cloud::PubSub.new

subscriptions = pubsub.subscriptions
if subscriptions.next?
  next_subscriptions = subscriptions.next
end

#token

def token()

If not empty, indicates that there are more subscriptions that match the request and this value should be passed to the next Topic#subscriptions to continue.

#token=

def token=(value)

If not empty, indicates that there are more subscriptions that match the request and this value should be passed to the next Topic#subscriptions to continue.