public final class LogSink extends com.google.protobuf.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, 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.LogSink| Modifier and Type | Class and Description |
|---|---|
static class |
LogSink.Builder
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.
|
static class |
LogSink.OptionsCase |
static class |
LogSink.VersionFormat
Available log entry formats.
|
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter| Modifier and Type | Field and Description |
|---|---|
static int |
BIGQUERY_OPTIONS_FIELD_NUMBER |
static int |
CREATE_TIME_FIELD_NUMBER |
static int |
DESCRIPTION_FIELD_NUMBER |
static int |
DESTINATION_FIELD_NUMBER |
static int |
DISABLED_FIELD_NUMBER |
static int |
END_TIME_FIELD_NUMBER |
static int |
FILTER_FIELD_NUMBER |
static int |
INCLUDE_CHILDREN_FIELD_NUMBER |
static int |
NAME_FIELD_NUMBER |
static int |
OUTPUT_VERSION_FORMAT_FIELD_NUMBER |
static int |
START_TIME_FIELD_NUMBER |
static int |
UPDATE_TIME_FIELD_NUMBER |
static int |
WRITER_IDENTITY_FIELD_NUMBER |
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(Object obj) |
BigQueryOptions |
getBigqueryOptions()
Optional.
|
BigQueryOptionsOrBuilder |
getBigqueryOptionsOrBuilder()
Optional.
|
com.google.protobuf.Timestamp |
getCreateTime()
Output only.
|
com.google.protobuf.TimestampOrBuilder |
getCreateTimeOrBuilder()
Output only.
|
static LogSink |
getDefaultInstance() |
LogSink |
getDefaultInstanceForType() |
String |
getDescription()
Optional.
|
com.google.protobuf.ByteString |
getDescriptionBytes()
Optional.
|
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
String |
getDestination()
Required.
|
com.google.protobuf.ByteString |
getDestinationBytes()
Required.
|
boolean |
getDisabled()
Optional.
|
com.google.protobuf.Timestamp |
getEndTime()
Deprecated.
|
com.google.protobuf.TimestampOrBuilder |
getEndTimeOrBuilder()
Deprecated.
|
String |
getFilter()
Optional.
|
com.google.protobuf.ByteString |
getFilterBytes()
Optional.
|
boolean |
getIncludeChildren()
Optional.
|
String |
getName()
Required.
|
com.google.protobuf.ByteString |
getNameBytes()
Required.
|
LogSink.OptionsCase |
getOptionsCase() |
LogSink.VersionFormat |
getOutputVersionFormat()
Deprecated.
|
int |
getOutputVersionFormatValue()
Deprecated.
|
com.google.protobuf.Parser<LogSink> |
getParserForType() |
int |
getSerializedSize() |
com.google.protobuf.Timestamp |
getStartTime()
Deprecated.
|
com.google.protobuf.TimestampOrBuilder |
getStartTimeOrBuilder()
Deprecated.
|
com.google.protobuf.UnknownFieldSet |
getUnknownFields() |
com.google.protobuf.Timestamp |
getUpdateTime()
Output only.
|
com.google.protobuf.TimestampOrBuilder |
getUpdateTimeOrBuilder()
Output only.
|
String |
getWriterIdentity()
Output only.
|
com.google.protobuf.ByteString |
getWriterIdentityBytes()
Output only.
|
boolean |
hasBigqueryOptions()
Optional.
|
boolean |
hasCreateTime()
Output only.
|
boolean |
hasEndTime()
Deprecated.
|
int |
hashCode() |
boolean |
hasStartTime()
Deprecated.
|
boolean |
hasUpdateTime()
Output only.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
static LogSink.Builder |
newBuilder() |
static LogSink.Builder |
newBuilder(LogSink prototype) |
LogSink.Builder |
newBuilderForType() |
protected LogSink.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
protected Object |
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) |
static LogSink |
parseDelimitedFrom(InputStream input) |
static LogSink |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static LogSink |
parseFrom(byte[] data) |
static LogSink |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static LogSink |
parseFrom(ByteBuffer data) |
static LogSink |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static LogSink |
parseFrom(com.google.protobuf.ByteString data) |
static LogSink |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static LogSink |
parseFrom(com.google.protobuf.CodedInputStream input) |
static LogSink |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static LogSink |
parseFrom(InputStream input) |
static LogSink |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<LogSink> |
parser() |
LogSink.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int NAME_FIELD_NUMBER
public static final int DESTINATION_FIELD_NUMBER
public static final int FILTER_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
public static final int DISABLED_FIELD_NUMBER
public static final int OUTPUT_VERSION_FORMAT_FIELD_NUMBER
public static final int WRITER_IDENTITY_FIELD_NUMBER
public static final int INCLUDE_CHILDREN_FIELD_NUMBER
public static final int BIGQUERY_OPTIONS_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
public static final int START_TIME_FIELD_NUMBER
public static final int END_TIME_FIELD_NUMBER
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance in class com.google.protobuf.GeneratedMessageV3public final com.google.protobuf.UnknownFieldSet getUnknownFields()
getUnknownFields in interface com.google.protobuf.MessageOrBuildergetUnknownFields in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public LogSink.OptionsCase getOptionsCase()
getOptionsCase in interface LogSinkOrBuilderpublic 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. First character has to be alphanumeric.
string name = 1;getName in interface LogSinkOrBuilderpublic com.google.protobuf.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. First character has to be alphanumeric.
string name = 1;getNameBytes in interface LogSinkOrBuilderpublic 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 [(.google.api.resource_reference) = { ... }getDestination in interface LogSinkOrBuilderpublic com.google.protobuf.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 [(.google.api.resource_reference) = { ... }getDestinationBytes in interface LogSinkOrBuilderpublic String getFilter()
Optional. An [advanced logs filter](/logging/docs/view/advanced-queries). The only
exported log entries are those that are in the resource owning the sink and
that match the filter. For example:
logName="projects/[PROJECT_ID]/logs/[LOG_ID]" AND severity>=ERROR
string filter = 5;getFilter in interface LogSinkOrBuilderpublic com.google.protobuf.ByteString getFilterBytes()
Optional. An [advanced logs filter](/logging/docs/view/advanced-queries). The only
exported log entries are those that are in the resource owning the sink and
that match the filter. For example:
logName="projects/[PROJECT_ID]/logs/[LOG_ID]" AND severity>=ERROR
string filter = 5;getFilterBytes in interface LogSinkOrBuilderpublic String getDescription()
Optional. A description of this sink. The maximum length of the description is 8000 characters.
string description = 18;getDescription in interface LogSinkOrBuilderpublic com.google.protobuf.ByteString getDescriptionBytes()
Optional. A description of this sink. The maximum length of the description is 8000 characters.
string description = 18;getDescriptionBytes in interface LogSinkOrBuilderpublic boolean getDisabled()
Optional. If set to True, then this sink is disabled and it does not export any log entries.
bool disabled = 19;getDisabled in interface LogSinkOrBuilder@Deprecated 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 [deprecated = true];
getOutputVersionFormatValue in interface LogSinkOrBuilder@Deprecated 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 [deprecated = true];
getOutputVersionFormat in interface LogSinkOrBuilderpublic String getWriterIdentity()
Output only. An IAM identity—a service account or group—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](/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 [(.google.api.field_behavior) = OUTPUT_ONLY];getWriterIdentity in interface LogSinkOrBuilderpublic com.google.protobuf.ByteString getWriterIdentityBytes()
Output only. An IAM identity—a service account or group—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](/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 [(.google.api.field_behavior) = OUTPUT_ONLY];getWriterIdentityBytes in interface LogSinkOrBuilderpublic 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 boolean hasBigqueryOptions()
Optional. Options that affect sinks exporting data to BigQuery.
.google.logging.v2.BigQueryOptions bigquery_options = 12;hasBigqueryOptions in interface LogSinkOrBuilderpublic BigQueryOptions getBigqueryOptions()
Optional. Options that affect sinks exporting data to BigQuery.
.google.logging.v2.BigQueryOptions bigquery_options = 12;getBigqueryOptions in interface LogSinkOrBuilderpublic BigQueryOptionsOrBuilder getBigqueryOptionsOrBuilder()
Optional. Options that affect sinks exporting data to BigQuery.
.google.logging.v2.BigQueryOptions bigquery_options = 12;getBigqueryOptionsOrBuilder in interface LogSinkOrBuilderpublic 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];
hasCreateTime in interface LogSinkOrBuilderpublic com.google.protobuf.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];
getCreateTime in interface LogSinkOrBuilderpublic com.google.protobuf.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];
getCreateTimeOrBuilder in interface LogSinkOrBuilderpublic 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];
hasUpdateTime in interface LogSinkOrBuilderpublic com.google.protobuf.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];
getUpdateTime in interface LogSinkOrBuilderpublic com.google.protobuf.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];
getUpdateTimeOrBuilder in interface LogSinkOrBuilder@Deprecated public boolean hasStartTime()
Do not use. This field is ignored.
.google.protobuf.Timestamp start_time = 10 [deprecated = true];hasStartTime in interface LogSinkOrBuilder@Deprecated public com.google.protobuf.Timestamp getStartTime()
Do not use. This field is ignored.
.google.protobuf.Timestamp start_time = 10 [deprecated = true];getStartTime in interface LogSinkOrBuilder@Deprecated public com.google.protobuf.TimestampOrBuilder getStartTimeOrBuilder()
Do not use. This field is ignored.
.google.protobuf.Timestamp start_time = 10 [deprecated = true];getStartTimeOrBuilder in interface LogSinkOrBuilder@Deprecated public boolean hasEndTime()
Do not use. This field is ignored.
.google.protobuf.Timestamp end_time = 11 [deprecated = true];hasEndTime in interface LogSinkOrBuilder@Deprecated public com.google.protobuf.Timestamp getEndTime()
Do not use. This field is ignored.
.google.protobuf.Timestamp end_time = 11 [deprecated = true];getEndTime in interface LogSinkOrBuilder@Deprecated public com.google.protobuf.TimestampOrBuilder getEndTimeOrBuilder()
Do not use. This field is ignored.
.google.protobuf.Timestamp end_time = 11 [deprecated = true];getEndTimeOrBuilder in interface LogSinkOrBuilderpublic final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static LogSink parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static LogSink parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static LogSink parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static LogSink parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static LogSink parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static LogSink parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static LogSink parseFrom(InputStream input) throws IOException
IOExceptionpublic static LogSink parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static LogSink parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static LogSink parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static LogSink parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static LogSink parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic LogSink.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static LogSink.Builder newBuilder()
public static LogSink.Builder newBuilder(LogSink prototype)
public LogSink.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected LogSink.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static LogSink getDefaultInstance()
public static com.google.protobuf.Parser<LogSink> parser()
public com.google.protobuf.Parser<LogSink> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public LogSink getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2020 Google LLC. All rights reserved.