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 Length of the data key.
String	getHsmClusterId() Get HSM cluster ID corresponding to KMS advanced edition.
String	getKeyId() Get Specifies the globally unique identifier of the root key.
Long	getKeyState() Get Filter based on DataKey state.
Long	getLimit() Get Specifies the maximum number of elements to retrieve, same as the Limit in SQL queries.
Long	getOffset() Get Meaning matches the Offset in SQL queries, indicates the retrieval starts from the Offset-th element in a sequentially arranged array, defaults to 0.
Long	getOrderType() Get Sorts according to the creation time of DataKey.
String	getOrigin() Get Filters data keys by DateKey type.
Long	getRole() Get Filter by creator role.
String	getSearchKeyAlias() Get Performs a fuzzy match query based on DataKeyId or DataKeyName.
void	setDataKeyLen(Long DataKeyLen) Set Length of the data key.
void	setHsmClusterId(String HsmClusterId) Set HSM cluster ID corresponding to KMS advanced edition.
void	setKeyId(String KeyId) Set Specifies the globally unique identifier of the root key.
void	setKeyState(Long KeyState) Set Filter based on DataKey state.
void	setLimit(Long Limit) Set Specifies the maximum number of elements to retrieve, same as the Limit in SQL queries.
void	setOffset(Long Offset) Set Meaning matches the Offset in SQL queries, indicates the retrieval starts from the Offset-th element in a sequentially arranged array, defaults to 0.
void	setOrderType(Long OrderType) Set Sorts according to the creation time of DataKey.
void	setOrigin(String Origin) Set Filters data keys by DateKey type.
void	setRole(Long Role) Set Filter by creator role.
void	setSearchKeyAlias(String SearchKeyAlias) Set Performs a fuzzy match query based on DataKeyId or 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 Meaning matches the Offset in SQL queries, indicates the retrieval starts from the Offset-th element in a sequentially arranged array, defaults to 0.

Returns:

Offset Meaning matches the Offset in SQL queries, indicates the retrieval starts from the Offset-th element in a sequentially arranged array, defaults to 0.

setOffset

public void setOffset(Long Offset)

Set Meaning matches the Offset in SQL queries, indicates the retrieval starts from the Offset-th element in a sequentially arranged array, defaults to 0.

Parameters:

Offset - Meaning matches the Offset in SQL queries, indicates the retrieval starts from the Offset-th element in a sequentially arranged array, defaults to 0.

getLimit

public Long getLimit()

Get Specifies the maximum number of elements to retrieve, same as the Limit in SQL queries. default value is 10. maximum value is 200.

Returns:

Limit Specifies the maximum number of elements to retrieve, same as the Limit in SQL queries. default value is 10. maximum value is 200.

setLimit

public void setLimit(Long Limit)

Set Specifies the maximum number of elements to retrieve, same as the Limit in SQL queries. default value is 10. maximum value is 200.

Parameters:

Limit - Specifies the maximum number of elements to retrieve, same as the Limit in SQL queries. default value is 10. maximum value is 200.

getRole

public Long getRole()

Get Filter by creator role. default 0 means data keys created by the user, 1 means data keys automatically created by authorized cloud services.

Returns:

Role Filter by creator role. default 0 means data keys created by the user, 1 means data keys automatically created by authorized cloud services.

setRole

public void setRole(Long Role)

Set Filter by creator role. default 0 means data keys created by the user, 1 means data keys automatically created by authorized cloud services.

Parameters:

Role - Filter by creator role. default 0 means data keys created by the user, 1 means data keys automatically created by authorized cloud services.

getOrderType

public Long getOrderType()

Get Sorts according to the creation time of DataKey. 0 indicates descending sort. 1 indicates ascending sort.

Returns:

OrderType Sorts according to the creation time of DataKey. 0 indicates descending sort. 1 indicates ascending sort.

setOrderType

public void setOrderType(Long OrderType)

Set Sorts according to the creation time of DataKey. 0 indicates descending sort. 1 indicates ascending sort.

Parameters:

OrderType - Sorts according to the creation time of DataKey. 0 indicates descending sort. 1 indicates ascending sort.

getKeyState

public Long getKeyState()

Get Filter based on DataKey state. 0 means all datakeys, 1 means querying only Enabled datakeys, 2 means querying only Disabled datakeys, 3 means querying datakeys in PendingDelete state (keys in scheduled deletion status).

Returns:

KeyState Filter based on DataKey state. 0 means all datakeys, 1 means querying only Enabled datakeys, 2 means querying only Disabled datakeys, 3 means querying datakeys in PendingDelete state (keys in scheduled deletion status).

setKeyState

public void setKeyState(Long KeyState)

Set Filter based on DataKey state. 0 means all datakeys, 1 means querying only Enabled datakeys, 2 means querying only Disabled datakeys, 3 means querying datakeys in PendingDelete state (keys in scheduled deletion status).

Parameters:

KeyState - Filter based on DataKey state. 0 means all datakeys, 1 means querying only Enabled datakeys, 2 means querying only Disabled datakeys, 3 means querying datakeys in PendingDelete state (keys in scheduled deletion status).

getSearchKeyAlias

public String getSearchKeyAlias()

Get Performs a fuzzy match query based on DataKeyId or DataKeyName.

Returns:

SearchKeyAlias Performs a fuzzy match query based on DataKeyId or DataKeyName.

setSearchKeyAlias

public void setSearchKeyAlias(String SearchKeyAlias)

Set Performs a fuzzy match query based on DataKeyId or DataKeyName.

Parameters:

SearchKeyAlias - Performs a fuzzy match query based on DataKeyId or DataKeyName.

getOrigin

public String getOrigin()

Get Filters data keys by DateKey type. "TENCENT_KMS" filters data keys with key material created by KMS. "EXTERNAL" filters EXTERNAL type data keys requiring user-imported key material. "ALL" or leave unset queries both types. case-sensitive.

Returns:

Origin Filters data keys by DateKey type. "TENCENT_KMS" filters data keys with key material created by KMS. "EXTERNAL" filters EXTERNAL type data keys requiring user-imported key material. "ALL" or leave unset queries both types. case-sensitive.

setOrigin

public void setOrigin(String Origin)

Set Filters data keys by DateKey type. "TENCENT_KMS" filters data keys with key material created by KMS. "EXTERNAL" filters EXTERNAL type data keys requiring user-imported key material. "ALL" or leave unset queries both types. case-sensitive.

Parameters:

Origin - Filters data keys by DateKey type. "TENCENT_KMS" filters data keys with key material created by KMS. "EXTERNAL" filters EXTERNAL type data keys requiring user-imported key material. "ALL" or leave unset queries both types. case-sensitive.

getHsmClusterId

public String getHsmClusterId()

Get HSM cluster ID corresponding to KMS advanced edition.

Returns:

HsmClusterId HSM cluster ID corresponding to KMS advanced edition.

setHsmClusterId

public void setHsmClusterId(String HsmClusterId)

Set HSM cluster ID corresponding to KMS advanced edition.

Parameters:

HsmClusterId - HSM cluster ID corresponding to KMS advanced edition.

getKeyId

public String getKeyId()

Get Specifies the globally unique identifier of the root key.

Returns:

KeyId Specifies the globally unique identifier of the root key.

setKeyId

public void setKeyId(String KeyId)

Set Specifies the globally unique identifier of the root key.

Parameters:

KeyId - Specifies the globally unique identifier of the root key.

getDataKeyLen

public Long getDataKeyLen()

Get Length of the data key.

Returns:

DataKeyLen Length of the data key.

setDataKeyLen

public void setDataKeyLen(Long DataKeyLen)

Set Length of the data key.

Parameters:

DataKeyLen - Length of the data key.

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.