Secret Manager V1 Client - Class SecretVersion (1.15.2)

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
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`	`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.
`↳ scheduled_destroy_time`	`Google\Protobuf\Timestamp` Optional. Output only. Scheduled destroy time for secret version. This is a part of the Delayed secret version destroy feature. For a Secret with a valid version destroy TTL, when a secert version is destroyed, the version is moved to disabled state and it is scheduled for destruction. The version is destroyed only after the `scheduled_destroy_time`.
`↳ customer_managed_encryption`	`Google\Cloud\SecretManager\V1\CustomerManagedEncryptionStatus` Output only. The customer-managed encryption status of the SecretVersion. Only populated if customer-managed encryption is used and Secret is a Regionalised Secret.

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getCreateTime

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

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasCreateTime

clearCreateTime

setCreateTime

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

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.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasDestroyTime

clearDestroyTime

setDestroyTime

Output only. The time this SecretVersion was destroyed.

Only present if state is DESTROYED.

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getState

Output only. The current state of the SecretVersion.

Returns
Type	Description
`int`

setState

Output only. The current state of the SecretVersion.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getReplicationStatus

The replication status of the SecretVersion.

Returns
Type	Description
`Google\Cloud\SecretManager\V1\ReplicationStatus\|null`

hasReplicationStatus

clearReplicationStatus

setReplicationStatus

The replication status of the SecretVersion.

Parameter
Name	Description
`var`	`Google\Cloud\SecretManager\V1\ReplicationStatus`

Returns
Type	Description
`$this`

getEtag

Output only. Etag of the currently stored SecretVersion.

Returns
Type	Description
`string`

setEtag

Output only. Etag of the currently stored SecretVersion.

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.

Returns
Type	Description
`bool`

setClientSpecifiedPayloadChecksum

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

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getScheduledDestroyTime

Optional. Output only. Scheduled destroy time for secret version.

This is a part of the Delayed secret version destroy feature. For a Secret with a valid version destroy TTL, when a secert version is destroyed, the version is moved to disabled state and it is scheduled for destruction. The version is destroyed only after the scheduled_destroy_time.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasScheduledDestroyTime

clearScheduledDestroyTime

setScheduledDestroyTime

Optional. Output only. Scheduled destroy time for secret version.

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getCustomerManagedEncryption

Output only. The customer-managed encryption status of the SecretVersion. Only populated if customer-managed encryption is used and Secret is a Regionalised Secret.

Returns
Type	Description
`Google\Cloud\SecretManager\V1\CustomerManagedEncryptionStatus\|null`

hasCustomerManagedEncryption

clearCustomerManagedEncryption

setCustomerManagedEncryption

Output only. The customer-managed encryption status of the SecretVersion. Only populated if customer-managed encryption is used and Secret is a Regionalised Secret.

Parameter
Name	Description
`var`	`Google\Cloud\SecretManager\V1\CustomerManagedEncryptionStatus`

Returns
Type	Description
`$this`