Class: Gcloud::Logging::Sink::List

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

Overview

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(arr = []) ⇒ List

Returns a new instance of List.



31
32
33
 
# File 'lib/gcloud/logging/sink/list.rb', line 31

def initialize arr = []
  super arr
end

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.



27
28
29
 
# File 'lib/gcloud/logging/sink/list.rb', line 27

def token
  @token
end

Class Method Details

.from_grpc(grpc_list, service, max = nil) ⇒ Object

object.



149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/gcloud/logging/sink/list.rb', line 149

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 == ""
  sinks.instance_variable_set "@token", token
  sinks.instance_variable_set "@service", service
  sinks.instance_variable_set "@max", max
  sinks
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 "gcloud"

gcloud = Gcloud.new
logging = gcloud.logging
sinks = logging.sinks

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

Using the enumerator by not passing a block:

require "gcloud"

gcloud = Gcloud.new
logging = gcloud.logging
sinks = logging.sinks

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

Limit the number of API calls made:

require "gcloud"

gcloud = Gcloud.new
logging = gcloud.logging
sinks = logging.sinks

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

Parameters:

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

  • sink (Sink) —

    The sink object.

Returns:

  • (Enumerator) 


129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/gcloud/logging/sink/list.rb', line 129

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 "gcloud"

gcloud = Gcloud.new
logging = gcloud.logging

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

Returns:



71
72
73
74
75
76
 
# File 'lib/gcloud/logging/sink/list.rb', line 71

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 "gcloud"

gcloud = Gcloud.new
logging = gcloud.logging

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

Returns:

  • (Boolean) 


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

def next?
  !token.nil?
end