Cloud Pub/Sub API - Class Google::Cloud::PubSub::Snapshot::List (v2.17.0)

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

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

Inherits

  • Array

Methods

#all

def all(request_limit: nil, &block) { |snapshot| ... } -> 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 snapshots. Default is no limit.
Yields
  • (snapshot) — The block for accessing each snapshot.
Yield Parameter
  • snapshot (Snapshot) — The snapshot object.
Returns
  • (Enumerator)
Examples

Iterating each snapshot by passing a block:

require "google/cloud/pubsub"

pubsub = Google::Cloud::PubSub.new

snapshots = pubsub.snapshots
snapshots.all do |snapshot|
  puts snapshot.name
end

Using the enumerator by not passing a block:

require "google/cloud/pubsub"

pubsub = Google::Cloud::PubSub.new

snapshots = pubsub.snapshots
all_names = snapshots.all.map do |snapshot|
  snapshot.name
end

Limit the number of API calls made:

require "google/cloud/pubsub"

pubsub = Google::Cloud::PubSub.new

snapshots = pubsub.snapshots
snapshots.all(request_limit: 10) do |snapshot|
  puts snapshot.name
end

#next

def next() -> Snapshot::List

Retrieve the next page of snapshots.

Returns
Example 
require "google/cloud/pubsub"

pubsub = Google::Cloud::PubSub.new

snapshots = pubsub.snapshots
if snapshots.next?
  next_snapshots = snapshots.next
end

#next?

def next?() -> Boolean

Whether there a next page of snapshots.

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

pubsub = Google::Cloud::PubSub.new

snapshots = pubsub.snapshots
if snapshots.next?
  next_snapshots = snapshots.next
end

#token

def token()

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

#token=

def token=(value)

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