Cloud Spanner API - Class Google::Cloud::Spanner::Backup::List (v2.16.1)

Reference documentation and code samples for the Cloud Spanner API class Google::Cloud::Spanner::Backup::List.

List

Google::Cloud::Spanner::Backup::List is a special case Array with additional values.

{Google::Cloud::Spanner::Admin::Database#database_admin Client#list_backups} instead.

Inherits

  • Array

Methods

#all

def all(&block) { |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.

Yields
  • (backup) — The block for accessing each backup.
Yield Parameter
Returns
  • (Enumerator)
Examples

Iterating each backup by passing a block:

require "google/cloud/spanner"

spanner = Google::Cloud::Spanner.new

instance = spanner.instance "my-instance"
backups = instance.backups

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

Using the enumerator by not passing a block:

require "google/cloud/spanner"

spanner = Google::Cloud::Spanner.new

instance = spanner.instance "my-instance"
backups = instance.backups

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

#next

def next()

if backups.next? next_backups = backups.next end

#next?

def next?() -> Boolean

Whether there is a next page of backups.

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

spanner = Google::Cloud::Spanner.new

instance = spanner.instance "my-instance"
backups = instance.backups

if backups.next?
  next_backups = backups.next
end