Cloud Spanner API - Class Google::Cloud::Spanner::Instance::List (v2.20.0)

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

Instance::List is a special case Array with additional values.

{Google::Cloud::Spanner::Admin::Instance#instance_admin Client#list_instances} instead.

Inherits

  • Array

Methods

#all

def all(request_limit: nil, &block) { |instance| ... } -> 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.

Parameter
  • request_limit (Integer) (defaults to: nil) — The upper limit of API requests to make to load all instances. Default is no limit.
Yields
  • (instance) — The block for accessing each instance.
Yield Parameter
  • instance (Instance) — The instance object.
Returns
  • (Enumerator)
Examples

Iterating each instance by passing a block:

require "google/cloud/spanner"

spanner = Google::Cloud::Spanner.new

spanner.instances.all do |instance|
  puts instance.instance_id
end

Using the enumerator by not passing a block:

require "google/cloud/spanner"

spanner = Google::Cloud::Spanner.new

all_instance_ids = spanner.instances.all.map do |instance|
  instance.instance_id
end

Limit the number of API calls made:

require "google/cloud/spanner"

spanner = Google::Cloud::Spanner.new

spanner.instances.all(request_limit: 10) do |instance|
  puts instance.instance_id
end

#next

def next() -> Instance::List

Retrieve the next page of instances.

Returns
Example 
require "google/cloud/spanner"

spanner = Google::Cloud::Spanner.new

instances = spanner.instances
if instances.next?
  next_instances = instances.next
end

#next?

def next?() -> Boolean

Whether there is a next page of instances.

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

spanner = Google::Cloud::Spanner.new

instances = spanner.instances
if instances.next?
  next_instances = instances.next
end

#token

def token()

If not empty, indicates that there are more records that match the request and this value should be passed to continue.

#token=

def token=(value)

If not empty, indicates that there are more records that match the request and this value should be passed to continue.