SinkArgs class

The set of arguments for Sink. The set of arguments for Sink.

Constructors

SinkArgs({Input<BigQueryOptions>? bigqueryOptions, Input<String>? customWriterIdentity, Input<String>? description, required Input<String> destination, Input<bool>? disabled, Input<List<LogExclusion>>? exclusions, Input<String>? filter, Input<bool>? includeChildren, Input<String>? name, Input<SinkOutputVersionFormat>? outputVersionFormat, Input<String>? project, Input<bool>? uniqueWriterIdentity})
Creates a new SinkArgs. bigqueryOptions Optional. Options that affect sinks exporting data to BigQuery. customWriterIdentity Optional. A service account provided by the caller that will be used to write the log entries. The format must be serviceAccount:some@email. This field can only be specified if you are routing logs to a destination outside this sink's project. If not specified, a Logging service account will automatically be generated. description Optional. A description of this sink.The maximum length of the description is 8000 characters. destination 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" "logging.googleapis.com/projects/PROJECT_ID" "logging.googleapis.com/projects/PROJECT_ID/locations/LOCATION_ID/buckets/BUCKET_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). disabled Optional. If set to true, then this sink is disabled and it does not export any log entries. exclusions 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. filter 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 includeChildren 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 name 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. outputVersionFormat Deprecated. This field is unused. project Optional. uniqueWriterIdentity Optional. Determines the kind of IAM identity returned as writer_identity in the new sink. If this value is omitted or set to false, and if the sink's parent is a project, then the value returned as writer_identity is the same group or service account used by Cloud Logging before the addition of writer identities to this API. The sink's destination must be in the same project as the sink itself.If this field is set to true, or if the sink is owned by a non-project resource such as an organization, then the value of writer_identity will be a service agent (https://cloud.google.com/iam/docs/service-account-types#service-agents) used by the sinks with the same parent. For more information, see writer_identity in LogSink.
const
SinkArgs.fromMap(Map<String, dynamic> map)
factory

Properties

bigqueryOptions → Input<BigQueryOptions>?
Optional. Options that affect sinks exporting data to BigQuery.
final
customWriterIdentity → Input<String>?
Optional. A service account provided by the caller that will be used to write the log entries. The format must be serviceAccount:some@email. This field can only be specified if you are routing logs to a destination outside this sink's project. If not specified, a Logging service account will automatically be generated.
final
description → Input<String>?
Optional. A description of this sink.The maximum length of the description is 8000 characters.
final
destination → Input<String>
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" "logging.googleapis.com/projects/PROJECT_ID" "logging.googleapis.com/projects/PROJECT_ID/locations/LOCATION_ID/buckets/BUCKET_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).
final
disabled → Input<bool>?
Optional. If set to true, then this sink is disabled and it does not export any log entries.
final
exclusions → Input<List<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.
final
filter → Input<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
final
hashCode → int
The hash code for this object.
no setterinherited
includeChildren → Input<bool>?
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
final
name → Input<String>?
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.
final
outputVersionFormat → Input<SinkOutputVersionFormat>?
Deprecated. This field is unused.
final
project → Input<String>?
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
uniqueWriterIdentity → Input<bool>?
Optional. Determines the kind of IAM identity returned as writer_identity in the new sink. If this value is omitted or set to false, and if the sink's parent is a project, then the value returned as writer_identity is the same group or service account used by Cloud Logging before the addition of writer identities to this API. The sink's destination must be in the same project as the sink itself.If this field is set to true, or if the sink is owned by a non-project resource such as an organization, then the value of writer_identity will be a service agent (https://cloud.google.com/iam/docs/service-account-types#service-agents) used by the sinks with the same parent. For more information, see writer_identity in LogSink.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited