Struct Secret

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

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.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: String

Output only. The resource name of the Secret in the format projects/*/secrets/*.

replication: Option<Replication>

Optional. Immutable. The replication policy of the secret data attached to the 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 was created.

labels: HashMap<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.

rotation: Option<Rotation>

Optional. Rotation policy attached to the Secret. May be excluded if there is no rotation policy.

version_aliases: HashMap<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 be supported on GetSecretVersion and AccessSecretVersion.

annotations: HashMap<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 regionalized secrets. If no configuration is provided, Google-managed default encryption is used.

Updates to the Secret encryption configuration only apply to SecretVersions added afterwards. They do not apply retroactively to existing SecretVersions.

expiration: Option<Expiration>

Expiration policy attached to the Secret. If specified the Secret and all SecretVersions 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.

Implementations

impl Secret

pub fn set_name<T: Into<String>>(self, v: T) -> Self

Sets the value of name.

pub fn set_replication<T: Into<Option<Replication>>>(self, v: T) -> Self

Sets the value of replication.

pub fn set_create_time<T: Into<Option<Timestamp>>>(self, v: T) -> Self

Sets the value of create_time.

pub fn set_etag<T: Into<String>>(self, v: T) -> Self

Sets the value of etag.

pub fn set_rotation<T: Into<Option<Rotation>>>(self, v: T) -> Self

Sets the value of rotation.

pub fn set_version_destroy_ttl<T: Into<Option<Duration>>>(self, v: T) -> Self

Sets the value of version_destroy_ttl.

pub fn set_customer_managed_encryption<T: Into<Option<CustomerManagedEncryption>>>( self, v: T, ) -> Self

Sets the value of customer_managed_encryption.

pub fn set_topics<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<Topic>,

Sets the value of topics.

pub fn set_labels<T, K, V>(self, v: T) -> Self

where T: IntoIterator<Item = (K, V)>, K: Into<String>, V: Into<String>,

Sets the value of labels.

pub fn set_version_aliases<T, K, V>(self, v: T) -> Self

where T: IntoIterator<Item = (K, V)>, K: Into<String>, V: Into<i64>,

Sets the value of version_aliases.

pub fn set_annotations<T, K, V>(self, v: T) -> Self

where T: IntoIterator<Item = (K, V)>, K: Into<String>, V: Into<String>,

Sets the value of annotations.

pub fn set_expiration<T: Into<Option<Expiration>>>(self, v: T) -> Self

Sets the value of expiration.

pub fn get_expire_time(&self) -> Option<&Box<Timestamp>>

The value of expiration if it holds a ExpireTime, None if the field is not set or holds a different branch.

pub fn get_ttl(&self) -> Option<&Box<Duration>>

The value of expiration if it holds a Ttl, None if the field is not set or holds a different branch.

pub fn set_expire_time<T: Into<Box<Timestamp>>>(self, v: T) -> Self

Sets the value of expiration to hold a ExpireTime.

Note that all the setters affecting expiration are mutually exclusive.

pub fn set_ttl<T: Into<Box<Duration>>>(self, v: T) -> Self

Sets the value of expiration to hold a Ttl.

Note that all the setters affecting expiration are mutually exclusive.

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() -> Secret

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Secret

where Secret: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for Secret

fn typename() -> &'static str

The typename of this message.

impl PartialEq for Secret

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for Secret

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Secret