Package com.google.logging.v2

Interface LogSinkOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
LogSink, LogSink.Builder
public interface LogSinkOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getName

      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:
      The name.

    • getNameBytes

      com.google.protobuf.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:
      The bytes for name.

    • getDestination

      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](https://cloud.google.com/logging/docs/api/tasks/exporting-logs).
      string destination = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The destination.

    • getDestinationBytes

      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](https://cloud.google.com/logging/docs/api/tasks/exporting-logs).
      string destination = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The bytes for destination.

    • getFilter

      String getFilter()
       Optional. An [advanced logs
 filter](https://cloud.google.com/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 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The filter.

    • getFilterBytes

      com.google.protobuf.ByteString getFilterBytes()
       Optional. An [advanced logs
 filter](https://cloud.google.com/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 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for filter.

    • getDescription

      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:
      The description.

    • getDescriptionBytes

      com.google.protobuf.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:
      The bytes for description.

    • getDisabled

      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:
      The disabled.

    • getExclusionsList

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

    • getExclusions

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

    • getExclusionsCount

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

    • getExclusionsOrBuilderList

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

    • getExclusionsOrBuilder

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

    • getOutputVersionFormatValue

      @Deprecated int getOutputVersionFormatValue()
      Deprecated.
      google.logging.v2.LogSink.output_version_format is deprecated. See google/logging/v2/logging_config.proto;l=1000
       Deprecated. This field is unused.
      .google.logging.v2.LogSink.VersionFormat output_version_format = 6 [deprecated = true];
      Returns:
      The enum numeric value on the wire for outputVersionFormat.

    • getOutputVersionFormat

      @Deprecated LogSink.VersionFormat getOutputVersionFormat()
      Deprecated.
      google.logging.v2.LogSink.output_version_format is deprecated. See google/logging/v2/logging_config.proto;l=1000
       Deprecated. This field is unused.
      .google.logging.v2.LogSink.VersionFormat output_version_format = 6 [deprecated = true];
      Returns:
      The outputVersionFormat.

    • getWriterIdentity

      String getWriterIdentity()
       Output only. An IAM identity&mdash;a service account or group&mdash;under
 which Cloud Logging writes the exported log entries to the sink's
 destination. This field is either set by specifying
 `custom_writer_identity` or set automatically 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](https://cloud.google.com/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.

 Sinks that have a destination that is a log bucket in the same project as
 the sink cannot have a writer_identity and no additional permissions are
 required.
      string writer_identity = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The writerIdentity.

    • getWriterIdentityBytes

      com.google.protobuf.ByteString getWriterIdentityBytes()
       Output only. An IAM identity&mdash;a service account or group&mdash;under
 which Cloud Logging writes the exported log entries to the sink's
 destination. This field is either set by specifying
 `custom_writer_identity` or set automatically 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](https://cloud.google.com/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.

 Sinks that have a destination that is a log bucket in the same project as
 the sink cannot have a writer_identity and no additional permissions are
 required.
      string writer_identity = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The bytes for writerIdentity.

    • 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
 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:
      The includeChildren.

    • hasBigqueryOptions

      boolean hasBigqueryOptions()
       Optional. Options that affect sinks exporting data to BigQuery.
      .google.logging.v2.BigQueryOptions bigquery_options = 12 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the bigqueryOptions field is set.

    • getBigqueryOptions

      BigQueryOptions getBigqueryOptions()
       Optional. Options that affect sinks exporting data to BigQuery.
      .google.logging.v2.BigQueryOptions bigquery_options = 12 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bigqueryOptions.

    • getBigqueryOptionsOrBuilder

      BigQueryOptionsOrBuilder getBigqueryOptionsOrBuilder()
       Optional. Options that affect sinks exporting data to BigQuery.
      .google.logging.v2.BigQueryOptions bigquery_options = 12 [(.google.api.field_behavior) = OPTIONAL];

    • hasCreateTime

      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:
      Whether the createTime field is set.

    • getCreateTime

      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];
      Returns:
      The createTime.

    • getCreateTimeOrBuilder

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

    • hasUpdateTime

      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:
      Whether the updateTime field is set.

    • getUpdateTime

      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];
      Returns:
      The updateTime.

    • getUpdateTimeOrBuilder

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

    • getOptionsCase

      LogSink.OptionsCase getOptionsCase()