Reference documentation and code samples for the Cloud Bigtable API class Google::Cloud::Bigtable::Backup::List.
Backup::List is a special-case array with additional values.
Inherits
- Array
Methods
#all
def all(&block) { |backup| ... } -> Enumerator, nil
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.
- (backup) — The block for accessing each backup.
- backup (Backup) — The backup object.
-
(Enumerator, nil) — An enumerator is returned if no block is given, otherwise
nil
.
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(&:backup_id)
#next
def next() -> Backup::List
Retrieves the next page of backups.
- (Backup::List) — The list of backups.
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
#next?
def next?() -> Boolean
Whether there is a next page of backups.
- (Boolean)
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