Cloud KMS V1 Client - Class CreateKeyHandleRequest (2.3.0)

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

Request message for Autokey.CreateKeyHandle.

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

Namespace

Google \ Cloud \ Kms \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
dataarray

Optional. Data for populating the Message object.

↳ parentstring

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

↳ key_handle_idstring

Optional. Id of the KeyHandle. Must be unique to the resource project and location. If not provided by the caller, a new UUID is used.

↳ key_handleKeyHandle

Required. KeyHandle to create.

getParent

Required. Name of the resource project and location to create the KeyHandle in, e.g.

projects/{PROJECT_ID}/locations/{LOCATION}.

Returns
TypeDescription
string

setParent

Required. Name of the resource project and location to create the KeyHandle in, e.g.

projects/{PROJECT_ID}/locations/{LOCATION}.

Parameter
NameDescription
varstring
Returns
TypeDescription
$this

getKeyHandleId

Optional. Id of the KeyHandle. Must be unique to the resource project and location. If not provided by the caller, a new UUID is used.

Returns
TypeDescription
string

setKeyHandleId

Optional. Id of the KeyHandle. Must be unique to the resource project and location. If not provided by the caller, a new UUID is used.

Parameter
NameDescription
varstring
Returns
TypeDescription
$this

getKeyHandle

Required. KeyHandle to create.

Returns
TypeDescription
KeyHandle|null

hasKeyHandle

clearKeyHandle

setKeyHandle

Required. KeyHandle to create.

Parameter
NameDescription
varKeyHandle
Returns
TypeDescription
$this

static::build

Parameters
NameDescription
parentstring

Required. Name of the resource project and location to create the KeyHandle in, e.g. projects/{PROJECT_ID}/locations/{LOCATION}. Please see AutokeyClient::locationName() for help formatting this field.

keyHandleKeyHandle

Required. KeyHandle to create.

keyHandleIdstring

Optional. Id of the KeyHandle. Must be unique to the resource project and location. If not provided by the caller, a new UUID is used.

Returns
TypeDescription
CreateKeyHandleRequest