com.google.logging.v2

Class LogSink

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.logging.v2.LogSink

All Implemented Interfaces:

LogSinkOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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.VersionFormat Available log entry formats.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

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

Field Summary

Fields

Modifier and Type	Field and Description
static int	DESTINATION_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	WRITER_IDENTITY_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
static LogSink	getDefaultInstance()
LogSink	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
java.lang.String	getDestination() Required.
com.google.api.resourcenames.ResourceName	getDestinationAsResourceName()
com.google.protobuf.ByteString	getDestinationBytes() Required.
com.google.protobuf.Timestamp	getEndTime() Optional.
com.google.protobuf.TimestampOrBuilder	getEndTimeOrBuilder() Optional.
java.lang.String	getFilter() Optional.
com.google.protobuf.ByteString	getFilterBytes() Optional.
boolean	getIncludeChildren() Optional.
java.lang.String	getName() Required.
com.google.protobuf.ByteString	getNameBytes() Required.
LogSink.VersionFormat	getOutputVersionFormat() Optional.
int	getOutputVersionFormatValue() Optional.
com.google.protobuf.Parser<LogSink>	getParserForType()
int	getSerializedSize()
com.google.protobuf.Timestamp	getStartTime() Optional.
com.google.protobuf.TimestampOrBuilder	getStartTimeOrBuilder() Optional.
com.google.protobuf.UnknownFieldSet	getUnknownFields()
java.lang.String	getWriterIdentity() Output only.
com.google.protobuf.ByteString	getWriterIdentityBytes() Output only.
boolean	hasEndTime() Optional.
int	hashCode()
boolean	hasStartTime() Optional.
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)
static LogSink	parseDelimitedFrom(java.io.InputStream input)
static LogSink	parseDelimitedFrom(java.io.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(java.nio.ByteBuffer data)
static LogSink	parseFrom(java.nio.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(java.io.InputStream input)
static LogSink	parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<LogSink>	parser()
LogSink.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

computeStringSize, computeStringSizeNoTag, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, newBuilderForType, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

See Also:

Constant Field Values

DESTINATION_FIELD_NUMBER

public static final int DESTINATION_FIELD_NUMBER

See Also:

Constant Field Values

FILTER_FIELD_NUMBER

public static final int FILTER_FIELD_NUMBER

See Also:

Constant Field Values

OUTPUT_VERSION_FORMAT_FIELD_NUMBER

public static final int OUTPUT_VERSION_FORMAT_FIELD_NUMBER

See Also:

Constant Field Values

WRITER_IDENTITY_FIELD_NUMBER

public static final int WRITER_IDENTITY_FIELD_NUMBER

See Also:

Constant Field Values

INCLUDE_CHILDREN_FIELD_NUMBER

public static final int INCLUDE_CHILDREN_FIELD_NUMBER

See Also:

Constant Field Values

START_TIME_FIELD_NUMBER

public static final int START_TIME_FIELD_NUMBER

See Also:

Constant Field Values

END_TIME_FIELD_NUMBER

public static final int END_TIME_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getName

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

Specified by:

getName in interface LogSinkOrBuilder

getNameBytes

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

string name = 1;

Specified by:

getNameBytes in interface LogSinkOrBuilder

getDestination

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;

Specified by:

getDestination in interface LogSinkOrBuilder

getDestinationBytes

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

Specified by:

getDestinationBytes in interface LogSinkOrBuilder

getFilter

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. The filter must use the log entry format specified
 by the `output_version_format` parameter.  For example, in the v2 format:
     logName="projects/[PROJECT_ID]/logs/[LOG_ID]" AND severity>=ERROR
 

string filter = 5;

Specified by:

getFilter in interface LogSinkOrBuilder

getFilterBytes

public com.google.protobuf.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. The filter must use the log entry format specified
 by the `output_version_format` parameter.  For example, in the v2 format:
     logName="projects/[PROJECT_ID]/logs/[LOG_ID]" AND severity>=ERROR
 

string filter = 5;

Specified by:

getFilterBytes in interface LogSinkOrBuilder

getOutputVersionFormatValue

public int getOutputVersionFormatValue()

 Optional. The log entry format to use for this sink's exported log
 entries.  The v2 format is used by default.
 **The v1 format is deprecated** and should be used only as part of a
 migration effort to v2.
 See [Migration to the v2 API](/logging/docs/api/v2/migration-to-v2).
 

.google.logging.v2.LogSink.VersionFormat output_version_format = 6;

Specified by:

getOutputVersionFormatValue in interface LogSinkOrBuilder

getOutputVersionFormat

public LogSink.VersionFormat getOutputVersionFormat()

 Optional. The log entry format to use for this sink's exported log
 entries.  The v2 format is used by default.
 **The v1 format is deprecated** and should be used only as part of a
 migration effort to v2.
 See [Migration to the v2 API](/logging/docs/api/v2/migration-to-v2).
 

.google.logging.v2.LogSink.VersionFormat output_version_format = 6;

Specified by:

getOutputVersionFormat in interface LogSinkOrBuilder

getWriterIdentity

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;

Specified by:

getWriterIdentity in interface LogSinkOrBuilder

getWriterIdentityBytes

public com.google.protobuf.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;

Specified by:

getWriterIdentityBytes in interface LogSinkOrBuilder

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

Specified by:

getIncludeChildren in interface LogSinkOrBuilder

hasStartTime

public boolean hasStartTime()

 Optional. The time at which this sink will begin exporting log entries.
 Log entries are exported only if their timestamp is not earlier than the
 start time.  The default value of this field is the time the sink is
 created or updated.
 

.google.protobuf.Timestamp start_time = 10;

Specified by:

hasStartTime in interface LogSinkOrBuilder

getStartTime

public com.google.protobuf.Timestamp getStartTime()

 Optional. The time at which this sink will begin exporting log entries.
 Log entries are exported only if their timestamp is not earlier than the
 start time.  The default value of this field is the time the sink is
 created or updated.
 

.google.protobuf.Timestamp start_time = 10;

Specified by:

getStartTime in interface LogSinkOrBuilder

getStartTimeOrBuilder

public com.google.protobuf.TimestampOrBuilder getStartTimeOrBuilder()

 Optional. The time at which this sink will begin exporting log entries.
 Log entries are exported only if their timestamp is not earlier than the
 start time.  The default value of this field is the time the sink is
 created or updated.
 

.google.protobuf.Timestamp start_time = 10;

Specified by:

getStartTimeOrBuilder in interface LogSinkOrBuilder

hasEndTime

public boolean hasEndTime()

 Optional. The time at which this sink will stop exporting log entries.  Log
 entries are exported only if their timestamp is earlier than the end time.
 If this field is not supplied, there is no end time.  If both a start time
 and an end time are provided, then the end time must be later than the
 start time.
 

.google.protobuf.Timestamp end_time = 11;

Specified by:

hasEndTime in interface LogSinkOrBuilder

getEndTime

public com.google.protobuf.Timestamp getEndTime()

 Optional. The time at which this sink will stop exporting log entries.  Log
 entries are exported only if their timestamp is earlier than the end time.
 If this field is not supplied, there is no end time.  If both a start time
 and an end time are provided, then the end time must be later than the
 start time.
 

.google.protobuf.Timestamp end_time = 11;

Specified by:

getEndTime in interface LogSinkOrBuilder

getEndTimeOrBuilder

public com.google.protobuf.TimestampOrBuilder getEndTimeOrBuilder()

 Optional. The time at which this sink will stop exporting log entries.  Log
 entries are exported only if their timestamp is earlier than the end time.
 If this field is not supplied, there is no end time.  If both a start time
 and an end time are provided, then the end time must be later than the
 start time.
 

.google.protobuf.Timestamp end_time = 11;

Specified by:

getEndTimeOrBuilder in interface LogSinkOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws java.io.IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

java.io.IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(java.lang.Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static LogSink parseFrom(java.nio.ByteBuffer data)
                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static LogSink parseFrom(java.nio.ByteBuffer data,
                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static LogSink parseFrom(com.google.protobuf.ByteString data)
                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static LogSink parseFrom(com.google.protobuf.ByteString data,
                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static LogSink parseFrom(byte[] data)
                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static LogSink parseFrom(byte[] data,
                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static LogSink parseFrom(java.io.InputStream input)
                         throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static LogSink parseFrom(java.io.InputStream input,
                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                         throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static LogSink parseDelimitedFrom(java.io.InputStream input)
                                  throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static LogSink parseDelimitedFrom(java.io.InputStream input,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static LogSink parseFrom(com.google.protobuf.CodedInputStream input)
                         throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static LogSink parseFrom(com.google.protobuf.CodedInputStream input,
                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                         throws java.io.IOException

Throws:

java.io.IOException

newBuilderForType

public LogSink.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static LogSink.Builder newBuilder()

newBuilder

public static LogSink.Builder newBuilder(LogSink prototype)

toBuilder

public LogSink.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected LogSink.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDestinationAsResourceName

public final com.google.api.resourcenames.ResourceName getDestinationAsResourceName()

getDefaultInstance

public static LogSink getDefaultInstance()

parser

public static com.google.protobuf.Parser<LogSink> parser()

getParserForType

public com.google.protobuf.Parser<LogSink> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public LogSink getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder