com.tencentcloudapi.kms.v20190118.models

Class ListKeyDetailRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.kms.v20190118.models.ListKeyDetailRequest

public class ListKeyDetailRequest
extends AbstractModel

Constructor Summary

Constructors

Constructor and Description
ListKeyDetailRequest()
ListKeyDetailRequest(ListKeyDetailRequest 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 ID of the HSM cluster.
Long	getKeyState() Get Filters by CMK status.
String	getKeyUsage() Get Filters by the `KeyUsage` field value.
Long	getLimit() Get This parameter has the same meaning of the `Limit` in an SQL query, indicating that up to `Limit` value elements can be obtained in this request.
Long	getOffset() Get This parameter has the same meaning of the `Offset` in an SQL query, indicating that this acquisition starts from the "No.
Long	getOrderType() Get Sorts by CMK creation time.
String	getOrigin() Get Filters by CMK type.
Long	getRole() Get Filters by creator role.
String	getSearchKeyAlias() Get Performs a fuzzy query by `KeyId` or `Alias`
TagFilter[]	getTagFilters() Get Tag filter condition
void	setHsmClusterId(String HsmClusterId) Set ID of the HSM cluster.
void	setKeyState(Long KeyState) Set Filters by CMK status.
void	setKeyUsage(String KeyUsage) Set Filters by the `KeyUsage` field value.
void	setLimit(Long Limit) Set This parameter has the same meaning of the `Limit` in an SQL query, indicating that up to `Limit` value elements can be obtained in this request.
void	setOffset(Long Offset) Set This parameter has the same meaning of the `Offset` in an SQL query, indicating that this acquisition starts from the "No.
void	setOrderType(Long OrderType) Set Sorts by CMK creation time.
void	setOrigin(String Origin) Set Filters by CMK type.
void	setRole(Long Role) Set Filters by creator role.
void	setSearchKeyAlias(String SearchKeyAlias) Set Performs a fuzzy query by `KeyId` or `Alias`
void	setTagFilters(TagFilter[] TagFilters) Set Tag filter condition
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, getMultipartRequestParams, set, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, toJsonString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ListKeyDetailRequest

public ListKeyDetailRequest()

ListKeyDetailRequest

public ListKeyDetailRequest(ListKeyDetailRequest 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 This parameter has the same meaning of the `Offset` in an SQL query, indicating that this acquisition starts from the "No. Offset value" element of the array arranged in a certain order. The default value is 0.

Returns:

Offset This parameter has the same meaning of the `Offset` in an SQL query, indicating that this acquisition starts from the "No. Offset value" element of the array arranged in a certain order. The default value is 0.

setOffset

public void setOffset(Long Offset)

Set This parameter has the same meaning of the `Offset` in an SQL query, indicating that this acquisition starts from the "No. Offset value" element of the array arranged in a certain order. The default value is 0.

Parameters:

Offset - This parameter has the same meaning of the `Offset` in an SQL query, indicating that this acquisition starts from the "No. Offset value" element of the array arranged in a certain order. The default value is 0.

getLimit

public Long getLimit()

Get This parameter has the same meaning of the `Limit` in an SQL query, indicating that up to `Limit` value elements can be obtained in this request. The default value is 10 and the maximum value is 200.

Returns:

Limit This parameter has the same meaning of the `Limit` in an SQL query, indicating that up to `Limit` value elements can be obtained in this request. The default value is 10 and the maximum value is 200.

setLimit

public void setLimit(Long Limit)

Set This parameter has the same meaning of the `Limit` in an SQL query, indicating that up to `Limit` value elements can be obtained in this request. The default value is 10 and the maximum value is 200.

Parameters:

Limit - This parameter has the same meaning of the `Limit` in an SQL query, indicating that up to `Limit` value elements can be obtained in this request. The default value is 10 and the maximum value is 200.

getRole

public Long getRole()

Get Filters by creator role. 0 (default value): the CMK is created by the user; 1: the CMK is created automatically by an authorized Tencent Cloud service.

Returns:

Role Filters by creator role. 0 (default value): the CMK is created by the user; 1: the CMK is created automatically by an authorized Tencent Cloud service.

setRole

public void setRole(Long Role)

Set Filters by creator role. 0 (default value): the CMK is created by the user; 1: the CMK is created automatically by an authorized Tencent Cloud service.

Parameters:

Role - Filters by creator role. 0 (default value): the CMK is created by the user; 1: the CMK is created automatically by an authorized Tencent Cloud service.

getOrderType

public Long getOrderType()

Get Sorts by CMK creation time. 0: descending; 1: ascending

Returns:

OrderType Sorts by CMK creation time. 0: descending; 1: ascending

setOrderType

public void setOrderType(Long OrderType)

Set Sorts by CMK creation time. 0: descending; 1: ascending

Parameters:

OrderType - Sorts by CMK creation time. 0: descending; 1: ascending

getKeyState

public Long getKeyState()

Get Filters by CMK status. 0: all CMKs; 1: CMKs in `Enabled` status only; 2: CMKs in `Disabled` status only; 3: CMKs in `PendingDelete` status only (i.e., keys with schedule deletion enabled); 4: CMKs in `PendingImport` status only; 5: CMKs in `Archived` status only.

Returns:

KeyState Filters by CMK status. 0: all CMKs; 1: CMKs in `Enabled` status only; 2: CMKs in `Disabled` status only; 3: CMKs in `PendingDelete` status only (i.e., keys with schedule deletion enabled); 4: CMKs in `PendingImport` status only; 5: CMKs in `Archived` status only.

setKeyState

public void setKeyState(Long KeyState)

Set Filters by CMK status. 0: all CMKs; 1: CMKs in `Enabled` status only; 2: CMKs in `Disabled` status only; 3: CMKs in `PendingDelete` status only (i.e., keys with schedule deletion enabled); 4: CMKs in `PendingImport` status only; 5: CMKs in `Archived` status only.

Parameters:

KeyState - Filters by CMK status. 0: all CMKs; 1: CMKs in `Enabled` status only; 2: CMKs in `Disabled` status only; 3: CMKs in `PendingDelete` status only (i.e., keys with schedule deletion enabled); 4: CMKs in `PendingImport` status only; 5: CMKs in `Archived` status only.

getSearchKeyAlias

public String getSearchKeyAlias()

Get Performs a fuzzy query by `KeyId` or `Alias`

Returns:

SearchKeyAlias Performs a fuzzy query by `KeyId` or `Alias`

setSearchKeyAlias

public void setSearchKeyAlias(String SearchKeyAlias)

Set Performs a fuzzy query by `KeyId` or `Alias`

Parameters:

SearchKeyAlias - Performs a fuzzy query by `KeyId` or `Alias`

getOrigin

public String getOrigin()

Get Filters by CMK type. "TENCENT_KMS" indicates to filter CMKs whose key materials are created by KMS; "EXTERNAL" indicates to filter CMKs of `EXTERNAL` type whose key materials are imported by users; "ALL" or empty indicates to filter CMKs of both types. This value is case-sensitive.

Returns:

Origin Filters by CMK type. "TENCENT_KMS" indicates to filter CMKs whose key materials are created by KMS; "EXTERNAL" indicates to filter CMKs of `EXTERNAL` type whose key materials are imported by users; "ALL" or empty indicates to filter CMKs of both types. This value is case-sensitive.

setOrigin

public void setOrigin(String Origin)

Set Filters by CMK type. "TENCENT_KMS" indicates to filter CMKs whose key materials are created by KMS; "EXTERNAL" indicates to filter CMKs of `EXTERNAL` type whose key materials are imported by users; "ALL" or empty indicates to filter CMKs of both types. This value is case-sensitive.

Parameters:

Origin - Filters by CMK type. "TENCENT_KMS" indicates to filter CMKs whose key materials are created by KMS; "EXTERNAL" indicates to filter CMKs of `EXTERNAL` type whose key materials are imported by users; "ALL" or empty indicates to filter CMKs of both types. This value is case-sensitive.

getKeyUsage

public String getKeyUsage()

Get Filters by the `KeyUsage` field value. Valid values: `ALL` (all CMKs), `ENCRYPT_DECRYPT` (used when this field is left empty), `ASYMMETRIC_DECRYPT_RSA_2048`, `ASYMMETRIC_DECRYPT_SM2`, `ASYMMETRIC_SIGN_VERIFY_SM2`, `ASYMMETRIC_SIGN_VERIFY_RSA_2048`, and `ASYMMETRIC_SIGN_VERIFY_ECC`.

Returns:

KeyUsage Filters by the `KeyUsage` field value. Valid values: `ALL` (all CMKs), `ENCRYPT_DECRYPT` (used when this field is left empty), `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 Filters by the `KeyUsage` field value. Valid values: `ALL` (all CMKs), `ENCRYPT_DECRYPT` (used when this field is left empty), `ASYMMETRIC_DECRYPT_RSA_2048`, `ASYMMETRIC_DECRYPT_SM2`, `ASYMMETRIC_SIGN_VERIFY_SM2`, `ASYMMETRIC_SIGN_VERIFY_RSA_2048`, and `ASYMMETRIC_SIGN_VERIFY_ECC`.

Parameters:

KeyUsage - Filters by the `KeyUsage` field value. Valid values: `ALL` (all CMKs), `ENCRYPT_DECRYPT` (used when this field is left empty), `ASYMMETRIC_DECRYPT_RSA_2048`, `ASYMMETRIC_DECRYPT_SM2`, `ASYMMETRIC_SIGN_VERIFY_SM2`, `ASYMMETRIC_SIGN_VERIFY_RSA_2048`, and `ASYMMETRIC_SIGN_VERIFY_ECC`.

getTagFilters

public TagFilter[] getTagFilters()

Get Tag filter condition

Returns:

TagFilters Tag filter condition

setTagFilters

public void setTagFilters(TagFilter[] TagFilters)

Set Tag filter condition

Parameters:

TagFilters - Tag filter condition

getHsmClusterId

public String getHsmClusterId()

Get ID of the HSM cluster. This field is only valid for Exclusive and Managed KMS instances.

Returns:

HsmClusterId ID of the HSM cluster. This field is only valid for Exclusive and Managed KMS instances.

setHsmClusterId

public void setHsmClusterId(String HsmClusterId)

Set ID of the HSM cluster. This field is only valid for Exclusive and Managed KMS instances.

Parameters:

HsmClusterId - ID of the HSM cluster. This field is only valid for Exclusive and Managed KMS instances.

toMap

public void toMap(HashMap<String,String> map,
                  String prefix)

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel