Class: Google::Cloud::Bigtable::Instance::List

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

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#failed_locations ⇒ Object

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.



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

def failed_locations
  @failed_locations
end

#token ⇒ Object

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



35
36
37
 
# File 'lib/google/cloud/bigtable/instance/list.rb', line 35

def token
  @token
end

Instance Method Details

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

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

Yields:

  • (instance) —

    The block for accessing each instance.

Yield Parameters:

  • instance (Instance) —

    The instance object.

Returns:

  • (Enumerator, nil) —

    An enumerator is returned if no block is given, otherwise nil.



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

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 ⇒ Instance::List

Retrieves the next page of instances.

Examples:

require "google/cloud/bigtable"

bigtable = Google::Cloud::Bigtable.new

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

Returns:



86
87
88
89
90
91
92
93
 
# 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? ⇒ Boolean

Whether there is a next page of instances.

Examples:

require "google/cloud/bigtable"

bigtable = Google::Cloud::Bigtable.new

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

Returns:

  • (Boolean) 


67
68
69
 
# File 'lib/google/cloud/bigtable/instance/list.rb', line 67

def next?
  !token.nil?
end