com.tencentcloudapi.kms.v20190118.models.ListKeyDetailRequest Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of tencentcloud-sdk-java-kms Show documentation
Show all versions of tencentcloud-sdk-java-kms Show documentation
Tencent Cloud Open API SDK for Java
/*
* Copyright (c) 2017-2018 THL A29 Limited, a Tencent company. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.tencentcloudapi.kms.v20190118.models;
import com.tencentcloudapi.common.AbstractModel;
import com.google.gson.annotations.SerializedName;
import com.google.gson.annotations.Expose;
import java.util.HashMap;
public class ListKeyDetailRequest extends AbstractModel{
/**
* 含义跟 SQL 查询的 Offset 一致，表示本次获取从按一定顺序排列数组的第 Offset 个元素开始，缺省为0
*/
@SerializedName("Offset")
@Expose
private Long Offset;
/**
* 含义跟 SQL 查询的 Limit 一致，表示本次最多获取 Limit 个元素。缺省值为10，最大值为200
*/
@SerializedName("Limit")
@Expose
private Long Limit;
/**
* 根据创建者角色筛选，默认 0 表示用户自己创建的cmk， 1 表示授权其它云产品自动创建的cmk
*/
@SerializedName("Role")
@Expose
private Long Role;
/**
* 根据CMK创建时间排序， 0 表示按照降序排序，1表示按照升序排序
*/
@SerializedName("OrderType")
@Expose
private Long OrderType;
/**
* 根据CMK状态筛选， 0表示全部CMK， 1 表示仅查询Enabled CMK， 2 表示仅查询Disabled CMK，3 表示查询PendingDelete 状态的CMK(处于计划删除状态的Key)，4 表示查询 PendingImport 状态的CMK，5 表示查询 Archived 状态的 CMK
*/
@SerializedName("KeyState")
@Expose
private Long KeyState;
/**
* 根据KeyId或者Alias进行模糊匹配查询
*/
@SerializedName("SearchKeyAlias")
@Expose
private String SearchKeyAlias;
/**
* 根据CMK类型筛选， "TENCENT_KMS" 表示筛选密钥材料由KMS创建的CMK， "EXTERNAL" 表示筛选密钥材料需要用户导入的 EXTERNAL类型CMK，"ALL" 或者不设置表示两种类型都查询，大小写敏感。
*/
@SerializedName("Origin")
@Expose
private String Origin;
/**
* 根据CMK的KeyUsage筛选，ALL表示筛选全部，可使用的参数为：ALL 或 ENCRYPT_DECRYPT 或 ASYMMETRIC_DECRYPT_RSA_2048 或 ASYMMETRIC_DECRYPT_SM2 或 ASYMMETRIC_SIGN_VERIFY_SM2 或 ASYMMETRIC_SIGN_VERIFY_RSA_2048 或 ASYMMETRIC_SIGN_VERIFY_ECC，为空则默认筛选ENCRYPT_DECRYPT类型
*/
@SerializedName("KeyUsage")
@Expose
private String KeyUsage;
/**
* 标签过滤条件
*/
@SerializedName("TagFilters")
@Expose
private TagFilter [] TagFilters;
/**
* KMS 高级版对应的 HSM 集群 ID（仅对 KMS 独占版/托管版服务实例有效）。
*/
@SerializedName("HsmClusterId")
@Expose
private String HsmClusterId;
/**
* Get 含义跟 SQL 查询的 Offset 一致，表示本次获取从按一定顺序排列数组的第 Offset 个元素开始，缺省为0
* @return Offset 含义跟 SQL 查询的 Offset 一致，表示本次获取从按一定顺序排列数组的第 Offset 个元素开始，缺省为0
*/
public Long getOffset() {
return this.Offset;
}
/**
* Set 含义跟 SQL 查询的 Offset 一致，表示本次获取从按一定顺序排列数组的第 Offset 个元素开始，缺省为0
* @param Offset 含义跟 SQL 查询的 Offset 一致，表示本次获取从按一定顺序排列数组的第 Offset 个元素开始，缺省为0
*/
public void setOffset(Long Offset) {
this.Offset = Offset;
}
/**
* Get 含义跟 SQL 查询的 Limit 一致，表示本次最多获取 Limit 个元素。缺省值为10，最大值为200
* @return Limit 含义跟 SQL 查询的 Limit 一致，表示本次最多获取 Limit 个元素。缺省值为10，最大值为200
*/
public Long getLimit() {
return this.Limit;
}
/**
* Set 含义跟 SQL 查询的 Limit 一致，表示本次最多获取 Limit 个元素。缺省值为10，最大值为200
* @param Limit 含义跟 SQL 查询的 Limit 一致，表示本次最多获取 Limit 个元素。缺省值为10，最大值为200
*/
public void setLimit(Long Limit) {
this.Limit = Limit;
}
/**
* Get 根据创建者角色筛选，默认 0 表示用户自己创建的cmk， 1 表示授权其它云产品自动创建的cmk
* @return Role 根据创建者角色筛选，默认 0 表示用户自己创建的cmk， 1 表示授权其它云产品自动创建的cmk
*/
public Long getRole() {
return this.Role;
}
/**
* Set 根据创建者角色筛选，默认 0 表示用户自己创建的cmk， 1 表示授权其它云产品自动创建的cmk
* @param Role 根据创建者角色筛选，默认 0 表示用户自己创建的cmk， 1 表示授权其它云产品自动创建的cmk
*/
public void setRole(Long Role) {
this.Role = Role;
}
/**
* Get 根据CMK创建时间排序， 0 表示按照降序排序，1表示按照升序排序
* @return OrderType 根据CMK创建时间排序， 0 表示按照降序排序，1表示按照升序排序
*/
public Long getOrderType() {
return this.OrderType;
}
/**
* Set 根据CMK创建时间排序， 0 表示按照降序排序，1表示按照升序排序
* @param OrderType 根据CMK创建时间排序， 0 表示按照降序排序，1表示按照升序排序
*/
public void setOrderType(Long OrderType) {
this.OrderType = OrderType;
}
/**
* Get 根据CMK状态筛选， 0表示全部CMK， 1 表示仅查询Enabled CMK， 2 表示仅查询Disabled CMK，3 表示查询PendingDelete 状态的CMK(处于计划删除状态的Key)，4 表示查询 PendingImport 状态的CMK，5 表示查询 Archived 状态的 CMK
* @return KeyState 根据CMK状态筛选， 0表示全部CMK， 1 表示仅查询Enabled CMK， 2 表示仅查询Disabled CMK，3 表示查询PendingDelete 状态的CMK(处于计划删除状态的Key)，4 表示查询 PendingImport 状态的CMK，5 表示查询 Archived 状态的 CMK
*/
public Long getKeyState() {
return this.KeyState;
}
/**
* Set 根据CMK状态筛选， 0表示全部CMK， 1 表示仅查询Enabled CMK， 2 表示仅查询Disabled CMK，3 表示查询PendingDelete 状态的CMK(处于计划删除状态的Key)，4 表示查询 PendingImport 状态的CMK，5 表示查询 Archived 状态的 CMK
* @param KeyState 根据CMK状态筛选， 0表示全部CMK， 1 表示仅查询Enabled CMK， 2 表示仅查询Disabled CMK，3 表示查询PendingDelete 状态的CMK(处于计划删除状态的Key)，4 表示查询 PendingImport 状态的CMK，5 表示查询 Archived 状态的 CMK
*/
public void setKeyState(Long KeyState) {
this.KeyState = KeyState;
}
/**
* Get 根据KeyId或者Alias进行模糊匹配查询
* @return SearchKeyAlias 根据KeyId或者Alias进行模糊匹配查询
*/
public String getSearchKeyAlias() {
return this.SearchKeyAlias;
}
/**
* Set 根据KeyId或者Alias进行模糊匹配查询
* @param SearchKeyAlias 根据KeyId或者Alias进行模糊匹配查询
*/
public void setSearchKeyAlias(String SearchKeyAlias) {
this.SearchKeyAlias = SearchKeyAlias;
}
/**
* Get 根据CMK类型筛选， "TENCENT_KMS" 表示筛选密钥材料由KMS创建的CMK， "EXTERNAL" 表示筛选密钥材料需要用户导入的 EXTERNAL类型CMK，"ALL" 或者不设置表示两种类型都查询，大小写敏感。
* @return Origin 根据CMK类型筛选， "TENCENT_KMS" 表示筛选密钥材料由KMS创建的CMK， "EXTERNAL" 表示筛选密钥材料需要用户导入的 EXTERNAL类型CMK，"ALL" 或者不设置表示两种类型都查询，大小写敏感。
*/
public String getOrigin() {
return this.Origin;
}
/**
* Set 根据CMK类型筛选， "TENCENT_KMS" 表示筛选密钥材料由KMS创建的CMK， "EXTERNAL" 表示筛选密钥材料需要用户导入的 EXTERNAL类型CMK，"ALL" 或者不设置表示两种类型都查询，大小写敏感。
* @param Origin 根据CMK类型筛选， "TENCENT_KMS" 表示筛选密钥材料由KMS创建的CMK， "EXTERNAL" 表示筛选密钥材料需要用户导入的 EXTERNAL类型CMK，"ALL" 或者不设置表示两种类型都查询，大小写敏感。
*/
public void setOrigin(String Origin) {
this.Origin = Origin;
}
/**
* Get 根据CMK的KeyUsage筛选，ALL表示筛选全部，可使用的参数为：ALL 或 ENCRYPT_DECRYPT 或 ASYMMETRIC_DECRYPT_RSA_2048 或 ASYMMETRIC_DECRYPT_SM2 或 ASYMMETRIC_SIGN_VERIFY_SM2 或 ASYMMETRIC_SIGN_VERIFY_RSA_2048 或 ASYMMETRIC_SIGN_VERIFY_ECC，为空则默认筛选ENCRYPT_DECRYPT类型
* @return KeyUsage 根据CMK的KeyUsage筛选，ALL表示筛选全部，可使用的参数为：ALL 或 ENCRYPT_DECRYPT 或 ASYMMETRIC_DECRYPT_RSA_2048 或 ASYMMETRIC_DECRYPT_SM2 或 ASYMMETRIC_SIGN_VERIFY_SM2 或 ASYMMETRIC_SIGN_VERIFY_RSA_2048 或 ASYMMETRIC_SIGN_VERIFY_ECC，为空则默认筛选ENCRYPT_DECRYPT类型
*/
public String getKeyUsage() {
return this.KeyUsage;
}
/**
* Set 根据CMK的KeyUsage筛选，ALL表示筛选全部，可使用的参数为：ALL 或 ENCRYPT_DECRYPT 或 ASYMMETRIC_DECRYPT_RSA_2048 或 ASYMMETRIC_DECRYPT_SM2 或 ASYMMETRIC_SIGN_VERIFY_SM2 或 ASYMMETRIC_SIGN_VERIFY_RSA_2048 或 ASYMMETRIC_SIGN_VERIFY_ECC，为空则默认筛选ENCRYPT_DECRYPT类型
* @param KeyUsage 根据CMK的KeyUsage筛选，ALL表示筛选全部，可使用的参数为：ALL 或 ENCRYPT_DECRYPT 或 ASYMMETRIC_DECRYPT_RSA_2048 或 ASYMMETRIC_DECRYPT_SM2 或 ASYMMETRIC_SIGN_VERIFY_SM2 或 ASYMMETRIC_SIGN_VERIFY_RSA_2048 或 ASYMMETRIC_SIGN_VERIFY_ECC，为空则默认筛选ENCRYPT_DECRYPT类型
*/
public void setKeyUsage(String KeyUsage) {
this.KeyUsage = KeyUsage;
}
/**
* Get 标签过滤条件
* @return TagFilters 标签过滤条件
*/
public TagFilter [] getTagFilters() {
return this.TagFilters;
}
/**
* Set 标签过滤条件
* @param TagFilters 标签过滤条件
*/
public void setTagFilters(TagFilter [] TagFilters) {
this.TagFilters = TagFilters;
}
/**
* Get KMS 高级版对应的 HSM 集群 ID（仅对 KMS 独占版/托管版服务实例有效）。
* @return HsmClusterId KMS 高级版对应的 HSM 集群 ID（仅对 KMS 独占版/托管版服务实例有效）。
*/
public String getHsmClusterId() {
return this.HsmClusterId;
}
/**
* Set KMS 高级版对应的 HSM 集群 ID（仅对 KMS 独占版/托管版服务实例有效）。
* @param HsmClusterId KMS 高级版对应的 HSM 集群 ID（仅对 KMS 独占版/托管版服务实例有效）。
*/
public void setHsmClusterId(String HsmClusterId) {
this.HsmClusterId = HsmClusterId;
}
public ListKeyDetailRequest() {
}
/**
* 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.
*/
public ListKeyDetailRequest(ListKeyDetailRequest source) {
if (source.Offset != null) {
this.Offset = new Long(source.Offset);
}
if (source.Limit != null) {
this.Limit = new Long(source.Limit);
}
if (source.Role != null) {
this.Role = new Long(source.Role);
}
if (source.OrderType != null) {
this.OrderType = new Long(source.OrderType);
}
if (source.KeyState != null) {
this.KeyState = new Long(source.KeyState);
}
if (source.SearchKeyAlias != null) {
this.SearchKeyAlias = new String(source.SearchKeyAlias);
}
if (source.Origin != null) {
this.Origin = new String(source.Origin);
}
if (source.KeyUsage != null) {
this.KeyUsage = new String(source.KeyUsage);
}
if (source.TagFilters != null) {
this.TagFilters = new TagFilter[source.TagFilters.length];
for (int i = 0; i < source.TagFilters.length; i++) {
this.TagFilters[i] = new TagFilter(source.TagFilters[i]);
}
}
if (source.HsmClusterId != null) {
this.HsmClusterId = new String(source.HsmClusterId);
}
}
/**
* Internal implementation, normal users should not use it.
*/
public void toMap(HashMap map, String prefix) {
this.setParamSimple(map, prefix + "Offset", this.Offset);
this.setParamSimple(map, prefix + "Limit", this.Limit);
this.setParamSimple(map, prefix + "Role", this.Role);
this.setParamSimple(map, prefix + "OrderType", this.OrderType);
this.setParamSimple(map, prefix + "KeyState", this.KeyState);
this.setParamSimple(map, prefix + "SearchKeyAlias", this.SearchKeyAlias);
this.setParamSimple(map, prefix + "Origin", this.Origin);
this.setParamSimple(map, prefix + "KeyUsage", this.KeyUsage);
this.setParamArrayObj(map, prefix + "TagFilters.", this.TagFilters);
this.setParamSimple(map, prefix + "HsmClusterId", this.HsmClusterId);
}
}