Class: Google::Apis::LoggingV2::TailLogEntriesRequest

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ TailLogEntriesRequest

Returns a new instance of TailLogEntriesRequest.



2205
2206
2207
 
# File 'generated/google/apis/logging_v2/classes.rb', line 2205

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

Instance Attribute Details

#buffer_window ⇒ String

Optional. The amount of time to buffer log entries at the server before being returned to prevent out of order results due to late arriving log entries. Valid values are between 0-60000 milliseconds. Defaults to 2000 milliseconds. Corresponds to the JSON property bufferWindow

Returns:

  • (String) 


2181
2182
2183
 
# File 'generated/google/apis/logging_v2/classes.rb', line 2181

def buffer_window
  @buffer_window
end

#filter ⇒ String

Optional. A filter that chooses which log entries to return. See Advanced 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 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) 


2191
2192
2193
 
# File 'generated/google/apis/logging_v2/classes.rb', line 2191

def filter
  @filter
end

#resource_names ⇒ Array<String>

Required. Name of a parent resource from which to retrieve log entries: " projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[ BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" May alternatively be one or more views: "projects/PROJECT_ID/locations/LOCATION_ID/buckets/BUCKET_ID/views/ VIEW_ID" "organization/ORGANIZATION_ID/locations/LOCATION_ID/buckets/BUCKET_ID/ views/VIEW_ID" "billingAccounts/BILLING_ACCOUNT_ID/locations/LOCATION_ID/ buckets/BUCKET_ID/views/VIEW_ID" "folders/FOLDER_ID/locations/LOCATION_ID/ buckets/BUCKET_ID/views/VIEW_ID" Corresponds to the JSON property resourceNames

Returns:

  • (Array<String>) 


2203
2204
2205
 
# File 'generated/google/apis/logging_v2/classes.rb', line 2203

def resource_names
  @resource_names
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2210
2211
2212
2213
2214
 
# File 'generated/google/apis/logging_v2/classes.rb', line 2210

def update!(**args)
  @buffer_window = args[:buffer_window] if args.key?(:buffer_window)
  @filter = args[:filter] if args.key?(:filter)
  @resource_names = args[:resource_names] if args.key?(:resource_names)
end