com.tencentcloudapi.kms.v20190118.models

Class KeyMetadata

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.kms.v20190118.models.KeyMetadata

public class KeyMetadata
extends AbstractModel

Constructor Summary

Constructors

Constructor and Description
KeyMetadata()

Method Summary

Modifier and Type	Method and Description
String	getAlias() Get
Long	getCreateTime() Get
Long	getCreatorUin() Get
Long	getDeletionDate() Get
String	getDescription() Get
String	getKeyId() Get
Boolean	getKeyRotationEnabled() Get
String	getKeyState() Get CMK status.
String	getKeyUsage() Get CMK purpose.
Long	getNextRotateTime() Get
String	getOrigin() Get CMK key material type.
String	getOwner() Get
String	getResourceId() Get Resource ID in the format of `creatorUin/$creatorUin/$keyId`.
Long	getType() Get CMK type.
Long	getValidTo() Get It's valid when `Origin` is `EXTERNAL`, indicating the expiration date of key material.
void	setAlias(String Alias) Set
void	setCreateTime(Long CreateTime) Set
void	setCreatorUin(Long CreatorUin) Set
void	setDeletionDate(Long DeletionDate) Set
void	setDescription(String Description) Set
void	setKeyId(String KeyId) Set
void	setKeyRotationEnabled(Boolean KeyRotationEnabled) Set
void	setKeyState(String KeyState) Set CMK status.
void	setKeyUsage(String KeyUsage) Set CMK purpose.
void	setNextRotateTime(Long NextRotateTime) Set
void	setOrigin(String Origin) Set CMK key material type.
void	setOwner(String Owner) Set
void	setResourceId(String ResourceId) Set Resource ID in the format of `creatorUin/$creatorUin/$keyId`.
void	setType(Long Type) Set CMK type.
void	setValidTo(Long ValidTo) Set It's valid when `Origin` is `EXTERNAL`, indicating the expiration date of key material.
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

KeyMetadata

public KeyMetadata()

Method Detail

getKeyId

public String getKeyId()

Get

Returns:

KeyId

setKeyId

public void setKeyId(String KeyId)

Set

Parameters:

KeyId -

getAlias

public String getAlias()

Get

Returns:

Alias

setAlias

public void setAlias(String Alias)

Set

Parameters:

Alias -

getCreateTime

public Long getCreateTime()

Get

Returns:

CreateTime

setCreateTime

public void setCreateTime(Long CreateTime)

Set

Parameters:

CreateTime -

getDescription

public String getDescription()

Get

Returns:

Description

setDescription

public void setDescription(String Description)

Set

Parameters:

Description -

getKeyState

public String getKeyState()

Get CMK status. Valid values: Enabled, Disabled, PendingDelete, PendingImport.

Returns:

KeyState CMK status. Valid values: Enabled, Disabled, PendingDelete, PendingImport.

setKeyState

public void setKeyState(String KeyState)

Set CMK status. Valid values: Enabled, Disabled, PendingDelete, PendingImport.

Parameters:

KeyState - CMK status. Valid values: Enabled, Disabled, PendingDelete, PendingImport.

getKeyUsage

public String getKeyUsage()

Get CMK purpose. Valid values: ENCRYPT_DECRYPT, ASYMMETRIC_DECRYPT_RSA_2048, ASYMMETRIC_DECRYPT_SM2

Returns:

KeyUsage CMK purpose. Valid values: ENCRYPT_DECRYPT, ASYMMETRIC_DECRYPT_RSA_2048, ASYMMETRIC_DECRYPT_SM2

setKeyUsage

public void setKeyUsage(String KeyUsage)

Set CMK purpose. Valid values: ENCRYPT_DECRYPT, ASYMMETRIC_DECRYPT_RSA_2048, ASYMMETRIC_DECRYPT_SM2

Parameters:

KeyUsage - CMK purpose. Valid values: ENCRYPT_DECRYPT, ASYMMETRIC_DECRYPT_RSA_2048, ASYMMETRIC_DECRYPT_SM2

getType

public Long getType()

Get CMK type. 2: FIPS-compliant; 4: SM-CRYPTO

Returns:

Type CMK type. 2: FIPS-compliant; 4: SM-CRYPTO

setType

public void setType(Long Type)

Set CMK type. 2: FIPS-compliant; 4: SM-CRYPTO

Parameters:

Type - CMK type. 2: FIPS-compliant; 4: SM-CRYPTO

getCreatorUin

public Long getCreatorUin()

Get

Returns:

CreatorUin

setCreatorUin

public void setCreatorUin(Long CreatorUin)

Set

Parameters:

CreatorUin -

getKeyRotationEnabled

public Boolean getKeyRotationEnabled()

Get

Returns:

KeyRotationEnabled

setKeyRotationEnabled

public void setKeyRotationEnabled(Boolean KeyRotationEnabled)

Set

Parameters:

KeyRotationEnabled -

getOwner

public String getOwner()

Get

Returns:

Owner

setOwner

public void setOwner(String Owner)

Set

Parameters:

Owner -

getNextRotateTime

public Long getNextRotateTime()

Get

Returns:

NextRotateTime

setNextRotateTime

public void setNextRotateTime(Long NextRotateTime)

Set

Parameters:

NextRotateTime -

getDeletionDate

public Long getDeletionDate()

Get

Returns:

DeletionDate

setDeletionDate

public void setDeletionDate(Long DeletionDate)

Set

Parameters:

DeletionDate -

getOrigin

public String getOrigin()

Get CMK key material type. TENCENT_KMS: created by KMS; EXTERNAL: imported by user. Note: This field may return null, indicating that no valid values can be obtained.

Returns:

Origin CMK key material type. TENCENT_KMS: created by KMS; EXTERNAL: imported by user. Note: This field may return null, indicating that no valid values can be obtained.

setOrigin

public void setOrigin(String Origin)

Set CMK key material type. TENCENT_KMS: created by KMS; EXTERNAL: imported by user. Note: This field may return null, indicating that no valid values can be obtained.

Parameters:

Origin - CMK key material type. TENCENT_KMS: created by KMS; EXTERNAL: imported by user. Note: This field may return null, indicating that no valid values can be obtained.

getValidTo

public Long getValidTo()

Get It's valid when `Origin` is `EXTERNAL`, indicating the expiration date of key material. 0 means valid forever. Note: This field may return null, indicating that no valid values can be obtained.

Returns:

ValidTo It's valid when `Origin` is `EXTERNAL`, indicating the expiration date of key material. 0 means valid forever. Note: This field may return null, indicating that no valid values can be obtained.

setValidTo

public void setValidTo(Long ValidTo)

Set It's valid when `Origin` is `EXTERNAL`, indicating the expiration date of key material. 0 means valid forever. Note: This field may return null, indicating that no valid values can be obtained.

Parameters:

ValidTo - It's valid when `Origin` is `EXTERNAL`, indicating the expiration date of key material. 0 means valid forever. Note: This field may return null, indicating that no valid values can be obtained.

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`.

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel