Interface LogSinkOrBuilder (3.10.3)

Version 3.10.3

• 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 interface LogSinkOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getBigqueryOptions()

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

getBigqueryOptionsOrBuilder()

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

getCreateTimeOrBuilder()

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

getDescription()

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

getDestination()

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

getExclusionsCount()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract LogSink.OptionsCase getOptionsCase()

Returns

Type	Description
LogSink.OptionsCase

getOutputVersionFormat() (deprecated)

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

getUpdateTimeOrBuilder()

public abstract 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 abstract String getWriterIdentity()

Output only. An IAM identity—a service account or group—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 abstract ByteString getWriterIdentityBytes()

Output only. An IAM identity—a service account or group—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 abstract 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 abstract 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 abstract 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.