Package com.google.logging.v2

Interface LogBucketOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    LogBucket, LogBucket.Builder
    public interface LogBucketOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getName

        String getName()
         Output only. The resource name of the bucket.

 For example:

   `projects/my-project/locations/global/buckets/my-bucket`

 For a list of supported locations, see [Supported
 Regions](https://cloud.google.com/logging/docs/region-support)

 For the location of `global` it is unspecified where log entries are
 actually stored.

 After a bucket has been created, the location cannot be changed.
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The name.

      • getNameBytes

        com.google.protobuf.ByteString getNameBytes()
         Output only. The resource name of the bucket.

 For example:

   `projects/my-project/locations/global/buckets/my-bucket`

 For a list of supported locations, see [Supported
 Regions](https://cloud.google.com/logging/docs/region-support)

 For the location of `global` it is unspecified where log entries are
 actually stored.

 After a bucket has been created, the location cannot be changed.
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The bytes for name.

      • getDescription

        String getDescription()
         Describes this bucket.
        string description = 3;
        Returns:
        The description.

      • getDescriptionBytes

        com.google.protobuf.ByteString getDescriptionBytes()
         Describes this bucket.
        string description = 3;
        Returns:
        The bytes for description.

      • hasCreateTime

        boolean hasCreateTime()
         Output only. The creation timestamp of the bucket. This is not set for any
 of the default buckets.
        .google.protobuf.Timestamp create_time = 4 [(.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 bucket. This is not set for any
 of the default buckets.
        .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The createTime.

      • getCreateTimeOrBuilder

        com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
         Output only. The creation timestamp of the bucket. This is not set for any
 of the default buckets.
        .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • hasUpdateTime

        boolean hasUpdateTime()
         Output only. The last update timestamp of the bucket.
        .google.protobuf.Timestamp update_time = 5 [(.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 bucket.
        .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The updateTime.

      • getUpdateTimeOrBuilder

        com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
         Output only. The last update timestamp of the bucket.
        .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getRetentionDays

        int getRetentionDays()
         Logs will be retained by default for this amount of time, after which they
 will automatically be deleted. The minimum retention period is 1 day. If
 this value is set to zero at bucket creation time, the default time of 30
 days will be used.
        int32 retention_days = 11;
        Returns:
        The retentionDays.

      • getLocked

        boolean getLocked()
         Whether the bucket is locked.

 The retention period on a locked bucket cannot be changed. Locked buckets
 may only be deleted if they are empty.
        bool locked = 9;
        Returns:
        The locked.

      • getLifecycleStateValue

        int getLifecycleStateValue()
         Output only. The bucket lifecycle state.
        .google.logging.v2.LifecycleState lifecycle_state = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The enum numeric value on the wire for lifecycleState.

      • getLifecycleState

        LifecycleState getLifecycleState()
         Output only. The bucket lifecycle state.
        .google.logging.v2.LifecycleState lifecycle_state = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The lifecycleState.

      • getAnalyticsEnabled

        boolean getAnalyticsEnabled()
         Whether log analytics is enabled for this bucket.

 Once enabled, log analytics features cannot be disabled.
        bool analytics_enabled = 14;
        Returns:
        The analyticsEnabled.

      • getRestrictedFieldsList

        List<String> getRestrictedFieldsList()
         Log entry field paths that are denied access in this bucket.

 The following fields and their children are eligible: `textPayload`,
 `jsonPayload`, `protoPayload`, `httpRequest`, `labels`, `sourceLocation`.

 Restricting a repeated field will restrict all values. Adding a parent will
 block all child fields. (e.g. `foo.bar` will block `foo.bar.baz`)
        repeated string restricted_fields = 15;
        Returns:
        A list containing the restrictedFields.

      • getRestrictedFieldsCount

        int getRestrictedFieldsCount()
         Log entry field paths that are denied access in this bucket.

 The following fields and their children are eligible: `textPayload`,
 `jsonPayload`, `protoPayload`, `httpRequest`, `labels`, `sourceLocation`.

 Restricting a repeated field will restrict all values. Adding a parent will
 block all child fields. (e.g. `foo.bar` will block `foo.bar.baz`)
        repeated string restricted_fields = 15;
        Returns:
        The count of restrictedFields.

      • getRestrictedFields

        String getRestrictedFields​(int index)
         Log entry field paths that are denied access in this bucket.

 The following fields and their children are eligible: `textPayload`,
 `jsonPayload`, `protoPayload`, `httpRequest`, `labels`, `sourceLocation`.

 Restricting a repeated field will restrict all values. Adding a parent will
 block all child fields. (e.g. `foo.bar` will block `foo.bar.baz`)
        repeated string restricted_fields = 15;
        Parameters:
        index - The index of the element to return.
        Returns:
        The restrictedFields at the given index.

      • getRestrictedFieldsBytes

        com.google.protobuf.ByteString getRestrictedFieldsBytes​(int index)
         Log entry field paths that are denied access in this bucket.

 The following fields and their children are eligible: `textPayload`,
 `jsonPayload`, `protoPayload`, `httpRequest`, `labels`, `sourceLocation`.

 Restricting a repeated field will restrict all values. Adding a parent will
 block all child fields. (e.g. `foo.bar` will block `foo.bar.baz`)
        repeated string restricted_fields = 15;
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the restrictedFields at the given index.

      • getIndexConfigsList

        List<IndexConfig> getIndexConfigsList()
         A list of indexed fields and related configuration data.
        repeated .google.logging.v2.IndexConfig index_configs = 17;

      • getIndexConfigs

        IndexConfig getIndexConfigs​(int index)
         A list of indexed fields and related configuration data.
        repeated .google.logging.v2.IndexConfig index_configs = 17;

      • getIndexConfigsCount

        int getIndexConfigsCount()
         A list of indexed fields and related configuration data.
        repeated .google.logging.v2.IndexConfig index_configs = 17;

      • getIndexConfigsOrBuilderList

        List<? extends IndexConfigOrBuilder> getIndexConfigsOrBuilderList()
         A list of indexed fields and related configuration data.
        repeated .google.logging.v2.IndexConfig index_configs = 17;

      • getIndexConfigsOrBuilder

        IndexConfigOrBuilder getIndexConfigsOrBuilder​(int index)
         A list of indexed fields and related configuration data.
        repeated .google.logging.v2.IndexConfig index_configs = 17;

      • hasCmekSettings

        boolean hasCmekSettings()
         The CMEK settings of the log bucket. If present, new log entries written to
 this log bucket are encrypted using the CMEK key provided in this
 configuration. If a log bucket has CMEK settings, the CMEK settings cannot
 be disabled later by updating the log bucket. Changing the KMS key is
 allowed.
        .google.logging.v2.CmekSettings cmek_settings = 19;
        Returns:
        Whether the cmekSettings field is set.

      • getCmekSettings

        CmekSettings getCmekSettings()
         The CMEK settings of the log bucket. If present, new log entries written to
 this log bucket are encrypted using the CMEK key provided in this
 configuration. If a log bucket has CMEK settings, the CMEK settings cannot
 be disabled later by updating the log bucket. Changing the KMS key is
 allowed.
        .google.logging.v2.CmekSettings cmek_settings = 19;
        Returns:
        The cmekSettings.

      • getCmekSettingsOrBuilder

        CmekSettingsOrBuilder getCmekSettingsOrBuilder()
         The CMEK settings of the log bucket. If present, new log entries written to
 this log bucket are encrypted using the CMEK key provided in this
 configuration. If a log bucket has CMEK settings, the CMEK settings cannot
 be disabled later by updating the log bucket. Changing the KMS key is
 allowed.
        .google.logging.v2.CmekSettings cmek_settings = 19;