Cloud Logging API - Class Google::Cloud::Logging::ResourceDescriptor::List (v2.3.3)

Reference documentation and code samples for the Cloud Logging API class Google::Cloud::Logging::ResourceDescriptor::List.

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

Inherits

  • Array

Methods

#all

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

Iterating each resource descriptor by passing a block:

require "google/cloud/logging"

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

resource_descriptors.all do |rd|
  puts rd.type
end

Using the enumerator by not passing a block:

require "google/cloud/logging"

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

all_types = resource_descriptors.all.map do |rd|
  rd.type
end

Limit the number of API calls made:

require "google/cloud/logging"

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

resource_descriptors.all(request_limit: 10) do |rd|
  puts rd.type
end

#next

def next() -> Sink::List

Retrieve the next page of resource descriptors.

Returns
Example 
require "google/cloud/logging"

logging = Google::Cloud::Logging.new

resource_descriptors = logging.resource_descriptors
if resource_descriptors.next?
  next_resource_descriptors = resource_descriptors.next
end

#next?

def next?() -> Boolean

Whether there is a next page of resource descriptors.

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

logging = Google::Cloud::Logging.new

resource_descriptors = logging.resource_descriptors
if resource_descriptors.next?
  next_resource_descriptors = resource_descriptors.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.