com.tencentcloudapi.ocr.v20181119.models

Class Encryption

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.ocr.v20181119.models.Encryption

public class Encryption
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
Encryption()
Encryption(Encryption 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	getAlgorithm() Get 加密使用的算法（支持'AES-256-CBC'、'SM4-GCM'），不传默认为'AES-256-CBC' 注意：此字段可能返回 null，表示取不到有效值。
String	getCiphertextBlob() Get 有加密需求的用户，接入传入kms的CiphertextBlob，关于数据加密可查阅数据加密 文档。 注意：此字段可能返回 null，表示取不到有效值。
String[]	getEncryptList() Get 在使用加密服务时，指定要被加密的字段。本接口默认为EncryptedBody 注意：此字段可能返回 null，表示取不到有效值。
String	getIv() Get 有加密需求的用户，传入CBC加密的初始向量（客户自定义字符串，长度16字符）。 注意：此字段可能返回 null，表示取不到有效值。
String[]	getTagList() Get SM4-GCM算法生成的消息摘要（校验消息完整性时使用） 注意：此字段可能返回 null，表示取不到有效值。
void	setAlgorithm(String Algorithm) Set 加密使用的算法（支持'AES-256-CBC'、'SM4-GCM'），不传默认为'AES-256-CBC' 注意：此字段可能返回 null，表示取不到有效值。
void	setCiphertextBlob(String CiphertextBlob) Set 有加密需求的用户，接入传入kms的CiphertextBlob，关于数据加密可查阅数据加密 文档。 注意：此字段可能返回 null，表示取不到有效值。
void	setEncryptList(String[] EncryptList) Set 在使用加密服务时，指定要被加密的字段。本接口默认为EncryptedBody 注意：此字段可能返回 null，表示取不到有效值。
void	setIv(String Iv) Set 有加密需求的用户，传入CBC加密的初始向量（客户自定义字符串，长度16字符）。 注意：此字段可能返回 null，表示取不到有效值。
void	setTagList(String[] TagList) Set SM4-GCM算法生成的消息摘要（校验消息完整性时使用） 注意：此字段可能返回 null，表示取不到有效值。
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

Encryption

public Encryption()

Encryption

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

getCiphertextBlob

public String getCiphertextBlob()

Get 有加密需求的用户，接入传入kms的CiphertextBlob，关于数据加密可查阅数据加密 文档。 注意：此字段可能返回 null，表示取不到有效值。

Returns:

CiphertextBlob 有加密需求的用户，接入传入kms的CiphertextBlob，关于数据加密可查阅数据加密 文档。 注意：此字段可能返回 null，表示取不到有效值。

setCiphertextBlob

public void setCiphertextBlob(String CiphertextBlob)

Set 有加密需求的用户，接入传入kms的CiphertextBlob，关于数据加密可查阅数据加密 文档。 注意：此字段可能返回 null，表示取不到有效值。

Parameters:

CiphertextBlob - 有加密需求的用户，接入传入kms的CiphertextBlob，关于数据加密可查阅数据加密 文档。 注意：此字段可能返回 null，表示取不到有效值。

getIv

public String getIv()

Get 有加密需求的用户，传入CBC加密的初始向量（客户自定义字符串，长度16字符）。 注意：此字段可能返回 null，表示取不到有效值。

Returns:

Iv 有加密需求的用户，传入CBC加密的初始向量（客户自定义字符串，长度16字符）。 注意：此字段可能返回 null，表示取不到有效值。

setIv

public void setIv(String Iv)

Set 有加密需求的用户，传入CBC加密的初始向量（客户自定义字符串，长度16字符）。 注意：此字段可能返回 null，表示取不到有效值。

Parameters:

Iv - 有加密需求的用户，传入CBC加密的初始向量（客户自定义字符串，长度16字符）。 注意：此字段可能返回 null，表示取不到有效值。

getAlgorithm

public String getAlgorithm()

Get 加密使用的算法（支持'AES-256-CBC'、'SM4-GCM'），不传默认为'AES-256-CBC' 注意：此字段可能返回 null，表示取不到有效值。

Returns:

Algorithm 加密使用的算法（支持'AES-256-CBC'、'SM4-GCM'），不传默认为'AES-256-CBC' 注意：此字段可能返回 null，表示取不到有效值。

setAlgorithm

public void setAlgorithm(String Algorithm)

Set 加密使用的算法（支持'AES-256-CBC'、'SM4-GCM'），不传默认为'AES-256-CBC' 注意：此字段可能返回 null，表示取不到有效值。

Parameters:

Algorithm - 加密使用的算法（支持'AES-256-CBC'、'SM4-GCM'），不传默认为'AES-256-CBC' 注意：此字段可能返回 null，表示取不到有效值。

getTagList

public String[] getTagList()

Get SM4-GCM算法生成的消息摘要（校验消息完整性时使用） 注意：此字段可能返回 null，表示取不到有效值。

Returns:

TagList SM4-GCM算法生成的消息摘要（校验消息完整性时使用） 注意：此字段可能返回 null，表示取不到有效值。

setTagList

public void setTagList(String[] TagList)

Set SM4-GCM算法生成的消息摘要（校验消息完整性时使用） 注意：此字段可能返回 null，表示取不到有效值。

Parameters:

TagList - SM4-GCM算法生成的消息摘要（校验消息完整性时使用） 注意：此字段可能返回 null，表示取不到有效值。

getEncryptList

public String[] getEncryptList()

Get 在使用加密服务时，指定要被加密的字段。本接口默认为EncryptedBody 注意：此字段可能返回 null，表示取不到有效值。

Returns:

EncryptList 在使用加密服务时，指定要被加密的字段。本接口默认为EncryptedBody 注意：此字段可能返回 null，表示取不到有效值。

setEncryptList

public void setEncryptList(String[] EncryptList)

Set 在使用加密服务时，指定要被加密的字段。本接口默认为EncryptedBody 注意：此字段可能返回 null，表示取不到有效值。

Parameters:

EncryptList - 在使用加密服务时，指定要被加密的字段。本接口默认为EncryptedBody 注意：此字段可能返回 null，表示取不到有效值。

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel