Class: Google::Cloud::Logging::Sink::List

Inherits:
Array
  • Object
show all
Defined in:
lib/google/cloud/logging/sink/list.rb

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#token ⇒ Object

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



28
29
30
 
# File 'lib/google/cloud/logging/sink/list.rb', line 28

def token
  @token
end

Instance Method Details

#all(request_limit: nil) {|sink| ... } ⇒ Enumerator

Retrieves all sinks by repeatedly loading #next until #next? returns false. Calls the given block once for each sink, which is passed as the parameter.

An Enumerator is returned if no block is given.

This method may make several API calls until all sinks are retrieved. Be sure to use as narrow a search criteria as possible. Please use with caution.

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

Parameters:

  • request_limit (Integer) —

    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 Parameters:

  • sink (Sink) —

    The sink object.

Returns:

  • (Enumerator) 


125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/google/cloud/logging/sink/list.rb', line 125

def all request_limit: nil
  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 { |r| yield r }
    if request_limit
      request_limit -= 1
      break if request_limit < 0
    end
    break unless results.next?
    results = results.next
  end
end

#next ⇒ Sink::List

Retrieve the next page of sinks.

Examples:

require "google/cloud/logging"

logging = Google::Cloud::Logging.new

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

Returns:



70
71
72
73
74
75
 
# 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
end

#next? ⇒ Boolean

Whether there is a next page of sinks.

Examples:

require "google/cloud/logging"

logging = Google::Cloud::Logging.new

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

Returns:

  • (Boolean) 


51
52
53
 
# File 'lib/google/cloud/logging/sink/list.rb', line 51

def next?
  !token.nil?
end