Cloud Bigtable API - Class Google::Cloud::Bigtable::Instance::List (v2.9.1)

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

Instance::List is a special-case array with additional values and failed_locations.

Inherits

  • Array

Methods

#all

def all(&block) { |instance| ... } -> Enumerator, nil

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
  • (instance) — The block for accessing each instance.
Yield Parameter
  • instance (Instance) — The instance object.
Returns
  • (Enumerator, nil) — An enumerator is returned if no block is given, otherwise nil.
Examples

Iterating each instance by passing a block:

require "google/cloud/bigtable"

bigtable = Google::Cloud::Bigtable.new

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

Using the enumerator by not passing a block:

require "google/cloud/bigtable"

bigtable = Google::Cloud::Bigtable.new

all_instance_ids = bigtable.instances.all.map do |instance|
  puts instance.instance_id
end

#failed_locations

def failed_locations()

Locations from which instance information could not be retrieved, due to an outage or some other transient condition. Instances whose clusters are all in one of the failed locations may be missing from instances, and instances with at least one cluster in a failed location may only have partial information returned.

#failed_locations=

def failed_locations=(value)

Locations from which instance information could not be retrieved, due to an outage or some other transient condition. Instances whose clusters are all in one of the failed locations may be missing from instances, and instances with at least one cluster in a failed location may only have partial information returned.

#next

def next() -> Instance::List

Retrieves the next page of instances.

Returns
Example 
require "google/cloud/bigtable"

bigtable = Google::Cloud::Bigtable.new

instances = bigtable.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/bigtable"

bigtable = Google::Cloud::Bigtable.new

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

#token

def token()

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

#token=

def token=(value)

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