Class: Google::Cloud::Bigtable::Backup::List

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

Overview

Backup::List is a special-case array with additional values.

Instance Method Summary collapse

Instance Method Details

#all {|backup| ... } ⇒ 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 backup by passing a block:

require "google/cloud/bigtable"

bigtable = Google::Cloud::Bigtable.new

instance = bigtable.instance("my-instance")
cluster = instance.cluster("my-cluster")

cluster.backups.all do |backup|
  puts backup.backup_id
end

Using the enumerator by not passing a block:

require "google/cloud/bigtable"

bigtable = Google::Cloud::Bigtable.new

instance = bigtable.instance("my-instance")
cluster = instance.cluster("my-cluster")

all_backup_ids = cluster.backups.all.map do |backup|
  backup.backup_id
end

Yields:

  • (backup) —

    The block for accessing each backup.

Yield Parameters:

  • backup (Backup) —

    The backup object.

Returns:

  • (Enumerator, nil) —

    An enumerator is returned if no block is given, otherwise nil.



127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/google/cloud/bigtable/backup/list.rb', line 127

def all
  return enum_for :all unless block_given?

  results = self
  loop do
    results.each { |r| yield r }
    break unless next?
    grpc.next_page
    results = self.class.from_grpc grpc, service
  end
end

#next ⇒ Backup::List

Retrieves the next page of backups.

Examples:

require "google/cloud/bigtable"

bigtable = Google::Cloud::Bigtable.new

instance = bigtable.instance("my-instance")
cluster = instance.cluster("my-cluster")

backups = cluster.backups

if backups.next?
  next_backups = backups.next
end

Returns:



81
82
83
84
85
86
87
 
# File 'lib/google/cloud/bigtable/backup/list.rb', line 81

def next
  ensure_grpc!

  return nil unless next?
  grpc.next_page
  self.class.from_grpc grpc, service
end

#next? ⇒ Boolean

Whether there is a next page of backups.

Examples:

require "google/cloud/bigtable"

bigtable = Google::Cloud::Bigtable.new

instance = bigtable.instance("my-instance")
cluster = instance.cluster("my-cluster")

backups = cluster.backups

if backups.next?
  next_backups = backups.next
end

Returns:

  • (Boolean) 


58
59
60
 
# File 'lib/google/cloud/bigtable/backup/list.rb', line 58

def next?
  grpc.next_page?
end