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

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

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

Inherits

Array

Methods

#all

def all(request_limit: nil, &block) { |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.

Parameter

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 Parameter

log (String) — The log name.

Returns

(Enumerator)

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 }

#next

def next() -> Log::List

Retrieve the next page of logs.

Returns

(Log::List)

Example

require "google/cloud/logging"

logging = Google::Cloud::Logging.new

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

#next?

def next?() -> Boolean

Whether there is a next page of logs.

Returns

(Boolean)

Example

require "google/cloud/logging"

logging = Google::Cloud::Logging.new

logs = logging.logs
if logs.next?
  next_logs = logs.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.