Class: Google::Apis::LoggingV2::LogSink

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

Describes a sink used to export log entries to one of the following destinations in any project: a Cloud Storage bucket, a BigQuery dataset, or a Cloud Pub/Sub topic. A logs filter controls which log entries are exported. The sink must be created within a project, organization, billing account, or folder.

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) ⇒ LogSink

Returns a new instance of LogSink



610
611
612
 
# File 'generated/google/apis/logging_v2/classes.rb', line 610

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

Instance Attribute Details

#destination ⇒ String

Required. The export destination: "storage.googleapis.com/[GCS_BUCKET]" "bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]" "pubsub.googleapis.com/projects/[PROJECT_ID]/topics/[TOPIC_ID]" The sink's writer_identity, set when the sink is created, must have permission to write to the destination or else the log entries are not exported. For more information, see Exporting Logs With Sinks. Corresponds to the JSON property destination

Returns:

  • (String) 


599
600
601
 
# File 'generated/google/apis/logging_v2/classes.rb', line 599

def destination
  @destination
end

#end_time ⇒ String

Optional. The time at which this sink will stop exporting log entries. Log entries are exported only if their timestamp is earlier than the end time. If this field is not supplied, there is no end time. If both a start time and an end time are provided, then the end time must be later than the start time. Corresponds to the JSON property endTime

Returns:

  • (String) 


541
542
543
 
# File 'generated/google/apis/logging_v2/classes.rb', line 541

def end_time
  @end_time
end

#filter ⇒ String

Optional. An advanced logs filter. The only exported log entries are those that are in the resource owning the sink and that match the filter. The filter must use the log entry format specified by the output_version_format parameter. For example, in the v2 format: logName="projects/[PROJECT_ID]/logs/[LOG_ID]" AND severity>=ERROR Corresponds to the JSON property filter

Returns:

  • (String) 


608
609
610
 
# File 'generated/google/apis/logging_v2/classes.rb', line 608

def filter
  @filter
end

#include_children ⇒ Boolean Also known as: include_children?

Optional. This field presently applies only to sinks in organizations and folders. If true, then logs from children of this entity will also be available to this sink for export. Whether particular log entries from the children are exported depends on the sink's filter expression. For example, if this sink is associated with an organization, then logs from all projects in the organization as well as from the organization itself will be available for export. Corresponds to the JSON property includeChildren

Returns:

  • (Boolean) 


587
588
589
 
# File 'generated/google/apis/logging_v2/classes.rb', line 587

def include_children
  @include_children
end

#name ⇒ String

Required. The client-assigned sink identifier, unique within the project. Example: "my-syslog-errors-to-pubsub". Sink identifiers are limited to 100 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods. Corresponds to the JSON property name

Returns:

  • (String) 


576
577
578
 
# File 'generated/google/apis/logging_v2/classes.rb', line 576

def name
  @name
end

#output_version_format ⇒ String

Optional. The log entry format to use for this sink's exported log entries. The v2 format is used by default. The v1 format is deprecated and should be used only as part of a migration effort to v2. See Migration to the v2 API. Corresponds to the JSON property outputVersionFormat

Returns:

  • (String) 


568
569
570
 
# File 'generated/google/apis/logging_v2/classes.rb', line 568

def output_version_format
  @output_version_format
end

#start_time ⇒ String

Optional. The time at which this sink will begin exporting log entries. Log entries are exported only if their timestamp is not earlier than the start time. The default value of this field is the time the sink is created or updated. Corresponds to the JSON property startTime

Returns:

  • (String) 


561
562
563
 
# File 'generated/google/apis/logging_v2/classes.rb', line 561

def start_time
  @start_time
end

#writer_identity ⇒ String

Output only. An IAM identity—a service account or group—under which Stackdriver Logging writes the exported log entries to the sink's destination. This field is set by sinks.create and sinks.update, based on the setting of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting access for a resource. Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity. Corresponds to the JSON property writerIdentity

Returns:

  • (String) 


553
554
555
 
# File 'generated/google/apis/logging_v2/classes.rb', line 553

def writer_identity
  @writer_identity
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



615
616
617
618
619
620
621
622
623
624
 
# File 'generated/google/apis/logging_v2/classes.rb', line 615

def update!(**args)
  @end_time = args[:end_time] if args.key?(:end_time)
  @writer_identity = args[:writer_identity] if args.key?(:writer_identity)
  @start_time = args[:start_time] if args.key?(:start_time)
  @output_version_format = args[:output_version_format] if args.key?(:output_version_format)
  @name = args[:name] if args.key?(:name)
  @include_children = args[:include_children] if args.key?(:include_children)
  @destination = args[:destination] if args.key?(:destination)
  @filter = args[:filter] if args.key?(:filter)
end