class Google::Cloud::Bigtable::Instance::List

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

Attributes

failed_locations[RW]

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.

service[RW]

@private The gRPC Service object.

token[RW]

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

Public Class Methods

from_grpc(grpc, service) click to toggle source

@private New Instance::List from a Google::Cloud::Bigtable::Admin::V2::Instance object.

# File lib/google/cloud/bigtable/instance/list.rb, line 142
def self.from_grpc grpc, service
  instances = List.new(Array(grpc.instances).map do |instance|
    Instance.from_grpc instance, service
  end)
  token = grpc.next_page_token
  token = nil if token == ""
  instances.token = token
  instances.service = service
  instances.failed_locations = grpc.failed_locations.map(&:to_s)
  instances
end
new(arr = []) click to toggle source

@private Creates a new Instance::List with an array of Instance instances.

Calls superclass method
# File lib/google/cloud/bigtable/instance/list.rb, line 48
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 [instance] The block for accessing each instance. @yieldparam [Instance] instance The instance object.

@return [Enumerator,nil] An enumerator is returned if no block is given, otherwise `nil`.

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

@example 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
# File lib/google/cloud/bigtable/instance/list.rb, line 129
def all &block
  return enum_for :all unless block_given?

  results = self
  loop do
    results.each(&block)
    break unless results.next?
    results = results.next
  end
end
next() click to toggle source

Retrieves the next page of instances.

@return [Instance::List] The list of instances.

@example

require "google/cloud/bigtable"

bigtable = Google::Cloud::Bigtable.new

instances = bigtable.instances
if instances.next?
  next_instances = instances.next
end
# File lib/google/cloud/bigtable/instance/list.rb, line 86
def next
  return nil unless next?
  ensure_service!
  grpc = service.list_instances token: token
  next_list = self.class.from_grpc grpc, service
  next_list.failed_locations.concat(failed_locations.map(&:to_s)) if failed_locations
  next_list
end
next?() click to toggle source

Whether there is a next page of instances.

@return [Boolean]

@example

require "google/cloud/bigtable"

bigtable = Google::Cloud::Bigtable.new

instances = bigtable.instances
if instances.next?
  next_instances = instances.next
end
# File lib/google/cloud/bigtable/instance/list.rb, line 67
def next?
  !token.nil?
end

Protected Instance Methods

ensure_service!() click to toggle source

Raises an error unless an active service is available.

# File lib/google/cloud/bigtable/instance/list.rb, line 157
def ensure_service!
  raise "Must have active connection" unless service
end