Class LogSink (3.17.0)

public final class LogSink extends GeneratedMessageV3 implements LogSinkOrBuilder

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.

Protobuf type google.logging.v2.LogSink

Implements

LogSinkOrBuilder

Static Fields

BIGQUERY_OPTIONS_FIELD_NUMBER

public static final int BIGQUERY_OPTIONS_FIELD_NUMBER
Field Value
Type Description
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

DESTINATION_FIELD_NUMBER

public static final int DESTINATION_FIELD_NUMBER
Field Value
Type Description
int

DISABLED_FIELD_NUMBER

public static final int DISABLED_FIELD_NUMBER
Field Value
Type Description
int

EXCLUSIONS_FIELD_NUMBER

public static final int EXCLUSIONS_FIELD_NUMBER
Field Value
Type Description
int

FILTER_FIELD_NUMBER

public static final int FILTER_FIELD_NUMBER
Field Value
Type Description
int

INCLUDE_CHILDREN_FIELD_NUMBER

public static final int INCLUDE_CHILDREN_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

OUTPUT_VERSION_FORMAT_FIELD_NUMBER

public static final int OUTPUT_VERSION_FORMAT_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

WRITER_IDENTITY_FIELD_NUMBER

public static final int WRITER_IDENTITY_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static LogSink getDefaultInstance()
Returns
Type Description
LogSink

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static LogSink.Builder newBuilder()
Returns
Type Description
LogSink.Builder

newBuilder(LogSink prototype)

public static LogSink.Builder newBuilder(LogSink prototype)
Parameter
Name Description
prototype LogSink
Returns
Type Description
LogSink.Builder

parseDelimitedFrom(InputStream input)

public static LogSink parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
LogSink
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static LogSink parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
LogSink
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static LogSink parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
LogSink
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static LogSink parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
LogSink
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static LogSink parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
LogSink
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static LogSink parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
LogSink
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static LogSink parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
LogSink
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static LogSink parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
LogSink
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static LogSink parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
LogSink
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static LogSink parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
LogSink
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static LogSink parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
LogSink
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static LogSink parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
LogSink
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<LogSink> parser()
Returns
Type Description
Parser<LogSink>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getBigqueryOptions()

public BigQueryOptions getBigqueryOptions()

Optional. Options that affect sinks exporting data to BigQuery.

.google.logging.v2.BigQueryOptions bigquery_options = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
BigQueryOptions

The bigqueryOptions.

getBigqueryOptionsOrBuilder()

public BigQueryOptionsOrBuilder getBigqueryOptionsOrBuilder()

Optional. Options that affect sinks exporting data to BigQuery.

.google.logging.v2.BigQueryOptions bigquery_options = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
BigQueryOptionsOrBuilder

getCreateTime()

public Timestamp getCreateTime()

Output only. The creation timestamp of the sink.

This field may not be present for older sinks.

.google.protobuf.Timestamp create_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The creation timestamp of the sink.

This field may not be present for older sinks.

.google.protobuf.Timestamp create_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public LogSink getDefaultInstanceForType()
Returns
Type Description
LogSink

getDescription()

public String getDescription()

Optional. A description of this sink.

The maximum length of the description is 8000 characters.

string description = 18 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Optional. A description of this sink.

The maximum length of the description is 8000 characters.

string description = 18 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for description.

getDestination()

public String getDestination()

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.

string destination = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The destination.

getDestinationBytes()

public ByteString getDestinationBytes()

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.

string destination = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for destination.

getDisabled()

public boolean getDisabled()

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

bool disabled = 19 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The disabled.

getExclusions(int index)

public LogExclusion getExclusions(int index)

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.

repeated .google.logging.v2.LogExclusion exclusions = 16 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
LogExclusion

getExclusionsCount()

public int getExclusionsCount()

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.

repeated .google.logging.v2.LogExclusion exclusions = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getExclusionsList()

public List<LogExclusion> getExclusionsList()

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.

repeated .google.logging.v2.LogExclusion exclusions = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<LogExclusion>

getExclusionsOrBuilder(int index)

public LogExclusionOrBuilder getExclusionsOrBuilder(int index)

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.

repeated .google.logging.v2.LogExclusion exclusions = 16 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
LogExclusionOrBuilder

getExclusionsOrBuilderList()

public List<? extends LogExclusionOrBuilder> getExclusionsOrBuilderList()

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.

repeated .google.logging.v2.LogExclusion exclusions = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.logging.v2.LogExclusionOrBuilder>

getFilter()

public String getFilter()

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

string filter = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The filter.

getFilterBytes()

public ByteString getFilterBytes()

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

string filter = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for filter.

getIncludeChildren()

public boolean getIncludeChildren()

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

bool include_children = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The includeChildren.

getName()

public String getName()

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.

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

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.

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for name.

getOptionsCase()

public LogSink.OptionsCase getOptionsCase()
Returns
Type Description
LogSink.OptionsCase

getOutputVersionFormat() (deprecated)

public LogSink.VersionFormat getOutputVersionFormat()

Deprecated. google.logging.v2.LogSink.output_version_format is deprecated. See google/logging/v2/logging_config.proto;l=1000

Deprecated. This field is unused.

.google.logging.v2.LogSink.VersionFormat output_version_format = 6 [deprecated = true];

Returns
Type Description
LogSink.VersionFormat

The outputVersionFormat.

getOutputVersionFormatValue() (deprecated)

public int getOutputVersionFormatValue()

Deprecated. google.logging.v2.LogSink.output_version_format is deprecated. See google/logging/v2/logging_config.proto;l=1000

Deprecated. This field is unused.

.google.logging.v2.LogSink.VersionFormat output_version_format = 6 [deprecated = true];

Returns
Type Description
int

The enum numeric value on the wire for outputVersionFormat.

getParserForType()

public Parser<LogSink> getParserForType()
Returns
Type Description
Parser<LogSink>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getUpdateTime()

public Timestamp getUpdateTime()

Output only. The last update timestamp of the sink.

This field may not be present for older sinks.

.google.protobuf.Timestamp update_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. The last update timestamp of the sink.

This field may not be present for older sinks.

.google.protobuf.Timestamp update_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getWriterIdentity()

public String getWriterIdentity()

Output only. An IAM identity&mdash;a service account or group&mdash;under which Cloud Logging writes the exported log entries to the sink's destination. This field is either set by specifying custom_writer_identity or set automatically 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. 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 cannot have a writer_identity and no additional permissions are required.

string writer_identity = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The writerIdentity.

getWriterIdentityBytes()

public ByteString getWriterIdentityBytes()

Output only. An IAM identity&mdash;a service account or group&mdash;under which Cloud Logging writes the exported log entries to the sink's destination. This field is either set by specifying custom_writer_identity or set automatically 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. 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 cannot have a writer_identity and no additional permissions are required.

string writer_identity = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for writerIdentity.

hasBigqueryOptions()

public boolean hasBigqueryOptions()

Optional. Options that affect sinks exporting data to BigQuery.

.google.logging.v2.BigQueryOptions bigquery_options = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the bigqueryOptions field is set.

hasCreateTime()

public boolean hasCreateTime()

Output only. The creation timestamp of the sink.

This field may not be present for older sinks.

.google.protobuf.Timestamp create_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. The last update timestamp of the sink.

This field may not be present for older sinks.

.google.protobuf.Timestamp update_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the updateTime field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public LogSink.Builder newBuilderForType()
Returns
Type Description
LogSink.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected LogSink.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
LogSink.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public LogSink.Builder toBuilder()
Returns
Type Description
LogSink.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException