Reference documentation and code samples for the Secret Manager V1beta2 Client class 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.
Generated from protobuf message google.cloud.secretmanager.v1beta2.Secret
Namespace
Google \ Cloud \ SecretManager \ V1beta2Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
↳ replication
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
↳ labels
array| Google\Protobuf\Internal\MapField
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
array< 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.
↳ expire_time
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.
↳ ttl
↳ etag
↳ rotation
↳ version_aliases
array| Google\Protobuf\Internal\MapField
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
array| Google\Protobuf\Internal\MapField
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
Google\Protobuf\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
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 encryption configuration only apply to SecretVersions added afterwards. They do not apply retroactively to existing SecretVersions .
getName
Output only. The resource name of the Secret
in the format projects/*/secrets/*
.
string
setName
Output only. The resource name of the Secret
in the format projects/*/secrets/*
.
var
string
$this
getReplication
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.
hasReplication
clearReplication
setReplication
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.
$this
getCreateTime
Output only. The time at which the Secret was created.
hasCreateTime
clearCreateTime
setCreateTime
Output only. The time at which the Secret was created.
$this
getLabels
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.
setLabels
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.
$this
getTopics
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.
setTopics
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.
$this
getExpireTime
Optional. Timestamp in UTC when the Secret is scheduled to expire. This is always provided on output, regardless of what was sent on input.
hasExpireTime
setExpireTime
Optional. Timestamp in UTC when the Secret is scheduled to expire. This is always provided on output, regardless of what was sent on input.
$this
getTtl
Input only. The TTL for the Secret .
hasTtl
setTtl
Input only. The TTL for the Secret .
$this
getEtag
Optional. Etag of the currently stored Secret .
string
setEtag
Optional. Etag of the currently stored Secret .
var
string
$this
getRotation
Optional. Rotation policy attached to the Secret . May be excluded if there is no rotation policy.
hasRotation
clearRotation
setRotation
Optional. Rotation policy attached to the Secret . May be excluded if there is no rotation policy.
$this
getVersionAliases
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.
setVersionAliases
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.
$this
getAnnotations
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.
setAnnotations
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.
$this
getVersionDestroyTtl
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.
hasVersionDestroyTtl
clearVersionDestroyTtl
setVersionDestroyTtl
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.
$this
getCustomerManagedEncryption
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 encryption configuration only apply to SecretVersions added afterwards. They do not apply retroactively to existing SecretVersions .
hasCustomerManagedEncryption
clearCustomerManagedEncryption
setCustomerManagedEncryption
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 encryption configuration only apply to SecretVersions added afterwards. They do not apply retroactively to existing SecretVersions .
$this
getExpiration
string
