Cloud KMS V1 Client - Class RetiredResource (2.8.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.

Parameter
Name	Description
`data`	`mixed`

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