Class: Google::Cloud::Logging::Entry::List
- Inherits:
-
Array
- Object
- Array
- Google::Cloud::Logging::Entry::List
- Defined in:
- lib/google/cloud/logging/entry/list.rb
Overview
Entry::List is a special case Array with additional values.
Instance Attribute Summary collapse
-
#token ⇒ Object
If not empty, indicates that there are more records that match the request and this value should be passed to continue.
Instance Method Summary collapse
- #all(request_limit: nil) {|entry| ... } ⇒ Enumerator
-
#next ⇒ Sink::List
Retrieve the next page of entries.
-
#next? ⇒ Boolean
Whether there is a next page of entries.
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/entry/list.rb', line 28 def token @token end |
Instance Method Details
#all(request_limit: nil) {|entry| ... } ⇒ Enumerator
Retrieves all log entries by repeatedly loading #next until
#next? returns false
. Calls the given block once for each log
entry, which is passed as the parameter.
An Enumerator is returned if no block is given.
This method may make several API calls until all log entries are retrieved. Be sure to use as narrow a search criteria as possible. Please use with caution.
127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 |
# File 'lib/google/cloud/logging/entry/list.rb', line 127 def all request_limit: nil 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 { |r| yield r } if request_limit request_limit -= 1 break if request_limit < 0 end break unless results.next? results = results.next end end |
#next ⇒ Sink::List
Retrieve the next page of entries.
70 71 72 73 74 75 76 77 |
# File 'lib/google/cloud/logging/entry/list.rb', line 70 def next return nil unless next? ensure_service! grpc = @service.list_entries token: token, projects: @projects, filter: @filter, order: @order, max: @max self.class.from_grpc grpc, @service end |
#next? ⇒ Boolean
Whether there is a next page of entries.
51 52 53 |
# File 'lib/google/cloud/logging/entry/list.rb', line 51 def next? !token.nil? end |