Secret Manager V1beta1 Client - Class Secret (1.13.0)

Reference documentation and code samples for the Secret Manager V1beta1 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.secrets.v1beta1.Secret

Namespace

Google \ Cloud \ SecretManager \ V1beta1

Methods

__construct

Constructor.

Parameters
NameDescription
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\V1beta1\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: [\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.

getName

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

Returns
TypeDescription
string

setName

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

Parameter
NameDescription
var string
Returns
TypeDescription
$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
TypeDescription
Google\Cloud\SecretManager\V1beta1\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
NameDescription
var Google\Cloud\SecretManager\V1beta1\Replication
Returns
TypeDescription
$this

getCreateTime

Output only. The time at which the Secret was created.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. The time at which the Secret was created.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var array|Google\Protobuf\Internal\MapField
Returns
TypeDescription
$this