com.tencentcloudapi.kms.v20190118.models

Class ListDataKeysRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.kms.v20190118.models.ListDataKeysRequest

public class ListDataKeysRequest
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
ListDataKeysRequest()
ListDataKeysRequest(ListDataKeysRequest 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	getHsmClusterId() Get HSM cluster ID corresponding to KMS advanced edition (only applicable to KMS exclusive/managed service instance).
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	getRole() Get Filter criteria based on the creator role.
void	setHsmClusterId(String HsmClusterId) Set HSM cluster ID corresponding to KMS advanced edition (only applicable to KMS exclusive/managed service instance).
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	setRole(Long Role) Set Filter criteria based on the creator role.
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

ListDataKeysRequest

public ListDataKeysRequest()

ListDataKeysRequest

public ListDataKeysRequest(ListDataKeysRequest 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 criteria based on the creator role. default 0 means data key created by oneself, 1 means data key automatically created by other cloud services.

Returns:

Role Filter criteria based on the creator role. default 0 means data key created by oneself, 1 means data key automatically created by other cloud services.

setRole

public void setRole(Long Role)

Set Filter criteria based on the creator role. default 0 means data key created by oneself, 1 means data key automatically created by other cloud services.

Parameters:

Role - Filter criteria based on the creator role. default 0 means data key created by oneself, 1 means data key automatically created by other cloud services.

getHsmClusterId

public String getHsmClusterId()

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

Returns:

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

setHsmClusterId

public void setHsmClusterId(String HsmClusterId)

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

Parameters:

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

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.