Reference documentation and code samples for the Secret Manager V1 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.v1.Secret
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Output only. The resource name of the Secret in the format |
↳ replication |
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. |
↳ create_time |
Google\Protobuf\Timestamp
Output only. The time at which the Secret was created. |
↳ 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: |
↳ topics |
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. |
↳ 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 |
Google\Protobuf\Duration
Input only. The TTL for the Secret. |
↳ etag |
string
Optional. Etag of the currently stored Secret. |
↳ rotation |
Google\Cloud\SecretManager\V1\Rotation
Optional. Rotation policy attached to the Secret. May be excluded if there is no rotation policy. |
↳ 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 ( |
↳ 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. |
getName
Output only. The resource name of the
Secret in the format
projects/*/secrets/*.
| Returns | |
|---|---|
| Type | Description |
string | |
setName
Output only. The resource name of the
Secret in the format
projects/*/secrets/*.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getReplication
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 | |
|---|---|
| Type | Description |
Google\Cloud\SecretManager\V1\Replication|null | |
hasReplication
clearReplication
setReplication
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.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\SecretManager\V1\Replication
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCreateTime
Output only. The time at which the Secret was created.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasCreateTime
clearCreateTime
setCreateTime
Output only. The time at which the Secret was created.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField | |
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.
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
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.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\SecretManager\V1\Topic>
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
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.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getTtl
Input only. The TTL for the Secret.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Duration|null | |
hasTtl
setTtl
Input only. The TTL for the Secret.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Duration
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getEtag
Optional. Etag of the currently stored Secret.
| Returns | |
|---|---|
| Type | Description |
string | |
setEtag
Optional. Etag of the currently stored Secret.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getRotation
Optional. Rotation policy attached to the Secret. May be excluded if there is no rotation policy.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\SecretManager\V1\Rotation|null | |
hasRotation
clearRotation
setRotation
Optional. Rotation policy attached to the Secret. May be excluded if there is no rotation policy.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\SecretManager\V1\Rotation
|
| Returns | |
|---|---|
| Type | Description |
$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. At launch access by alias will only be supported on
GetSecretVersion and AccessSecretVersion.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField | |
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. At launch access by alias will only be supported on
GetSecretVersion and AccessSecretVersion.
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField | |
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.
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getExpiration
| Returns | |
|---|---|
| Type | Description |
string | |