ListKeyDetailRequest (tencentcloud-sdk-java 3.0.112 API)

java.lang.Object
- com.tencentcloudapi.common.AbstractModel
- - com.tencentcloudapi.kms.v20190118.models.ListKeyDetailRequest

public class ListKeyDetailRequest
extends AbstractModel

构造器概要

构造器
构造器和说明

ListKeyDetailRequest()

构造器
构造器和说明
`ListKeyDetailRequest()`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`Long`	`getKeyState()` 获取根据CMK状态筛选， 0表示全部CMK， 1 表示仅查询Enabled CMK， 2 表示仅查询Disabled CMK，3 表示查询PendingDelete 状态的CMK(处于计划删除状态的Key)，4 表示查询 PendingImport 状态的CMK
`Long`	`getLimit()` 获取含义跟 SQL 查询的 Limit 一致，表示本次获最多获取 Limit 个元素。
`Long`	`getOffset()` 获取含义跟 SQL 查询的 Offset 一致，表示本次获取从按一定顺序排列数组的第 Offset 个元素开始，缺省为0
`Long`	`getOrderType()` 获取根据CMK创建时间排序， 0 表示按照降序排序，1表示按照升序排序
`String`	`getOrigin()` 获取根据CMK类型筛选， "TENCENT_KMS" 表示筛选密钥材料由KMS创建的CMK， "EXTERNAL" 表示筛选密钥材料需要用户导入的 EXTERNAL类型CMK，"ALL" 或者不设置表示两种类型都查询，大小写敏感。
`Long`	`getRole()` 获取根据创建者角色筛选，默认 0 表示用户自己创建的cmk， 1 表示授权其它云产品自动创建的cmk
`String`	`getSearchKeyAlias()` 获取根据KeyId或者Alias进行模糊匹配查询
`void`	`setKeyState(Long KeyState)` 设置根据CMK状态筛选， 0表示全部CMK， 1 表示仅查询Enabled CMK， 2 表示仅查询Disabled CMK，3 表示查询PendingDelete 状态的CMK(处于计划删除状态的Key)，4 表示查询 PendingImport 状态的CMK
`void`	`setLimit(Long Limit)` 设置含义跟 SQL 查询的 Limit 一致，表示本次获最多获取 Limit 个元素。
`void`	`setOffset(Long Offset)` 设置含义跟 SQL 查询的 Offset 一致，表示本次获取从按一定顺序排列数组的第 Offset 个元素开始，缺省为0
`void`	`setOrderType(Long OrderType)` 设置根据CMK创建时间排序， 0 表示按照降序排序，1表示按照升序排序
`void`	`setOrigin(String Origin)` 设置根据CMK类型筛选， "TENCENT_KMS" 表示筛选密钥材料由KMS创建的CMK， "EXTERNAL" 表示筛选密钥材料需要用户导入的 EXTERNAL类型CMK，"ALL" 或者不设置表示两种类型都查询，大小写敏感。
`void`	`setRole(Long Role)` 设置根据创建者角色筛选，默认 0 表示用户自己创建的cmk， 1 表示授权其它云产品自动创建的cmk
`void`	`setSearchKeyAlias(String SearchKeyAlias)` 设置根据KeyId或者Alias进行模糊匹配查询
`void`	`toMap(HashMap<String,String> map, String prefix)` 内部实现，用户禁止调用

从类继承的方法 com.tencentcloudapi.common.AbstractModel
any, fromJsonString, getBinaryParams, getMultipartRequestParams, set, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, toJsonString

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - ListKeyDetailRequest
```
public ListKeyDetailRequest()
```
- 方法详细资料
  - getOffset
```
public Long getOffset()
```
    获取含义跟 SQL 查询的 Offset 一致，表示本次获取从按一定顺序排列数组的第 Offset 个元素开始，缺省为0
    
    返回:
    
    Offset 含义跟 SQL 查询的 Offset 一致，表示本次获取从按一定顺序排列数组的第 Offset 个元素开始，缺省为0
  - setOffset
```
public void setOffset(Long Offset)
```
    设置含义跟 SQL 查询的 Offset 一致，表示本次获取从按一定顺序排列数组的第 Offset 个元素开始，缺省为0
    
    参数:
    
    Offset - 含义跟 SQL 查询的 Offset 一致，表示本次获取从按一定顺序排列数组的第 Offset 个元素开始，缺省为0
  - getLimit
```
public Long getLimit()
```
    获取含义跟 SQL 查询的 Limit 一致，表示本次获最多获取 Limit 个元素。缺省值为10，最大值为200
    
    返回:
    
    Limit 含义跟 SQL 查询的 Limit 一致，表示本次获最多获取 Limit 个元素。缺省值为10，最大值为200
  - setLimit
```
public void setLimit(Long Limit)
```
    设置含义跟 SQL 查询的 Limit 一致，表示本次获最多获取 Limit 个元素。缺省值为10，最大值为200
    
    参数:
    
    Limit - 含义跟 SQL 查询的 Limit 一致，表示本次获最多获取 Limit 个元素。缺省值为10，最大值为200
  - getRole
```
public Long getRole()
```
    获取根据创建者角色筛选，默认 0 表示用户自己创建的cmk， 1 表示授权其它云产品自动创建的cmk
    
    返回:
    
    Role 根据创建者角色筛选，默认 0 表示用户自己创建的cmk， 1 表示授权其它云产品自动创建的cmk
  - setRole
```
public void setRole(Long Role)
```
    设置根据创建者角色筛选，默认 0 表示用户自己创建的cmk， 1 表示授权其它云产品自动创建的cmk
    
    参数:
    
    Role - 根据创建者角色筛选，默认 0 表示用户自己创建的cmk， 1 表示授权其它云产品自动创建的cmk
  - getOrderType
```
public Long getOrderType()
```
    获取根据CMK创建时间排序， 0 表示按照降序排序，1表示按照升序排序
    
    返回:
    
    OrderType 根据CMK创建时间排序， 0 表示按照降序排序，1表示按照升序排序
  - setOrderType
```
public void setOrderType(Long OrderType)
```
    设置根据CMK创建时间排序， 0 表示按照降序排序，1表示按照升序排序
    
    参数:
    
    OrderType - 根据CMK创建时间排序， 0 表示按照降序排序，1表示按照升序排序
  - getKeyState
```
public Long getKeyState()
```
    获取根据CMK状态筛选， 0表示全部CMK， 1 表示仅查询Enabled CMK， 2 表示仅查询Disabled CMK，3 表示查询PendingDelete 状态的CMK(处于计划删除状态的Key)，4 表示查询 PendingImport 状态的CMK
    
    返回:
    
    KeyState 根据CMK状态筛选， 0表示全部CMK， 1 表示仅查询Enabled CMK， 2 表示仅查询Disabled CMK，3 表示查询PendingDelete 状态的CMK(处于计划删除状态的Key)，4 表示查询 PendingImport 状态的CMK
  - setKeyState
```
public void setKeyState(Long KeyState)
```
    设置根据CMK状态筛选， 0表示全部CMK， 1 表示仅查询Enabled CMK， 2 表示仅查询Disabled CMK，3 表示查询PendingDelete 状态的CMK(处于计划删除状态的Key)，4 表示查询 PendingImport 状态的CMK
    
    参数:
    
    KeyState - 根据CMK状态筛选， 0表示全部CMK， 1 表示仅查询Enabled CMK， 2 表示仅查询Disabled CMK，3 表示查询PendingDelete 状态的CMK(处于计划删除状态的Key)，4 表示查询 PendingImport 状态的CMK
  - getSearchKeyAlias
```
public String getSearchKeyAlias()
```
    获取根据KeyId或者Alias进行模糊匹配查询
    
    返回:
    
    SearchKeyAlias 根据KeyId或者Alias进行模糊匹配查询
  - setSearchKeyAlias
```
public void setSearchKeyAlias(String SearchKeyAlias)
```
    设置根据KeyId或者Alias进行模糊匹配查询
    
    参数:
    
    SearchKeyAlias - 根据KeyId或者Alias进行模糊匹配查询
  - getOrigin
```
public String getOrigin()
```
    获取根据CMK类型筛选， "TENCENT_KMS" 表示筛选密钥材料由KMS创建的CMK， "EXTERNAL" 表示筛选密钥材料需要用户导入的 EXTERNAL类型CMK，"ALL" 或者不设置表示两种类型都查询，大小写敏感。
    
    返回:
    
    Origin 根据CMK类型筛选， "TENCENT_KMS" 表示筛选密钥材料由KMS创建的CMK， "EXTERNAL" 表示筛选密钥材料需要用户导入的 EXTERNAL类型CMK，"ALL" 或者不设置表示两种类型都查询，大小写敏感。
  - setOrigin
```
public void setOrigin(String Origin)
```
    设置根据CMK类型筛选， "TENCENT_KMS" 表示筛选密钥材料由KMS创建的CMK， "EXTERNAL" 表示筛选密钥材料需要用户导入的 EXTERNAL类型CMK，"ALL" 或者不设置表示两种类型都查询，大小写敏感。
    
    参数:
    
    Origin - 根据CMK类型筛选， "TENCENT_KMS" 表示筛选密钥材料由KMS创建的CMK， "EXTERNAL" 表示筛选密钥材料需要用户导入的 EXTERNAL类型CMK，"ALL" 或者不设置表示两种类型都查询，大小写敏感。
  - toMap
```
public void toMap(HashMap<String,String> map,
                  String prefix)
```
    内部实现，用户禁止调用
    
    指定者:
    
    toMap 在类中 AbstractModel

类 ListKeyDetailRequest

构造器概要

方法概要

从类继承的方法 com.tencentcloudapi.common.AbstractModel

从类继承的方法 java.lang.Object

构造器详细资料

ListKeyDetailRequest

方法详细资料

getOffset

setOffset

getLimit

setLimit

getRole

setRole

getOrderType

setOrderType

getKeyState

setKeyState

getSearchKeyAlias

setSearchKeyAlias

getOrigin

setOrigin

toMap