class Google::Cloud::Logging::Sink::List

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

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

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

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

@yield [sink] The block for accessing each sink. @yieldparam [Sink] sink The sink object.

@return [Enumerator]

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

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

@example 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
# File lib/google/cloud/logging/sink/list.rb, line 125
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 sinks.

@return [Sink::List]

@example

require "google/cloud/logging"

logging = Google::Cloud::Logging.new

sinks = logging.sinks
if sinks.next?
  next_sinks = sinks.next
end
# File lib/google/cloud/logging/sink/list.rb, line 70
def next
  return nil unless next?
  ensure_service!
  list_grpc = @service.list_sinks 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 sinks.

@return [Boolean]

@example

require "google/cloud/logging"

logging = Google::Cloud::Logging.new

sinks = logging.sinks
if sinks.next?
  next_sinks = sinks.next
end
# File lib/google/cloud/logging/sink/list.rb, line 51
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/sink/list.rb, line 161
def ensure_service!
  raise "Must have active service" unless @service
end