Cloud KMS V1 Client - Class CreateKeyRingRequest (2.1.0)

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 Google\Cloud\Kms\V1\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
Google\Cloud\Kms\V1\KeyRing|null

hasKeyRing

clearKeyRing

setKeyRing

Required. A KeyRing with initial field values.

Parameter
Name Description
var Google\Cloud\Kms\V1\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 Google\Cloud\Kms\V1\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 Google\Cloud\Kms\V1\KeyRing

Required. A KeyRing with initial field values.
Returns
Type Description
Google\Cloud\Kms\V1\CreateKeyRingRequest