Reference documentation and code samples for the google-cloud-logging class Google::Cloud::Logging::Metric::List.
Metric::List is a special case Array with additional values.
Inherits
- Array
Methods
#all
def all(request_limit: nil, &block) { |metric| ... } -> 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.
- request_limit (Integer) (defaults to: nil) — The upper limit of API requests to make to load all metrics. Default is no limit.
- (metric) — The block for accessing each metric.
- metric (Metric) — The metric object.
- (Enumerator)
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
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
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
#next
def next() -> Sink::List
Retrieve the next page of metrics.
require "google/cloud/logging" logging = Google::Cloud::Logging.new metrics = logging.metrics if metrics.next? next_metrics = metrics.next end
#next?
def next?() -> Boolean
Whether there is a next page of metrics.
- (Boolean)
require "google/cloud/logging" logging = Google::Cloud::Logging.new metrics = logging.metrics if metrics.next? next_metrics = metrics.next end
#token
def token()
If not empty, indicates that there are more records that match the request and this value should be passed to continue.
#token=
def token=(value)
If not empty, indicates that there are more records that match the request and this value should be passed to continue.