Cloud KMS V1 Client - Class RetiredResource (2.7.0)

Reference documentation and code samples for the Cloud KMS V1 Client class RetiredResource.

A RetiredResource resource represents the record of a deleted CryptoKey. Its purpose is to provide visibility into retained user data and to prevent reuse of these names for new CryptoKeys.

Generated from protobuf message google.cloud.kms.v1.RetiredResource

Namespace

Google \ Cloud \ Kms \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ name string

Output only. Identifier. The resource name for this RetiredResource in the format projects/*/locations/*/retiredResources/*.
↳ original_resource string

Output only. The full resource name of the original CryptoKey that was deleted in the format projects/*/locations/*/keyRings/*/cryptoKeys/*.
↳ resource_type string

Output only. The resource type of the original deleted resource.
↳ delete_time Google\Protobuf\Timestamp

Output only. The time at which the original resource was deleted and this RetiredResource record was created.

getName

Output only. Identifier. The resource name for this RetiredResource in the format projects/*/locations/*/retiredResources/*.

Returns
Type Description
string

setName

Output only. Identifier. The resource name for this RetiredResource in the format projects/*/locations/*/retiredResources/*.

Parameter
Name Description
var string
Returns
Type Description
$this

getOriginalResource

Output only. The full resource name of the original CryptoKey that was deleted in the format projects/*/locations/*/keyRings/*/cryptoKeys/*.

Returns
Type Description
string

setOriginalResource

Output only. The full resource name of the original CryptoKey that was deleted in the format projects/*/locations/*/keyRings/*/cryptoKeys/*.

Parameter
Name Description
var string
Returns
Type Description
$this

getResourceType

Output only. The resource type of the original deleted resource.

Returns
Type Description
string

setResourceType

Output only. The resource type of the original deleted resource.

Parameter
Name Description
var string
Returns
Type Description
$this

getDeleteTime

Output only. The time at which the original resource was deleted and this RetiredResource record was created.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasDeleteTime

clearDeleteTime

setDeleteTime

Output only. The time at which the original resource was deleted and this RetiredResource record was created.

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