com.tencentcloudapi.kms.v20190118.models

Class DataKeyMetadata

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.kms.v20190118.models.DataKeyMetadata

public class DataKeyMetadata
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
DataKeyMetadata()
DataKeyMetadata(DataKeyMetadata 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
Long	getCreateTime() Get Key key creation time.
Long	getCreatorUin() Get Creator.
String	getDataKeyId() Get DataKey globally unique id.
String	getDataKeyName() Get Key name as a more recognizable and understandable data key.
Long	getDeletionDate() Get The time when schedule deletion.
String	getDescription() Get DataKey description.
String	getHsmClusterId() Get HSM cluster ID (only applicable to KMS exclusive/managed service instance).
Long	getIsSyncReplica() Get Whether the key is a primary replica.
String	getKeyId() Get Globally unique id of the CMK.
String	getKeyState() Get DataKey status.
Long	getNumberOfBytes() Get Specifies the length of the data key in bytes.
String	getOrigin() Get Specifies the key material type of DataKey.
String	getOwner() Get Specifies the creator of the data key.
String	getResourceId() Get Resource ID in the format of `creatorUin/$creatorUin/$dataKeyId`.
String	getSourceHsmClusterId() Get Synchronous original cluster.
String	getSourceRegion() Get Synchronous original region.
Long	getSyncEndTime() Get Specifies the synchronous end time.
String	getSyncMessages() Get Sresult description}.
Long	getSyncStartTime() Get Start time of synchronization.
Long	getSyncStatus() Get The state of key synchronization.
void	setCreateTime(Long CreateTime) Set Key key creation time.
void	setCreatorUin(Long CreatorUin) Set Creator.
void	setDataKeyId(String DataKeyId) Set DataKey globally unique id.
void	setDataKeyName(String DataKeyName) Set Key name as a more recognizable and understandable data key.
void	setDeletionDate(Long DeletionDate) Set The time when schedule deletion.
void	setDescription(String Description) Set DataKey description.
void	setHsmClusterId(String HsmClusterId) Set HSM cluster ID (only applicable to KMS exclusive/managed service instance).
void	setIsSyncReplica(Long IsSyncReplica) Set Whether the key is a primary replica.
void	setKeyId(String KeyId) Set Globally unique id of the CMK.
void	setKeyState(String KeyState) Set DataKey status.
void	setNumberOfBytes(Long NumberOfBytes) Set Specifies the length of the data key in bytes.
void	setOrigin(String Origin) Set Specifies the key material type of DataKey.
void	setOwner(String Owner) Set Specifies the creator of the data key.
void	setResourceId(String ResourceId) Set Resource ID in the format of `creatorUin/$creatorUin/$dataKeyId`.
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 Sresult description}.
void	setSyncStartTime(Long SyncStartTime) Set Start time of synchronization.
void	setSyncStatus(Long SyncStatus) Set The state of key synchronization.
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, 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

DataKeyMetadata

public DataKeyMetadata()

DataKeyMetadata

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

getDataKeyId

public String getDataKeyId()

Get DataKey globally unique id.

Returns:

DataKeyId DataKey globally unique id.

setDataKeyId

public void setDataKeyId(String DataKeyId)

Set DataKey globally unique id.

Parameters:

DataKeyId - DataKey globally unique id.

getKeyId

public String getKeyId()

Get Globally unique id of the CMK.

Returns:

KeyId Globally unique id of the CMK.

setKeyId

public void setKeyId(String KeyId)

Set Globally unique id of the CMK.

Parameters:

KeyId - Globally unique id of the CMK.

getDataKeyName

public String getDataKeyName()

Get Key name as a more recognizable and understandable data key.

Returns:

DataKeyName Key name as a more recognizable and understandable data key.

setDataKeyName

public void setDataKeyName(String DataKeyName)

Set Key name as a more recognizable and understandable data key.

Parameters:

DataKeyName - Key name as a more recognizable and understandable data key.

getNumberOfBytes

public Long getNumberOfBytes()

Get Specifies the length of the data key in bytes.

Returns:

NumberOfBytes Specifies the length of the data key in bytes.

setNumberOfBytes

public void setNumberOfBytes(Long NumberOfBytes)

Set Specifies the length of the data key in bytes.

Parameters:

NumberOfBytes - Specifies the length of the data key in bytes.

getCreateTime

public Long getCreateTime()

Get Key key creation time.

Returns:

CreateTime Key key creation time.

setCreateTime

public void setCreateTime(Long CreateTime)

Set Key key creation time.

Parameters:

CreateTime - Key key creation time.

getDescription

public String getDescription()

Get DataKey description.

Returns:

Description DataKey description.

setDescription

public void setDescription(String Description)

Set DataKey description.

Parameters:

Description - DataKey description.

getKeyState

public String getKeyState()

Get DataKey status. valid values: Enabled, Disabled, PendingDelete.

Returns:

KeyState DataKey status. valid values: Enabled, Disabled, PendingDelete.

setKeyState

public void setKeyState(String KeyState)

Set DataKey status. valid values: Enabled, Disabled, PendingDelete.

Parameters:

KeyState - DataKey status. valid values: Enabled, Disabled, PendingDelete.

getCreatorUin

public Long getCreatorUin()

Get Creator.

Returns:

CreatorUin Creator.

setCreatorUin

public void setCreatorUin(Long CreatorUin)

Set Creator.

Parameters:

CreatorUin - Creator.

getOwner

public String getOwner()

Get Specifies the creator of the data key. valid values: user (user-created) or product name (auto-created by authorized cloud services).

Returns:

Owner Specifies the creator of the data key. valid values: user (user-created) or product name (auto-created by authorized cloud services).

setOwner

public void setOwner(String Owner)

Set Specifies the creator of the data key. valid values: user (user-created) or product name (auto-created by authorized cloud services).

Parameters:

Owner - Specifies the creator of the data key. valid values: user (user-created) or product name (auto-created by authorized cloud services).

getDeletionDate

public Long getDeletionDate()

Get The time when schedule deletion.

Returns:

DeletionDate The time when schedule deletion.

setDeletionDate

public void setDeletionDate(Long DeletionDate)

Set The time when schedule deletion.

Parameters:

DeletionDate - The time when schedule deletion.

getOrigin

public String getOrigin()

Get Specifies the key material type of DataKey. valid values: TENCENT_KMS (created by KMS), EXTERNAL (user import).

Returns:

Origin Specifies the key material type of DataKey. valid values: TENCENT_KMS (created by KMS), EXTERNAL (user import).

setOrigin

public void setOrigin(String Origin)

Set Specifies the key material type of DataKey. valid values: TENCENT_KMS (created by KMS), EXTERNAL (user import).

Parameters:

Origin - Specifies the key material type of DataKey. valid values: TENCENT_KMS (created by KMS), EXTERNAL (user import).

getHsmClusterId

public String getHsmClusterId()

Get HSM cluster ID (only applicable to KMS exclusive/managed service instance).

Returns:

HsmClusterId HSM cluster ID (only applicable to KMS exclusive/managed service instance).

setHsmClusterId

public void setHsmClusterId(String HsmClusterId)

Set HSM cluster ID (only applicable to KMS exclusive/managed service instance).

Parameters:

HsmClusterId - HSM cluster ID (only applicable to KMS exclusive/managed service instance).

getResourceId

public String getResourceId()

Get Resource ID in the format of `creatorUin/$creatorUin/$dataKeyId`.

Returns:

ResourceId Resource ID in the format of `creatorUin/$creatorUin/$dataKeyId`.

setResourceId

public void setResourceId(String ResourceId)

Set Resource ID in the format of `creatorUin/$creatorUin/$dataKeyId`.

Parameters:

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

getIsSyncReplica

public Long getIsSyncReplica()

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

Returns:

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

setIsSyncReplica

public void setIsSyncReplica(Long IsSyncReplica)

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

Parameters:

IsSyncReplica - Whether the key is a primary replica. valid values: `0` (primary), `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 Sresult description}.

Returns:

SyncMessages Sresult description}.

setSyncMessages

public void setSyncMessages(String SyncMessages)

Set Sresult description}.

Parameters:

SyncMessages - Sresult description}.

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