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

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

List

List is a special case Array with additional values for backup operations.

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

Inherits

  • Array

Methods

#all

def all(&block) { |job| ... } -> 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
  • (job) — The block for accessing each backup job.
Yield Parameter
Returns
  • (Enumerator)
Examples

Iterating each backup job by passing a block:

require "google/cloud/spanner" spanner = Google::Cloud::Spanner.new instance = spanner.instance "my-instance" jobs = instance.backup_operations jobs.all do |job|  puts job.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" jobs = instance.backup_operations all_backup_ids = jobs.all.map do |job|  job.backup.backup_id end

#next

def next() -> Backup::Job::List

Retrieve the next page of backup jobs.

Returns
Example 
require "google/cloud/spanner" spanner = Google::Cloud::Spanner.new instance = spanner.instance "my-instance" jobs = instance.backup_operations if jobs.next?  next_jobs = jobs.next end

#next?

def next?() -> Boolean

Whether there is a next page of backup jobs.

Returns
  • (Boolean)
Example 
require "google/cloud/spanner" spanner = Google::Cloud::Spanner.new instance = spanner.instance "my-instance" jobs = instance.backup_operations if jobs.next?  next_jobs = jobs.next end