Reference documentation and code samples for the google-cloud-bigtable class Google::Cloud::Bigtable::Table::List.
Table::List is a special-case array with additional values.
Inherits
- Array
Methods
#all
def all(&block) { |table| ... } -> Enumerator, nil
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.
- (table) — The block for accessing each table instance.
- table (Table) — The table instance object.
-
(Enumerator, nil) — An enumerator is returned if no block is given, otherwise
nil
.
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
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
#next
def next() -> Table::List
Retrieves the next page of tables.
- (Table::List) — The list of table instances.
require "google/cloud/bigtable" bigtable = Google::Cloud::Bigtable.new tables = bigtable.tables "my-instance" if tables.next? next_tables = tables.next end
#next?
def next?() -> Boolean
Whether there is a next page of tables.
- (Boolean)
require "google/cloud/bigtable" bigtable = Google::Cloud::Bigtable.new tables = bigtable.tables "my-instance" if tables.next? next_tables = tables.next end