com.google.logging.v2

Interface LogSinkOrBuilder

All Superinterfaces:

MessageLiteOrBuilder, MessageOrBuilder

All Known Implementing Classes:

LogSink, LogSink.Builder

public interface LogSinkOrBuilder
extends MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDestination() Required.
ByteString	getDestinationBytes() Required.
Timestamp	getEndTime() Deprecated.
TimestampOrBuilder	getEndTimeOrBuilder() Deprecated.
java.lang.String	getFilter() Optional.
ByteString	getFilterBytes() Optional.
boolean	getIncludeChildren() Optional.
java.lang.String	getName() Required.
ByteString	getNameBytes() Required.
LogSink.VersionFormat	getOutputVersionFormat() Deprecated.
int	getOutputVersionFormatValue() Deprecated.
Timestamp	getStartTime() Deprecated.
TimestampOrBuilder	getStartTimeOrBuilder() Deprecated.
java.lang.String	getWriterIdentity() Output only.
ByteString	getWriterIdentityBytes() Output only.
boolean	hasEndTime() Deprecated.
boolean	hasStartTime() Deprecated.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getName

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;

getNameBytes

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;

getDestination

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;

getDestinationBytes

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;

getFilter

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;

getFilterBytes

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;

getOutputVersionFormatValue

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;

getOutputVersionFormat

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;

getWriterIdentity

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;

getWriterIdentityBytes

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;

getIncludeChildren

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;

hasStartTime

boolean hasStartTime()

 Deprecated. This field is ignored when creating or updating sinks.
 

.google.protobuf.Timestamp start_time = 10;

getStartTime

Timestamp getStartTime()

 Deprecated. This field is ignored when creating or updating sinks.
 

.google.protobuf.Timestamp start_time = 10;

getStartTimeOrBuilder

TimestampOrBuilder getStartTimeOrBuilder()

 Deprecated. This field is ignored when creating or updating sinks.
 

.google.protobuf.Timestamp start_time = 10;

hasEndTime

boolean hasEndTime()

 Deprecated. This field is ignored when creating or updating sinks.
 

.google.protobuf.Timestamp end_time = 11;

getEndTime

Timestamp getEndTime()

 Deprecated. This field is ignored when creating or updating sinks.
 

.google.protobuf.Timestamp end_time = 11;

getEndTimeOrBuilder

TimestampOrBuilder getEndTimeOrBuilder()

 Deprecated. This field is ignored when creating or updating sinks.
 

.google.protobuf.Timestamp end_time = 11;