Class: Google::Cloud::Bigtable::Cluster::List

Inherits:
Array
  • Object
show all
Defined in:
lib/google/cloud/bigtable/cluster/list.rb

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#failed_locations ⇒ Object

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.



43
44
45
 
# File 'lib/google/cloud/bigtable/cluster/list.rb', line 43

def failed_locations
  @failed_locations
end

#token ⇒ Object

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



37
38
39
 
# File 'lib/google/cloud/bigtable/cluster/list.rb', line 37

def token
  @token
end

Instance Method Details

#all {|cluster| ... } ⇒ 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.

Examples:

Iterating each cluster by passing a block:

require "google/cloud/bigtable"

bigtable = Google::Cloud::Bigtable.new

bigtable.clusters("instance-id").all do |cluster|
  puts cluster.cluster_id
end

Using the enumerator by not passing a block:

require "google/cloud/bigtable"

bigtable = Google::Cloud::Bigtable.new

all_cluster_ids = bigtable.clusters("instance-id").all.map do |cluster|
  puts cluster.instance_id
end

Yields:

  • (cluster) —

    The block for accessing each cluster.

Yield Parameters:

  • cluster (Cluster) —

    The cluster object.

Returns:

  • (Enumerator) 


130
131
132
133
134
135
136
137
138
139
 
# File 'lib/google/cloud/bigtable/cluster/list.rb', line 130

def all
  return enum_for(:all) unless block_given?

  results = self
  loop do
    results.each { |r| yield r }
    break unless results.next?
    results = results.next
  end
end

#next ⇒ Cluster::List

Retrieve the next page of clusters.

Examples:

require "google/cloud/bigtable"

bigtable = Google::Cloud::Bigtable.new

clusters = bigtable.clusters("instance-id")
if instances.next?
  next_clusters = clusters.next
end

Returns:



82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/google/cloud/bigtable/cluster/list.rb', line 82

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
  )
  if failed_locations
    next_list.failed_locations.concat(failed_locations.map(&:to_s))
  end
  next_list
end

#next? ⇒ Boolean

Whether there is a next page of instances.

Examples:

require "google/cloud/bigtable"

bigtable = Google::Cloud::Bigtable.new

clusters = bigtable.clusters("instance-id")
if clusters.next?
  next_clusters = clusters.next
end

Returns:

  • (Boolean) 


65
66
67
 
# File 'lib/google/cloud/bigtable/cluster/list.rb', line 65

def next?
  !token.nil?
end