com.tencentcloudapi.kms.v20190118.models

Class ImportDataKeyRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.kms.v20190118.models.ImportDataKeyRequest

public class ImportDataKeyRequest
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
ImportDataKeyRequest()
ImportDataKeyRequest(ImportDataKeyRequest source) NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy, and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.

Method Summary

Modifier and Type	Method and Description
String	getDataKeyName() Get Name of the data key.
String	getDescription() Get Describes the data key.
String	getHsmClusterId() Get HSM cluster ID corresponding to the KMS exclusive edition.
String	getImportKeyMaterial() Get If the imported key is plaintext data key, it is the base64 plaintext data key after conversion.
Long	getImportType() Get 1: ciphertext import (data key generated by KMS api) 2: plaintext import.
String	getKeyId() Get When importing an encrypted data key, no need to input the root key.
void	setDataKeyName(String DataKeyName) Set Name of the data key.
void	setDescription(String Description) Set Describes the data key.
void	setHsmClusterId(String HsmClusterId) Set HSM cluster ID corresponding to the KMS exclusive edition.
void	setImportKeyMaterial(String ImportKeyMaterial) Set If the imported key is plaintext data key, it is the base64 plaintext data key after conversion.
void	setImportType(Long ImportType) Set 1: ciphertext import (data key generated by KMS api) 2: plaintext import.
void	setKeyId(String KeyId) Set When importing an encrypted data key, no need to input the root key.
void	toMap(HashMap<String,String> map, String prefix) Internal implementation, normal users should not use it.

Methods inherited from class com.tencentcloudapi.common.AbstractModel

any, fromJsonString, getBinaryParams, GetHeader, getMultipartRequestParams, getSkipSign, isStream, set, SetHeader, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, setSkipSign, toJsonString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ImportDataKeyRequest

public ImportDataKeyRequest()

ImportDataKeyRequest

public ImportDataKeyRequest(ImportDataKeyRequest source)

NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy, and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.

Method Detail

getDataKeyName

public String getDataKeyName()

Get Name of the data key.

Returns:

DataKeyName Name of the data key.

setDataKeyName

public void setDataKeyName(String DataKeyName)

Set Name of the data key.

Parameters:

DataKeyName - Name of the data key.

getImportKeyMaterial

public String getImportKeyMaterial()

Get If the imported key is plaintext data key, it is the base64 plaintext data key after conversion. if the imported key is ciphertext data key, it is the ciphertext data key generated by the KMS GenerateDataKey interface.

Returns:

ImportKeyMaterial If the imported key is plaintext data key, it is the base64 plaintext data key after conversion. if the imported key is ciphertext data key, it is the ciphertext data key generated by the KMS GenerateDataKey interface.

setImportKeyMaterial

public void setImportKeyMaterial(String ImportKeyMaterial)

Set If the imported key is plaintext data key, it is the base64 plaintext data key after conversion. if the imported key is ciphertext data key, it is the ciphertext data key generated by the KMS GenerateDataKey interface.

Parameters:

ImportKeyMaterial - If the imported key is plaintext data key, it is the base64 plaintext data key after conversion. if the imported key is ciphertext data key, it is the ciphertext data key generated by the KMS GenerateDataKey interface.

getImportType

public Long getImportType()

Get 1: ciphertext import (data key generated by KMS api) 2: plaintext import.

Returns:

ImportType 1: ciphertext import (data key generated by KMS api) 2: plaintext import.

setImportType

public void setImportType(Long ImportType)

Set 1: ciphertext import (data key generated by KMS api) 2: plaintext import.

Parameters:

ImportType - 1: ciphertext import (data key generated by KMS api) 2: plaintext import.

getDescription

public String getDescription()

Get Describes the data key. maximum 100 bytes.

Returns:

Description Describes the data key. maximum 100 bytes.

setDescription

public void setDescription(String Description)

Set Describes the data key. maximum 100 bytes.

Parameters:

Description - Describes the data key. maximum 100 bytes.

getKeyId

public String getKeyId()

Get When importing an encrypted data key, no need to input the root key. if the input is provided, validate whether the KeyId matches the one in the ciphertext. When importing plaintext data key, KeyId cannot be empty. the data key is encrypted with the specified root key.

Returns:

KeyId When importing an encrypted data key, no need to input the root key. if the input is provided, validate whether the KeyId matches the one in the ciphertext. When importing plaintext data key, KeyId cannot be empty. the data key is encrypted with the specified root key.

setKeyId

public void setKeyId(String KeyId)

Set When importing an encrypted data key, no need to input the root key. if the input is provided, validate whether the KeyId matches the one in the ciphertext. When importing plaintext data key, KeyId cannot be empty. the data key is encrypted with the specified root key.

Parameters:

KeyId - When importing an encrypted data key, no need to input the root key. if the input is provided, validate whether the KeyId matches the one in the ciphertext. When importing plaintext data key, KeyId cannot be empty. the data key is encrypted with the specified root key.

getHsmClusterId

public String getHsmClusterId()

Get HSM cluster ID corresponding to the KMS exclusive edition. if HsmClusterId is specified, it indicates the root key is in this cluster and verifies whether KeyId corresponds to HsmClusterId.

Returns:

HsmClusterId HSM cluster ID corresponding to the KMS exclusive edition. if HsmClusterId is specified, it indicates the root key is in this cluster and verifies whether KeyId corresponds to HsmClusterId.

setHsmClusterId

public void setHsmClusterId(String HsmClusterId)

Set HSM cluster ID corresponding to the KMS exclusive edition. if HsmClusterId is specified, it indicates the root key is in this cluster and verifies whether KeyId corresponds to HsmClusterId.

Parameters:

HsmClusterId - HSM cluster ID corresponding to the KMS exclusive edition. if HsmClusterId is specified, it indicates the root key is in this cluster and verifies whether KeyId corresponds to HsmClusterId.

toMap

public void toMap(HashMap<String,String> map,
                  String prefix)

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel

Parameters:

map - The map to populate with the model's parameters.

prefix - A string prefix for the keys.