com.tencentcloudapi.kms.v20190118.models

Class WhiteboxKeyInfo

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.kms.v20190118.models.WhiteboxKeyInfo

public class WhiteboxKeyInfo
extends AbstractModel

Constructor Summary

Constructors

Constructor and Description
WhiteboxKeyInfo()
WhiteboxKeyInfo(WhiteboxKeyInfo 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 Key algorithm type
String	getAlias() Get Unique alias that makes a key more recognizable and understandable.
Long	getCreateTime() Get Key creation time in Unix timestamp
Long	getCreatorUin() Get Creator
String	getDecryptKey() Get Base64-encoded white-box decryption key
String	getDescription() Get Key description information
Boolean	getDeviceFingerprintBind() Get Whether there is a device fingerprint bound to the current key Note: this field may return null, indicating that no valid values can be obtained.
String	getEncryptKey() Get Base64-encoded white-box encryption key
String	getKeyId() Get Globally unique white-box key ID
Long	getOwnerUin() Get Creator
String	getResourceId() Get Resource ID in the format of `creatorUin/$creatorUin/$keyId`
String	getStatus() Get White-box key status.
void	setAlgorithm(String Algorithm) Set Key algorithm type
void	setAlias(String Alias) Set Unique alias that makes a key more recognizable and understandable.
void	setCreateTime(Long CreateTime) Set Key creation time in Unix timestamp
void	setCreatorUin(Long CreatorUin) Set Creator
void	setDecryptKey(String DecryptKey) Set Base64-encoded white-box decryption key
void	setDescription(String Description) Set Key description information
void	setDeviceFingerprintBind(Boolean DeviceFingerprintBind) Set Whether there is a device fingerprint bound to the current key Note: this field may return null, indicating that no valid values can be obtained.
void	setEncryptKey(String EncryptKey) Set Base64-encoded white-box encryption key
void	setKeyId(String KeyId) Set Globally unique white-box key ID
void	setOwnerUin(Long OwnerUin) Set Creator
void	setResourceId(String ResourceId) Set Resource ID in the format of `creatorUin/$creatorUin/$keyId`
void	setStatus(String Status) Set White-box key status.
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

WhiteboxKeyInfo

public WhiteboxKeyInfo()

WhiteboxKeyInfo

public WhiteboxKeyInfo(WhiteboxKeyInfo 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 white-box key ID

Returns:

KeyId Globally unique white-box key ID

setKeyId

public void setKeyId(String KeyId)

Set Globally unique white-box key ID

Parameters:

KeyId - Globally unique white-box key ID

getAlias

public String getAlias()

Get Unique alias that makes a key more recognizable and understandable. This parameter cannot be empty, can contain 1 to 60 letters, digits, hyphens (-), and underscores (_), and must begin with a letter or digit.

Returns:

Alias Unique alias that makes a key more recognizable and understandable. This parameter cannot be empty, can contain 1 to 60 letters, digits, hyphens (-), and underscores (_), and must begin with a letter or digit.

setAlias

public void setAlias(String Alias)

Set Unique alias that makes a key more recognizable and understandable. This parameter cannot be empty, can contain 1 to 60 letters, digits, hyphens (-), and underscores (_), and must begin with a letter or digit.

Parameters:

Alias - Unique alias that makes a key more recognizable and understandable. This parameter cannot be empty, can contain 1 to 60 letters, digits, hyphens (-), and underscores (_), and must begin with a letter or digit.

getCreatorUin

public Long getCreatorUin()

Get Creator

Returns:

CreatorUin Creator

setCreatorUin

public void setCreatorUin(Long CreatorUin)

Set Creator

Parameters:

CreatorUin - Creator

getDescription

public String getDescription()

Get Key description information

Returns:

Description Key description information

setDescription

public void setDescription(String Description)

Set Key description information

Parameters:

Description - Key description information

getCreateTime

public Long getCreateTime()

Get Key creation time in Unix timestamp

Returns:

CreateTime Key creation time in Unix timestamp

setCreateTime

public void setCreateTime(Long CreateTime)

Set Key creation time in Unix timestamp

Parameters:

CreateTime - Key creation time in Unix timestamp

getStatus

public String getStatus()

Get White-box key status. Valid values: Enabled, Disabled

Returns:

Status White-box key status. Valid values: Enabled, Disabled

setStatus

public void setStatus(String Status)

Set White-box key status. Valid values: Enabled, Disabled

Parameters:

Status - White-box key status. Valid values: Enabled, Disabled

getOwnerUin

public Long getOwnerUin()

Get Creator

Returns:

OwnerUin Creator

setOwnerUin

public void setOwnerUin(Long OwnerUin)

Set Creator

Parameters:

OwnerUin - Creator

getAlgorithm

public String getAlgorithm()

Get Key algorithm type

Returns:

Algorithm Key algorithm type

setAlgorithm

public void setAlgorithm(String Algorithm)

Set Key algorithm type

Parameters:

Algorithm - Key algorithm type

getEncryptKey

public String getEncryptKey()

Get Base64-encoded white-box encryption key

Returns:

EncryptKey Base64-encoded white-box encryption key

setEncryptKey

public void setEncryptKey(String EncryptKey)

Set Base64-encoded white-box encryption key

Parameters:

EncryptKey - Base64-encoded white-box encryption key

getDecryptKey

public String getDecryptKey()

Get Base64-encoded white-box decryption key

Returns:

DecryptKey Base64-encoded white-box decryption key

setDecryptKey

public void setDecryptKey(String DecryptKey)

Set Base64-encoded white-box decryption key

Parameters:

DecryptKey - Base64-encoded white-box decryption key

getResourceId

public String getResourceId()

Get Resource ID in the format of `creatorUin/$creatorUin/$keyId`

Returns:

ResourceId Resource ID in the format of `creatorUin/$creatorUin/$keyId`

setResourceId

public void setResourceId(String ResourceId)

Set Resource ID in the format of `creatorUin/$creatorUin/$keyId`

Parameters:

ResourceId - Resource ID in the format of `creatorUin/$creatorUin/$keyId`

getDeviceFingerprintBind

public Boolean getDeviceFingerprintBind()

Get Whether there is a device fingerprint bound to the current key Note: this field may return null, indicating that no valid values can be obtained.

Returns:

DeviceFingerprintBind Whether there is a device fingerprint bound to the current key Note: this field may return null, indicating that no valid values can be obtained.

setDeviceFingerprintBind

public void setDeviceFingerprintBind(Boolean DeviceFingerprintBind)

Set Whether there is a device fingerprint bound to the current key Note: this field may return null, indicating that no valid values can be obtained.

Parameters:

DeviceFingerprintBind - Whether there is a device fingerprint bound to the current key Note: this field may return null, indicating that no valid values can be obtained.

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel