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, 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.Protobuf type
google.logging.v2.LogSinkgetAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitfindInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneofmergeFrompublic static final Descriptors.Descriptor getDescriptor()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class GeneratedMessageV3.Builder<LogSink.Builder>public LogSink.Builder clear()
clear in interface Message.Builderclear in interface MessageLite.Builderclear in class GeneratedMessageV3.Builder<LogSink.Builder>public Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface Message.BuildergetDescriptorForType in interface MessageOrBuildergetDescriptorForType in class GeneratedMessageV3.Builder<LogSink.Builder>public LogSink getDefaultInstanceForType()
getDefaultInstanceForType in interface MessageLiteOrBuildergetDefaultInstanceForType in interface MessageOrBuilderpublic LogSink build()
build in interface Message.Builderbuild in interface MessageLite.Builderpublic LogSink buildPartial()
buildPartial in interface Message.BuilderbuildPartial in interface MessageLite.Builderpublic LogSink.Builder clone()
clone in interface Message.Builderclone in interface MessageLite.Builderclone in class GeneratedMessageV3.Builder<LogSink.Builder>public LogSink.Builder setField(Descriptors.FieldDescriptor field, java.lang.Object value)
setField in interface Message.BuildersetField in class GeneratedMessageV3.Builder<LogSink.Builder>public LogSink.Builder clearField(Descriptors.FieldDescriptor field)
clearField in interface Message.BuilderclearField in class GeneratedMessageV3.Builder<LogSink.Builder>public LogSink.Builder clearOneof(Descriptors.OneofDescriptor oneof)
clearOneof in interface Message.BuilderclearOneof in class GeneratedMessageV3.Builder<LogSink.Builder>public LogSink.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, java.lang.Object value)
setRepeatedField in interface Message.BuildersetRepeatedField in class GeneratedMessageV3.Builder<LogSink.Builder>public LogSink.Builder addRepeatedField(Descriptors.FieldDescriptor field, java.lang.Object value)
addRepeatedField in interface Message.BuilderaddRepeatedField in class GeneratedMessageV3.Builder<LogSink.Builder>public LogSink.Builder mergeFrom(Message other)
mergeFrom in interface Message.BuildermergeFrom in class AbstractMessage.Builder<LogSink.Builder>public LogSink.Builder mergeFrom(LogSink other)
public final boolean isInitialized()
isInitialized in interface MessageLiteOrBuilderisInitialized in class GeneratedMessageV3.Builder<LogSink.Builder>public LogSink.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) throws java.io.IOException
mergeFrom in interface Message.BuildermergeFrom in interface MessageLite.BuildermergeFrom in class AbstractMessage.Builder<LogSink.Builder>java.io.IOExceptionpublic java.lang.String getName()
Required. The client-assigned sink identifier, unique within the project. 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.
string name = 1;getName in interface LogSinkOrBuilderpublic ByteString getNameBytes()
Required. The client-assigned sink identifier, unique within the project. 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.
string name = 1;getNameBytes in interface LogSinkOrBuilderpublic LogSink.Builder setName(java.lang.String value)
Required. The client-assigned sink identifier, unique within the project. 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.
string name = 1;public LogSink.Builder clearName()
Required. The client-assigned sink identifier, unique within the project. 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.
string name = 1;public LogSink.Builder setNameBytes(ByteString value)
Required. The client-assigned sink identifier, unique within the project. 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.
string name = 1;public java.lang.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](/logging/docs/api/tasks/exporting-logs).
string destination = 3;getDestination in interface LogSinkOrBuilderpublic 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](/logging/docs/api/tasks/exporting-logs).
string destination = 3;getDestinationBytes in interface LogSinkOrBuilderpublic LogSink.Builder setDestination(java.lang.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](/logging/docs/api/tasks/exporting-logs).
string destination = 3;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](/logging/docs/api/tasks/exporting-logs).
string destination = 3;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](/logging/docs/api/tasks/exporting-logs).
string destination = 3;public java.lang.String getFilter()
Optional.
An [advanced logs filter](/logging/docs/view/advanced_filters). 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;getFilter in interface LogSinkOrBuilderpublic ByteString getFilterBytes()
Optional.
An [advanced logs filter](/logging/docs/view/advanced_filters). 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;getFilterBytes in interface LogSinkOrBuilderpublic LogSink.Builder setFilter(java.lang.String value)
Optional.
An [advanced logs filter](/logging/docs/view/advanced_filters). 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;public LogSink.Builder clearFilter()
Optional.
An [advanced logs filter](/logging/docs/view/advanced_filters). 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;public LogSink.Builder setFilterBytes(ByteString value)
Optional.
An [advanced logs filter](/logging/docs/view/advanced_filters). 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;public int getOutputVersionFormatValue()
Deprecated. The log entry format to use for this sink's exported log entries. The v2 format is used by default and cannot be changed.
.google.logging.v2.LogSink.VersionFormat output_version_format = 6;getOutputVersionFormatValue in interface LogSinkOrBuilderpublic LogSink.Builder setOutputVersionFormatValue(int value)
Deprecated. The log entry format to use for this sink's exported log entries. The v2 format is used by default and cannot be changed.
.google.logging.v2.LogSink.VersionFormat output_version_format = 6;public LogSink.VersionFormat getOutputVersionFormat()
Deprecated. The log entry format to use for this sink's exported log entries. The v2 format is used by default and cannot be changed.
.google.logging.v2.LogSink.VersionFormat output_version_format = 6;getOutputVersionFormat in interface LogSinkOrBuilderpublic LogSink.Builder setOutputVersionFormat(LogSink.VersionFormat value)
Deprecated. The log entry format to use for this sink's exported log entries. The v2 format is used by default and cannot be changed.
.google.logging.v2.LogSink.VersionFormat output_version_format = 6;public LogSink.Builder clearOutputVersionFormat()
Deprecated. The log entry format to use for this sink's exported log entries. The v2 format is used by default and cannot be changed.
.google.logging.v2.LogSink.VersionFormat output_version_format = 6;public java.lang.String getWriterIdentity()
Output only. An IAM identity—a service account or group—under which Stackdriver Logging writes the exported log entries to the sink's destination. This field is set by [sinks.create](/logging/docs/api/reference/rest/v2/projects.sinks/create) and [sinks.update](/logging/docs/api/reference/rest/v2/projects.sinks/update), based on the setting 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](/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.
string writer_identity = 8;getWriterIdentity in interface LogSinkOrBuilderpublic ByteString getWriterIdentityBytes()
Output only. An IAM identity—a service account or group—under which Stackdriver Logging writes the exported log entries to the sink's destination. This field is set by [sinks.create](/logging/docs/api/reference/rest/v2/projects.sinks/create) and [sinks.update](/logging/docs/api/reference/rest/v2/projects.sinks/update), based on the setting 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](/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.
string writer_identity = 8;getWriterIdentityBytes in interface LogSinkOrBuilderpublic LogSink.Builder setWriterIdentity(java.lang.String value)
Output only. An IAM identity—a service account or group—under which Stackdriver Logging writes the exported log entries to the sink's destination. This field is set by [sinks.create](/logging/docs/api/reference/rest/v2/projects.sinks/create) and [sinks.update](/logging/docs/api/reference/rest/v2/projects.sinks/update), based on the setting 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](/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.
string writer_identity = 8;public LogSink.Builder clearWriterIdentity()
Output only. An IAM identity—a service account or group—under which Stackdriver Logging writes the exported log entries to the sink's destination. This field is set by [sinks.create](/logging/docs/api/reference/rest/v2/projects.sinks/create) and [sinks.update](/logging/docs/api/reference/rest/v2/projects.sinks/update), based on the setting 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](/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.
string writer_identity = 8;public LogSink.Builder setWriterIdentityBytes(ByteString value)
Output only. An IAM identity—a service account or group—under which Stackdriver Logging writes the exported log entries to the sink's destination. This field is set by [sinks.create](/logging/docs/api/reference/rest/v2/projects.sinks/create) and [sinks.update](/logging/docs/api/reference/rest/v2/projects.sinks/update), based on the setting 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](/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.
string writer_identity = 8;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
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
bool include_children = 9;getIncludeChildren in interface LogSinkOrBuilderpublic 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
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
bool include_children = 9;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
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
bool include_children = 9;public boolean hasStartTime()
Deprecated. This field is ignored when creating or updating sinks.
.google.protobuf.Timestamp start_time = 10;hasStartTime in interface LogSinkOrBuilderpublic Timestamp getStartTime()
Deprecated. This field is ignored when creating or updating sinks.
.google.protobuf.Timestamp start_time = 10;getStartTime in interface LogSinkOrBuilderpublic LogSink.Builder setStartTime(Timestamp value)
Deprecated. This field is ignored when creating or updating sinks.
.google.protobuf.Timestamp start_time = 10;public LogSink.Builder setStartTime(Timestamp.Builder builderForValue)
Deprecated. This field is ignored when creating or updating sinks.
.google.protobuf.Timestamp start_time = 10;public LogSink.Builder mergeStartTime(Timestamp value)
Deprecated. This field is ignored when creating or updating sinks.
.google.protobuf.Timestamp start_time = 10;public LogSink.Builder clearStartTime()
Deprecated. This field is ignored when creating or updating sinks.
.google.protobuf.Timestamp start_time = 10;public Timestamp.Builder getStartTimeBuilder()
Deprecated. This field is ignored when creating or updating sinks.
.google.protobuf.Timestamp start_time = 10;public TimestampOrBuilder getStartTimeOrBuilder()
Deprecated. This field is ignored when creating or updating sinks.
.google.protobuf.Timestamp start_time = 10;getStartTimeOrBuilder in interface LogSinkOrBuilderpublic boolean hasEndTime()
Deprecated. This field is ignored when creating or updating sinks.
.google.protobuf.Timestamp end_time = 11;hasEndTime in interface LogSinkOrBuilderpublic Timestamp getEndTime()
Deprecated. This field is ignored when creating or updating sinks.
.google.protobuf.Timestamp end_time = 11;getEndTime in interface LogSinkOrBuilderpublic LogSink.Builder setEndTime(Timestamp value)
Deprecated. This field is ignored when creating or updating sinks.
.google.protobuf.Timestamp end_time = 11;public LogSink.Builder setEndTime(Timestamp.Builder builderForValue)
Deprecated. This field is ignored when creating or updating sinks.
.google.protobuf.Timestamp end_time = 11;public LogSink.Builder mergeEndTime(Timestamp value)
Deprecated. This field is ignored when creating or updating sinks.
.google.protobuf.Timestamp end_time = 11;public LogSink.Builder clearEndTime()
Deprecated. This field is ignored when creating or updating sinks.
.google.protobuf.Timestamp end_time = 11;public Timestamp.Builder getEndTimeBuilder()
Deprecated. This field is ignored when creating or updating sinks.
.google.protobuf.Timestamp end_time = 11;public TimestampOrBuilder getEndTimeOrBuilder()
Deprecated. This field is ignored when creating or updating sinks.
.google.protobuf.Timestamp end_time = 11;getEndTimeOrBuilder in interface LogSinkOrBuilderpublic final LogSink.Builder setUnknownFields(UnknownFieldSet unknownFields)
setUnknownFields in interface Message.BuildersetUnknownFields in class GeneratedMessageV3.Builder<LogSink.Builder>public final LogSink.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
mergeUnknownFields in interface Message.BuildermergeUnknownFields in class GeneratedMessageV3.Builder<LogSink.Builder>