Secret Manager V1 Client - Class SecretVersion (1.9.7)

Reference documentation and code samples for the Secret Manager V1 Client class SecretVersion.

A secret version resource in the Secret Manager API.

Generated from protobuf message google.cloud.secretmanager.v1.SecretVersion

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ name
string

Output only. The resource name of the SecretVersion in the format projects/*/secrets/*/versions/* . SecretVersion IDs in a Secret start at 1 and are incremented for each subsequent version of the secret.

↳ create_time
Google\Protobuf\Timestamp

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

↳ destroy_time
Google\Protobuf\Timestamp

Output only. The time this SecretVersion was destroyed. Only present if state is DESTROYED .

↳ state
int

Output only. The current state of the SecretVersion .

↳ replication_status
↳ etag
string

Output only. Etag of the currently stored SecretVersion .

↳ client_specified_payload_checksum
bool

Output only. True if payload checksum specified in SecretPayload object has been received by SecretManagerService on SecretManagerService.AddSecretVersion .

getName

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

SecretVersion IDs in a Secret start at 1 and are incremented for each subsequent version of the secret.

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 SecretVersion in the format projects/*/secrets/*/versions/* .

SecretVersion IDs in a Secret start at 1 and are incremented for each subsequent version of the secret.

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

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getCreateTime

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

Generated from protobuf field .google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type
Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

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

Generated from protobuf field .google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name
Description
var
Google\Protobuf\Timestamp
Returns
Type
Description
$this

getDestroyTime

Output only. The time this SecretVersion was destroyed.

Only present if state is DESTROYED .

Generated from protobuf field .google.protobuf.Timestamp destroy_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type
Description
Google\Protobuf\Timestamp|null

hasDestroyTime

clearDestroyTime

setDestroyTime

Output only. The time this SecretVersion was destroyed.

Only present if state is DESTROYED .

Generated from protobuf field .google.protobuf.Timestamp destroy_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name
Description
var
Google\Protobuf\Timestamp
Returns
Type
Description
$this

getState

Output only. The current state of the SecretVersion .

Generated from protobuf field .google.cloud.secretmanager.v1.SecretVersion.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type
Description
int

setState

Output only. The current state of the SecretVersion .

Generated from protobuf field .google.cloud.secretmanager.v1.SecretVersion.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name
Description
var
int
Returns
Type
Description
$this

getReplicationStatus

The replication status of the SecretVersion .

Generated from protobuf field .google.cloud.secretmanager.v1.ReplicationStatus replication_status = 5;

Returns
Type
Description

hasReplicationStatus

clearReplicationStatus

setReplicationStatus

The replication status of the SecretVersion .

Generated from protobuf field .google.cloud.secretmanager.v1.ReplicationStatus replication_status = 5;

Parameter
Name
Description
Returns
Type
Description
$this

getEtag

Output only. Etag of the currently stored SecretVersion .

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

Returns
Type
Description
string

setEtag

Output only. Etag of the currently stored SecretVersion .

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

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getClientSpecifiedPayloadChecksum

Output only. True if payload checksum specified in SecretPayload object has been received by SecretManagerService on SecretManagerService.AddSecretVersion .

Generated from protobuf field bool client_specified_payload_checksum = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type
Description
bool

setClientSpecifiedPayloadChecksum

Output only. True if payload checksum specified in SecretPayload object has been received by SecretManagerService on SecretManagerService.AddSecretVersion .

Generated from protobuf field bool client_specified_payload_checksum = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name
Description
var
bool
Returns
Type
Description
$this
Create a Mobile Website
View Site in Mobile | Classic
Share by: