public final class Secret extends GeneratedMessageV3 implements SecretOrBuilder
A Secret is a logical secret whose
value and versions can be accessed.
A Secret is made up of zero or more
SecretVersions that represent
the secret data.
Protobuf type google.cloud.secretmanager.v1.Secret
Static Fields
ANNOTATIONS_FIELD_NUMBER
public static final int ANNOTATIONS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
ETAG_FIELD_NUMBER
public static final int ETAG_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
EXPIRE_TIME_FIELD_NUMBER
public static final int EXPIRE_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
REPLICATION_FIELD_NUMBER
public static final int REPLICATION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
ROTATION_FIELD_NUMBER
public static final int ROTATION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
TOPICS_FIELD_NUMBER
public static final int TOPICS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
TTL_FIELD_NUMBER
public static final int TTL_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
VERSION_ALIASES_FIELD_NUMBER
public static final int VERSION_ALIASES_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static Secret getDefaultInstance()
| Returns |
| Type |
Description |
Secret |
|
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static Secret.Builder newBuilder()
newBuilder(Secret prototype)
public static Secret.Builder newBuilder(Secret prototype)
| Parameter |
| Name |
Description |
prototype |
Secret
|
public static Secret parseDelimitedFrom(InputStream input)
| Returns |
| Type |
Description |
Secret |
|
public static Secret parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Secret |
|
parseFrom(byte[] data)
public static Secret parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
| Returns |
| Type |
Description |
Secret |
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Secret parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Secret |
|
parseFrom(ByteString data)
public static Secret parseFrom(ByteString data)
| Returns |
| Type |
Description |
Secret |
|
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Secret parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Secret |
|
public static Secret parseFrom(CodedInputStream input)
| Returns |
| Type |
Description |
Secret |
|
public static Secret parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Secret |
|
public static Secret parseFrom(InputStream input)
| Returns |
| Type |
Description |
Secret |
|
public static Secret parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Secret |
|
parseFrom(ByteBuffer data)
public static Secret parseFrom(ByteBuffer data)
| Returns |
| Type |
Description |
Secret |
|
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Secret parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Secret |
|
parser()
public static Parser<Secret> parser()
Methods
containsAnnotations(String key)
public 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];
| Parameter |
| Name |
Description |
key |
String
|
containsLabels(String key)
public 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}{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;
| Parameter |
| Name |
Description |
key |
String
|
containsVersionAliases(String key)
public 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. At launch access by alias will only be supported on
GetSecretVersion and AccessSecretVersion.
map<string, int64> version_aliases = 11 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
| Name |
Description |
key |
String
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getAnnotations()
public Map<String,String> getAnnotations()
getAnnotationsCount()
public 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];
| Returns |
| Type |
Description |
int |
|
getAnnotationsMap()
public 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 key, String defaultValue)
public 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];
| Returns |
| Type |
Description |
String |
|
getAnnotationsOrThrow(String key)
public 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];
| Parameter |
| Name |
Description |
key |
String
|
| Returns |
| Type |
Description |
String |
|
getCreateTime()
public Timestamp getCreateTime()
Output only. The time at which the
Secret was created.
.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
Timestamp |
The createTime.
|
getCreateTimeOrBuilder()
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. The time at which the
Secret was created.
.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
getDefaultInstanceForType()
public Secret getDefaultInstanceForType()
| Returns |
| Type |
Description |
Secret |
|
getEtag()
Optional. Etag of the currently stored
Secret.
string etag = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
String |
The etag.
|
getEtagBytes()
public ByteString getEtagBytes()
Optional. Etag of the currently stored
Secret.
string etag = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
ByteString |
The bytes for etag.
|
getExpirationCase()
public Secret.ExpirationCase getExpirationCase()
getExpireTime()
public Timestamp getExpireTime()
Optional. Timestamp in UTC when the
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 |
| Type |
Description |
Timestamp |
The expireTime.
|
getExpireTimeOrBuilder()
public TimestampOrBuilder getExpireTimeOrBuilder()
Optional. Timestamp in UTC when the
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];
getLabels()
public Map<String,String> getLabels()
getLabelsCount()
public 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}{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;
| Returns |
| Type |
Description |
int |
|
getLabelsMap()
public 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}{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 key, String defaultValue)
public 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}{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;
| Returns |
| Type |
Description |
String |
|
getLabelsOrThrow(String key)
public 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}{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;
| Parameter |
| Name |
Description |
key |
String
|
| Returns |
| Type |
Description |
String |
|
getName()
Output only. The resource name of the
Secret in the format
projects/*/secrets/*.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
String |
The name.
|
getNameBytes()
public ByteString getNameBytes()
Output only. The resource name of the
Secret in the format
projects/*/secrets/*.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
ByteString |
The bytes for name.
|
getParserForType()
public Parser<Secret> getParserForType()
Overrides
getReplication()
public Replication getReplication()
Required. Immutable. The replication policy of the secret data attached to
the Secret.
The replication policy cannot be changed after the Secret has been created.
.google.cloud.secretmanager.v1.Replication replication = 2 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED];
getReplicationOrBuilder()
public ReplicationOrBuilder getReplicationOrBuilder()
Required. Immutable. The replication policy of the secret data attached to
the Secret.
The replication policy cannot be changed after the Secret has been created.
.google.cloud.secretmanager.v1.Replication replication = 2 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED];
getRotation()
public Rotation getRotation()
Optional. Rotation policy attached to the
Secret. May be excluded if there is
no rotation policy.
.google.cloud.secretmanager.v1.Rotation rotation = 9 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
Rotation |
The rotation.
|
getRotationOrBuilder()
public RotationOrBuilder getRotationOrBuilder()
Optional. Rotation policy attached to the
Secret. May be excluded if there is
no rotation policy.
.google.cloud.secretmanager.v1.Rotation rotation = 9 [(.google.api.field_behavior) = OPTIONAL];
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
getTopics(int index)
public 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.v1.Topic topics = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
| Name |
Description |
index |
int
|
| Returns |
| Type |
Description |
Topic |
|
getTopicsCount()
public 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.v1.Topic topics = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
int |
|
getTopicsList()
public 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.v1.Topic topics = 5 [(.google.api.field_behavior) = OPTIONAL];
getTopicsOrBuilder(int index)
public 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.v1.Topic topics = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
| Name |
Description |
index |
int
|
getTopicsOrBuilderList()
public 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.v1.Topic topics = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
List<? extends com.google.cloud.secretmanager.v1.TopicOrBuilder> |
|
getTtl()
Input only. The TTL for the
Secret.
.google.protobuf.Duration ttl = 7 [(.google.api.field_behavior) = INPUT_ONLY];
| Returns |
| Type |
Description |
Duration |
The ttl.
|
getTtlOrBuilder()
public DurationOrBuilder getTtlOrBuilder()
Input only. The TTL for the
Secret.
.google.protobuf.Duration ttl = 7 [(.google.api.field_behavior) = INPUT_ONLY];
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Overrides
getVersionAliases()
public Map<String,Long> getVersionAliases()
| Returns |
| Type |
Description |
Map<String,java.lang.Long> |
|
getVersionAliasesCount()
public 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. At launch access by alias will only be supported on
GetSecretVersion and AccessSecretVersion.
map<string, int64> version_aliases = 11 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
int |
|
getVersionAliasesMap()
public 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. At launch access by alias will only be supported on
GetSecretVersion and AccessSecretVersion.
map<string, int64> version_aliases = 11 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
Map<String,java.lang.Long> |
|
getVersionAliasesOrDefault(String key, long defaultValue)
public 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. At launch access by alias will only be supported on
GetSecretVersion and AccessSecretVersion.
map<string, int64> version_aliases = 11 [(.google.api.field_behavior) = OPTIONAL];
| Parameters |
| Name |
Description |
key |
String
|
defaultValue |
long
|
| Returns |
| Type |
Description |
long |
|
getVersionAliasesOrThrow(String key)
public 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. At launch access by alias will only be supported on
GetSecretVersion and AccessSecretVersion.
map<string, int64> version_aliases = 11 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
| Name |
Description |
key |
String
|
| Returns |
| Type |
Description |
long |
|
hasCreateTime()
public boolean hasCreateTime()
Output only. The time at which the
Secret was created.
.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
boolean |
Whether the createTime field is set.
|
hasExpireTime()
public boolean hasExpireTime()
Optional. Timestamp in UTC when the
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 |
| Type |
Description |
boolean |
Whether the expireTime field is set.
|
hasReplication()
public boolean hasReplication()
Required. Immutable. The replication policy of the secret data attached to
the Secret.
The replication policy cannot be changed after the Secret has been created.
.google.cloud.secretmanager.v1.Replication replication = 2 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
boolean |
Whether the replication field is set.
|
hasRotation()
public boolean hasRotation()
Optional. Rotation policy attached to the
Secret. May be excluded if there is
no rotation policy.
.google.cloud.secretmanager.v1.Rotation rotation = 9 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
Whether the rotation field is set.
|
hasTtl()
Input only. The TTL for the
Secret.
.google.protobuf.Duration ttl = 7 [(.google.api.field_behavior) = INPUT_ONLY];
| Returns |
| Type |
Description |
boolean |
Whether the ttl field is set.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
| Parameter |
| Name |
Description |
number |
int
|
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public Secret.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Secret.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public Secret.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
