class Google::Cloud::Logging::ResourceDescriptor::List

ResourceDescriptor::List is a special case Array with additional values.

Attributes

token[RW]

If not empty, indicates that there are more records that match the request and this value should be passed to continue.

Public Class Methods

from_grpc(grpc_list, service, max = nil) click to toggle source

@private New ResourceDescriptor::List from a Google::Cloud::Logging::V2::ListMonitoredResourceDescriptorsResponse object.

# File lib/google/cloud/logging/resource_descriptor/list.rb, line 152
def self.from_grpc grpc_list, service, max = nil
  rds = new(Array(grpc_list.resource_descriptors).map do |grpc|
    ResourceDescriptor.from_grpc grpc
  end)
  token = grpc_list.next_page_token
  token = nil if token == "".freeze
  rds.instance_variable_set :@token,   token
  rds.instance_variable_set :@service, service
  rds.instance_variable_set :@max,     max
  rds
end
new(arr = []) click to toggle source

@private Create a new ResourceDescriptor::List with an array of ResourceDescriptor instances.

Calls superclass method
# File lib/google/cloud/logging/resource_descriptor/list.rb, line 34
def initialize arr = []
  super arr
end

Public Instance Methods

all(request_limit: nil, &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.

@param [Integer] request_limit The upper limit of API requests to

make to load all resource descriptors. Default is no limit.

@yield [resource_descriptor] The block for accessing each resource

descriptor.

@yieldparam [ResourceDescriptor] resource_descriptor The resource

descriptor object.

@return [Enumerator]

@example Iterating each resource descriptor by passing a block:

require "google/cloud/logging"

logging = Google::Cloud::Logging.new
resource_descriptors = logging.resource_descriptors

resource_descriptors.all do |rd|
  puts rd.type
end

@example Using the enumerator by not passing a block:

require "google/cloud/logging"

logging = Google::Cloud::Logging.new
resource_descriptors = logging.resource_descriptors

all_types = resource_descriptors.all.map do |rd|
  rd.type
end

@example Limit the number of API calls made:

require "google/cloud/logging"

logging = Google::Cloud::Logging.new
resource_descriptors = logging.resource_descriptors

resource_descriptors.all(request_limit: 10) do |rd|
  puts rd.type
end
# File lib/google/cloud/logging/resource_descriptor/list.rb, line 131
def all request_limit: nil, &block
  request_limit = request_limit.to_i if request_limit
  unless block_given?
    return enum_for :all, request_limit: request_limit
  end
  results = self
  loop do
    results.each(&block)
    if request_limit
      request_limit -= 1
      break if request_limit.negative?
    end
    break unless results.next?
    results = results.next
  end
end
next() click to toggle source

Retrieve the next page of resource descriptors.

@return [Sink::List]

@example

require "google/cloud/logging"

logging = Google::Cloud::Logging.new

resource_descriptors = logging.resource_descriptors
if resource_descriptors.next?
  next_resource_descriptors = resource_descriptors.next
end
# File lib/google/cloud/logging/resource_descriptor/list.rb, line 72
def next
  return nil unless next?
  ensure_service!
  list_grpc = @service.list_resource_descriptors(
    token: token, max: @max
  )
  self.class.from_grpc list_grpc, @service, @max
end
next?() click to toggle source

Whether there is a next page of resource descriptors.

@return [Boolean]

@example

require "google/cloud/logging"

logging = Google::Cloud::Logging.new

resource_descriptors = logging.resource_descriptors
if resource_descriptors.next?
  next_resource_descriptors = resource_descriptors.next
end
# File lib/google/cloud/logging/resource_descriptor/list.rb, line 53
def next?
  !token.nil?
end

Protected Instance Methods

ensure_service!() click to toggle source

Raise an error unless an active service is available.

# File lib/google/cloud/logging/resource_descriptor/list.rb, line 168
def ensure_service!
  raise "Must have active service" unless @service
end