public final class Secret extends com.google.protobuf.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 |
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter| 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 |
| Modifier and Type | Method and Description |
|---|---|
boolean |
containsLabels(String key)
The labels assigned to this Secret.
|
boolean |
equals(Object obj) |
com.google.protobuf.Timestamp |
getCreateTime()
Output only.
|
com.google.protobuf.TimestampOrBuilder |
getCreateTimeOrBuilder()
Output only.
|
static Secret |
getDefaultInstance() |
Secret |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
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.
|
com.google.protobuf.Parser<Secret> |
getParserForType() |
Replication |
getReplication()
Required.
|
ReplicationOrBuilder |
getReplicationOrBuilder()
Required.
|
Rotation |
getRotation()
Optional.
|
RotationOrBuilder |
getRotationOrBuilder()
Optional.
|
int |
getSerializedSize() |
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.
|
com.google.protobuf.UnknownFieldSet |
getUnknownFields() |
boolean |
hasCreateTime()
Output only.
|
boolean |
hasExpireTime()
Optional.
|
int |
hashCode() |
boolean |
hasReplication()
Required.
|
boolean |
hasRotation()
Optional.
|
boolean |
hasTtl()
Input only.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
protected com.google.protobuf.MapField |
internalGetMapField(int number) |
boolean |
isInitialized() |
static Secret.Builder |
newBuilder() |
static Secret.Builder |
newBuilder(Secret prototype) |
Secret.Builder |
newBuilderForType() |
protected Secret.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
protected Object |
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) |
static Secret |
parseDelimitedFrom(InputStream input) |
static Secret |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Secret |
parseFrom(byte[] data) |
static Secret |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Secret |
parseFrom(ByteBuffer data) |
static Secret |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Secret |
parseFrom(com.google.protobuf.ByteString data) |
static Secret |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Secret |
parseFrom(com.google.protobuf.CodedInputStream input) |
static Secret |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Secret |
parseFrom(InputStream input) |
static Secret |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<Secret> |
parser() |
Secret.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
canUseUnsafe, 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, waitpublic 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
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance in class com.google.protobuf.GeneratedMessageV3public final com.google.protobuf.UnknownFieldSet getUnknownFields()
getUnknownFields in interface com.google.protobuf.MessageOrBuildergetUnknownFields in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.MapField internalGetMapField(int number)
internalGetMapField in class com.google.protobuf.GeneratedMessageV3protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.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 com.google.protobuf.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 com.google.protobuf.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 com.google.protobuf.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 com.google.protobuf.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 com.google.protobuf.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 com.google.protobuf.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 com.google.protobuf.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 com.google.protobuf.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 final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static Secret parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Secret parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Secret parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Secret parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Secret parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Secret parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Secret parseFrom(InputStream input) throws IOException
IOExceptionpublic static Secret parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static Secret parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static Secret parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static Secret parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static Secret parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic Secret.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static Secret.Builder newBuilder()
public static Secret.Builder newBuilder(Secret prototype)
public Secret.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected Secret.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static Secret getDefaultInstance()
public static com.google.protobuf.Parser<Secret> parser()
public com.google.protobuf.Parser<Secret> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public Secret getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2022 Google LLC. All rights reserved.