Struct google_api_proto::google::cloud::secretmanager::v1beta2::Secret

pub struct Secret {
    pub name: String,
    pub replication: Option<Replication>,
    pub create_time: Option<Timestamp>,
    pub labels: BTreeMap<String, String>,
    pub topics: Vec<Topic>,
    pub etag: String,
    pub rotation: Option<Rotation>,
    pub version_aliases: BTreeMap<String, i64>,
    pub annotations: BTreeMap<String, String>,
    pub version_destroy_ttl: Option<Duration>,
    pub customer_managed_encryption: Option<CustomerManagedEncryption>,
    pub expiration: Option<Expiration>,
}

A [Secret][google.cloud.secretmanager.v1beta2.Secret] is a logical secret whose value and versions can be accessed.

A [Secret][google.cloud.secretmanager.v1beta2.Secret] is made up of zero or more [SecretVersions][google.cloud.secretmanager.v1beta2.SecretVersion] that represent the secret data.

Fields

name: String

Output only. The resource name of the [Secret][google.cloud.secretmanager.v1beta2.Secret] in the format projects/*/secrets/*.

replication: Option<Replication>

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.

create_time: Option<Timestamp>

Output only. The time at which the [Secret][google.cloud.secretmanager.v1beta2.Secret] was created.

labels: BTreeMap<String, String>

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.

topics: Vec<Topic>

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.

etag: String

Optional. Etag of the currently stored [Secret][google.cloud.secretmanager.v1beta2.Secret].

rotation: Option<Rotation>

Optional. Rotation policy attached to the [Secret][google.cloud.secretmanager.v1beta2.Secret]. May be excluded if there is no rotation policy.

version_aliases: BTreeMap<String, i64>

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.

annotations: BTreeMap<String, String>

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.

version_destroy_ttl: Option<Duration>

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.

customer_managed_encryption: Option<CustomerManagedEncryption>

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

expiration: Option<Expiration>

Expiration policy attached to the [Secret][google.cloud.secretmanager.v1beta2.Secret]. If specified the [Secret][google.cloud.secretmanager.v1beta2.Secret] and all [SecretVersions][google.cloud.secretmanager.v1beta2.SecretVersion] will be automatically deleted at expiration. Expired secrets are irreversibly deleted.

Expiration is not the recommended way to set time-based permissions. IAM Conditions is recommended for granting time-based permissions because the operation can be reversed.

Trait Implementations

impl Clone for Secret

fn clone(&self) -> Secret

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Secret

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Secret

fn default() -> Self

Returns the “default value” for a type.

impl Message for Secret

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for Secret

fn eq(&self, other: &Secret) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Secret