Cloud Logging API - Class Google::Cloud::Logging::Sink::List (v2.4.0)

Reference documentation and code samples for the Cloud Logging API class Google::Cloud::Logging::Sink::List.

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

Inherits

  • Array

Methods

#all

def all(request_limit: nil, &block) { |sink| ... } -> 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.

Parameter
  • request_limit (Integer) (defaults to: nil) — The upper limit of API requests to make to load all sinks. Default is no limit.
Yields
  • (sink) — The block for accessing each sink.
Yield Parameter
  • sink (Sink) — The sink object.
Returns
  • (Enumerator)
Examples

Iterating each sink by passing a block:

require "google/cloud/logging"

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

sinks.all do |sink|
  puts "#{sink.name}: #{sink.filter} -> #{sink.destination}"
end

Using the enumerator by not passing a block:

require "google/cloud/logging"

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

all_names = sinks.all.map do |sink|
  sink.name
end

Limit the number of API calls made:

require "google/cloud/logging"

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

sinks.all(request_limit: 10) do |sink|
  puts "#{sink.name}: #{sink.filter} -> #{sink.destination}"
end

#next

def next() -> Sink::List

Retrieve the next page of sinks.

Returns
Example 
require "google/cloud/logging"

logging = Google::Cloud::Logging.new

sinks = logging.sinks
if sinks.next?
  next_sinks = sinks.next
end

#next?

def next?() -> Boolean

Whether there is a next page of sinks.

Returns
  • (Boolean)
Example 
require "google/cloud/logging"

logging = Google::Cloud::Logging.new

sinks = logging.sinks
if sinks.next?
  next_sinks = sinks.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.