class Google::Cloud::Spanner::Backup::List

# List

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

Attributes

grpc[RW]

@private The gRPC page enumerable object.

service[RW]

@private The gRPC Service object.

Public Class Methods

from_grpc(grpc, service) click to toggle source

@private New Backup::List from a `Gapic::PagedEnumerable<Google::Cloud::Spanner::Admin::Database::V1::Backup>` object.

# File lib/google/cloud/spanner/backup/list.rb, line 148
def self.from_grpc grpc, service
  backups = List.new(Array(grpc.response.backups).map do |backup|
    Backup.from_grpc backup, service
  end)

  backups.grpc = grpc
  backups.service = service
  backups
end
new(arr = []) click to toggle source

@private Create a new Backup::List with an array of Backup instances.

Calls superclass method
# File lib/google/cloud/spanner/backup/list.rb, line 40
def initialize arr = []
  super arr
end

Public Instance Methods

all(&block) click to toggle source

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.

@yield [backup] The block for accessing each backup. @yieldparam [Google::Cloud::Spanner::Backup] backup The backup

object.

@return [Enumerator]

@example 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

@example 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
# 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
next() click to toggle source

if backups.next?

next_backups = backups.next

end

# 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?() click to toggle source

Whether there is a next page of backups.

@return [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
# File lib/google/cloud/spanner/backup/list.rb, line 61
def next?
  grpc.next_page?
end

Protected Instance Methods

ensure_service!() click to toggle source

Raise an error unless an active service is available.

# File lib/google/cloud/spanner/backup/list.rb, line 162
def ensure_service!
  raise "Must have active connection" unless @service
end