Class: Google::Cloud::PubSub::Snapshot::List

Inherits:
Array
  • Object
show all
Defined in:
lib/google/cloud/pubsub/snapshot/list.rb

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#token ⇒ Object

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.



29
30
31
 
# File 'lib/google/cloud/pubsub/snapshot/list.rb', line 29

def token
  @token
end

Instance Method Details

#all(request_limit: nil) {|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.

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

Parameters:

  • 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 Parameters:

  • snapshot (Snapshot) —

    The snapshot object.

Returns:

  • (Enumerator) 


128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/google/cloud/pubsub/snapshot/list.rb', line 128

def all request_limit: nil, &block
  request_limit = request_limit.to_i if request_limit
  return enum_for :all, request_limit: request_limit unless block_given?
  results = self
  loop do
    results.each(&block)
    if request_limit
      request_limit -= 1
      break if request_limit.negative?
    end
    break unless results.next?
    results = results.next
  end
end

#next ⇒ Snapshot::List

Retrieve the next page of snapshots.

Examples:

require "google/cloud/pubsub"

pubsub = Google::Cloud::PubSub.new

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

Returns:



74
75
76
77
78
 
# File 'lib/google/cloud/pubsub/snapshot/list.rb', line 74

def next
  return nil unless next?
  ensure_service!
  next_snapshots
end

#next? ⇒ Boolean

Whether there a next page of snapshots.

Examples:

require "google/cloud/pubsub"

pubsub = Google::Cloud::PubSub.new

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

Returns:

  • (Boolean) 


55
56
57
 
# File 'lib/google/cloud/pubsub/snapshot/list.rb', line 55

def next?
  !token.nil?
end