Class: Google::Cloud::Spanner::Backup::List

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

Overview

List

Google::Cloud::Spanner::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/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

Yields:

  • (backup)

    The block for accessing each backup.

Yield Parameters:

Returns:

  • (Enumerator)

131
132
133
134
135
136
137
138
139
140
141
# File 'lib/google/cloud/spanner/backup/list.rb', line 131

def all &block
  return enum_for :all unless block_given?

  results = self
  loop do
    results.each(&block)
    break unless next?
    grpc.next_page
    results = self.class.from_grpc grpc, service
  end
end

#nextObject

if backups.next? next_backups = backups.next end


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

def next
  ensure_service!

  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/spanner"

spanner = Google::Cloud::Spanner.new

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

if backups.next?
  next_backups = backups.next
end

Returns:

  • (Boolean)

61
62
63
# File 'lib/google/cloud/spanner/backup/list.rb', line 61

def next?
  grpc.next_page?
end