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

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

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 The time when scheduled deletion occurs.
String	getDescription() Get CMK description
String	getHsmClusterId() Get HSM cluster ID (valid only for exclusive or managed version KMS service instances).
Long	getIsSyncReplica() Get Specifies whether the key is a primary replica.
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	getLastRotateTime() Get Last disorderly rotation time (Unix timestamp).
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	getRotateDays() Get Key rotation period (days).
String	getSourceHsmClusterId() Get Synchronous original cluster.
String	getSourceRegion() Get Synchronous original region.
Long	getSyncEndTime() Get Specifies the synchronous end time.
String	getSyncMessages() Get Describes the synchronous result.
Long	getSyncStartTime() Get Start time of synchronization.
Long	getSyncStatus() Get The state of key synchronization.
Long	getType() Get CMK type.
Long	getValidTo() Get Valid when Origin is EXTERNAL.
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 The time when scheduled deletion occurs.
void	setDescription(String Description) Set CMK description
void	setHsmClusterId(String HsmClusterId) Set HSM cluster ID (valid only for exclusive or managed version KMS service instances).
void	setIsSyncReplica(Long IsSyncReplica) Set Specifies whether the key is a primary replica.
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	setLastRotateTime(Long LastRotateTime) Set Last disorderly rotation time (Unix timestamp).
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	setRotateDays(Long RotateDays) Set Key rotation period (days).
void	setSourceHsmClusterId(String SourceHsmClusterId) Set Synchronous original cluster.
void	setSourceRegion(String SourceRegion) Set Synchronous original region.
void	setSyncEndTime(Long SyncEndTime) Set Specifies the synchronous end time.
void	setSyncMessages(String SyncMessages) Set Describes the synchronous result.
void	setSyncStartTime(Long SyncStartTime) Set Start time of synchronization.
void	setSyncStatus(Long SyncStatus) Set The state of key synchronization.
void	setType(Long Type) Set CMK type.
void	setValidTo(Long ValidTo) Set Valid when Origin is EXTERNAL.
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

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 The time when scheduled deletion occurs.

Returns:

DeletionDate The time when scheduled deletion occurs.

setDeletionDate

public void setDeletionDate(Long DeletionDate)

Set The time when scheduled deletion occurs.

Parameters:

DeletionDate - The time when scheduled deletion occurs.

getOrigin

public String getOrigin()

Get CMK key material type. the type created by KMS is TENCENT_KMS. the user-imported type is EXTERNAL.

Returns:

Origin CMK key material type. the type created by KMS is TENCENT_KMS. the user-imported type is EXTERNAL.

setOrigin

public void setOrigin(String Origin)

Set CMK key material type. the type created by KMS is TENCENT_KMS. the user-imported type is EXTERNAL.

Parameters:

Origin - CMK key material type. the type created by KMS is TENCENT_KMS. the user-imported type is EXTERNAL.

getValidTo

public Long getValidTo()

Get Valid when Origin is EXTERNAL. indicates the validity date of the key material. 0 means no expiration.

Returns:

ValidTo Valid when Origin is EXTERNAL. indicates the validity date of the key material. 0 means no expiration.

setValidTo

public void setValidTo(Long ValidTo)

Set Valid when Origin is EXTERNAL. indicates the validity date of the key material. 0 means no expiration.

Parameters:

ValidTo - Valid when Origin is EXTERNAL. indicates the validity date of the key material. 0 means no expiration.

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 HSM cluster ID (valid only for exclusive or managed version KMS service instances).

Returns:

HsmClusterId HSM cluster ID (valid only for exclusive or managed version KMS service instances).

setHsmClusterId

public void setHsmClusterId(String HsmClusterId)

Set HSM cluster ID (valid only for exclusive or managed version KMS service instances).

Parameters:

HsmClusterId - HSM cluster ID (valid only for exclusive or managed version KMS service instances).

getRotateDays

public Long getRotateDays()

Get Key rotation period (days).

Returns:

RotateDays Key rotation period (days).

setRotateDays

public void setRotateDays(Long RotateDays)

Set Key rotation period (days).

Parameters:

RotateDays - Key rotation period (days).

getLastRotateTime

public Long getLastRotateTime()

Get Last disorderly rotation time (Unix timestamp).

Returns:

LastRotateTime Last disorderly rotation time (Unix timestamp).

setLastRotateTime

public void setLastRotateTime(Long LastRotateTime)

Set Last disorderly rotation time (Unix timestamp).

Parameters:

LastRotateTime - Last disorderly rotation time (Unix timestamp).

getIsSyncReplica

public Long getIsSyncReplica()

Get Specifies whether the key is a primary replica. valid values: 0 (primary replica), 1 (synced replica).

Returns:

IsSyncReplica Specifies whether the key is a primary replica. valid values: 0 (primary replica), 1 (synced replica).

setIsSyncReplica

public void setIsSyncReplica(Long IsSyncReplica)

Set Specifies whether the key is a primary replica. valid values: 0 (primary replica), 1 (synced replica).

Parameters:

IsSyncReplica - Specifies whether the key is a primary replica. valid values: 0 (primary replica), 1 (synced replica).

getSourceRegion

public String getSourceRegion()

Get Synchronous original region.

Returns:

SourceRegion Synchronous original region.

setSourceRegion

public void setSourceRegion(String SourceRegion)

Set Synchronous original region.

Parameters:

SourceRegion - Synchronous original region.

getSyncStatus

public Long getSyncStatus()

Get The state of key synchronization. valid values: 0 (unsynced), 1 (synchronization successful), 2 (synchronization failed), 3 (synchronizing).

Returns:

SyncStatus The state of key synchronization. valid values: 0 (unsynced), 1 (synchronization successful), 2 (synchronization failed), 3 (synchronizing).

setSyncStatus

public void setSyncStatus(Long SyncStatus)

Set The state of key synchronization. valid values: 0 (unsynced), 1 (synchronization successful), 2 (synchronization failed), 3 (synchronizing).

Parameters:

SyncStatus - The state of key synchronization. valid values: 0 (unsynced), 1 (synchronization successful), 2 (synchronization failed), 3 (synchronizing).

getSyncMessages

public String getSyncMessages()

Get Describes the synchronous result.

Returns:

SyncMessages Describes the synchronous result.

setSyncMessages

public void setSyncMessages(String SyncMessages)

Set Describes the synchronous result.

Parameters:

SyncMessages - Describes the synchronous result.

getSyncStartTime

public Long getSyncStartTime()

Get Start time of synchronization.

Returns:

SyncStartTime Start time of synchronization.

setSyncStartTime

public void setSyncStartTime(Long SyncStartTime)

Set Start time of synchronization.

Parameters:

SyncStartTime - Start time of synchronization.

getSyncEndTime

public Long getSyncEndTime()

Get Specifies the synchronous end time.

Returns:

SyncEndTime Specifies the synchronous end time.

setSyncEndTime

public void setSyncEndTime(Long SyncEndTime)

Set Specifies the synchronous end time.

Parameters:

SyncEndTime - Specifies the synchronous end time.

getSourceHsmClusterId

public String getSourceHsmClusterId()

Get Synchronous original cluster. if empty, it is a public cloud public cluster.

Returns:

SourceHsmClusterId Synchronous original cluster. if empty, it is a public cloud public cluster.

setSourceHsmClusterId

public void setSourceHsmClusterId(String SourceHsmClusterId)

Set Synchronous original cluster. if empty, it is a public cloud public cluster.

Parameters:

SourceHsmClusterId - Synchronous original cluster. if empty, it is a public cloud public cluster.

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.