Secret Manager V1 API - Class Google::Cloud::SecretManager::V1::Secret (v0.17.0)

Reference documentation and code samples for the Secret Manager V1 API class Google::Cloud::SecretManager::V1::Secret.

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.

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#annotations

def annotations() -> ::Google::Protobuf::Map{::String => ::String}

Returns

(::Google::Protobuf::Map{::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.

#annotations=

def annotations=(value) -> ::Google::Protobuf::Map{::String => ::String}

Parameter

value (::Google::Protobuf::Map{::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.

Returns

(::Google::Protobuf::Map{::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.

#create_time

def create_time() -> ::Google::Protobuf::Timestamp

Returns

(::Google::Protobuf::Timestamp) — Output only. The time at which the Secret was created.

#etag

def etag() -> ::String

Returns

(::String) — Optional. Etag of the currently stored Secret.

#etag=

def etag=(value) -> ::String

Parameter

value (::String) — Optional. Etag of the currently stored Secret.

Returns

(::String) — Optional. Etag of the currently stored Secret.

#expire_time

def expire_time() -> ::Google::Protobuf::Timestamp

Returns

(::Google::Protobuf::Timestamp) — Optional. Timestamp in UTC when the Secret is scheduled to expire. This is always provided on output, regardless of what was sent on input.

#expire_time=

def expire_time=(value) -> ::Google::Protobuf::Timestamp

Parameter

value (::Google::Protobuf::Timestamp) — Optional. Timestamp in UTC when the Secret is scheduled to expire. This is always provided on output, regardless of what was sent on input.

Returns

(::Google::Protobuf::Timestamp) — Optional. Timestamp in UTC when the Secret is scheduled to expire. This is always provided on output, regardless of what was sent on input.

#labels

def labels() -> ::Google::Protobuf::Map{::String => ::String}

Returns

(::Google::Protobuf::Map{::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.

#labels=

def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}

Parameter

value (::Google::Protobuf::Map{::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.

Returns

(::Google::Protobuf::Map{::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.

#name

def name() -> ::String

Returns

(::String) — Output only. The resource name of the Secret in the format projects/*/secrets/*.

#replication

def replication() -> ::Google::Cloud::SecretManager::V1::Replication

Returns

(::Google::Cloud::SecretManager::V1::Replication) — Required. Immutable. The replication policy of the secret data attached to the Secret.

The replication policy cannot be changed after the Secret has been created.

#replication=

def replication=(value) -> ::Google::Cloud::SecretManager::V1::Replication

Parameter

value (::Google::Cloud::SecretManager::V1::Replication) — Required. Immutable. The replication policy of the secret data attached to the Secret.

The replication policy cannot be changed after the Secret has been created.

Returns

(::Google::Cloud::SecretManager::V1::Replication) — Required. Immutable. The replication policy of the secret data attached to the Secret.

The replication policy cannot be changed after the Secret has been created.

#rotation

def rotation() -> ::Google::Cloud::SecretManager::V1::Rotation

Returns

(::Google::Cloud::SecretManager::V1::Rotation) — Optional. Rotation policy attached to the Secret. May be excluded if there is no rotation policy.

#rotation=

def rotation=(value) -> ::Google::Cloud::SecretManager::V1::Rotation

Parameter

value (::Google::Cloud::SecretManager::V1::Rotation) — Optional. Rotation policy attached to the Secret. May be excluded if there is no rotation policy.

Returns

(::Google::Cloud::SecretManager::V1::Rotation) — Optional. Rotation policy attached to the Secret. May be excluded if there is no rotation policy.

#topics

def topics() -> ::Array<::Google::Cloud::SecretManager::V1::Topic>

Returns

(::Array<::Google::Cloud::SecretManager::V1::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.

#topics=

def topics=(value) -> ::Array<::Google::Cloud::SecretManager::V1::Topic>

Parameter

value (::Array<::Google::Cloud::SecretManager::V1::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.

Returns

(::Array<::Google::Cloud::SecretManager::V1::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.

#ttl

def ttl() -> ::Google::Protobuf::Duration

Returns

(::Google::Protobuf::Duration) — Input only. The TTL for the Secret.

#ttl=

def ttl=(value) -> ::Google::Protobuf::Duration

Parameter

value (::Google::Protobuf::Duration) — Input only. The TTL for the Secret.

Returns

(::Google::Protobuf::Duration) — Input only. The TTL for the Secret.

#version_aliases

def version_aliases() -> ::Google::Protobuf::Map{::String => ::Integer}

Returns

(::Google::Protobuf::Map{::String => ::Integer}) — 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.

#version_aliases=

def version_aliases=(value) -> ::Google::Protobuf::Map{::String => ::Integer}

Parameter

value (::Google::Protobuf::Map{::String => ::Integer}) — 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.

Returns

(::Google::Protobuf::Map{::String => ::Integer}) — 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.