Reference documentation and code samples for the Cloud KMS V1 Client class CreateCryptoKeyRequest.
Request message for KeyManagementService.CreateCryptoKey.
Generated from protobuf message google.cloud.kms.v1.CreateCryptoKeyRequest
Namespace
Google \ Cloud \ Kms \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data | arrayOptional. Data for populating the Message object. |
↳ parent | stringRequired. The name of the KeyRing associated with the CryptoKeys. |
↳ crypto_key_id | stringRequired. It must be unique within a KeyRing and match the regular expression |
↳ crypto_key | CryptoKeyRequired. A CryptoKey with initial field values. |
↳ skip_initial_version_creation | boolIf set to true, the request will create a CryptoKey without any CryptoKeyVersions. You must manually call CreateCryptoKeyVersion or ImportCryptoKeyVersion before you can use this CryptoKey. |
getParent
Required. The name of the KeyRing associated with the CryptoKeys.
| Returns | |
|---|---|
| Type | Description |
string | |
setParent
Required. The name of the KeyRing associated with the CryptoKeys.
| Parameter | |
|---|---|
| Name | Description |
var | string |
| Returns | |
|---|---|
| Type | Description |
$this | |
getCryptoKeyId
Required. It must be unique within a KeyRing and match the regular expression [a-zA-Z0-9_-]{1,63}
| Returns | |
|---|---|
| Type | Description |
string | |
setCryptoKeyId
Required. It must be unique within a KeyRing and match the regular expression [a-zA-Z0-9_-]{1,63}
| Parameter | |
|---|---|
| Name | Description |
var | string |
| Returns | |
|---|---|
| Type | Description |
$this | |
getCryptoKey
Required. A CryptoKey with initial field values.
| Returns | |
|---|---|
| Type | Description |
CryptoKey|null | |
hasCryptoKey
clearCryptoKey
setCryptoKey
Required. A CryptoKey with initial field values.
| Parameter | |
|---|---|
| Name | Description |
var | CryptoKey |
| Returns | |
|---|---|
| Type | Description |
$this | |
getSkipInitialVersionCreation
If set to true, the request will create a CryptoKey without any CryptoKeyVersions. You must manually call CreateCryptoKeyVersion or ImportCryptoKeyVersion before you can use this CryptoKey.
| Returns | |
|---|---|
| Type | Description |
bool | |
setSkipInitialVersionCreation
If set to true, the request will create a CryptoKey without any CryptoKeyVersions. You must manually call CreateCryptoKeyVersion or ImportCryptoKeyVersion before you can use this CryptoKey.
| Parameter | |
|---|---|
| Name | Description |
var | bool |
| Returns | |
|---|---|
| Type | Description |
$this | |
static::build
| Parameters | |
|---|---|
| Name | Description |
parent | stringRequired. The name of the KeyRing associated with the CryptoKeys. Please see KeyManagementServiceClient::keyRingName() for help formatting this field. |
cryptoKeyId | stringRequired. It must be unique within a KeyRing and match the regular expression |
cryptoKey | CryptoKeyRequired. A CryptoKey with initial field values. |
| Returns | |
|---|---|
| Type | Description |
CreateCryptoKeyRequest | |