Class: Google::Cloud::Logging::Log::List

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

Overview

Log::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/log/list.rb', line 28

def token
  @token
end

Instance Method Details

#all(request_limit: nil) {|log| ... } ⇒ 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.

Examples:

Iterating each log name by passing a block:

require "google/cloud/logging"

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

logs.all { |l| puts l }

Limit the number of API calls made:

require "google/cloud/logging"

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

logs.all(request_limit: 10) { |l| puts l }

Parameters:

  • request_limit (Integer) (defaults to: nil) —

    The upper limit of API requests to make to load all log names. Default is no limit.

Yields:

  • (log) —

    The block for accessing each log name.

Yield Parameters:

  • log (String) —

    The log name.

Returns:

  • (Enumerator) 


113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/google/cloud/logging/log/list.rb', line 113

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 ⇒ Log::List

Retrieve the next page of logs.

Examples:

require "google/cloud/logging"

logging = Google::Cloud::Logging.new

logs = logging.logs
if logs.next?
  next_logs = logs.next
end

Returns:



70
71
72
73
74
75
76
77
 
# File 'lib/google/cloud/logging/log/list.rb', line 70

def next
  return nil unless next?
  ensure_service!
  grpc = @service.list_logs token: token, resource: @resource,
                            max: @max
  self.class.from_grpc grpc, @service, resource: @resource,
                                       max:      @max
end

#next? ⇒ Boolean

Whether there is a next page of logs.

Examples:

require "google/cloud/logging"

logging = Google::Cloud::Logging.new

logs = logging.logs
if logs.next?
  next_logs = logs.next
end

Returns:

  • (Boolean) 


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

def next?
  !token.nil?
end