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

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



2622
2623
2624
 
# File 'lib/google/apis/logging_v2/classes.rb', line 2622

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) 


2598
2599
2600
 
# File 'lib/google/apis/logging_v2/classes.rb', line 2598

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) 


2608
2609
2610
 
# File 'lib/google/apis/logging_v2/classes.rb', line 2608

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] organizations/[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>) 


2620
2621
2622
 
# File 'lib/google/apis/logging_v2/classes.rb', line 2620

def resource_names
  @resource_names
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2627
2628
2629
2630
2631
 
# File 'lib/google/apis/logging_v2/classes.rb', line 2627

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