com.tencentcloudapi.kms.v20190118.models

Class GenerateDataKeyRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.kms.v20190118.models.GenerateDataKeyRequest

public class GenerateDataKeyRequest
extends AbstractModel

Constructor Summary

Constructors

Constructor and Description
GenerateDataKeyRequest()
GenerateDataKeyRequest(GenerateDataKeyRequest 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	getEncryptionAlgorithm() Get Asymmetric encryption algorithm.
String	getEncryptionContext() Get JSON string of key-value pair.
String	getEncryptionPublicKey() Get PEM-encoded public key (2048-bit RSA/SM2 key), which can be used to encrypt the `Plaintext` returned.
String	getKeyId() Get Globally unique CMK ID
String	getKeySpec() Get Specifies the encryption algorithm and size of the `DataKey`.
Long	getNumberOfBytes() Get Length of the `DataKey`.
void	setEncryptionAlgorithm(String EncryptionAlgorithm) Set Asymmetric encryption algorithm.
void	setEncryptionContext(String EncryptionContext) Set JSON string of key-value pair.
void	setEncryptionPublicKey(String EncryptionPublicKey) Set PEM-encoded public key (2048-bit RSA/SM2 key), which can be used to encrypt the `Plaintext` returned.
void	setKeyId(String KeyId) Set Globally unique CMK ID
void	setKeySpec(String KeySpec) Set Specifies the encryption algorithm and size of the `DataKey`.
void	setNumberOfBytes(Long NumberOfBytes) Set Length of the `DataKey`.
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, getMultipartRequestParams, set, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, toJsonString

Methods inherited from class java.lang.Object

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

Constructor Detail

GenerateDataKeyRequest

public GenerateDataKeyRequest()

GenerateDataKeyRequest

public GenerateDataKeyRequest(GenerateDataKeyRequest 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

getKeyId

public String getKeyId()

Get Globally unique CMK ID

Returns:

KeyId Globally unique CMK ID

setKeyId

public void setKeyId(String KeyId)

Set Globally unique CMK ID

Parameters:

KeyId - Globally unique CMK ID

getKeySpec

public String getKeySpec()

Get Specifies the encryption algorithm and size of the `DataKey`. Valid values: AES_128, AES_256. Either `KeySpec` or `NumberOfBytes` must be specified.

Returns:

KeySpec Specifies the encryption algorithm and size of the `DataKey`. Valid values: AES_128, AES_256. Either `KeySpec` or `NumberOfBytes` must be specified.

setKeySpec

public void setKeySpec(String KeySpec)

Set Specifies the encryption algorithm and size of the `DataKey`. Valid values: AES_128, AES_256. Either `KeySpec` or `NumberOfBytes` must be specified.

Parameters:

KeySpec - Specifies the encryption algorithm and size of the `DataKey`. Valid values: AES_128, AES_256. Either `KeySpec` or `NumberOfBytes` must be specified.

getNumberOfBytes

public Long getNumberOfBytes()

Get Length of the `DataKey`. If both `NumberOfBytes` and `KeySpec` are specified, `NumberOfBytes` will prevail. Minimum value: 1; maximum value: 1024. Either `KeySpec` or `NumberOfBytes` must be specified.

Returns:

NumberOfBytes Length of the `DataKey`. If both `NumberOfBytes` and `KeySpec` are specified, `NumberOfBytes` will prevail. Minimum value: 1; maximum value: 1024. Either `KeySpec` or `NumberOfBytes` must be specified.

setNumberOfBytes

public void setNumberOfBytes(Long NumberOfBytes)

Set Length of the `DataKey`. If both `NumberOfBytes` and `KeySpec` are specified, `NumberOfBytes` will prevail. Minimum value: 1; maximum value: 1024. Either `KeySpec` or `NumberOfBytes` must be specified.

Parameters:

NumberOfBytes - Length of the `DataKey`. If both `NumberOfBytes` and `KeySpec` are specified, `NumberOfBytes` will prevail. Minimum value: 1; maximum value: 1024. Either `KeySpec` or `NumberOfBytes` must be specified.

getEncryptionContext

public String getEncryptionContext()

Get JSON string of key-value pair. If this field is used, the same string should be entered when the returned `DataKey` is decrypted.

Returns:

EncryptionContext JSON string of key-value pair. If this field is used, the same string should be entered when the returned `DataKey` is decrypted.

setEncryptionContext

public void setEncryptionContext(String EncryptionContext)

Set JSON string of key-value pair. If this field is used, the same string should be entered when the returned `DataKey` is decrypted.

Parameters:

EncryptionContext - JSON string of key-value pair. If this field is used, the same string should be entered when the returned `DataKey` is decrypted.

getEncryptionPublicKey

public String getEncryptionPublicKey()

Get PEM-encoded public key (2048-bit RSA/SM2 key), which can be used to encrypt the `Plaintext` returned. If this field is left empty, the `Plaintext` will not be encrypted.

Returns:

EncryptionPublicKey PEM-encoded public key (2048-bit RSA/SM2 key), which can be used to encrypt the `Plaintext` returned. If this field is left empty, the `Plaintext` will not be encrypted.

setEncryptionPublicKey

public void setEncryptionPublicKey(String EncryptionPublicKey)

Set PEM-encoded public key (2048-bit RSA/SM2 key), which can be used to encrypt the `Plaintext` returned. If this field is left empty, the `Plaintext` will not be encrypted.

Parameters:

EncryptionPublicKey - PEM-encoded public key (2048-bit RSA/SM2 key), which can be used to encrypt the `Plaintext` returned. If this field is left empty, the `Plaintext` will not be encrypted.

getEncryptionAlgorithm

public String getEncryptionAlgorithm()

Get Asymmetric encryption algorithm. Valid values: `SM2` (C1C3C2 ciphertext is returned)`, `SM2_C1C3C2_ASN1` (C1C3C2 ASN1 ciphertext is returned), `RSAES_PKCS1_V1_5`, `RSAES_OAEP_SHA_1`, and `RSAES_OAEP_SHA_256`. This field is used in combination with `EncryptionPublicKey` for encryption. If it is left empty, an SM2 public key will be used by default.

Returns:

EncryptionAlgorithm Asymmetric encryption algorithm. Valid values: `SM2` (C1C3C2 ciphertext is returned)`, `SM2_C1C3C2_ASN1` (C1C3C2 ASN1 ciphertext is returned), `RSAES_PKCS1_V1_5`, `RSAES_OAEP_SHA_1`, and `RSAES_OAEP_SHA_256`. This field is used in combination with `EncryptionPublicKey` for encryption. If it is left empty, an SM2 public key will be used by default.

setEncryptionAlgorithm

public void setEncryptionAlgorithm(String EncryptionAlgorithm)

Set Asymmetric encryption algorithm. Valid values: `SM2` (C1C3C2 ciphertext is returned)`, `SM2_C1C3C2_ASN1` (C1C3C2 ASN1 ciphertext is returned), `RSAES_PKCS1_V1_5`, `RSAES_OAEP_SHA_1`, and `RSAES_OAEP_SHA_256`. This field is used in combination with `EncryptionPublicKey` for encryption. If it is left empty, an SM2 public key will be used by default.

Parameters:

EncryptionAlgorithm - Asymmetric encryption algorithm. Valid values: `SM2` (C1C3C2 ciphertext is returned)`, `SM2_C1C3C2_ASN1` (C1C3C2 ASN1 ciphertext is returned), `RSAES_PKCS1_V1_5`, `RSAES_OAEP_SHA_1`, and `RSAES_OAEP_SHA_256`. This field is used in combination with `EncryptionPublicKey` for encryption. If it is left empty, an SM2 public key will be used by default.

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel