Class LogSink

public sealed class LogSink : IMessage<LogSink>, IEquatable<LogSink>, IDeepCloneable<LogSink>, IBufferMessage, IMessage

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.

Inheritance

Object > LogSink

Namespace

Google.Cloud.Logging.V2

Assembly

Google.Cloud.Logging.V2.dll

Constructors

LogSink()

public LogSink()

LogSink(LogSink)

public LogSink(LogSink other)
Parameter
TypeNameDescription
LogSinkother

Properties

BigqueryOptions

public BigQueryOptions BigqueryOptions { get; set; }

Optional. Options that affect sinks exporting data to BigQuery.

Property Value
TypeDescription
BigQueryOptions

CreateTime

public Timestamp CreateTime { get; set; }

Output only. The creation timestamp of the sink.

This field may not be present for older sinks.

Property Value
TypeDescription
Timestamp

Description

public string Description { get; set; }

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

Property Value
TypeDescription
String

Destination

public string Destination { get; set; }

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.

Property Value
TypeDescription
String

DestinationAsResourceName

public IResourceName DestinationAsResourceName { get; set; }

IResourceName-typed view over the Destination resource name property.

Property Value
TypeDescription
IResourceName

Disabled

public bool Disabled { get; set; }

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

Property Value
TypeDescription
Boolean

Exclusions

public RepeatedField<LogExclusion> Exclusions { get; }

Optional. Log entries that match any of the 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.

Property Value
TypeDescription
RepeatedField<LogExclusion>

Filter

public string Filter { get; set; }

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. For example:

logName="projects/[PROJECT_ID]/logs/[LOG_ID]" AND severity>=ERROR

Property Value
TypeDescription
String

IncludeChildren

public bool IncludeChildren { get; set; }

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 logs 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

Property Value
TypeDescription
Boolean

LogSinkName

public LogSinkName LogSinkName { get; set; }

LogSinkName-typed view over the Name resource name property.

Property Value
TypeDescription
LogSinkName

Name

public string Name { get; set; }

Required. The client-assigned sink identifier, unique within the project. Example: &quot;my-syslog-errors-to-pubsub&quot;. 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.

Property Value
TypeDescription
String

OptionsCase

public LogSink.OptionsOneofCase OptionsCase { get; }
Property Value
TypeDescription
LogSink.OptionsOneofCase

OutputVersionFormat

[Obsolete]
public LogSink.Types.VersionFormat OutputVersionFormat { get; set; }

Deprecated. This field is unused.

Property Value
TypeDescription
LogSink.Types.VersionFormat

UpdateTime

public Timestamp UpdateTime { get; set; }

Output only. The last update timestamp of the sink.

This field may not be present for older sinks.

Property Value
TypeDescription
Timestamp

WriterIdentity

public string WriterIdentity { get; set; }

Output only. An IAM identity&mdash;a service account or group&mdash;under which Logging writes the exported log entries to the sink's destination. This field is set by [sinks.create][google.logging.v2.ConfigServiceV2.CreateSink] and [sinks.update][google.logging.v2.ConfigServiceV2.UpdateSink] 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. Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.

Property Value
TypeDescription
String