SinkArgs

data class SinkArgs(val bigqueryOptions: Output<BigQueryOptionsArgs>? = null, val description: Output<String>? = null, val destination: Output<String>? = null, val disabled: Output<Boolean>? = null, val exclusions: Output<List<LogExclusionArgs>>? = null, val filter: Output<String>? = null, val includeChildren: Output<Boolean>? = null, val name: Output<String>? = null, val outputVersionFormat: Output<SinkOutputVersionFormat>? = null, val project: Output<String>? = null, val uniqueWriterIdentity: Output<Boolean>? = null) : ConvertibleToJava<SinkArgs>

Creates a sink that exports specified log entries to a destination. The export of newly-ingested log entries begins immediately, unless the sink's writer_identity is not permitted to write to the destination. A sink can export log entries only from the resource owning the sink.

Constructors

Link copied to clipboard
fun SinkArgs(bigqueryOptions: Output<BigQueryOptionsArgs>? = null, description: Output<String>? = null, destination: Output<String>? = null, disabled: Output<Boolean>? = null, exclusions: Output<List<LogExclusionArgs>>? = null, filter: Output<String>? = null, includeChildren: Output<Boolean>? = null, name: Output<String>? = null, outputVersionFormat: Output<SinkOutputVersionFormat>? = null, project: Output<String>? = null, uniqueWriterIdentity: Output<Boolean>? = null)

Functions

Link copied to clipboard
open override fun toJava(): SinkArgs

Properties

Link copied to clipboard

Optional. Options that affect sinks exporting data to BigQuery.

Link copied to clipboard
val description: Output<String>? = null

Optional. A description of this sink.The maximum length of the description is 8000 characters.

Link copied to clipboard
val destination: Output<String>? = null

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).

Link copied to clipboard
val disabled: Output<Boolean>? = null

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

Link copied to clipboard
val exclusions: Output<List<LogExclusionArgs>>? = null

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.

Link copied to clipboard
val filter: Output<String>? = null

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

Link copied to clipboard
val includeChildren: Output<Boolean>? = null

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

Link copied to clipboard
val name: Output<String>? = null

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.

Link copied to clipboard

Deprecated. This field is unused.

Link copied to clipboard
val project: Output<String>? = null
Link copied to clipboard
val uniqueWriterIdentity: Output<Boolean>? = null

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 unique service account used only for exports from the new sink. For more information, see writer_identity in LogSink.