Cloud KMS V1 Client - Class CreateKeyRingRequest (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 CreateKeyRingRequest.

Request message for KeyManagementService.CreateKeyRing.

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

Namespace

Google \ Cloud \ Kms \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ parent	string Required. The resource name of the location associated with the KeyRings, in the format projects/*/locations/*.
↳ key_ring_id	string Required. It must be unique within a location and match the regular expression [a-zA-Z0-9_-]{1,63}
↳ key_ring	KeyRing Required. A KeyRing with initial field values.

getParent

Required. The resource name of the location associated with the KeyRings, in the format projects/*/locations/*.

Returns
Type	Description
string

setParent

Required. The resource name of the location associated with the KeyRings, in the format projects/*/locations/*.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getKeyRingId

Required. It must be unique within a location and match the regular expression [a-zA-Z0-9_-]{1,63}

Returns
Type	Description
string

setKeyRingId

Required. It must be unique within a location and match the regular expression [a-zA-Z0-9_-]{1,63}

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getKeyRing

Required. A KeyRing with initial field values.

Returns
Type	Description
KeyRing|null

hasKeyRing

clearKeyRing

setKeyRing

Required. A KeyRing with initial field values.

Parameter
Name	Description
var	KeyRing

Returns
Type	Description
$this

static::build

Parameters
Name	Description
parent	string Required. The resource name of the location associated with the KeyRings, in the format projects/*/locations/*. Please see KeyManagementServiceClient::locationName() for help formatting this field.
keyRingId	string Required. It must be unique within a location and match the regular expression [a-zA-Z0-9_-]{1,63}
keyRing	KeyRing Required. A KeyRing with initial field values.

Returns
Type	Description
CreateKeyRingRequest