Class: Google::Apis::LoggingV2::ListLogEntriesRequest

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/logging_v2/classes.rb,
generated/google/apis/logging_v2/representations.rb,
generated/google/apis/logging_v2/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



431
432
433
 
# File 'generated/google/apis/logging_v2/classes.rb', line 431

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 in the resources listed in resource_names. Referencing a parent resource that is not listed in resource_names will cause the filter to return no results. The maximum length of the filter is 20000 characters. Corresponds to the JSON property filter

Returns:

  • (String) 


385
386
387
 
# File 'generated/google/apis/logging_v2/classes.rb', line 385

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 their insert_id values. Corresponds to the JSON property orderBy

Returns:

  • (String) 


395
396
397
 
# File 'generated/google/apis/logging_v2/classes.rb', line 395

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 next_page_token in the response indicates that more results might be available. Corresponds to the JSON property pageSize

Returns:

  • (Fixnum) 


402
403
404
 
# File 'generated/google/apis/logging_v2/classes.rb', line 402

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. page_token must be the value of next_page_token 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) 


410
411
412
 
# File 'generated/google/apis/logging_v2/classes.rb', line 410

def page_token
  @page_token
end

#project_ids ⇒ Array<String>

Deprecated. Use resource_names instead. One or more project identifiers or project numbers from which to retrieve log entries. Example: "my-project-1A". If present, these project identifiers are converted to resource name format and added to the list of resources in resource_names. Corresponds to the JSON property projectIds

Returns:

  • (Array<String>) 


418
419
420
 
# File 'generated/google/apis/logging_v2/classes.rb', line 418

def project_ids
  @project_ids
end

#resource_names ⇒ Array<String>

Required. Names of one or more parent resources from which to retrieve log entries: "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" Projects listed in the project_ids field are added to this list. Corresponds to the JSON property resourceNames

Returns:

  • (Array<String>) 


429
430
431
 
# File 'generated/google/apis/logging_v2/classes.rb', line 429

def resource_names
  @resource_names
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



436
437
438
439
440
441
442
443
 
# File 'generated/google/apis/logging_v2/classes.rb', line 436

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