com.google.cloud.secretmanager.v1

Interface SecretOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

Secret, Secret.Builder

public interface SecretOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	containsLabels(String key) The labels assigned to this Secret.
com.google.protobuf.Timestamp	getCreateTime() Output only.
com.google.protobuf.TimestampOrBuilder	getCreateTimeOrBuilder() Output only.
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() Required.
ReplicationOrBuilder	getReplicationOrBuilder() Required.
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.
boolean	hasCreateTime() Output only.
boolean	hasExpireTime() Optional.
boolean	hasReplication() Required.
boolean	hasRotation() Optional.
boolean	hasTtl() Input only.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getName

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];

Returns:

The name.

getNameBytes

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];

Returns:

The bytes for name.

hasReplication

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];

Returns:

Whether the replication field is set.

getReplication

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];

Returns:

The replication.

getReplicationOrBuilder

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];

hasCreateTime

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];

Returns:

Whether the createTime field is set.

getCreateTime

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];

Returns:

The createTime.

getCreateTimeOrBuilder

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];

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.v1.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.v1.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.v1.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.v1.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.v1.Topic topics = 5 [(.google.api.field_behavior) = OPTIONAL];

hasExpireTime

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];

Returns:

Whether the expireTime field is set.

getExpireTime

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];

Returns:

The expireTime.

getExpireTimeOrBuilder

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];

hasTtl

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];

Returns:

Whether the ttl field is set.

getTtl

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];

Returns:

The ttl.

getTtlOrBuilder

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];

getEtag

String getEtag()

 Optional. Etag of the currently stored [Secret][google.cloud.secretmanager.v1.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.v1.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.v1.Secret]. May be excluded if there is no
 rotation policy.
 

.google.cloud.secretmanager.v1.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.v1.Secret]. May be excluded if there is no
 rotation policy.
 

.google.cloud.secretmanager.v1.Rotation rotation = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The rotation.

getRotationOrBuilder

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];

getExpirationCase

Secret.ExpirationCase getExpirationCase()