retired_resources

Creates, updates, deletes, gets or lists a retired_resources resource.

Overview

Name	retired_resources
Type	Resource
Id	google.cloudkms.retired_resources

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string	Output only. Identifier. The resource name for this RetiredResource in the format projects/*/locations/*/retiredResources/*.
deleteTime	string (google-datetime)	Output only. The time at which the original resource was deleted and this RetiredResource record was created.
originalResource	string	Output only. The full resource name of the original CryptoKey that was deleted in the format projects/*/locations/*/keyRings/*/cryptoKeys/*.
resourceType	string	Output only. The resource type of the original deleted resource.

list

Name	Datatype	Description
name	string	Output only. Identifier. The resource name for this RetiredResource in the format projects/*/locations/*/retiredResources/*.
deleteTime	string (google-datetime)	Output only. The time at which the original resource was deleted and this RetiredResource record was created.
originalResource	string	Output only. The full resource name of the original CryptoKey that was deleted in the format projects/*/locations/*/keyRings/*/cryptoKeys/*.
resourceType	string	Output only. The resource type of the original deleted resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, retiredResourcesId		Retrieves a specific RetiredResource resource, which represents the record of a deleted CryptoKey.
list	select	projectsId, locationsId	pageSize, pageToken	Lists the RetiredResources which are the records of deleted CryptoKeys. RetiredResources prevent the reuse of these resource names after deletion.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
locationsId	string
projectsId	string
retiredResourcesId	string
pageSize	integer (int32)
pageToken	string

SELECT examples

get

Retrieves a specific RetiredResource resource, which represents the record of a deleted CryptoKey.

SELECT
name,
deleteTime,
originalResource,
resourceType
FROM google.cloudkms.retired_resources
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND retiredResourcesId = '{{ retiredResourcesId }}' -- required
;

list

Lists the RetiredResources which are the records of deleted CryptoKeys. RetiredResources prevent the reuse of these resource names after deletion.

SELECT
name,
deleteTime,
originalResource,
resourceType
FROM google.cloudkms.retired_resources
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
;