public interface SecretOrBuilder
extends com.google.protobuf.MessageOrBuilder
| Modifier and Type | Method and Description |
|---|---|
boolean |
containsAnnotations(String key)
Optional.
|
boolean |
containsLabels(String key)
The labels assigned to this Secret.
|
boolean |
containsVersionAliases(String key)
Optional.
|
Map<String,String> |
getAnnotations()
Deprecated.
|
int |
getAnnotationsCount()
Optional.
|
Map<String,String> |
getAnnotationsMap()
Optional.
|
String |
getAnnotationsOrDefault(String key,
String defaultValue)
Optional.
|
String |
getAnnotationsOrThrow(String key)
Optional.
|
com.google.protobuf.Timestamp |
getCreateTime()
Output only.
|
com.google.protobuf.TimestampOrBuilder |
getCreateTimeOrBuilder()
Output only.
|
CustomerManagedEncryption |
getCustomerManagedEncryption()
Optional.
|
CustomerManagedEncryptionOrBuilder |
getCustomerManagedEncryptionOrBuilder()
Optional.
|
String |
getEtag()
Optional.
|
com.google.protobuf.ByteString |
getEtagBytes()
Optional.
|
Secret.ExpirationCase |
getExpirationCase() |
com.google.protobuf.Timestamp |
getExpireTime()
Optional.
|
com.google.protobuf.TimestampOrBuilder |
getExpireTimeOrBuilder()
Optional.
|
Map<String,String> |
getLabels()
Deprecated.
|
int |
getLabelsCount()
The labels assigned to this Secret.
|
Map<String,String> |
getLabelsMap()
The labels assigned to this Secret.
|
String |
getLabelsOrDefault(String key,
String defaultValue)
The labels assigned to this Secret.
|
String |
getLabelsOrThrow(String key)
The labels assigned to this Secret.
|
String |
getName()
Output only.
|
com.google.protobuf.ByteString |
getNameBytes()
Output only.
|
Replication |
getReplication()
Optional.
|
ReplicationOrBuilder |
getReplicationOrBuilder()
Optional.
|
Rotation |
getRotation()
Optional.
|
RotationOrBuilder |
getRotationOrBuilder()
Optional.
|
Topic |
getTopics(int index)
Optional.
|
int |
getTopicsCount()
Optional.
|
List<Topic> |
getTopicsList()
Optional.
|
TopicOrBuilder |
getTopicsOrBuilder(int index)
Optional.
|
List<? extends TopicOrBuilder> |
getTopicsOrBuilderList()
Optional.
|
com.google.protobuf.Duration |
getTtl()
Input only.
|
com.google.protobuf.DurationOrBuilder |
getTtlOrBuilder()
Input only.
|
Map<String,Long> |
getVersionAliases()
Deprecated.
|
int |
getVersionAliasesCount()
Optional.
|
Map<String,Long> |
getVersionAliasesMap()
Optional.
|
long |
getVersionAliasesOrDefault(String key,
long defaultValue)
Optional.
|
long |
getVersionAliasesOrThrow(String key)
Optional.
|
com.google.protobuf.Duration |
getVersionDestroyTtl()
Optional.
|
com.google.protobuf.DurationOrBuilder |
getVersionDestroyTtlOrBuilder()
Optional.
|
boolean |
hasCreateTime()
Output only.
|
boolean |
hasCustomerManagedEncryption()
Optional.
|
boolean |
hasExpireTime()
Optional.
|
boolean |
hasReplication()
Optional.
|
boolean |
hasRotation()
Optional.
|
boolean |
hasTtl()
Input only.
|
boolean |
hasVersionDestroyTtl()
Optional.
|
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneofString 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];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];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];
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];
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];
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];
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];
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];
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;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;@Deprecated Map<String,String> getLabels()
getLabelsMap() instead.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;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;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;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];
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];
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];
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];
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];
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];
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];
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];
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];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];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];String getEtag()
Optional. Etag of the currently stored [Secret][google.cloud.secretmanager.v1beta2.Secret].
string etag = 8 [(.google.api.field_behavior) = OPTIONAL];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];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];
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];
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];
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];
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];
@Deprecated Map<String,Long> getVersionAliases()
getVersionAliasesMap() instead.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];
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];
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];
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];
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];
@Deprecated Map<String,String> getAnnotations()
getAnnotationsMap() instead.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];
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];
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];
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];
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];
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];
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];
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];
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];
Secret.ExpirationCase getExpirationCase()
Copyright © 2025 Google LLC. All rights reserved.