Cloud Key Management Service (KMS) API . projects . locations . retiredResources

close()

Close httplib2 connections.

get(name, x__xgafv=None)

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

Args:
  name: string, Required. The name of the RetiredResource to get. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # 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.
  "deleteTime": "A String", # Output only. The time at which the original resource was deleted and this RetiredResource record was created.
  "name": "A String", # Output only. Identifier. The resource name for this RetiredResource in the format `projects/*/locations/*/retiredResources/*`.
  "originalResource": "A String", # Output only. The full resource name of the original CryptoKey that was deleted in the format `projects/*/locations/*/keyRings/*/cryptoKeys/*`.
  "resourceType": "A String", # Output only. The resource type of the original deleted resource.
}

list(parent, pageSize=None, pageToken=None, x__xgafv=None)

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

Args:
  parent: string, Required. The project-specific location holding the RetiredResources, in the format `projects/*/locations/*`. (required)
  pageSize: integer, Optional. Optional limit on the number of RetiredResources to be included in the response. Further RetiredResources can subsequently be obtained by including the ListRetiredResourcesResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default.
  pageToken: string, Optional. Optional pagination token, returned earlier via ListRetiredResourcesResponse.next_page_token.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for KeyManagementService.ListRetiredResources.
  "nextPageToken": "A String", # A token to retrieve the next page of results. Pass this value in ListRetiredResourcesRequest.page_token to retrieve the next page of results.
  "retiredResources": [ # The list of RetiredResources.
    { # 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.
      "deleteTime": "A String", # Output only. The time at which the original resource was deleted and this RetiredResource record was created.
      "name": "A String", # Output only. Identifier. The resource name for this RetiredResource in the format `projects/*/locations/*/retiredResources/*`.
      "originalResource": "A String", # Output only. The full resource name of the original CryptoKey that was deleted in the format `projects/*/locations/*/keyRings/*/cryptoKeys/*`.
      "resourceType": "A String", # Output only. The resource type of the original deleted resource.
    },
  ],
  "totalSize": "A String", # The total number of RetiredResources that matched the query.
}

list_next()

Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.