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 instance 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_snapshot_ids = instance.app_profiles.all.map do |app_profile|
  app_profile.name
end

Yields:

  • (app_profile) —

    The block for accessing each instance.

Yield Parameters:

Returns:

  • (Enumerator) 


119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/google/cloud/bigtable/app_profile/list.rb', line 119

def all
  return enum_for(:all) unless block_given?

  results = self
  loop do
    results.each { |r| yield r }
    break unless next?
    grpc.next_page
    results = self.class.from_grpc(grpc, service)
  end
end

#next ⇒ AppProfile::List

Retrieve 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:



73
74
75
76
77
78
79
 
# File 'lib/google/cloud/bigtable/app_profile/list.rb', line 73

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 instances.

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) 


54
55
56
 
# File 'lib/google/cloud/bigtable/app_profile/list.rb', line 54

def next?
  grpc.next_page?
end