Package com.google.cloud.secretmanager.v1beta2

Interface SecretOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Secret, Secret.Builder
@Generated public interface SecretOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getName

      String getName()
       Output only. The resource name of the
 [Secret][google.cloud.secretmanager.v1beta2.Secret] in the format
 `projects/*/secrets/*`.
      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
 [Secret][google.cloud.secretmanager.v1beta2.Secret] in the format
 `projects/*/secrets/*`.
      string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The bytes for name.

    • hasReplication

      boolean hasReplication()
       Optional. Immutable. The replication policy of the secret data attached to
 the [Secret][google.cloud.secretmanager.v1beta2.Secret].

 The replication policy cannot be changed after the Secret has been created.
      .google.cloud.secretmanager.v1beta2.Replication replication = 2 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the replication field is set.

    • getReplication

      Replication getReplication()
       Optional. Immutable. The replication policy of the secret data attached to
 the [Secret][google.cloud.secretmanager.v1beta2.Secret].

 The replication policy cannot be changed after the Secret has been created.
      .google.cloud.secretmanager.v1beta2.Replication replication = 2 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];
      Returns:
      The replication.

    • getReplicationOrBuilder

      ReplicationOrBuilder getReplicationOrBuilder()
       Optional. Immutable. The replication policy of the secret data attached to
 the [Secret][google.cloud.secretmanager.v1beta2.Secret].

 The replication policy cannot be changed after the Secret has been created.
      .google.cloud.secretmanager.v1beta2.Replication replication = 2 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];

    • hasCreateTime

      boolean hasCreateTime()
       Output only. The time at which the
 [Secret][google.cloud.secretmanager.v1beta2.Secret] was created.
      .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the createTime field is set.

    • getCreateTime

      com.google.protobuf.Timestamp getCreateTime()
       Output only. The time at which the
 [Secret][google.cloud.secretmanager.v1beta2.Secret] was created.
      .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The createTime.

    • getCreateTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
       Output only. The time at which the
 [Secret][google.cloud.secretmanager.v1beta2.Secret] was created.
      .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getLabelsCount

      int getLabelsCount()
       The labels assigned to this Secret.

 Label keys must be between 1 and 63 characters long, have a UTF-8 encoding
 of maximum 128 bytes, and must conform to the following PCRE regular
 expression: `[\p{Ll}\p{Lo}][\p{Ll}\p{Lo}\p{N}_-]{0,62}`

 Label values must be between 0 and 63 characters long, have a UTF-8
 encoding of maximum 128 bytes, and must conform to the following PCRE
 regular expression: `[\p{Ll}\p{Lo}\p{N}_-]{0,63}`

 No more than 64 labels can be assigned to a given resource.
      map<string, string> labels = 4;

    • containsLabels

      boolean containsLabels(String key)
       The labels assigned to this Secret.

 Label keys must be between 1 and 63 characters long, have a UTF-8 encoding
 of maximum 128 bytes, and must conform to the following PCRE regular
 expression: `[\p{Ll}\p{Lo}][\p{Ll}\p{Lo}\p{N}_-]{0,62}`

 Label values must be between 0 and 63 characters long, have a UTF-8
 encoding of maximum 128 bytes, and must conform to the following PCRE
 regular expression: `[\p{Ll}\p{Lo}\p{N}_-]{0,63}`

 No more than 64 labels can be assigned to a given resource.
      map<string, string> labels = 4;

    • getLabels

      @Deprecated Map<String,String> getLabels()
      Deprecated.
      Use getLabelsMap() instead.

    • getLabelsMap

      Map<String,String> getLabelsMap()
       The labels assigned to this Secret.

 Label keys must be between 1 and 63 characters long, have a UTF-8 encoding
 of maximum 128 bytes, and must conform to the following PCRE regular
 expression: `[\p{Ll}\p{Lo}][\p{Ll}\p{Lo}\p{N}_-]{0,62}`

 Label values must be between 0 and 63 characters long, have a UTF-8
 encoding of maximum 128 bytes, and must conform to the following PCRE
 regular expression: `[\p{Ll}\p{Lo}\p{N}_-]{0,63}`

 No more than 64 labels can be assigned to a given resource.
      map<string, string> labels = 4;

    • getLabelsOrDefault

      String getLabelsOrDefault(String key, String defaultValue)
       The labels assigned to this Secret.

 Label keys must be between 1 and 63 characters long, have a UTF-8 encoding
 of maximum 128 bytes, and must conform to the following PCRE regular
 expression: `[\p{Ll}\p{Lo}][\p{Ll}\p{Lo}\p{N}_-]{0,62}`

 Label values must be between 0 and 63 characters long, have a UTF-8
 encoding of maximum 128 bytes, and must conform to the following PCRE
 regular expression: `[\p{Ll}\p{Lo}\p{N}_-]{0,63}`

 No more than 64 labels can be assigned to a given resource.
      map<string, string> labels = 4;

    • getLabelsOrThrow

      String getLabelsOrThrow(String key)
       The labels assigned to this Secret.

 Label keys must be between 1 and 63 characters long, have a UTF-8 encoding
 of maximum 128 bytes, and must conform to the following PCRE regular
 expression: `[\p{Ll}\p{Lo}][\p{Ll}\p{Lo}\p{N}_-]{0,62}`

 Label values must be between 0 and 63 characters long, have a UTF-8
 encoding of maximum 128 bytes, and must conform to the following PCRE
 regular expression: `[\p{Ll}\p{Lo}\p{N}_-]{0,63}`

 No more than 64 labels can be assigned to a given resource.
      map<string, string> labels = 4;

    • getTopicsList

      List<Topic> getTopicsList()
       Optional. A list of up to 10 Pub/Sub topics to which messages are published
 when control plane operations are called on the secret or its versions.
      repeated .google.cloud.secretmanager.v1beta2.Topic topics = 5 [(.google.api.field_behavior) = OPTIONAL];

    • getTopics

      Topic getTopics(int index)
       Optional. A list of up to 10 Pub/Sub topics to which messages are published
 when control plane operations are called on the secret or its versions.
      repeated .google.cloud.secretmanager.v1beta2.Topic topics = 5 [(.google.api.field_behavior) = OPTIONAL];

    • getTopicsCount

      int getTopicsCount()
       Optional. A list of up to 10 Pub/Sub topics to which messages are published
 when control plane operations are called on the secret or its versions.
      repeated .google.cloud.secretmanager.v1beta2.Topic topics = 5 [(.google.api.field_behavior) = OPTIONAL];

    • getTopicsOrBuilderList

      List<? extends TopicOrBuilder> getTopicsOrBuilderList()
       Optional. A list of up to 10 Pub/Sub topics to which messages are published
 when control plane operations are called on the secret or its versions.
      repeated .google.cloud.secretmanager.v1beta2.Topic topics = 5 [(.google.api.field_behavior) = OPTIONAL];

    • getTopicsOrBuilder

      TopicOrBuilder getTopicsOrBuilder(int index)
       Optional. A list of up to 10 Pub/Sub topics to which messages are published
 when control plane operations are called on the secret or its versions.
      repeated .google.cloud.secretmanager.v1beta2.Topic topics = 5 [(.google.api.field_behavior) = OPTIONAL];

    • hasExpireTime

      boolean hasExpireTime()
       Optional. Timestamp in UTC when the
 [Secret][google.cloud.secretmanager.v1beta2.Secret] is scheduled to
 expire. This is always provided on output, regardless of what was sent on
 input.
      .google.protobuf.Timestamp expire_time = 6 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the expireTime field is set.

    • getExpireTime

      com.google.protobuf.Timestamp getExpireTime()
       Optional. Timestamp in UTC when the
 [Secret][google.cloud.secretmanager.v1beta2.Secret] is scheduled to
 expire. This is always provided on output, regardless of what was sent on
 input.
      .google.protobuf.Timestamp expire_time = 6 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The expireTime.

    • getExpireTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getExpireTimeOrBuilder()
       Optional. Timestamp in UTC when the
 [Secret][google.cloud.secretmanager.v1beta2.Secret] is scheduled to
 expire. This is always provided on output, regardless of what was sent on
 input.
      .google.protobuf.Timestamp expire_time = 6 [(.google.api.field_behavior) = OPTIONAL];

    • hasTtl

      boolean hasTtl()
       Input only. The TTL for the
 [Secret][google.cloud.secretmanager.v1beta2.Secret].
      .google.protobuf.Duration ttl = 7 [(.google.api.field_behavior) = INPUT_ONLY];
      Returns:
      Whether the ttl field is set.

    • getTtl

      com.google.protobuf.Duration getTtl()
       Input only. The TTL for the
 [Secret][google.cloud.secretmanager.v1beta2.Secret].
      .google.protobuf.Duration ttl = 7 [(.google.api.field_behavior) = INPUT_ONLY];
      Returns:
      The ttl.

    • getTtlOrBuilder

      com.google.protobuf.DurationOrBuilder getTtlOrBuilder()
       Input only. The TTL for the
 [Secret][google.cloud.secretmanager.v1beta2.Secret].
      .google.protobuf.Duration ttl = 7 [(.google.api.field_behavior) = INPUT_ONLY];

    • getEtag

      String getEtag()
       Optional. Etag of the currently stored
 [Secret][google.cloud.secretmanager.v1beta2.Secret].
      string etag = 8 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The etag.

    • getEtagBytes

      com.google.protobuf.ByteString getEtagBytes()
       Optional. Etag of the currently stored
 [Secret][google.cloud.secretmanager.v1beta2.Secret].
      string etag = 8 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for etag.

    • hasRotation

      boolean hasRotation()
       Optional. Rotation policy attached to the
 [Secret][google.cloud.secretmanager.v1beta2.Secret]. May be excluded if
 there is no rotation policy.
      .google.cloud.secretmanager.v1beta2.Rotation rotation = 9 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the rotation field is set.

    • getRotation

      Rotation getRotation()
       Optional. Rotation policy attached to the
 [Secret][google.cloud.secretmanager.v1beta2.Secret]. May be excluded if
 there is no rotation policy.
      .google.cloud.secretmanager.v1beta2.Rotation rotation = 9 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The rotation.

    • getRotationOrBuilder

      RotationOrBuilder getRotationOrBuilder()
       Optional. Rotation policy attached to the
 [Secret][google.cloud.secretmanager.v1beta2.Secret]. May be excluded if
 there is no rotation policy.
      .google.cloud.secretmanager.v1beta2.Rotation rotation = 9 [(.google.api.field_behavior) = OPTIONAL];

    • getVersionAliasesCount

      int getVersionAliasesCount()
       Optional. Mapping from version alias to version name.

 A version alias is a string with a maximum length of 63 characters and can
 contain uppercase and lowercase letters, numerals, and the hyphen (`-`)
 and underscore ('_') characters. An alias string must start with a
 letter and cannot be the string 'latest' or 'NEW'.
 No more than 50 aliases can be assigned to a given secret.

 Version-Alias pairs will be viewable via GetSecret and modifiable via
 UpdateSecret. Access by alias is only supported for
 GetSecretVersion and AccessSecretVersion.
      map<string, int64> version_aliases = 11 [(.google.api.field_behavior) = OPTIONAL];

    • containsVersionAliases

      boolean containsVersionAliases(String key)
       Optional. Mapping from version alias to version name.

 A version alias is a string with a maximum length of 63 characters and can
 contain uppercase and lowercase letters, numerals, and the hyphen (`-`)
 and underscore ('_') characters. An alias string must start with a
 letter and cannot be the string 'latest' or 'NEW'.
 No more than 50 aliases can be assigned to a given secret.

 Version-Alias pairs will be viewable via GetSecret and modifiable via
 UpdateSecret. Access by alias is only supported for
 GetSecretVersion and AccessSecretVersion.
      map<string, int64> version_aliases = 11 [(.google.api.field_behavior) = OPTIONAL];

    • getVersionAliases

      @Deprecated Map<String,Long> getVersionAliases()
      Deprecated.
      Use getVersionAliasesMap() instead.

    • getVersionAliasesMap

      Map<String,Long> getVersionAliasesMap()
       Optional. Mapping from version alias to version name.

 A version alias is a string with a maximum length of 63 characters and can
 contain uppercase and lowercase letters, numerals, and the hyphen (`-`)
 and underscore ('_') characters. An alias string must start with a
 letter and cannot be the string 'latest' or 'NEW'.
 No more than 50 aliases can be assigned to a given secret.

 Version-Alias pairs will be viewable via GetSecret and modifiable via
 UpdateSecret. Access by alias is only supported for
 GetSecretVersion and AccessSecretVersion.
      map<string, int64> version_aliases = 11 [(.google.api.field_behavior) = OPTIONAL];

    • getVersionAliasesOrDefault

      long getVersionAliasesOrDefault(String key, long defaultValue)
       Optional. Mapping from version alias to version name.

 A version alias is a string with a maximum length of 63 characters and can
 contain uppercase and lowercase letters, numerals, and the hyphen (`-`)
 and underscore ('_') characters. An alias string must start with a
 letter and cannot be the string 'latest' or 'NEW'.
 No more than 50 aliases can be assigned to a given secret.

 Version-Alias pairs will be viewable via GetSecret and modifiable via
 UpdateSecret. Access by alias is only supported for
 GetSecretVersion and AccessSecretVersion.
      map<string, int64> version_aliases = 11 [(.google.api.field_behavior) = OPTIONAL];

    • getVersionAliasesOrThrow

      long getVersionAliasesOrThrow(String key)
       Optional. Mapping from version alias to version name.

 A version alias is a string with a maximum length of 63 characters and can
 contain uppercase and lowercase letters, numerals, and the hyphen (`-`)
 and underscore ('_') characters. An alias string must start with a
 letter and cannot be the string 'latest' or 'NEW'.
 No more than 50 aliases can be assigned to a given secret.

 Version-Alias pairs will be viewable via GetSecret and modifiable via
 UpdateSecret. Access by alias is only supported for
 GetSecretVersion and AccessSecretVersion.
      map<string, int64> version_aliases = 11 [(.google.api.field_behavior) = OPTIONAL];

    • getAnnotationsCount

      int getAnnotationsCount()
       Optional. Custom metadata about the secret.

 Annotations are distinct from various forms of labels.
 Annotations exist to allow client tools to store their own state
 information without requiring a database.

 Annotation keys must be between 1 and 63 characters long, have a UTF-8
 encoding of maximum 128 bytes, begin and end with an alphanumeric character
 ([a-z0-9A-Z]), and may have dashes (-), underscores (_), dots (.), and
 alphanumerics in between these symbols.

 The total size of annotation keys and values must be less than 16KiB.
      map<string, string> annotations = 13 [(.google.api.field_behavior) = OPTIONAL];

    • containsAnnotations

      boolean containsAnnotations(String key)
       Optional. Custom metadata about the secret.

 Annotations are distinct from various forms of labels.
 Annotations exist to allow client tools to store their own state
 information without requiring a database.

 Annotation keys must be between 1 and 63 characters long, have a UTF-8
 encoding of maximum 128 bytes, begin and end with an alphanumeric character
 ([a-z0-9A-Z]), and may have dashes (-), underscores (_), dots (.), and
 alphanumerics in between these symbols.

 The total size of annotation keys and values must be less than 16KiB.
      map<string, string> annotations = 13 [(.google.api.field_behavior) = OPTIONAL];

    • getAnnotations

      @Deprecated Map<String,String> getAnnotations()
      Deprecated.
      Use getAnnotationsMap() instead.

    • getAnnotationsMap

      Map<String,String> getAnnotationsMap()
       Optional. Custom metadata about the secret.

 Annotations are distinct from various forms of labels.
 Annotations exist to allow client tools to store their own state
 information without requiring a database.

 Annotation keys must be between 1 and 63 characters long, have a UTF-8
 encoding of maximum 128 bytes, begin and end with an alphanumeric character
 ([a-z0-9A-Z]), and may have dashes (-), underscores (_), dots (.), and
 alphanumerics in between these symbols.

 The total size of annotation keys and values must be less than 16KiB.
      map<string, string> annotations = 13 [(.google.api.field_behavior) = OPTIONAL];

    • getAnnotationsOrDefault

      String getAnnotationsOrDefault(String key, String defaultValue)
       Optional. Custom metadata about the secret.

 Annotations are distinct from various forms of labels.
 Annotations exist to allow client tools to store their own state
 information without requiring a database.

 Annotation keys must be between 1 and 63 characters long, have a UTF-8
 encoding of maximum 128 bytes, begin and end with an alphanumeric character
 ([a-z0-9A-Z]), and may have dashes (-), underscores (_), dots (.), and
 alphanumerics in between these symbols.

 The total size of annotation keys and values must be less than 16KiB.
      map<string, string> annotations = 13 [(.google.api.field_behavior) = OPTIONAL];

    • getAnnotationsOrThrow

      String getAnnotationsOrThrow(String key)
       Optional. Custom metadata about the secret.

 Annotations are distinct from various forms of labels.
 Annotations exist to allow client tools to store their own state
 information without requiring a database.

 Annotation keys must be between 1 and 63 characters long, have a UTF-8
 encoding of maximum 128 bytes, begin and end with an alphanumeric character
 ([a-z0-9A-Z]), and may have dashes (-), underscores (_), dots (.), and
 alphanumerics in between these symbols.

 The total size of annotation keys and values must be less than 16KiB.
      map<string, string> annotations = 13 [(.google.api.field_behavior) = OPTIONAL];

    • hasVersionDestroyTtl

      boolean hasVersionDestroyTtl()
       Optional. Secret Version TTL after destruction request

 This is a part of the Delayed secret version destroy feature.
 For secret with TTL>0, version destruction doesn't happen immediately
 on calling destroy instead the version goes to a disabled state and
 destruction happens after the TTL expires.
      .google.protobuf.Duration version_destroy_ttl = 14 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the versionDestroyTtl field is set.

    • getVersionDestroyTtl

      com.google.protobuf.Duration getVersionDestroyTtl()
       Optional. Secret Version TTL after destruction request

 This is a part of the Delayed secret version destroy feature.
 For secret with TTL>0, version destruction doesn't happen immediately
 on calling destroy instead the version goes to a disabled state and
 destruction happens after the TTL expires.
      .google.protobuf.Duration version_destroy_ttl = 14 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The versionDestroyTtl.

    • getVersionDestroyTtlOrBuilder

      com.google.protobuf.DurationOrBuilder getVersionDestroyTtlOrBuilder()
       Optional. Secret Version TTL after destruction request

 This is a part of the Delayed secret version destroy feature.
 For secret with TTL>0, version destruction doesn't happen immediately
 on calling destroy instead the version goes to a disabled state and
 destruction happens after the TTL expires.
      .google.protobuf.Duration version_destroy_ttl = 14 [(.google.api.field_behavior) = OPTIONAL];

    • hasCustomerManagedEncryption

      boolean hasCustomerManagedEncryption()
       Optional. The customer-managed encryption configuration of the Regionalised
 Secrets. If no configuration is provided, Google-managed default encryption
 is used.

 Updates to the [Secret][google.cloud.secretmanager.v1beta2.Secret]
 encryption configuration only apply to
 [SecretVersions][google.cloud.secretmanager.v1beta2.SecretVersion] added
 afterwards. They do not apply retroactively to existing
 [SecretVersions][google.cloud.secretmanager.v1beta2.SecretVersion].
      .google.cloud.secretmanager.v1beta2.CustomerManagedEncryption customer_managed_encryption = 15 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the customerManagedEncryption field is set.

    • getCustomerManagedEncryption

      CustomerManagedEncryption getCustomerManagedEncryption()
       Optional. The customer-managed encryption configuration of the Regionalised
 Secrets. If no configuration is provided, Google-managed default encryption
 is used.

 Updates to the [Secret][google.cloud.secretmanager.v1beta2.Secret]
 encryption configuration only apply to
 [SecretVersions][google.cloud.secretmanager.v1beta2.SecretVersion] added
 afterwards. They do not apply retroactively to existing
 [SecretVersions][google.cloud.secretmanager.v1beta2.SecretVersion].
      .google.cloud.secretmanager.v1beta2.CustomerManagedEncryption customer_managed_encryption = 15 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The customerManagedEncryption.

    • getCustomerManagedEncryptionOrBuilder

      CustomerManagedEncryptionOrBuilder getCustomerManagedEncryptionOrBuilder()
       Optional. The customer-managed encryption configuration of the Regionalised
 Secrets. If no configuration is provided, Google-managed default encryption
 is used.

 Updates to the [Secret][google.cloud.secretmanager.v1beta2.Secret]
 encryption configuration only apply to
 [SecretVersions][google.cloud.secretmanager.v1beta2.SecretVersion] added
 afterwards. They do not apply retroactively to existing
 [SecretVersions][google.cloud.secretmanager.v1beta2.SecretVersion].
      .google.cloud.secretmanager.v1beta2.CustomerManagedEncryption customer_managed_encryption = 15 [(.google.api.field_behavior) = OPTIONAL];

    • getExpirationCase

      Secret.ExpirationCase getExpirationCase()