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.
data
array
Optional. Data for populating the Message object.
↳ name
string
Output only. The resource name of the Secret
in the format projects/*/secrets/*
.
↳ 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
↳ 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< 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
↳ etag
↳ 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 ( -
) 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.
getName
Output only. The resource name of the Secret
in the format projects/*/secrets/*
.
Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
string
setName
Output only. The resource name of the Secret
in the format projects/*/secrets/*
.
Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
var
string
$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.
Generated from protobuf field .google.cloud.secretmanager.v1.Replication replication = 2 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED];
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.
Generated from protobuf field .google.cloud.secretmanager.v1.Replication replication = 2 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED];
$this
getCreateTime
Output only. The time at which the Secret was created.
Generated from protobuf field .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
Google\Protobuf\Timestamp|null
hasCreateTime
clearCreateTime
setCreateTime
Output only. The time at which the Secret was created.
Generated from protobuf field .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
var
Google\Protobuf\Timestamp
$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.
Generated from protobuf field map<string, string> labels = 4;
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.
Generated from protobuf field map<string, string> labels = 4;
var
array|Google\Protobuf\Internal\MapField
$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.
Generated from protobuf field repeated .google.cloud.secretmanager.v1.Topic topics = 5 [(.google.api.field_behavior) = OPTIONAL];
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.
Generated from protobuf field repeated .google.cloud.secretmanager.v1.Topic topics = 5 [(.google.api.field_behavior) = OPTIONAL];
$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.
Generated from protobuf field .google.protobuf.Timestamp expire_time = 6 [(.google.api.field_behavior) = OPTIONAL];
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.
Generated from protobuf field .google.protobuf.Timestamp expire_time = 6 [(.google.api.field_behavior) = OPTIONAL];
var
Google\Protobuf\Timestamp
$this
getTtl
Input only. The TTL for the Secret .
Generated from protobuf field .google.protobuf.Duration ttl = 7 [(.google.api.field_behavior) = INPUT_ONLY];
Google\Protobuf\Duration|null
hasTtl
setTtl
Input only. The TTL for the Secret .
Generated from protobuf field .google.protobuf.Duration ttl = 7 [(.google.api.field_behavior) = INPUT_ONLY];
var
Google\Protobuf\Duration
$this
getEtag
Optional. Etag of the currently stored Secret .
Generated from protobuf field string etag = 8 [(.google.api.field_behavior) = OPTIONAL];
string
setEtag
Optional. Etag of the currently stored Secret .
Generated from protobuf field string etag = 8 [(.google.api.field_behavior) = OPTIONAL];
var
string
$this
getRotation
Optional. Rotation policy attached to the Secret . May be excluded if there is no rotation policy.
Generated from protobuf field .google.cloud.secretmanager.v1.Rotation rotation = 9 [(.google.api.field_behavior) = OPTIONAL];
hasRotation
clearRotation
setRotation
Optional. Rotation policy attached to the Secret . May be excluded if there is no rotation policy.
Generated from protobuf field .google.cloud.secretmanager.v1.Rotation rotation = 9 [(.google.api.field_behavior) = OPTIONAL];
$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.
Generated from protobuf field map<string, int64> version_aliases = 11 [(.google.api.field_behavior) = OPTIONAL];
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.
Generated from protobuf field map<string, int64> version_aliases = 11 [(.google.api.field_behavior) = OPTIONAL];
var
array|Google\Protobuf\Internal\MapField
$this
getExpiration
string
