Class: Google::Logging::V2::ListLogEntriesRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/logging/v2/doc/google/logging/v2/logging.rb

Overview

The parameters to +ListLogEntries+.

Instance Attribute Summary collapse

Instance Attribute Details

#filter ⇒ String

Returns Optional. A filter that chooses which log entries to return. See Logs Filters[https://cloud.google.com/logging/docs/view/advanced_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.

Returns:

  • (String) —

    Optional. A filter that chooses which log entries to return. See Logs Filters[https://cloud.google.com/logging/docs/view/advanced_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.



132
 
# File 'lib/google/cloud/logging/v2/doc/google/logging/v2/logging.rb', line 132

class ListLogEntriesRequest; end

#order_by ⇒ String

Returns 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+.

Returns:

  • (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+.



132
 
# File 'lib/google/cloud/logging/v2/doc/google/logging/v2/logging.rb', line 132

class ListLogEntriesRequest; end

#page_size ⇒ Integer

Returns 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.

Returns:

  • (Integer) —

    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.



132
 
# File 'lib/google/cloud/logging/v2/doc/google/logging/v2/logging.rb', line 132

class ListLogEntriesRequest; end

#page_token ⇒ String

Returns 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.

Returns:

  • (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.



132
 
# File 'lib/google/cloud/logging/v2/doc/google/logging/v2/logging.rb', line 132

class ListLogEntriesRequest; end

#project_ids ⇒ Array<String>

Returns 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+.

Returns:

  • (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+.



132
 
# File 'lib/google/cloud/logging/v2/doc/google/logging/v2/logging.rb', line 132

class ListLogEntriesRequest; end

#resource_names ⇒ Array<String>

Returns Required. Names of one or more resources from which to retrieve log entries:

"projects/[PROJECT_ID]"
"organizations/[ORGANIZATION_ID]"

Projects listed in the +project_ids+ field are added to this list.

Returns:

  • (Array<String>) —

    Required. Names of one or more resources from which to retrieve log entries:

    "projects/[PROJECT_ID]"
"organizations/[ORGANIZATION_ID]"

    Projects listed in the +project_ids+ field are added to this list.



132
 
# File 'lib/google/cloud/logging/v2/doc/google/logging/v2/logging.rb', line 132

class ListLogEntriesRequest; end