google-cloud-logging - Class Google::Cloud::Logging::Entry::List (v2.2.2)

Reference documentation and code samples for the google-cloud-logging class Google::Cloud::Logging::Entry::List.

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

Inherits

  • Array

Methods

#all

def all(request_limit: nil, &block) { |entry| ... } -> 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 log entries. Default is no limit.
Yields
  • (entry) — The block for accessing each log entry.
Yield Parameter
  • entry (Entry) — The log entry object.
Returns
  • (Enumerator)
Examples

Iterating each log entry by passing a block:

require "google/cloud/logging"

logging = Google::Cloud::Logging.new
entries = logging.entries order: "timestamp desc"

entries.all do |e|
  puts "[#{e.timestamp}] #{e.log_name} #{e.payload.inspect}"
end

Using the enumerator by not passing a block:

require "google/cloud/logging"

logging = Google::Cloud::Logging.new
entries = logging.entries order: "timestamp desc"

all_payloads = entries.all.map do |entry|
  entry.payload
end

Limit the number of API calls made:

require "google/cloud/logging"

logging = Google::Cloud::Logging.new
entries = logging.entries order: "timestamp desc"

entries.all(request_limit: 10) do |e|
  puts "[#{e.timestamp}] #{e.log_name} #{e.payload.inspect}"
end

#next

def next() -> Sink::List

Retrieve the next page of entries.

Returns
Example 
require "google/cloud/logging"

logging = Google::Cloud::Logging.new

entries = logging.entries
if entries.next?
  next_entries = entries.next
end

#next?

def next?() -> Boolean

Whether there is a next page of entries.

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

logging = Google::Cloud::Logging.new

entries = logging.entries
if entries.next?
  next_entries = entries.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.