Class: Google::Cloud::Bigtable::AppProfile::List

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

Overview

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

Instance Method Summary collapse

Instance Method Details

#all {|app_profile| ... } ⇒ 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 app profile by passing a block:

require "google/cloud/bigtable"

bigtable = Google::Cloud::Bigtable.new

instance = bigtable.instance "my-instance"
app_profiles = instance.app_profiles

instance.app_profiles.all do |app_profile|
  puts app_profile.name
end

Using the enumerator by not passing a block:

require "google/cloud/bigtable"

bigtable = Google::Cloud::Bigtable.new

instance = bigtable.instance "my-instance"

all_app_profile_ids = instance.app_profiles.all.map(&:name)

Yields:

  • (app_profile) —

    The block for accessing each app profile.

Yield Parameters:

  • app_profile (AppProfile) —

    The app profile object.

Returns:

  • (Enumerator, nil) —

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



123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/google/cloud/bigtable/app_profile/list.rb', line 123

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

Retrieves the next page of app profiles.

Examples:

require "google/cloud/bigtable"

bigtable = Google::Cloud::Bigtable.new

instance = bigtable.instance "my-instance"
app_profiles = instance.app_profiles

if app_profiles.next?
  next_app_profiles = app_profiles.next
end

Returns:



78
79
80
81
82
83
84
 
# File 'lib/google/cloud/bigtable/app_profile/list.rb', line 78

def next
  ensure_grpc!

  return nil unless next?
  grpc.next_page
  self.class.from_grpc grpc, service
end

#next? ⇒ Boolean

Whether there is a next page of app profiles.

Examples:

require "google/cloud/bigtable"

bigtable = Google::Cloud::Bigtable.new

instance = bigtable.instance "my-instance"
app_profiles = instance.app_profiles

if app_profiles.next?
  next_app_profiles = app_profiles.next
end

Returns:

  • (Boolean) 


57
58
59
 
# File 'lib/google/cloud/bigtable/app_profile/list.rb', line 57

def next?
  grpc.next_page?
end