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-intl-en Show documentation
Show all versions of tencentcloud-sdk-java-intl-en Show documentation
Tencent Cloud 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.tencentcloudapi.common.SSEResponseModel;
import com.google.gson.annotations.SerializedName;
import com.google.gson.annotations.Expose;
import java.util.HashMap;
public class ListKeyDetailRequest extends AbstractModel {
/**
* 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.
*/
@SerializedName("Offset")
@Expose
private Long Offset;
/**
* 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.
*/
@SerializedName("Limit")
@Expose
private Long Limit;
/**
* 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.
*/
@SerializedName("Role")
@Expose
private Long Role;
/**
* Sorts by CMK creation time. 0: descending; 1: ascending
*/
@SerializedName("OrderType")
@Expose
private Long OrderType;
/**
* 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.
*/
@SerializedName("KeyState")
@Expose
private Long KeyState;
/**
* Performs a fuzzy query by `KeyId` or `Alias`
*/
@SerializedName("SearchKeyAlias")
@Expose
private String SearchKeyAlias;
/**
* 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.
*/
@SerializedName("Origin")
@Expose
private String Origin;
/**
* 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`.
*/
@SerializedName("KeyUsage")
@Expose
private String KeyUsage;
/**
* Tag filter condition
*/
@SerializedName("TagFilters")
@Expose
private TagFilter [] TagFilters;
/**
* ID of the HSM cluster. This field is only valid for Exclusive and Managed KMS instances.
*/
@SerializedName("HsmClusterId")
@Expose
private String HsmClusterId;
/**
* 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.
* @return 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.
*/
public Long getOffset() {
return this.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.
* @param 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.
*/
public void setOffset(Long Offset) {
this.Offset = Offset;
}
/**
* 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.
* @return 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.
*/
public Long getLimit() {
return this.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.
* @param 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.
*/
public void setLimit(Long Limit) {
this.Limit = Limit;
}
/**
* 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.
* @return 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.
*/
public Long getRole() {
return this.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.
* @param 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.
*/
public void setRole(Long Role) {
this.Role = Role;
}
/**
* Get Sorts by CMK creation time. 0: descending; 1: ascending
* @return OrderType Sorts by CMK creation time. 0: descending; 1: ascending
*/
public Long getOrderType() {
return this.OrderType;
}
/**
* Set Sorts by CMK creation time. 0: descending; 1: ascending
* @param OrderType Sorts by CMK creation time. 0: descending; 1: ascending
*/
public void setOrderType(Long OrderType) {
this.OrderType = OrderType;
}
/**
* 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.
* @return 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.
*/
public Long getKeyState() {
return this.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.
* @param 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.
*/
public void setKeyState(Long KeyState) {
this.KeyState = KeyState;
}
/**
* Get Performs a fuzzy query by `KeyId` or `Alias`
* @return SearchKeyAlias Performs a fuzzy query by `KeyId` or `Alias`
*/
public String getSearchKeyAlias() {
return this.SearchKeyAlias;
}
/**
* Set Performs a fuzzy query by `KeyId` or `Alias`
* @param SearchKeyAlias Performs a fuzzy query by `KeyId` or `Alias`
*/
public void setSearchKeyAlias(String SearchKeyAlias) {
this.SearchKeyAlias = SearchKeyAlias;
}
/**
* 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.
* @return 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.
*/
public String getOrigin() {
return this.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.
* @param 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.
*/
public void setOrigin(String Origin) {
this.Origin = Origin;
}
/**
* 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`.
* @return 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`.
*/
public String getKeyUsage() {
return this.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`.
* @param 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`.
*/
public void setKeyUsage(String KeyUsage) {
this.KeyUsage = KeyUsage;
}
/**
* Get Tag filter condition
* @return TagFilters Tag filter condition
*/
public TagFilter [] getTagFilters() {
return this.TagFilters;
}
/**
* Set Tag filter condition
* @param TagFilters Tag filter condition
*/
public void setTagFilters(TagFilter [] TagFilters) {
this.TagFilters = TagFilters;
}
/**
* Get ID of the HSM cluster. This field is only valid for Exclusive and Managed KMS instances.
* @return HsmClusterId ID of the HSM cluster. This field is only valid for Exclusive and Managed KMS instances.
*/
public String getHsmClusterId() {
return this.HsmClusterId;
}
/**
* Set ID of the HSM cluster. This field is only valid for Exclusive and Managed KMS instances.
* @param HsmClusterId ID of the HSM cluster. This field is only valid for Exclusive and Managed KMS instances.
*/
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);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy