com.tencentcloudapi.kms.v20190118.models

Class ListDataKeyDetailRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.kms.v20190118.models.ListDataKeyDetailRequest

public class ListDataKeyDetailRequest
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
ListDataKeyDetailRequest()
ListDataKeyDetailRequest(ListDataKeyDetailRequest 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	getDataKeyLen() Get 数据密钥的长度
String	getHsmClusterId() Get KMS 高级版对应的 HSM 集群 ID。
String	getKeyId() Get 根密钥全局唯一标识符
Long	getKeyState() Get 根据DataKey状态筛选， 0表示全部DataKey， 1 表示仅查询Enabled DataKey， 2 表示仅查询Disabled DataKey，3 表示查询PendingDelete 状态的DataKey(处于计划删除状态的Key)。
Long	getLimit() Get 含义跟 SQL 查询的 Limit 一致，表示本次最多获取 Limit 个元素。缺省值为10，最大值为200
Long	getOffset() Get 含义跟 SQL 查询的 Offset 一致，表示本次获取从按一定顺序排列数组的第 Offset 个元素开始，缺省为0
Long	getOrderType() Get 根据DataKey创建时间排序， 0 表示按照降序排序，1表示按照升序排序
String	getOrigin() Get 根据DateKey类型筛选， "TENCENT_KMS" 表示筛选密钥材料由KMS创建的数据密钥， "EXTERNAL" 表示筛选密钥材料需要用户导入的 EXTERNAL类型数据密钥，"ALL" 或者不设置表示两种类型都查询，大小写敏感。
Long	getRole() Get 根据创建者角色筛选，默认 0 表示用户自己创建的数据密钥， 1 表示授权其它云产品自动创建的数据密钥
String	getSearchKeyAlias() Get 根据DataKeyId或者DataKeyName进行模糊匹配查询
void	setDataKeyLen(Long DataKeyLen) Set 数据密钥的长度
void	setHsmClusterId(String HsmClusterId) Set KMS 高级版对应的 HSM 集群 ID。
void	setKeyId(String KeyId) Set 根密钥全局唯一标识符
void	setKeyState(Long KeyState) Set 根据DataKey状态筛选， 0表示全部DataKey， 1 表示仅查询Enabled DataKey， 2 表示仅查询Disabled DataKey，3 表示查询PendingDelete 状态的DataKey(处于计划删除状态的Key)。
void	setLimit(Long Limit) Set 含义跟 SQL 查询的 Limit 一致，表示本次最多获取 Limit 个元素。缺省值为10，最大值为200
void	setOffset(Long Offset) Set 含义跟 SQL 查询的 Offset 一致，表示本次获取从按一定顺序排列数组的第 Offset 个元素开始，缺省为0
void	setOrderType(Long OrderType) Set 根据DataKey创建时间排序， 0 表示按照降序排序，1表示按照升序排序
void	setOrigin(String Origin) Set 根据DateKey类型筛选， "TENCENT_KMS" 表示筛选密钥材料由KMS创建的数据密钥， "EXTERNAL" 表示筛选密钥材料需要用户导入的 EXTERNAL类型数据密钥，"ALL" 或者不设置表示两种类型都查询，大小写敏感。
void	setRole(Long Role) Set 根据创建者角色筛选，默认 0 表示用户自己创建的数据密钥， 1 表示授权其它云产品自动创建的数据密钥
void	setSearchKeyAlias(String SearchKeyAlias) Set 根据DataKeyId或者DataKeyName进行模糊匹配查询
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

ListDataKeyDetailRequest

public ListDataKeyDetailRequest()

ListDataKeyDetailRequest

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

getOffset

public Long getOffset()

Get 含义跟 SQL 查询的 Offset 一致，表示本次获取从按一定顺序排列数组的第 Offset 个元素开始，缺省为0

Returns:

Offset 含义跟 SQL 查询的 Offset 一致，表示本次获取从按一定顺序排列数组的第 Offset 个元素开始，缺省为0

setOffset

public void setOffset(Long Offset)

Set 含义跟 SQL 查询的 Offset 一致，表示本次获取从按一定顺序排列数组的第 Offset 个元素开始，缺省为0

Parameters:

Offset - 含义跟 SQL 查询的 Offset 一致，表示本次获取从按一定顺序排列数组的第 Offset 个元素开始，缺省为0

getLimit

public Long getLimit()

Get 含义跟 SQL 查询的 Limit 一致，表示本次最多获取 Limit 个元素。缺省值为10，最大值为200

Returns:

Limit 含义跟 SQL 查询的 Limit 一致，表示本次最多获取 Limit 个元素。缺省值为10，最大值为200

setLimit

public void setLimit(Long Limit)

Set 含义跟 SQL 查询的 Limit 一致，表示本次最多获取 Limit 个元素。缺省值为10，最大值为200

Parameters:

Limit - 含义跟 SQL 查询的 Limit 一致，表示本次最多获取 Limit 个元素。缺省值为10，最大值为200

getRole

public Long getRole()

Get 根据创建者角色筛选，默认 0 表示用户自己创建的数据密钥， 1 表示授权其它云产品自动创建的数据密钥

Returns:

Role 根据创建者角色筛选，默认 0 表示用户自己创建的数据密钥， 1 表示授权其它云产品自动创建的数据密钥

setRole

public void setRole(Long Role)

Set 根据创建者角色筛选，默认 0 表示用户自己创建的数据密钥， 1 表示授权其它云产品自动创建的数据密钥

Parameters:

Role - 根据创建者角色筛选，默认 0 表示用户自己创建的数据密钥， 1 表示授权其它云产品自动创建的数据密钥

getOrderType

public Long getOrderType()

Get 根据DataKey创建时间排序， 0 表示按照降序排序，1表示按照升序排序

Returns:

OrderType 根据DataKey创建时间排序， 0 表示按照降序排序，1表示按照升序排序

setOrderType

public void setOrderType(Long OrderType)

Set 根据DataKey创建时间排序， 0 表示按照降序排序，1表示按照升序排序

Parameters:

OrderType - 根据DataKey创建时间排序， 0 表示按照降序排序，1表示按照升序排序

getKeyState

public Long getKeyState()

Get 根据DataKey状态筛选， 0表示全部DataKey， 1 表示仅查询Enabled DataKey， 2 表示仅查询Disabled DataKey，3 表示查询PendingDelete 状态的DataKey(处于计划删除状态的Key)。

Returns:

KeyState 根据DataKey状态筛选， 0表示全部DataKey， 1 表示仅查询Enabled DataKey， 2 表示仅查询Disabled DataKey，3 表示查询PendingDelete 状态的DataKey(处于计划删除状态的Key)。

setKeyState

public void setKeyState(Long KeyState)

Set 根据DataKey状态筛选， 0表示全部DataKey， 1 表示仅查询Enabled DataKey， 2 表示仅查询Disabled DataKey，3 表示查询PendingDelete 状态的DataKey(处于计划删除状态的Key)。

Parameters:

KeyState - 根据DataKey状态筛选， 0表示全部DataKey， 1 表示仅查询Enabled DataKey， 2 表示仅查询Disabled DataKey，3 表示查询PendingDelete 状态的DataKey(处于计划删除状态的Key)。

getSearchKeyAlias

public String getSearchKeyAlias()

Get 根据DataKeyId或者DataKeyName进行模糊匹配查询

Returns:

SearchKeyAlias 根据DataKeyId或者DataKeyName进行模糊匹配查询

setSearchKeyAlias

public void setSearchKeyAlias(String SearchKeyAlias)

Set 根据DataKeyId或者DataKeyName进行模糊匹配查询

Parameters:

SearchKeyAlias - 根据DataKeyId或者DataKeyName进行模糊匹配查询

getOrigin

public String getOrigin()

Get 根据DateKey类型筛选， "TENCENT_KMS" 表示筛选密钥材料由KMS创建的数据密钥， "EXTERNAL" 表示筛选密钥材料需要用户导入的 EXTERNAL类型数据密钥，"ALL" 或者不设置表示两种类型都查询，大小写敏感。

Returns:

Origin 根据DateKey类型筛选， "TENCENT_KMS" 表示筛选密钥材料由KMS创建的数据密钥， "EXTERNAL" 表示筛选密钥材料需要用户导入的 EXTERNAL类型数据密钥，"ALL" 或者不设置表示两种类型都查询，大小写敏感。

setOrigin

public void setOrigin(String Origin)

Set 根据DateKey类型筛选， "TENCENT_KMS" 表示筛选密钥材料由KMS创建的数据密钥， "EXTERNAL" 表示筛选密钥材料需要用户导入的 EXTERNAL类型数据密钥，"ALL" 或者不设置表示两种类型都查询，大小写敏感。

Parameters:

Origin - 根据DateKey类型筛选， "TENCENT_KMS" 表示筛选密钥材料由KMS创建的数据密钥， "EXTERNAL" 表示筛选密钥材料需要用户导入的 EXTERNAL类型数据密钥，"ALL" 或者不设置表示两种类型都查询，大小写敏感。

getHsmClusterId

public String getHsmClusterId()

Get KMS 高级版对应的 HSM 集群 ID。

Returns:

HsmClusterId KMS 高级版对应的 HSM 集群 ID。

setHsmClusterId

public void setHsmClusterId(String HsmClusterId)

Set KMS 高级版对应的 HSM 集群 ID。

Parameters:

HsmClusterId - KMS 高级版对应的 HSM 集群 ID。

getKeyId

public String getKeyId()

Get 根密钥全局唯一标识符

Returns:

KeyId 根密钥全局唯一标识符

setKeyId

public void setKeyId(String KeyId)

Set 根密钥全局唯一标识符

Parameters:

KeyId - 根密钥全局唯一标识符

getDataKeyLen

public Long getDataKeyLen()

Get 数据密钥的长度

Returns:

DataKeyLen 数据密钥的长度

setDataKeyLen

public void setDataKeyLen(Long DataKeyLen)

Set 数据密钥的长度

Parameters:

DataKeyLen - 数据密钥的长度

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.