class Google::Cloud::Bigtable::Table::List

Table::List is a special-case array with additional values.

Attributes

grpc[RW]

@private The gRPC page enumerable object.

service[RW]

@private The gRPC Service object.

Public Class Methods

from_grpc(grpc, service) click to toggle source

@private New Table::List from a Gapic::PagedEnumerable<Google::Cloud::Bigtable::Admin::V2::Table> object.

# File lib/google/cloud/bigtable/table/list.rb, line 132
def self.from_grpc grpc, service
  tables = List.new(Array(grpc.response.tables).map do |table|
    Table.from_grpc table, service, view: :NAME_ONLY
  end)
  tables.grpc = grpc
  tables.service = service
  tables
end
new(arr = []) click to toggle source

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

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

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

@example Iterating each table by passing a block:

require "google/cloud/bigtable"

bigtable = Google::Cloud::Bigtable.new

bigtable.tables("my-instance").all do |table|
  puts table.table_id
end

@example Using the enumerator by not passing a block:

require "google/cloud/bigtable"

bigtable = Google::Cloud::Bigtable.new

all_table_ids = bigtable.tables("my-instance").all.map do |table|
  puts table.table_id
end
# File lib/google/cloud/bigtable/table/list.rb, line 117
def all &block
  return enum_for :all unless block_given?

  results = self
  loop do
    results.each(&block)
    break unless next?
    grpc.next_page
    results = self.class.from_grpc grpc, service
  end
end
next() click to toggle source

Retrieves the next page of tables.

@return [Table::List] The list of table instances.

@example

require "google/cloud/bigtable"

bigtable = Google::Cloud::Bigtable.new

tables = bigtable.tables "my-instance"
if tables.next?
  next_tables = tables.next
end
# File lib/google/cloud/bigtable/table/list.rb, line 75
def next
  ensure_grpc!

  return nil unless next?
  grpc.next_page
  self.class.from_grpc grpc, service
end
next?() click to toggle source

Whether there is a next page of tables.

@return [Boolean]

@example

require "google/cloud/bigtable"

bigtable = Google::Cloud::Bigtable.new

tables = bigtable.tables "my-instance"
if tables.next?
  next_tables = tables.next
end
# File lib/google/cloud/bigtable/table/list.rb, line 56
def next?
  grpc.next_page?
end

Protected Instance Methods

ensure_grpc!() click to toggle source

@private

Raises an error unless an active grpc call is available.

# File lib/google/cloud/bigtable/table/list.rb, line 147
def ensure_grpc!
  raise "Must have grpc call" unless grpc
end