GenerateDataKeyRequest (tencentcloud-sdk-java 3.1.1355 API)

java.lang.Object
- com.tencentcloudapi.common.AbstractModel
- - com.tencentcloudapi.kms.v20190118.models.GenerateDataKeyRequest

public class GenerateDataKeyRequest
extends AbstractModel

Field Summary
- Fields inherited from class com.tencentcloudapi.common.AbstractModel
  header, skipSign

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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getDataKeyName()` Get 数据密钥的名称，当IsHostedByKms为1时,必须填写。当IsHostedByKms为0时,可以不填，KMS不托管。
`String`	`getDescription()` Get 数据密钥的描述，最大100字节
`String`	`getEncryptionAlgorithm()` Get 非对称加密算法，配合 EncryptionPublicKey 对返回数据进行加密。目前支持：SM2（以 C1C3C2 格式返回密文），SM2_C1C3C2_ASN1 （以 C1C3C2 ASN1 格式返回密文），RSAES_PKCS1_V1_5，RSAES_OAEP_SHA_1，RSAES_OAEP_SHA_256。若为空，则默认为 SM2。
`String`	`getEncryptionContext()` Get key/value对的json字符串，如果使用该字段，则返回的DataKey在解密时需要填入相同的字符串
`String`	`getEncryptionPublicKey()` Get PEM 格式公钥字符串，支持 RSA2048 和 SM2 公钥，用于对返回数据中的 Plaintext 值进行加密。若为空，则不对 Plaintext 值加密。
`String`	`getHsmClusterId()` Get KMS 独享版对应的 HSM 集群 ID。如果指定HsmClusterId，表明根密钥在此集群里，会校验KeyId是否和HsmClusterId对应。
`Long`	`getIsHostedByKms()` Get 表示生成的数据密钥是否被KMS托管。1:表示被KMS托管保存,0:表示KMS不托管。
`String`	`getKeyId()` Get CMK全局唯一标识符
`String`	`getKeySpec()` Get 指定生成Datakey的加密算法以及Datakey大小，AES_128或者AES_256。KeySpec 和 NumberOfBytes 必须指定一个
`Long`	`getNumberOfBytes()` Get 生成的DataKey的长度，同时指定NumberOfBytes和KeySpec时，以NumberOfBytes为准。最小值为1，最大值为1024。KeySpec 和 NumberOfBytes 必须指定一个
`void`	`setDataKeyName(String DataKeyName)` Set 数据密钥的名称，当IsHostedByKms为1时,必须填写。当IsHostedByKms为0时,可以不填，KMS不托管。
`void`	`setDescription(String Description)` Set 数据密钥的描述，最大100字节
`void`	`setEncryptionAlgorithm(String EncryptionAlgorithm)` Set 非对称加密算法，配合 EncryptionPublicKey 对返回数据进行加密。目前支持：SM2（以 C1C3C2 格式返回密文），SM2_C1C3C2_ASN1 （以 C1C3C2 ASN1 格式返回密文），RSAES_PKCS1_V1_5，RSAES_OAEP_SHA_1，RSAES_OAEP_SHA_256。若为空，则默认为 SM2。
`void`	`setEncryptionContext(String EncryptionContext)` Set key/value对的json字符串，如果使用该字段，则返回的DataKey在解密时需要填入相同的字符串
`void`	`setEncryptionPublicKey(String EncryptionPublicKey)` Set PEM 格式公钥字符串，支持 RSA2048 和 SM2 公钥，用于对返回数据中的 Plaintext 值进行加密。若为空，则不对 Plaintext 值加密。
`void`	`setHsmClusterId(String HsmClusterId)` Set KMS 独享版对应的 HSM 集群 ID。如果指定HsmClusterId，表明根密钥在此集群里，会校验KeyId是否和HsmClusterId对应。
`void`	`setIsHostedByKms(Long IsHostedByKms)` Set 表示生成的数据密钥是否被KMS托管。1:表示被KMS托管保存,0:表示KMS不托管。
`void`	`setKeyId(String KeyId)` Set CMK全局唯一标识符
`void`	`setKeySpec(String KeySpec)` Set 指定生成Datakey的加密算法以及Datakey大小，AES_128或者AES_256。KeySpec 和 NumberOfBytes 必须指定一个
`void`	`setNumberOfBytes(Long NumberOfBytes)` Set 生成的DataKey的长度，同时指定NumberOfBytes和KeySpec时，以NumberOfBytes为准。最小值为1，最大值为1024。KeySpec 和 NumberOfBytes 必须指定一个
`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
  - 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 CMK全局唯一标识符
    
    Returns:
    
    KeyId CMK全局唯一标识符
  - setKeyId
```
public void setKeyId(String KeyId)
```
    Set CMK全局唯一标识符
    
    Parameters:
    
    KeyId - CMK全局唯一标识符
  - getKeySpec
```
public String getKeySpec()
```
    Get 指定生成Datakey的加密算法以及Datakey大小，AES_128或者AES_256。KeySpec 和 NumberOfBytes 必须指定一个
    
    Returns:
    
    KeySpec 指定生成Datakey的加密算法以及Datakey大小，AES_128或者AES_256。KeySpec 和 NumberOfBytes 必须指定一个
  - setKeySpec
```
public void setKeySpec(String KeySpec)
```
    Set 指定生成Datakey的加密算法以及Datakey大小，AES_128或者AES_256。KeySpec 和 NumberOfBytes 必须指定一个
    
    Parameters:
    
    KeySpec - 指定生成Datakey的加密算法以及Datakey大小，AES_128或者AES_256。KeySpec 和 NumberOfBytes 必须指定一个
  - getNumberOfBytes
```
public Long getNumberOfBytes()
```
    Get 生成的DataKey的长度，同时指定NumberOfBytes和KeySpec时，以NumberOfBytes为准。最小值为1，最大值为1024。KeySpec 和 NumberOfBytes 必须指定一个
    
    Returns:
    
    NumberOfBytes 生成的DataKey的长度，同时指定NumberOfBytes和KeySpec时，以NumberOfBytes为准。最小值为1，最大值为1024。KeySpec 和 NumberOfBytes 必须指定一个
  - setNumberOfBytes
```
public void setNumberOfBytes(Long NumberOfBytes)
```
    Set 生成的DataKey的长度，同时指定NumberOfBytes和KeySpec时，以NumberOfBytes为准。最小值为1，最大值为1024。KeySpec 和 NumberOfBytes 必须指定一个
    
    Parameters:
    
    NumberOfBytes - 生成的DataKey的长度，同时指定NumberOfBytes和KeySpec时，以NumberOfBytes为准。最小值为1，最大值为1024。KeySpec 和 NumberOfBytes 必须指定一个
  - getEncryptionContext
```
public String getEncryptionContext()
```
    Get key/value对的json字符串，如果使用该字段，则返回的DataKey在解密时需要填入相同的字符串
    
    Returns:
    
    EncryptionContext key/value对的json字符串，如果使用该字段，则返回的DataKey在解密时需要填入相同的字符串
  - setEncryptionContext
```
public void setEncryptionContext(String EncryptionContext)
```
    Set key/value对的json字符串，如果使用该字段，则返回的DataKey在解密时需要填入相同的字符串
    
    Parameters:
    
    EncryptionContext - key/value对的json字符串，如果使用该字段，则返回的DataKey在解密时需要填入相同的字符串
  - getEncryptionPublicKey
```
public String getEncryptionPublicKey()
```
    Get PEM 格式公钥字符串，支持 RSA2048 和 SM2 公钥，用于对返回数据中的 Plaintext 值进行加密。若为空，则不对 Plaintext 值加密。
    
    Returns:
    
    EncryptionPublicKey PEM 格式公钥字符串，支持 RSA2048 和 SM2 公钥，用于对返回数据中的 Plaintext 值进行加密。若为空，则不对 Plaintext 值加密。
  - setEncryptionPublicKey
```
public void setEncryptionPublicKey(String EncryptionPublicKey)
```
    Set PEM 格式公钥字符串，支持 RSA2048 和 SM2 公钥，用于对返回数据中的 Plaintext 值进行加密。若为空，则不对 Plaintext 值加密。
    
    Parameters:
    
    EncryptionPublicKey - PEM 格式公钥字符串，支持 RSA2048 和 SM2 公钥，用于对返回数据中的 Plaintext 值进行加密。若为空，则不对 Plaintext 值加密。
  - getEncryptionAlgorithm
```
public String getEncryptionAlgorithm()
```
    Get 非对称加密算法，配合 EncryptionPublicKey 对返回数据进行加密。目前支持：SM2（以 C1C3C2 格式返回密文），SM2_C1C3C2_ASN1 （以 C1C3C2 ASN1 格式返回密文），RSAES_PKCS1_V1_5，RSAES_OAEP_SHA_1，RSAES_OAEP_SHA_256。若为空，则默认为 SM2。
    
    Returns:
    
    EncryptionAlgorithm 非对称加密算法，配合 EncryptionPublicKey 对返回数据进行加密。目前支持：SM2（以 C1C3C2 格式返回密文），SM2_C1C3C2_ASN1 （以 C1C3C2 ASN1 格式返回密文），RSAES_PKCS1_V1_5，RSAES_OAEP_SHA_1，RSAES_OAEP_SHA_256。若为空，则默认为 SM2。
  - setEncryptionAlgorithm
```
public void setEncryptionAlgorithm(String EncryptionAlgorithm)
```
    Set 非对称加密算法，配合 EncryptionPublicKey 对返回数据进行加密。目前支持：SM2（以 C1C3C2 格式返回密文），SM2_C1C3C2_ASN1 （以 C1C3C2 ASN1 格式返回密文），RSAES_PKCS1_V1_5，RSAES_OAEP_SHA_1，RSAES_OAEP_SHA_256。若为空，则默认为 SM2。
    
    Parameters:
    
    EncryptionAlgorithm - 非对称加密算法，配合 EncryptionPublicKey 对返回数据进行加密。目前支持：SM2（以 C1C3C2 格式返回密文），SM2_C1C3C2_ASN1 （以 C1C3C2 ASN1 格式返回密文），RSAES_PKCS1_V1_5，RSAES_OAEP_SHA_1，RSAES_OAEP_SHA_256。若为空，则默认为 SM2。
  - getIsHostedByKms
```
public Long getIsHostedByKms()
```
    Get 表示生成的数据密钥是否被KMS托管。1:表示被KMS托管保存,0:表示KMS不托管。
    
    Returns:
    
    IsHostedByKms 表示生成的数据密钥是否被KMS托管。1:表示被KMS托管保存,0:表示KMS不托管。
  - setIsHostedByKms
```
public void setIsHostedByKms(Long IsHostedByKms)
```
    Set 表示生成的数据密钥是否被KMS托管。1:表示被KMS托管保存,0:表示KMS不托管。
    
    Parameters:
    
    IsHostedByKms - 表示生成的数据密钥是否被KMS托管。1:表示被KMS托管保存,0:表示KMS不托管。
  - getDataKeyName
```
public String getDataKeyName()
```
    Get 数据密钥的名称，当IsHostedByKms为1时,必须填写。当IsHostedByKms为0时,可以不填，KMS不托管。
    
    Returns:
    
    DataKeyName 数据密钥的名称，当IsHostedByKms为1时,必须填写。当IsHostedByKms为0时,可以不填，KMS不托管。
  - setDataKeyName
```
public void setDataKeyName(String DataKeyName)
```
    Set 数据密钥的名称，当IsHostedByKms为1时,必须填写。当IsHostedByKms为0时,可以不填，KMS不托管。
    
    Parameters:
    
    DataKeyName - 数据密钥的名称，当IsHostedByKms为1时,必须填写。当IsHostedByKms为0时,可以不填，KMS不托管。
  - getDescription
```
public String getDescription()
```
    Get 数据密钥的描述，最大100字节
    
    Returns:
    
    Description 数据密钥的描述，最大100字节
  - setDescription
```
public void setDescription(String Description)
```
    Set 数据密钥的描述，最大100字节
    
    Parameters:
    
    Description - 数据密钥的描述，最大100字节
  - getHsmClusterId
```
public String getHsmClusterId()
```
    Get KMS 独享版对应的 HSM 集群 ID。如果指定HsmClusterId，表明根密钥在此集群里，会校验KeyId是否和HsmClusterId对应。
    
    Returns:
    
    HsmClusterId KMS 独享版对应的 HSM 集群 ID。如果指定HsmClusterId，表明根密钥在此集群里，会校验KeyId是否和HsmClusterId对应。
  - setHsmClusterId
```
public void setHsmClusterId(String HsmClusterId)
```
    Set KMS 独享版对应的 HSM 集群 ID。如果指定HsmClusterId，表明根密钥在此集群里，会校验KeyId是否和HsmClusterId对应。
    
    Parameters:
    
    HsmClusterId - KMS 独享版对应的 HSM 集群 ID。如果指定HsmClusterId，表明根密钥在此集群里，会校验KeyId是否和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.

Class GenerateDataKeyRequest

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

Constructor Summary

Method Summary

Methods inherited from class com.tencentcloudapi.common.AbstractModel

Methods inherited from class java.lang.Object

Constructor Detail

GenerateDataKeyRequest

GenerateDataKeyRequest

Method Detail

getKeyId

setKeyId

getKeySpec

setKeySpec

getNumberOfBytes

setNumberOfBytes

getEncryptionContext

setEncryptionContext

getEncryptionPublicKey

setEncryptionPublicKey

getEncryptionAlgorithm

setEncryptionAlgorithm

getIsHostedByKms

setIsHostedByKms

getDataKeyName

setDataKeyName

getDescription

setDescription

getHsmClusterId

setHsmClusterId

toMap