Cloud KMS V1 Client - Class CreateKeyHandleRequest (2.5.1)

Version latest

• 2.5.1 (latest)
• 2.5.0
• 2.4.0
• 2.3.1
• 2.2.0
• 2.1.6
• 2.0.0
• 1.23.0
• 1.22.1
• 1.21.4
• 1.20.3
• 1.19.0
• 1.18.1
• 1.17.0
• 1.16.4
• 1.15.3

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
Name	Description
data	array Optional. Data for populating the Message object.
↳ parent	string Required. Name of the resource project and location to create the KeyHandle in, e.g. projects/{PROJECT_ID}/locations/{LOCATION}.
↳ key_handle_id	string 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_handle	KeyHandle 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
Type	Description
string

setParent

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

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

Parameter
Name	Description
var	string

Returns
Type	Description
$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
Type	Description
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
Name	Description
var	string

Returns
Type	Description
$this

getKeyHandle

Required. KeyHandle to create.

Returns
Type	Description
KeyHandle|null

hasKeyHandle

clearKeyHandle

setKeyHandle

Required. KeyHandle to create.

Parameter
Name	Description
var	KeyHandle

Returns
Type	Description
$this

static::build

Parameters
Name	Description
parent	string 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.
keyHandle	KeyHandle Required. KeyHandle to create.
keyHandleId	string 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
Type	Description
CreateKeyHandleRequest