class Google::Cloud::Logging::Log::List
Log::List
is a special case Array with additional values.
Attributes
If not empty, indicates that there are more records that match the request and this value should be passed to continue.
Public Class Methods
@private New Log::List
from a Google::Cloud::Logging::V2::ListLogsResponse object.
# File lib/google/cloud/logging/log/list.rb, line 133 def self.from_grpc grpc_list, service, resource: nil, max: nil logs = new Array(grpc_list.log_names) token = grpc_list.next_page_token token = nil if token == "".freeze logs.instance_variable_set :@token, token logs.instance_variable_set :@service, service logs.instance_variable_set :@resource, resource logs.instance_variable_set :@max, max logs end
@private Create a new Log::List
with an array of log names.
# File lib/google/cloud/logging/log/list.rb, line 32 def initialize arr = [] super arr end
Public Instance Methods
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.
@param [Integer] request_limit The upper limit of API requests to
make to load all log names. Default is no limit.
@yield [log] The block for accessing each log name. @yieldparam [String] log The log name.
@return [Enumerator]
@example 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 }
@example 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 }
# 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
Retrieve the next page of logs.
@return [Log::List]
@example
require "google/cloud/logging" logging = Google::Cloud::Logging.new logs = logging.logs if logs.next? next_logs = logs.next end
# 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
Whether there is a next page of logs.
@return [Boolean]
@example
require "google/cloud/logging" logging = Google::Cloud::Logging.new logs = logging.logs if logs.next? next_logs = logs.next end
# File lib/google/cloud/logging/log/list.rb, line 51 def next? !token.nil? end
Protected Instance Methods
@private Raise an error unless an active connection to the service is available.
# File lib/google/cloud/logging/log/list.rb, line 149 def ensure_service! raise "Must have active connection to service" unless @service end