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.



450
451
452
 
# File 'generated/google/apis/logging_v2beta1/classes.rb', line 450

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

Instance Attribute Details

#filter ⇒ String

Optional. An advanced logs filter. The filter is compared against all log entries in the projects specified by projectIds. Only entries that match the filter are retrieved. An empty filter matches all log entries. Corresponds to the JSON property filter

Returns:

  • (String) 


414
415
416
 
# File 'generated/google/apis/logging_v2beta1/classes.rb', line 414

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) 


424
425
426
 
# File 'generated/google/apis/logging_v2beta1/classes.rb', line 424

def order_by
  @order_by
end

#page_size ⇒ Fixnum

Optional. The maximum number of results to return from this request. You must check for presence of nextPageToken to determine if additional results are available, which you can retrieve by passing the nextPageToken value as the pageToken parameter in the next request. Corresponds to the JSON property pageSize

Returns:

  • (Fixnum) 


432
433
434
 
# File 'generated/google/apis/logging_v2beta1/classes.rb', line 432

def page_size
  @page_size
end

#page_token ⇒ String

Optional. If the pageToken parameter is supplied, then the next page of results is retrieved. The pageToken parameter must be set to the value of the nextPageToken from the previous response. The values of projectIds, filter, and orderBy must be the same as in the previous request. Corresponds to the JSON property pageToken

Returns:

  • (String) 


440
441
442
 
# File 'generated/google/apis/logging_v2beta1/classes.rb', line 440

def page_token
  @page_token
end

#partial_success ⇒ Boolean Also known as: partial_success?

Optional. If true, read access to all projects is not required and results will be returned for the subset of projects for which read access is permitted (empty subset is permitted). Corresponds to the JSON property partialSuccess

Returns:

  • (Boolean) 


447
448
449
 
# File 'generated/google/apis/logging_v2beta1/classes.rb', line 447

def partial_success
  @partial_success
end

#project_ids ⇒ Array<String>

Required. One or more project IDs or project numbers from which to retrieve log entries. Examples of a project ID: "my-project-1A", "1234567890". Corresponds to the JSON property projectIds

Returns:

  • (Array<String>) 


406
407
408
 
# File 'generated/google/apis/logging_v2beta1/classes.rb', line 406

def project_ids
  @project_ids
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



455
456
457
458
459
460
461
462
 
# File 'generated/google/apis/logging_v2beta1/classes.rb', line 455

def update!(**args)
  @project_ids = args[:project_ids] if args.key?(:project_ids)
  @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)
  @partial_success = args[:partial_success] if args.key?(:partial_success)
end