Secret Manager V1 Client - Class SecretVersion (1.13.0)

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

Namespace

Google \ Cloud \ SecretManager \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
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 Google\Cloud\SecretManager\V1\ReplicationStatus

The replication status of the SecretVersion.

↳ 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.

Returns
TypeDescription
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.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getCreateTime

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

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

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

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getDestroyTime

Output only. The time this SecretVersion was destroyed.

Only present if state is DESTROYED.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasDestroyTime

clearDestroyTime

setDestroyTime

Output only. The time this SecretVersion was destroyed.

Only present if state is DESTROYED.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getState

Output only. The current state of the SecretVersion.

Returns
TypeDescription
int

setState

Output only. The current state of the SecretVersion.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getReplicationStatus

The replication status of the SecretVersion.

Returns
TypeDescription
Google\Cloud\SecretManager\V1\ReplicationStatus|null

hasReplicationStatus

clearReplicationStatus

setReplicationStatus

The replication status of the SecretVersion.

Parameter
NameDescription
var Google\Cloud\SecretManager\V1\ReplicationStatus
Returns
TypeDescription
$this

getEtag

Output only. Etag of the currently stored SecretVersion.

Returns
TypeDescription
string

setEtag

Output only. Etag of the currently stored SecretVersion.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getClientSpecifiedPayloadChecksum

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

Returns
TypeDescription
bool

setClientSpecifiedPayloadChecksum

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

Parameter
NameDescription
var bool
Returns
TypeDescription
$this