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

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

Describes a sink used to export log entries to one of the following destinations in any project: a Cloud Storage bucket, a BigQuery dataset, a Pub/ Sub topic or a Cloud Logging log bucket. 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

Constructor Details

#initialize(**args) ⇒ LogSink

Returns a new instance of LogSink.



1647
1648
1649
 
# File 'lib/google/apis/logging_v2/classes.rb', line 1647

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

Instance Attribute Details

#bigquery_options ⇒ Google::Apis::LoggingV2::BigQueryOptions

Options that change functionality of a sink exporting data to BigQuery. Corresponds to the JSON property bigqueryOptions

Returns:



1548
1549
1550
 
# File 'lib/google/apis/logging_v2/classes.rb', line 1548

def bigquery_options
  @bigquery_options
end

#create_time ⇒ String

Output only. The creation timestamp of the sink.This field may not be present for older sinks. Corresponds to the JSON property createTime

Returns:

  • (String) 


1554
1555
1556
 
# File 'lib/google/apis/logging_v2/classes.rb', line 1554

def create_time
  @create_time
end

#description ⇒ String

Optional. A description of this sink.The maximum length of the description is 8000 characters. Corresponds to the JSON property description

Returns:

  • (String) 


1560
1561
1562
 
# File 'lib/google/apis/logging_v2/classes.rb', line 1560

def description
  @description
end

#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 (https://cloud.google.com/logging/ docs/api/tasks/exporting-logs). Corresponds to the JSON property destination

Returns:

  • (String) 


1571
1572
1573
 
# File 'lib/google/apis/logging_v2/classes.rb', line 1571

def destination
  @destination
end

#disabled ⇒ Boolean Also known as: disabled?

Optional. If set to true, then this sink is disabled and it does not export any log entries. Corresponds to the JSON property disabled

Returns:

  • (Boolean) 


1577
1578
1579
 
# File 'lib/google/apis/logging_v2/classes.rb', line 1577

def disabled
  @disabled
end

#exclusions ⇒ Array<Google::Apis::LoggingV2::LogExclusion>

Optional. Log entries that match any of these exclusion filters will not be exported.If a log entry is matched by both filter and one of exclusion_filters it will not be exported. Corresponds to the JSON property exclusions

Returns:



1585
1586
1587
 
# File 'lib/google/apis/logging_v2/classes.rb', line 1585

def exclusions
  @exclusions
end

#filter ⇒ String

Optional. An advanced logs filter (https://cloud.google.com/logging/docs/view/ advanced-queries). The only exported log entries are those that are in the resource owning the sink and that match the filter.For example:logName=" projects/[PROJECT_ID]/logs/[LOG_ID]" AND severity>=ERROR Corresponds to the JSON property filter

Returns:

  • (String) 


1593
1594
1595
 
# File 'lib/google/apis/logging_v2/classes.rb', line 1593

def filter
  @filter
end

#include_children ⇒ Boolean Also known as: include_children?

Optional. This field applies only to sinks owned by organizations and folders. If the field is false, the default, only the logs owned by the sink's parent resource are available for export. If the field is true, then log entries from all the projects, folders, and billing accounts contained in the sink's parent resource are also available for export. Whether a particular log entry from the children is exported depends on the sink's filter expression.For example, if this field is true, then the filter resource.type=gce_instance would export all Compute Engine VM instance log entries from all projects in the sink's parent.To only export entries from certain child projects, filter on the project part of the log name:logName:("projects/test-project1/" OR "projects/ test-project2/") AND resource.type=gce_instance Corresponds to the JSON property includeChildren

Returns:

  • (Boolean) 


1608
1609
1610
 
# File 'lib/google/apis/logging_v2/classes.rb', line 1608

def include_children
  @include_children
end

#name ⇒ String

Required. The client-assigned sink identifier, unique within the project.For 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. First character has to be alphanumeric. Corresponds to the JSON property name

Returns:

  • (String) 


1618
1619
1620
 
# File 'lib/google/apis/logging_v2/classes.rb', line 1618

def name
  @name
end

#output_version_format ⇒ String

Deprecated. This field is unused. Corresponds to the JSON property outputVersionFormat

Returns:

  • (String) 


1623
1624
1625
 
# File 'lib/google/apis/logging_v2/classes.rb', line 1623

def output_version_format
  @output_version_format
end

#update_time ⇒ String

Output only. The last update timestamp of the sink.This field may not be present for older sinks. Corresponds to the JSON property updateTime

Returns:

  • (String) 


1629
1630
1631
 
# File 'lib/google/apis/logging_v2/classes.rb', line 1629

def update_time
  @update_time
end

#writer_identity ⇒ String

Output only. An IAM identity—a service account or group—under which Cloud Logging writes the exported log entries to the sink's destination. This field is set by sinks.create and sinks.update based on the value 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 (https://cloud.google.com/ iam/docs/granting-roles-to-service-accounts# granting_access_to_a_service_account_for_a_resource). Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.Sinks that have a destination that is a log bucket in the same project as the sink do not have a writer_identity and no additional permissions are required. Corresponds to the JSON property writerIdentity

Returns:

  • (String) 


1645
1646
1647
 
# File 'lib/google/apis/logging_v2/classes.rb', line 1645

def writer_identity
  @writer_identity
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
 
# File 'lib/google/apis/logging_v2/classes.rb', line 1652

def update!(**args)
  @bigquery_options = args[:bigquery_options] if args.key?(:bigquery_options)
  @create_time = args[:create_time] if args.key?(:create_time)
  @description = args[:description] if args.key?(:description)
  @destination = args[:destination] if args.key?(:destination)
  @disabled = args[:disabled] if args.key?(:disabled)
  @exclusions = args[:exclusions] if args.key?(:exclusions)
  @filter = args[:filter] if args.key?(:filter)
  @include_children = args[:include_children] if args.key?(:include_children)
  @name = args[:name] if args.key?(:name)
  @output_version_format = args[:output_version_format] if args.key?(:output_version_format)
  @update_time = args[:update_time] if args.key?(:update_time)
  @writer_identity = args[:writer_identity] if args.key?(:writer_identity)
end