Class: Google::Apis::LoggingV2beta1::ListLogEntriesRequest

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/logging_v2beta1/classes.rb,
generated/google/apis/logging_v2beta1/representations.rb,
generated/google/apis/logging_v2beta1/representations.rb

Overview

The parameters to ListLogEntries.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ ListLogEntriesRequest

Returns a new instance of ListLogEntriesRequest.



1155
1156
1157
 
# File 'generated/google/apis/logging_v2beta1/classes.rb', line 1155

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#filter ⇒ String

Optional. A filter that chooses which log entries to return. See Advanced Logs Filters. Only log entries that match the filter are returned. An empty filter matches all log entries. Corresponds to the JSON property filter

Returns:

  • (String) 


1112
1113
1114
 
# File 'generated/google/apis/logging_v2beta1/classes.rb', line 1112

def filter
  @filter
end

#order_by ⇒ String

Optional. How the results should be sorted. Presently, the only permitted values are "timestamp asc" (default) and "timestamp desc". The first option returns entries in order of increasing values of LogEntry.timestamp (oldest first), and the second option returns entries in order of decreasing timestamps (newest first). Entries with equal timestamps are returned in order of LogEntry.insertId. Corresponds to the JSON property orderBy

Returns:

  • (String) 


1145
1146
1147
 
# File 'generated/google/apis/logging_v2beta1/classes.rb', line 1145

def order_by
  @order_by
end

#page_size ⇒ Fixnum

Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. Corresponds to the JSON property pageSize

Returns:

  • (Fixnum) 


1135
1136
1137
 
# File 'generated/google/apis/logging_v2beta1/classes.rb', line 1135

def page_size
  @page_size
end

#page_token ⇒ String

Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call. Corresponds to the JSON property pageToken

Returns:

  • (String) 


1153
1154
1155
 
# File 'generated/google/apis/logging_v2beta1/classes.rb', line 1153

def page_token
  @page_token
end

#project_ids ⇒ Array<String>

Deprecated. One or more project identifiers or project numbers from which to retrieve log entries. Examples: "my-project-1A", "1234567890". If present, these project identifiers are converted to resource format and added to the list of resources in resourceNames. Callers should use resourceNames rather than this parameter. Corresponds to the JSON property projectIds

Returns:

  • (Array<String>) 


1121
1122
1123
 
# File 'generated/google/apis/logging_v2beta1/classes.rb', line 1121

def project_ids
  @project_ids
end

#resource_names ⇒ Array<String>

Required. One or more cloud resources from which to retrieve log entries. Example: "projects/my-project-1A", "projects/1234567890". Projects listed in projectIds are added to this list. Corresponds to the JSON property resourceNames

Returns:

  • (Array<String>) 


1128
1129
1130
 
# File 'generated/google/apis/logging_v2beta1/classes.rb', line 1128

def resource_names
  @resource_names
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1160
1161
1162
1163
1164
1165
1166
1167
 
# File 'generated/google/apis/logging_v2beta1/classes.rb', line 1160

def update!(**args)
  @filter = args[:filter] if args.key?(:filter)
  @project_ids = args[:project_ids] if args.key?(:project_ids)
  @resource_names = args[:resource_names] if args.key?(:resource_names)
  @page_size = args[:page_size] if args.key?(:page_size)
  @order_by = args[:order_by] if args.key?(:order_by)
  @page_token = args[:page_token] if args.key?(:page_token)
end