class Google::Cloud::Logging::Metric::List

Metric::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 Metric::List from a Google::Cloud::Logging::V2::ListLogMetricsResponse object.

# File lib/google/cloud/logging/metric/list.rb, line 146
def self.from_grpc grpc_list, service, max = nil
  metrics = new(Array(grpc_list.metrics).map do |grpc_metric|
    Metric.from_grpc grpc_metric, service
  end)
  token = grpc_list.next_page_token
  token = nil if token == "".freeze
  metrics.instance_variable_set :@token,   token
  metrics.instance_variable_set :@service, service
  metrics.instance_variable_set :@max,     max
  metrics
end
new(arr = []) click to toggle source

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

Calls superclass method
# File lib/google/cloud/logging/metric/list.rb, line 33
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 metrics. Default is no limit.

@yield [metric] The block for accessing each metric. @yieldparam [Metric] metric The metric object.

@return [Enumerator]

@example Iterating each metric by passing a block:

require "google/cloud/logging"

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

metrics.all do |metric|
  puts "#{metric.name}: #{metric.filter}"
end

@example Using the enumerator by not passing a block:

require "google/cloud/logging"

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

all_names = metrics.all.map do |metric|
  metric.name
end

@example Limit the number of API calls made:

require "google/cloud/logging"

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

metrics.all(request_limit: 10) do |metric|
  puts "#{metric.name}: #{metric.filter}"
end
# File lib/google/cloud/logging/metric/list.rb, line 126
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 metrics.

@return [Sink::List]

@example

require "google/cloud/logging"

logging = Google::Cloud::Logging.new

metrics = logging.metrics
if metrics.next?
  next_metrics = metrics.next
end
# File lib/google/cloud/logging/metric/list.rb, line 71
def next
  return nil unless next?
  ensure_service!
  grpc = @service.list_metrics token: token, max: @max
  self.class.from_grpc grpc, @service, @max
end
next?() click to toggle source

Whether there is a next page of metrics.

@return [Boolean]

@example

require "google/cloud/logging"

logging = Google::Cloud::Logging.new

metrics = logging.metrics
if metrics.next?
  next_metrics = metrics.next
end
# File lib/google/cloud/logging/metric/list.rb, line 52
def next?
  !token.nil?
end

Protected Instance Methods

ensure_service!() click to toggle source

@private Raise an error unless an active connection to the service is available.

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