Class LogSink.Builder (3.14.7)

Version 3.14.7

• 3.20.7 (latest)
• 3.20.6
• 3.19.0
• 3.18.0
• 3.17.2
• 3.16.2
• 3.15.17
• 3.14.9
• 3.13.7
• 3.12.1
• 3.11.10
• 3.10.7
• 3.9.0
• 3.8.0
• 3.7.6
• 3.6.4
• 3.5.3

public static final class LogSink.Builder extends GeneratedMessageV3.Builder<LogSink.Builder> 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

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > LogSink.Builder

Implements

LogSinkOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

addAllExclusions(Iterable<? extends LogExclusion> values)

public LogSink.Builder addAllExclusions(Iterable<? extends LogExclusion> values)

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
values	Iterable<? extends com.google.logging.v2.LogExclusion>

Returns
Type	Description
LogSink.Builder

addExclusions(LogExclusion value)

public LogSink.Builder addExclusions(LogExclusion value)

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
value	LogExclusion

Returns
Type	Description
LogSink.Builder

addExclusions(LogExclusion.Builder builderForValue)

public LogSink.Builder addExclusions(LogExclusion.Builder builderForValue)

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
builderForValue	LogExclusion.Builder

Returns
Type	Description
LogSink.Builder

addExclusions(int index, LogExclusion value)

public LogSink.Builder addExclusions(int index, LogExclusion value)

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];

Parameters
Name	Description
index	int
value	LogExclusion

Returns
Type	Description
LogSink.Builder

addExclusions(int index, LogExclusion.Builder builderForValue)

public LogSink.Builder addExclusions(int index, LogExclusion.Builder builderForValue)

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];

Parameters
Name	Description
index	int
builderForValue	LogExclusion.Builder

Returns
Type	Description
LogSink.Builder

addExclusionsBuilder()

public LogExclusion.Builder addExclusionsBuilder()

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
LogExclusion.Builder

addExclusionsBuilder(int index)

public LogExclusion.Builder addExclusionsBuilder(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.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public LogSink.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
LogSink.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public LogSink build()

Returns
Type	Description
LogSink

buildPartial()

public LogSink buildPartial()

Returns
Type	Description
LogSink

clear()

public LogSink.Builder clear()

Returns
Type	Description
LogSink.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearBigqueryOptions()

public LogSink.Builder clearBigqueryOptions()

Optional. Options that affect sinks exporting data to BigQuery.

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

Returns
Type	Description
LogSink.Builder

clearCreateTime()

public LogSink.Builder clearCreateTime()

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
LogSink.Builder

clearDescription()

public LogSink.Builder clearDescription()

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
LogSink.Builder	This builder for chaining.

clearDestination()

public LogSink.Builder clearDestination()

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
LogSink.Builder	This builder for chaining.

clearDisabled()

public LogSink.Builder clearDisabled()

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
LogSink.Builder	This builder for chaining.

clearExclusions()

public LogSink.Builder clearExclusions()

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
LogSink.Builder

clearField(Descriptors.FieldDescriptor field)

public LogSink.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
LogSink.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearFilter()

public LogSink.Builder clearFilter()

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
LogSink.Builder	This builder for chaining.

clearIncludeChildren()

public LogSink.Builder clearIncludeChildren()

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
LogSink.Builder	This builder for chaining.

clearName()

public LogSink.Builder clearName()

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
LogSink.Builder	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public LogSink.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
LogSink.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearOptions()

public LogSink.Builder clearOptions()

Returns
Type	Description
LogSink.Builder

clearOutputVersionFormat() (deprecated)

public LogSink.Builder clearOutputVersionFormat()

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

Deprecated. This field is unused.

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

Returns
Type	Description
LogSink.Builder	This builder for chaining.

clearUpdateTime()

public LogSink.Builder clearUpdateTime()

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
LogSink.Builder

clearWriterIdentity()

public LogSink.Builder clearWriterIdentity()

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 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. 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 do not have a writer_identity and no additional permissions are required.

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

Returns
Type	Description
LogSink.Builder	This builder for chaining.

clone()

public LogSink.Builder clone()

Returns
Type	Description
LogSink.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

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.

getBigqueryOptionsBuilder()

public BigQueryOptions.Builder getBigqueryOptionsBuilder()

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

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.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

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
Builder

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.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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

getExclusionsBuilder(int index)

public LogExclusion.Builder getExclusionsBuilder(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.Builder

getExclusionsBuilderList()

public List<LogExclusion.Builder> getExclusionsBuilderList()

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

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=880

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=880

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.

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.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

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
Builder

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 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. 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 do not 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 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. 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 do not 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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeBigqueryOptions(BigQueryOptions value)

public LogSink.Builder mergeBigqueryOptions(BigQueryOptions value)

Optional. Options that affect sinks exporting data to BigQuery.

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

Parameter
Name	Description
value	BigQueryOptions

Returns
Type	Description
LogSink.Builder

mergeCreateTime(Timestamp value)

public LogSink.Builder mergeCreateTime(Timestamp value)

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];

Parameter
Name	Description
value	Timestamp

Returns
Type	Description
LogSink.Builder

mergeFrom(LogSink other)

public LogSink.Builder mergeFrom(LogSink other)

Parameter
Name	Description
other	LogSink

Returns
Type	Description
LogSink.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public LogSink.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
LogSink.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public LogSink.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
LogSink.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final LogSink.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
LogSink.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

mergeUpdateTime(Timestamp value)

public LogSink.Builder mergeUpdateTime(Timestamp value)

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];

Parameter
Name	Description
value	Timestamp

Returns
Type	Description
LogSink.Builder

removeExclusions(int index)

public LogSink.Builder removeExclusions(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
LogSink.Builder

setBigqueryOptions(BigQueryOptions value)

public LogSink.Builder setBigqueryOptions(BigQueryOptions value)

Optional. Options that affect sinks exporting data to BigQuery.

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

Parameter
Name	Description
value	BigQueryOptions

Returns
Type	Description
LogSink.Builder

setBigqueryOptions(BigQueryOptions.Builder builderForValue)

public LogSink.Builder setBigqueryOptions(BigQueryOptions.Builder builderForValue)

Optional. Options that affect sinks exporting data to BigQuery.

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

Parameter
Name	Description
builderForValue	BigQueryOptions.Builder

Returns
Type	Description
LogSink.Builder

setCreateTime(Timestamp value)

public LogSink.Builder setCreateTime(Timestamp value)

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];

Parameter
Name	Description
value	Timestamp

Returns
Type	Description
LogSink.Builder

setCreateTime(Timestamp.Builder builderForValue)

public LogSink.Builder setCreateTime(Timestamp.Builder builderForValue)

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];

Parameter
Name	Description
builderForValue	Builder

Returns
Type	Description
LogSink.Builder

setDescription(String value)

public LogSink.Builder setDescription(String value)

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

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

Parameter
Name	Description
value	String The description to set.

Returns
Type	Description
LogSink.Builder	This builder for chaining.

setDescriptionBytes(ByteString value)

public LogSink.Builder setDescriptionBytes(ByteString value)

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

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

Parameter
Name	Description
value	ByteString The bytes for description to set.

Returns
Type	Description
LogSink.Builder	This builder for chaining.

setDestination(String value)

public LogSink.Builder setDestination(String value)

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) = { ... }

Parameter
Name	Description
value	String The destination to set.

Returns
Type	Description
LogSink.Builder	This builder for chaining.

setDestinationBytes(ByteString value)

public LogSink.Builder setDestinationBytes(ByteString value)

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) = { ... }

Parameter
Name	Description
value	ByteString The bytes for destination to set.

Returns
Type	Description
LogSink.Builder	This builder for chaining.

setDisabled(boolean value)

public LogSink.Builder setDisabled(boolean value)

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];

Parameter
Name	Description
value	boolean The disabled to set.

Returns
Type	Description
LogSink.Builder	This builder for chaining.

setExclusions(int index, LogExclusion value)

public LogSink.Builder setExclusions(int index, LogExclusion value)

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];

Parameters
Name	Description
index	int
value	LogExclusion

Returns
Type	Description
LogSink.Builder

setExclusions(int index, LogExclusion.Builder builderForValue)

public LogSink.Builder setExclusions(int index, LogExclusion.Builder builderForValue)

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];

Parameters
Name	Description
index	int
builderForValue	LogExclusion.Builder

Returns
Type	Description
LogSink.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public LogSink.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
LogSink.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setFilter(String value)

public LogSink.Builder setFilter(String value)

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];

Parameter
Name	Description
value	String The filter to set.

Returns
Type	Description
LogSink.Builder	This builder for chaining.

setFilterBytes(ByteString value)

public LogSink.Builder setFilterBytes(ByteString value)

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];

Parameter
Name	Description
value	ByteString The bytes for filter to set.

Returns
Type	Description
LogSink.Builder	This builder for chaining.

setIncludeChildren(boolean value)

public LogSink.Builder setIncludeChildren(boolean value)

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];

Parameter
Name	Description
value	boolean The includeChildren to set.

Returns
Type	Description
LogSink.Builder	This builder for chaining.

setName(String value)

public LogSink.Builder setName(String value)

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];

Parameter
Name	Description
value	String The name to set.

Returns
Type	Description
LogSink.Builder	This builder for chaining.

setNameBytes(ByteString value)

public LogSink.Builder setNameBytes(ByteString value)

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];

Parameter
Name	Description
value	ByteString The bytes for name to set.

Returns
Type	Description
LogSink.Builder	This builder for chaining.

setOutputVersionFormat(LogSink.VersionFormat value) (deprecated)

public LogSink.Builder setOutputVersionFormat(LogSink.VersionFormat value)

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

Deprecated. This field is unused.

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

Parameter
Name	Description
value	LogSink.VersionFormat The outputVersionFormat to set.

Returns
Type	Description
LogSink.Builder	This builder for chaining.

setOutputVersionFormatValue(int value) (deprecated)

public LogSink.Builder setOutputVersionFormatValue(int value)

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

Deprecated. This field is unused.

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

Parameter
Name	Description
value	int The enum numeric value on the wire for outputVersionFormat to set.

Returns
Type	Description
LogSink.Builder	This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public LogSink.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
LogSink.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setUnknownFields(UnknownFieldSet unknownFields)

public final LogSink.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
LogSink.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)

setUpdateTime(Timestamp value)

public LogSink.Builder setUpdateTime(Timestamp value)

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];

Parameter
Name	Description
value	Timestamp

Returns
Type	Description
LogSink.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public LogSink.Builder setUpdateTime(Timestamp.Builder builderForValue)

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];

Parameter
Name	Description
builderForValue	Builder

Returns
Type	Description
LogSink.Builder

setWriterIdentity(String value)

public LogSink.Builder setWriterIdentity(String value)

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 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. 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 do not have a writer_identity and no additional permissions are required.

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

Parameter
Name	Description
value	String The writerIdentity to set.

Returns
Type	Description
LogSink.Builder	This builder for chaining.

setWriterIdentityBytes(ByteString value)

public LogSink.Builder setWriterIdentityBytes(ByteString value)

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 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. 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 do not have a writer_identity and no additional permissions are required.

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

Parameter
Name	Description
value	ByteString The bytes for writerIdentity to set.

Returns
Type	Description
LogSink.Builder	This builder for chaining.