class Google::Cloud::Bigtable::AppProfile::List

AppProfile::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 Snapshot::List from a Gapic::PagedEnumerable<Google::Cloud::Bigtable::Admin::V2::AppProfile> object.

@param grpc [Gapic::PagedEnumerable<Google::Cloud::Bigtable::Admin::V2::AppProfile> ] @param service [Google::Cloud::Bigtable::Service] @return [Array<Google::Cloud::Bigtable::AppProfile>]

# File lib/google/cloud/bigtable/app_profile/list.rb, line 142
def self.from_grpc grpc, service
  app_profiles = List.new(
    Array(grpc.response.app_profiles).map do |app_profile|
      AppProfile.from_grpc app_profile, service
    end
  )
  app_profiles.grpc = grpc
  app_profiles.service = service
  app_profiles
end
new(arr = []) click to toggle source

@private Creates a new AppProfile::List with an array of app profiles.

Calls superclass method
# File lib/google/cloud/bigtable/app_profile/list.rb, line 36
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 [app_profile] The block for accessing each app profile. @yieldparam [AppProfile] app_profile The app profile object.

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

@example 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

@example 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)
# 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() click to toggle source

Retrieves the next page of app profiles.

@return [AppProfile::List] The list of app profiles.

@example

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
# 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?() click to toggle source

Whether there is a next page of app profiles.

@return [Boolean]

@example

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
# File lib/google/cloud/bigtable/app_profile/list.rb, line 57
def next?
  grpc.next_page?
end

Protected Instance Methods

ensure_grpc!() click to toggle source

@private

Raises an error if an active gRPC call is not available.

# File lib/google/cloud/bigtable/app_profile/list.rb, line 158
def ensure_grpc!
  raise "Must have active gRPC call" unless grpc
end