class Google::Apis::LoggingV2::LogSink
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.
Attributes
Options that change functionality of a sink exporting data to BigQuery. Corresponds to the JSON property `bigqueryOptions` @return [Google::Apis::LoggingV2::BigQueryOptions]
Output only. The creation timestamp of the sink.This field may not be present for older sinks. Corresponds to the JSON property `createTime` @return [String]
Optional. A description of this sink.The maximum length of the description is 8000 characters. Corresponds to the JSON property `description` @return [String]
Required. The export destination: “storage.googleapis.com/” “ bigquery.googleapis.com/projects//datasets/” “pubsub. googleapis.com/projects//topics/” 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 (cloud.google.com/logging/ docs/api/tasks/exporting-logs). Corresponds to the JSON property `destination` @return [String]
Optional. If set to true, then this sink is disabled and it does not export any log entries. Corresponds to the JSON property `disabled` @return [Boolean]
Optional. If set to true, then this sink is disabled and it does not export any log entries. Corresponds to the JSON property `disabled` @return [Boolean]
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` @return [Array<Google::Apis::LoggingV2::LogExclusion>]
Optional. An advanced logs filter (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//logs/” AND severity>=ERROR Corresponds to the JSON property `filter` @return [String]
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` @return [Boolean]
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` @return [Boolean]
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` @return [String]
Deprecated. This field is unused. Corresponds to the JSON property `outputVersionFormat` @return [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` @return [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 (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. Corresponds to the JSON property `writerIdentity` @return [String]
Public Class Methods
# File lib/google/apis/logging_v2/classes.rb, line 1646 def initialize(**args) update!(**args) end
Public Instance Methods
Update properties of this object
# File lib/google/apis/logging_v2/classes.rb, line 1651 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