Secret Manager V1beta1 Client - Class Secret (1.9.7)

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

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 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/* .

Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type
Description
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];

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.

Generated from protobuf field .google.cloud.secrets.v1beta1.Replication replication = 2 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED];

Returns
Type
Description

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.secrets.v1beta1.Replication replication = 2 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED];

Parameter
Name
Description
Returns
Type
Description
$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];

Returns
Type
Description
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];

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.

Generated from protobuf field map<string, string> labels = 4;

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.

Generated from protobuf field map<string, string> labels = 4;

Parameter
Name
Description
var
array|Google\Protobuf\Internal\MapField
Returns
Type
Description
$this
Design a Mobile Site
View Site in Mobile | Classic
Share by: