1. class
  2. Google
  3. \
  4. Service
  5. \
  6. CloudKMS
  7. \
  8. Resource
  9. \
  10. ProjectsLocationsKeyHandles

ProjectsLocationsKeyHandles

class ProjectsLocationsKeyHandles extends Resource (View source)

The "keyHandles" collection of methods.

Typical usage is:

 $cloudkmsService = new Google\Service\CloudKMS(...);
 $keyHandles = $cloudkmsService->projects_locations_keyHandles;

Methods

Operation
create(string $parent, KeyHandle $postBody, array $optParams = [])

Creates a new KeyHandle, triggering the provisioning of a new CryptoKey for CMEK use with the given resource type in the configured key project and the same location. GetOperation should be used to resolve the resulting long- running operation and get the resulting KeyHandle and CryptoKey.

KeyHandle
get(string $name, array $optParams = [])

Returns the KeyHandle. (keyHandles.get)

ListKeyHandlesResponse
listProjectsLocationsKeyHandles(string $parent, array $optParams = [])

Lists KeyHandles. (keyHandles.listProjectsLocationsKeyHandles)

Details

at line 52
Operation create(string $parent, KeyHandle $postBody, array $optParams = [])

Creates a new KeyHandle, triggering the provisioning of a new CryptoKey for CMEK use with the given resource type in the configured key project and the same location. GetOperation should be used to resolve the resulting long- running operation and get the resulting KeyHandle and CryptoKey.

(keyHandles.create)

Parameters

string $parent

Required. Name of the resource project and location to create the KeyHandle in, e.g. projects/{PROJECT_ID}/locations/{LOCATION}.
KeyHandle $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 67
KeyHandle get(string $name, array $optParams = [])

Returns the KeyHandle. (keyHandles.get)

Parameters

string $name

Required. Name of the KeyHandle resource, e.g. projects/{PROJECT_ID}/locations/{LOCATION}/keyHandles/{KEY_HANDLE_ID}.
array $optParams

Optional parameters.

Return Value

KeyHandle

Exceptions

Exception

at line 86
ListKeyHandlesResponse listProjectsLocationsKeyHandles(string $parent, array $optParams = [])

Lists KeyHandles. (keyHandles.listProjectsLocationsKeyHandles)

Parameters

string $parent

Required. Name of the resource project and location from which to list KeyHandles, e.g. projects/{PROJECT_ID}/locations/{LOCATION}.
array $optParams

Optional parameters.

Return Value

ListKeyHandlesResponse

Exceptions

Exception