Reference documentation and code samples for the Cloud KMS V1 Client class ImportTrustedKeyWrappedCryptoKeyVersionRequest.
Request message for KeyManagementService.ImportTrustedKeyWrappedCryptoKeyVersion.
Generated from protobuf message google.cloud.kms.v1.ImportTrustedKeyWrappedCryptoKeyVersionRequest
Namespace
Google \ Cloud \ Kms \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
|
↳ importing_key |
string
Required. Required - the CKV of the trusted key used to import. This can be the name of a CryptoKeyVersion or a CryptoKey. |
↳ crypto_key_version |
string
Optional. The optional name of an existing CryptoKeyVersion to target for an import operation. If this field is not present, a new CryptoKeyVersion containing the supplied key material is created. If this field is present, the supplied key material is imported into the existing CryptoKeyVersion. To import into an existing CryptoKeyVersion, the CryptoKeyVersion must be a child of ImportTrustedKeyWrappedCryptoKeyVersionRequest.parent, have been previously created via ImportTrustedKeyWrappedCryptoKeyVersion, and be in DESTROYED or IMPORT_FAILED state. The key material and algorithm must match the previous CryptoKeyVersion exactly if the CryptoKeyVersion has ever contained key material |
↳ wrapped_key |
string
Required. The target key pre-wrapped on premises. |
↳ algorithm |
int
Required. Required - The algorithm of the key being imported. This does not need to match the version_template of the CryptoKey this version imports into. |
getParent
| Returns | |
|---|---|
| Type | Description |
string |
|
setParent
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getImportingKey
Required. Required - the CKV of the trusted key used to import.
This can be the name of a CryptoKeyVersion or a CryptoKey.
| Returns | |
|---|---|
| Type | Description |
string |
|
setImportingKey
Required. Required - the CKV of the trusted key used to import.
This can be the name of a CryptoKeyVersion or a CryptoKey.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCryptoKeyVersion
Optional. The optional name of an existing CryptoKeyVersion to target for an import operation. If this field is not present, a new CryptoKeyVersion containing the supplied key material is created.
If this field is present, the supplied key material is imported into the existing CryptoKeyVersion. To import into an existing CryptoKeyVersion, the CryptoKeyVersion must be a child of ImportTrustedKeyWrappedCryptoKeyVersionRequest.parent, have been previously created via ImportTrustedKeyWrappedCryptoKeyVersion, and be in DESTROYED or IMPORT_FAILED state. The key material and algorithm must match the previous CryptoKeyVersion exactly if the CryptoKeyVersion has ever contained key material
| Returns | |
|---|---|
| Type | Description |
string |
|
setCryptoKeyVersion
Optional. The optional name of an existing CryptoKeyVersion to target for an import operation. If this field is not present, a new CryptoKeyVersion containing the supplied key material is created.
If this field is present, the supplied key material is imported into the existing CryptoKeyVersion. To import into an existing CryptoKeyVersion, the CryptoKeyVersion must be a child of ImportTrustedKeyWrappedCryptoKeyVersionRequest.parent, have been previously created via ImportTrustedKeyWrappedCryptoKeyVersion, and be in DESTROYED or IMPORT_FAILED state. The key material and algorithm must match the previous CryptoKeyVersion exactly if the CryptoKeyVersion has ever contained key material
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getWrappedKey
Required. The target key pre-wrapped on premises.
| Returns | |
|---|---|
| Type | Description |
string |
|
setWrappedKey
Required. The target key pre-wrapped on premises.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAlgorithm
Required. Required - The algorithm of the key being imported. This does not need to match the version_template of the CryptoKey this version imports into.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type CryptoKeyVersionAlgorithm. |
setAlgorithm
Required. Required - The algorithm of the key being imported. This does not need to match the version_template of the CryptoKey this version imports into.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type CryptoKeyVersionAlgorithm. |
| Returns | |
|---|---|
| Type | Description |
$this |
|