class Google::Cloud::Bigtable::Cluster::List

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

Attributes

failed_locations[RW]

Locations from which cluster information could not be retrieved, due to an outage or some other transient condition. Clusters from these locations may be missing from `clusters` or may only have partial information returned.

instance_id[RW]

@private Instance ID

service[RW]

@private The gRPC Service object.

token[RW]

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

Public Class Methods

from_grpc(grpc, service, instance_id: nil) click to toggle source

@private

New Cluster::List from a Google::Cloud::Bigtable::Admin::V2::ListClustersResponse object.

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

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

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

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

@example Iterating each cluster by passing a block:

require "google/cloud/bigtable"

bigtable = Google::Cloud::Bigtable.new

bigtable.clusters.all do |cluster|
  puts cluster.cluster_id
end

@example Using the enumerator by not passing a block:

require "google/cloud/bigtable"

bigtable = Google::Cloud::Bigtable.new

all_cluster_ids = bigtable.clusters.all.map do |cluster|
  puts cluster.cluster_id
end
# File lib/google/cloud/bigtable/cluster/list.rb, line 132
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

Retrieve the next page of clusters.

@return [Cluster::List] The list of clusters.

@example

require "google/cloud/bigtable"

bigtable = Google::Cloud::Bigtable.new

clusters = bigtable.clusters
if clusters.next?
  next_clusters = clusters.next
end
# File lib/google/cloud/bigtable/cluster/list.rb, line 89
def next
  return nil unless next?
  ensure_service!
  grpc = service.list_clusters instance_id, token: token
  next_list = self.class.from_grpc grpc, service, instance_id: instance_id
  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 clusters.

@return [Boolean]

@example

require "google/cloud/bigtable"

bigtable = Google::Cloud::Bigtable.new

clusters = bigtable.clusters
if clusters.next?
  next_clusters = clusters.next
end
# File lib/google/cloud/bigtable/cluster/list.rb, line 70
def next?
  !token.nil?
end

Protected Instance Methods

ensure_service!() click to toggle source

@private

Raise an error unless an active service is available.

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