public final class Secret extends GeneratedMessageV3 implements SecretOrBuilder
A [Secret][google.cloud.secretmanager.v1.Secret] is a logical secret whose value and versions can be accessed. A [Secret][google.cloud.secretmanager.v1.Secret] is made up of zero or more [SecretVersions][google.cloud.secretmanager.v1.SecretVersion] that represent the secret data.Protobuf type
google.cloud.secretmanager.v1.Secret| Modifier and Type | Class and Description |
|---|---|
static class |
Secret.Builder
A [Secret][google.cloud.secretmanager.v1.Secret] is a logical secret whose value and versions can
be accessed.
|
static class |
Secret.ExpirationCase |
GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage,BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageV3.ExtendableMessage<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.FieldAccessorTable, GeneratedMessageV3.UnusedPrivateParameterAbstractMessageLite.InternalOneOfEnum| Modifier and Type | Field and Description |
|---|---|
static int |
CREATE_TIME_FIELD_NUMBER |
static int |
ETAG_FIELD_NUMBER |
static int |
EXPIRE_TIME_FIELD_NUMBER |
static int |
LABELS_FIELD_NUMBER |
static int |
NAME_FIELD_NUMBER |
static int |
REPLICATION_FIELD_NUMBER |
static int |
ROTATION_FIELD_NUMBER |
static int |
TOPICS_FIELD_NUMBER |
static int |
TTL_FIELD_NUMBER |
static int |
VERSION_ALIASES_FIELD_NUMBER |
alwaysUseFieldBuilders, unknownFieldsmemoizedSizememoizedHashCodecanUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitfindInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneoftoByteArray, toByteString, writeDelimitedTo, writeTopublic static final int NAME_FIELD_NUMBER
public static final int REPLICATION_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
public static final int TOPICS_FIELD_NUMBER
public static final int EXPIRE_TIME_FIELD_NUMBER
public static final int TTL_FIELD_NUMBER
public static final int ETAG_FIELD_NUMBER
public static final int ROTATION_FIELD_NUMBER
public static final int VERSION_ALIASES_FIELD_NUMBER
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance in class GeneratedMessageV3public final UnknownFieldSet getUnknownFields()
getUnknownFields in interface MessageOrBuildergetUnknownFields in class GeneratedMessageV3public static final Descriptors.Descriptor getDescriptor()
protected MapField internalGetMapField(int number)
internalGetMapField in class GeneratedMessageV3protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class GeneratedMessageV3public Secret.ExpirationCase getExpirationCase()
getExpirationCase in interface SecretOrBuilderpublic String getName()
Output only. The resource name of the [Secret][google.cloud.secretmanager.v1.Secret] in the format `projects/*/secrets/*`.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];getName in interface SecretOrBuilderpublic ByteString getNameBytes()
Output only. The resource name of the [Secret][google.cloud.secretmanager.v1.Secret] in the format `projects/*/secrets/*`.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];getNameBytes in interface SecretOrBuilderpublic boolean hasReplication()
Required. Immutable. The replication policy of the secret data attached to the [Secret][google.cloud.secretmanager.v1.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];
hasReplication in interface SecretOrBuilderpublic Replication getReplication()
Required. Immutable. The replication policy of the secret data attached to the [Secret][google.cloud.secretmanager.v1.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];
getReplication in interface SecretOrBuilderpublic ReplicationOrBuilder getReplicationOrBuilder()
Required. Immutable. The replication policy of the secret data attached to the [Secret][google.cloud.secretmanager.v1.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 in interface SecretOrBuilderpublic boolean hasCreateTime()
Output only. The time at which the [Secret][google.cloud.secretmanager.v1.Secret] was created.
.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasCreateTime in interface SecretOrBuilderpublic Timestamp getCreateTime()
Output only. The time at which the [Secret][google.cloud.secretmanager.v1.Secret] was created.
.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
getCreateTime in interface SecretOrBuilderpublic TimestampOrBuilder getCreateTimeOrBuilder()
Output only. The time at which the [Secret][google.cloud.secretmanager.v1.Secret] was created.
.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
getCreateTimeOrBuilder in interface SecretOrBuilderpublic int getLabelsCount()
SecretOrBuilder
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;getLabelsCount in interface SecretOrBuilderpublic 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;containsLabels in interface SecretOrBuilder@Deprecated public Map<String,String> getLabels()
getLabelsMap() instead.getLabels in interface SecretOrBuilderpublic 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;getLabelsMap in interface SecretOrBuilderpublic 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;getLabelsOrDefault in interface SecretOrBuilderpublic 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;getLabelsOrThrow in interface SecretOrBuilderpublic 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];
getTopicsList in interface SecretOrBuilderpublic 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];
getTopicsOrBuilderList in interface SecretOrBuilderpublic 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];
getTopicsCount in interface SecretOrBuilderpublic 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];
getTopics in interface SecretOrBuilderpublic 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];
getTopicsOrBuilder in interface SecretOrBuilderpublic boolean hasExpireTime()
Optional. Timestamp in UTC when the [Secret][google.cloud.secretmanager.v1.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];
hasExpireTime in interface SecretOrBuilderpublic Timestamp getExpireTime()
Optional. Timestamp in UTC when the [Secret][google.cloud.secretmanager.v1.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];
getExpireTime in interface SecretOrBuilderpublic TimestampOrBuilder getExpireTimeOrBuilder()
Optional. Timestamp in UTC when the [Secret][google.cloud.secretmanager.v1.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];
getExpireTimeOrBuilder in interface SecretOrBuilderpublic boolean hasTtl()
Input only. The TTL for the [Secret][google.cloud.secretmanager.v1.Secret].
.google.protobuf.Duration ttl = 7 [(.google.api.field_behavior) = INPUT_ONLY];hasTtl in interface SecretOrBuilderpublic Duration getTtl()
Input only. The TTL for the [Secret][google.cloud.secretmanager.v1.Secret].
.google.protobuf.Duration ttl = 7 [(.google.api.field_behavior) = INPUT_ONLY];getTtl in interface SecretOrBuilderpublic DurationOrBuilder getTtlOrBuilder()
Input only. The TTL for the [Secret][google.cloud.secretmanager.v1.Secret].
.google.protobuf.Duration ttl = 7 [(.google.api.field_behavior) = INPUT_ONLY];getTtlOrBuilder in interface SecretOrBuilderpublic String getEtag()
Optional. Etag of the currently stored [Secret][google.cloud.secretmanager.v1.Secret].
string etag = 8 [(.google.api.field_behavior) = OPTIONAL];getEtag in interface SecretOrBuilderpublic ByteString getEtagBytes()
Optional. Etag of the currently stored [Secret][google.cloud.secretmanager.v1.Secret].
string etag = 8 [(.google.api.field_behavior) = OPTIONAL];getEtagBytes in interface SecretOrBuilderpublic boolean hasRotation()
Optional. Rotation policy attached to the [Secret][google.cloud.secretmanager.v1.Secret]. May be excluded if there is no rotation policy.
.google.cloud.secretmanager.v1.Rotation rotation = 9 [(.google.api.field_behavior) = OPTIONAL];
hasRotation in interface SecretOrBuilderpublic Rotation getRotation()
Optional. Rotation policy attached to the [Secret][google.cloud.secretmanager.v1.Secret]. May be excluded if there is no rotation policy.
.google.cloud.secretmanager.v1.Rotation rotation = 9 [(.google.api.field_behavior) = OPTIONAL];
getRotation in interface SecretOrBuilderpublic RotationOrBuilder getRotationOrBuilder()
Optional. Rotation policy attached to the [Secret][google.cloud.secretmanager.v1.Secret]. May be excluded if there is no rotation policy.
.google.cloud.secretmanager.v1.Rotation rotation = 9 [(.google.api.field_behavior) = OPTIONAL];
getRotationOrBuilder in interface SecretOrBuilderpublic int getVersionAliasesCount()
SecretOrBuilder
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];
getVersionAliasesCount in interface SecretOrBuilderpublic 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];
containsVersionAliases in interface SecretOrBuilder@Deprecated public Map<String,Long> getVersionAliases()
getVersionAliasesMap() instead.getVersionAliases in interface SecretOrBuilderpublic 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];
getVersionAliasesMap in interface SecretOrBuilderpublic 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];
getVersionAliasesOrDefault in interface SecretOrBuilderpublic 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];
getVersionAliasesOrThrow in interface SecretOrBuilderpublic final boolean isInitialized()
isInitialized in interface MessageLiteOrBuilderisInitialized in class GeneratedMessageV3public void writeTo(CodedOutputStream output) throws IOException
writeTo in interface MessageLitewriteTo in class GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface MessageLitegetSerializedSize in class GeneratedMessageV3public boolean equals(Object obj)
equals in interface Messageequals in class AbstractMessagepublic int hashCode()
hashCode in interface MessagehashCode in class AbstractMessagepublic static Secret parseFrom(ByteBuffer data) throws InvalidProtocolBufferException
InvalidProtocolBufferExceptionpublic static Secret parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferExceptionpublic static Secret parseFrom(ByteString data) throws InvalidProtocolBufferException
InvalidProtocolBufferExceptionpublic static Secret parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferExceptionpublic static Secret parseFrom(byte[] data) throws InvalidProtocolBufferException
InvalidProtocolBufferExceptionpublic static Secret parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferExceptionpublic static Secret parseFrom(InputStream input) throws IOException
IOExceptionpublic static Secret parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static Secret parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static Secret parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static Secret parseFrom(CodedInputStream input) throws IOException
IOExceptionpublic static Secret parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic Secret.Builder newBuilderForType()
newBuilderForType in interface MessagenewBuilderForType in interface MessageLitepublic static Secret.Builder newBuilder()
public static Secret.Builder newBuilder(Secret prototype)
public Secret.Builder toBuilder()
toBuilder in interface MessagetoBuilder in interface MessageLiteprotected Secret.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class GeneratedMessageV3public static Secret getDefaultInstance()
public Parser<Secret> getParserForType()
getParserForType in interface MessagegetParserForType in interface MessageLitegetParserForType in class GeneratedMessageV3public Secret getDefaultInstanceForType()
getDefaultInstanceForType in interface MessageLiteOrBuildergetDefaultInstanceForType in interface MessageOrBuilderCopyright © 2022 Google LLC. All rights reserved.