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()
KeyMetadata(KeyMetadata 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	getAlias() Get Alias that makes a key more recognizable and understandable
Long	getCreateTime() Get Key creation time
Long	getCreatorUin() Get Creator
Long	getDeletionDate() Get Scheduled deletion time
String	getDescription() Get CMK description
String	getHsmClusterId() Get ID of the HSM cluster.
String	getKeyId() Get Globally unique CMK ID
Boolean	getKeyRotationEnabled() Get Whether key rotation is enabled
String	getKeyState() Get CMK status.
String	getKeyUsage() Get CMK purpose.
Long	getNextRotateTime() Get Time of next rotation if key rotation is enabled
String	getOrigin() Get CMK key material type.
String	getOwner() Get CMK creator.
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 Alias that makes a key more recognizable and understandable
void	setCreateTime(Long CreateTime) Set Key creation time
void	setCreatorUin(Long CreatorUin) Set Creator
void	setDeletionDate(Long DeletionDate) Set Scheduled deletion time
void	setDescription(String Description) Set CMK description
void	setHsmClusterId(String HsmClusterId) Set ID of the HSM cluster.
void	setKeyId(String KeyId) Set Globally unique CMK ID
void	setKeyRotationEnabled(Boolean KeyRotationEnabled) Set Whether key rotation is enabled
void	setKeyState(String KeyState) Set CMK status.
void	setKeyUsage(String KeyUsage) Set CMK purpose.
void	setNextRotateTime(Long NextRotateTime) Set Time of next rotation if key rotation is enabled
void	setOrigin(String Origin) Set CMK key material type.
void	setOwner(String Owner) Set CMK creator.
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()

KeyMetadata

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

getAlias

public String getAlias()

Get Alias that makes a key more recognizable and understandable

Returns:

Alias Alias that makes a key more recognizable and understandable

setAlias

public void setAlias(String Alias)

Set Alias that makes a key more recognizable and understandable

Parameters:

Alias - Alias that makes a key more recognizable and understandable

getCreateTime

public Long getCreateTime()

Get Key creation time

Returns:

CreateTime Key creation time

setCreateTime

public void setCreateTime(Long CreateTime)

Set Key creation time

Parameters:

CreateTime - Key creation time

getDescription

public String getDescription()

Get CMK description

Returns:

Description CMK description

setDescription

public void setDescription(String Description)

Set CMK description

Parameters:

Description - CMK description

getKeyState

public String getKeyState()

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

Returns:

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

setKeyState

public void setKeyState(String KeyState)

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

Parameters:

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

getKeyUsage

public String getKeyUsage()

Get CMK purpose. Valid values: `ENCRYPT_DECRYPT`, `ASYMMETRIC_DECRYPT_RSA_2048`, `ASYMMETRIC_DECRYPT_SM2`, `ASYMMETRIC_SIGN_VERIFY_SM2`, `ASYMMETRIC_SIGN_VERIFY_RSA_2048`, and `ASYMMETRIC_SIGN_VERIFY_ECC`.

Returns:

KeyUsage CMK purpose. Valid values: `ENCRYPT_DECRYPT`, `ASYMMETRIC_DECRYPT_RSA_2048`, `ASYMMETRIC_DECRYPT_SM2`, `ASYMMETRIC_SIGN_VERIFY_SM2`, `ASYMMETRIC_SIGN_VERIFY_RSA_2048`, and `ASYMMETRIC_SIGN_VERIFY_ECC`.

setKeyUsage

public void setKeyUsage(String KeyUsage)

Set CMK purpose. Valid values: `ENCRYPT_DECRYPT`, `ASYMMETRIC_DECRYPT_RSA_2048`, `ASYMMETRIC_DECRYPT_SM2`, `ASYMMETRIC_SIGN_VERIFY_SM2`, `ASYMMETRIC_SIGN_VERIFY_RSA_2048`, and `ASYMMETRIC_SIGN_VERIFY_ECC`.

Parameters:

KeyUsage - CMK purpose. Valid values: `ENCRYPT_DECRYPT`, `ASYMMETRIC_DECRYPT_RSA_2048`, `ASYMMETRIC_DECRYPT_SM2`, `ASYMMETRIC_SIGN_VERIFY_SM2`, `ASYMMETRIC_SIGN_VERIFY_RSA_2048`, and `ASYMMETRIC_SIGN_VERIFY_ECC`.

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 Creator

Returns:

CreatorUin Creator

setCreatorUin

public void setCreatorUin(Long CreatorUin)

Set Creator

Parameters:

CreatorUin - Creator

getKeyRotationEnabled

public Boolean getKeyRotationEnabled()

Get Whether key rotation is enabled

Returns:

KeyRotationEnabled Whether key rotation is enabled

setKeyRotationEnabled

public void setKeyRotationEnabled(Boolean KeyRotationEnabled)

Set Whether key rotation is enabled

Parameters:

KeyRotationEnabled - Whether key rotation is enabled

getOwner

public String getOwner()

Get CMK creator. The value of this parameter is `user` if the CMK is created by the user, or the corresponding service name if it is created automatically by an authorized Tencent Cloud service.

Returns:

Owner CMK creator. The value of this parameter is `user` if the CMK is created by the user, or the corresponding service name if it is created automatically by an authorized Tencent Cloud service.

setOwner

public void setOwner(String Owner)

Set CMK creator. The value of this parameter is `user` if the CMK is created by the user, or the corresponding service name if it is created automatically by an authorized Tencent Cloud service.

Parameters:

Owner - CMK creator. The value of this parameter is `user` if the CMK is created by the user, or the corresponding service name if it is created automatically by an authorized Tencent Cloud service.

getNextRotateTime

public Long getNextRotateTime()

Get Time of next rotation if key rotation is enabled

Returns:

NextRotateTime Time of next rotation if key rotation is enabled

setNextRotateTime

public void setNextRotateTime(Long NextRotateTime)

Set Time of next rotation if key rotation is enabled

Parameters:

NextRotateTime - Time of next rotation if key rotation is enabled

getDeletionDate

public Long getDeletionDate()

Get Scheduled deletion time

Returns:

DeletionDate Scheduled deletion time

setDeletionDate

public void setDeletionDate(Long DeletionDate)

Set Scheduled deletion time

Parameters:

DeletionDate - Scheduled deletion time

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

getHsmClusterId

public String getHsmClusterId()

Get ID of the HSM cluster. This field is only valid for Exclusive and Managed KMS instances. Note: This field may return `null`, indicating that no valid value can be obtained.

Returns:

HsmClusterId ID of the HSM cluster. This field is only valid for Exclusive and Managed KMS instances. Note: This field may return `null`, indicating that no valid value can be obtained.

setHsmClusterId

public void setHsmClusterId(String HsmClusterId)

Set ID of the HSM cluster. This field is only valid for Exclusive and Managed KMS instances. Note: This field may return `null`, indicating that no valid value can be obtained.

Parameters:

HsmClusterId - ID of the HSM cluster. This field is only valid for Exclusive and Managed KMS instances. Note: This field may return `null`, indicating that no valid value 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