com.tencentcloudapi.lighthouse.v20200324.models

Class DescribeDisksRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.lighthouse.v20200324.models.DescribeDisksRequest

public class DescribeDisksRequest
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
DescribeDisksRequest()
DescribeDisksRequest(DescribeDisksRequest 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[]	getDiskIds() Get 云硬盘ID列表。可通过[DescribeDisks](https://cloud.tencent.com/document/product/1207/66093)接口返回值字段KeyPairSet获取。列表长度最大值为100。
Filter[]	getFilters() Get 过滤器列表。 disk-id 按照【云硬盘 ID】进行过滤。 类型：String 必选：否 instance-id 按照【实例ID】进行过滤。 类型：String 必选：否 disk-name 按照【云硬盘名称】进行过滤。 类型：String 必选：否 zone 按照【可用区】进行过滤。 类型：String 必选：否 disk-usage 按照【云硬盘类型】进行过滤。 类型：String 必选：否 取值：SYSTEM_DISK（系统盘）或 DATA_DISK（数据盘） disk-state 按照【云硬盘状态】进行过滤。 类型：String 必选：否 取值：参考数据结构[Disk](https://cloud.tencent.com/document/api/1207/47576#Disk)中DiskState取值。 tag-key 按照【标签键】进行过滤。 类型：String 必选：否 tag-value 按照【标签值】进行过滤。 类型：String 必选：否 tag:tag-key 按照【标签键值对】进行过滤。 tag-key使用具体的标签键进行替换。 每次请求的 Filters 的上限为 10，Filter.Values 的上限为 100。参数不支持同时指定 DiskIds 和 Filters。
Long	getLimit() Get 返回数量，默认为20，最大值为100。
Long	getOffset() Get 偏移量，默认为0。
String	getOrder() Get 输出云硬盘列表的排列顺序。取值范围："ASC"：升序排列。 "DESC"：降序排列。默认按降序排列。
String	getOrderField() Get 云硬盘列表排序的依据字段。取值范围："CREATED_TIME"：依据云硬盘的创建时间排序。 "EXPIRED_TIME"：依据云硬盘的到期时间排序。"DISK_SIZE"：依据云硬盘的大小排序。默认按云硬盘创建时间排序。
void	setDiskIds(String[] DiskIds) Set 云硬盘ID列表。可通过[DescribeDisks](https://cloud.tencent.com/document/product/1207/66093)接口返回值字段KeyPairSet获取。列表长度最大值为100。
void	setFilters(Filter[] Filters) Set 过滤器列表。 disk-id 按照【云硬盘 ID】进行过滤。 类型：String 必选：否 instance-id 按照【实例ID】进行过滤。 类型：String 必选：否 disk-name 按照【云硬盘名称】进行过滤。 类型：String 必选：否 zone 按照【可用区】进行过滤。 类型：String 必选：否 disk-usage 按照【云硬盘类型】进行过滤。 类型：String 必选：否 取值：SYSTEM_DISK（系统盘）或 DATA_DISK（数据盘） disk-state 按照【云硬盘状态】进行过滤。 类型：String 必选：否 取值：参考数据结构[Disk](https://cloud.tencent.com/document/api/1207/47576#Disk)中DiskState取值。 tag-key 按照【标签键】进行过滤。 类型：String 必选：否 tag-value 按照【标签值】进行过滤。 类型：String 必选：否 tag:tag-key 按照【标签键值对】进行过滤。 tag-key使用具体的标签键进行替换。 每次请求的 Filters 的上限为 10，Filter.Values 的上限为 100。参数不支持同时指定 DiskIds 和 Filters。
void	setLimit(Long Limit) Set 返回数量，默认为20，最大值为100。
void	setOffset(Long Offset) Set 偏移量，默认为0。
void	setOrder(String Order) Set 输出云硬盘列表的排列顺序。取值范围："ASC"：升序排列。 "DESC"：降序排列。默认按降序排列。
void	setOrderField(String OrderField) Set 云硬盘列表排序的依据字段。取值范围："CREATED_TIME"：依据云硬盘的创建时间排序。 "EXPIRED_TIME"：依据云硬盘的到期时间排序。"DISK_SIZE"：依据云硬盘的大小排序。默认按云硬盘创建时间排序。
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

DescribeDisksRequest

public DescribeDisksRequest()

DescribeDisksRequest

public DescribeDisksRequest(DescribeDisksRequest 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

getDiskIds

public String[] getDiskIds()

Get 云硬盘ID列表。可通过[DescribeDisks](https://cloud.tencent.com/document/product/1207/66093)接口返回值字段KeyPairSet获取。列表长度最大值为100。

Returns:

DiskIds 云硬盘ID列表。可通过[DescribeDisks](https://cloud.tencent.com/document/product/1207/66093)接口返回值字段KeyPairSet获取。列表长度最大值为100。

setDiskIds

public void setDiskIds(String[] DiskIds)

Set 云硬盘ID列表。可通过[DescribeDisks](https://cloud.tencent.com/document/product/1207/66093)接口返回值字段KeyPairSet获取。列表长度最大值为100。

Parameters:

DiskIds - 云硬盘ID列表。可通过[DescribeDisks](https://cloud.tencent.com/document/product/1207/66093)接口返回值字段KeyPairSet获取。列表长度最大值为100。

getFilters

public Filter[] getFilters()

Get 过滤器列表。 disk-id 按照【云硬盘 ID】进行过滤。 类型：String 必选：否 instance-id 按照【实例ID】进行过滤。 类型：String 必选：否 disk-name 按照【云硬盘名称】进行过滤。 类型：String 必选：否 zone 按照【可用区】进行过滤。 类型：String 必选：否 disk-usage 按照【云硬盘类型】进行过滤。 类型：String 必选：否 取值：SYSTEM_DISK（系统盘）或 DATA_DISK（数据盘） disk-state 按照【云硬盘状态】进行过滤。 类型：String 必选：否 取值：参考数据结构[Disk](https://cloud.tencent.com/document/api/1207/47576#Disk)中DiskState取值。 tag-key 按照【标签键】进行过滤。 类型：String 必选：否 tag-value 按照【标签值】进行过滤。 类型：String 必选：否 tag:tag-key 按照【标签键值对】进行过滤。 tag-key使用具体的标签键进行替换。 每次请求的 Filters 的上限为 10，Filter.Values 的上限为 100。参数不支持同时指定 DiskIds 和 Filters。

Returns:

Filters 过滤器列表。 disk-id 按照【云硬盘 ID】进行过滤。 类型：String 必选：否 instance-id 按照【实例ID】进行过滤。 类型：String 必选：否 disk-name 按照【云硬盘名称】进行过滤。 类型：String 必选：否 zone 按照【可用区】进行过滤。 类型：String 必选：否 disk-usage 按照【云硬盘类型】进行过滤。 类型：String 必选：否 取值：SYSTEM_DISK（系统盘）或 DATA_DISK（数据盘） disk-state 按照【云硬盘状态】进行过滤。 类型：String 必选：否 取值：参考数据结构[Disk](https://cloud.tencent.com/document/api/1207/47576#Disk)中DiskState取值。 tag-key 按照【标签键】进行过滤。 类型：String 必选：否 tag-value 按照【标签值】进行过滤。 类型：String 必选：否 tag:tag-key 按照【标签键值对】进行过滤。 tag-key使用具体的标签键进行替换。 每次请求的 Filters 的上限为 10，Filter.Values 的上限为 100。参数不支持同时指定 DiskIds 和 Filters。

setFilters

public void setFilters(Filter[] Filters)

Set 过滤器列表。 disk-id 按照【云硬盘 ID】进行过滤。 类型：String 必选：否 instance-id 按照【实例ID】进行过滤。 类型：String 必选：否 disk-name 按照【云硬盘名称】进行过滤。 类型：String 必选：否 zone 按照【可用区】进行过滤。 类型：String 必选：否 disk-usage 按照【云硬盘类型】进行过滤。 类型：String 必选：否 取值：SYSTEM_DISK（系统盘）或 DATA_DISK（数据盘） disk-state 按照【云硬盘状态】进行过滤。 类型：String 必选：否 取值：参考数据结构[Disk](https://cloud.tencent.com/document/api/1207/47576#Disk)中DiskState取值。 tag-key 按照【标签键】进行过滤。 类型：String 必选：否 tag-value 按照【标签值】进行过滤。 类型：String 必选：否 tag:tag-key 按照【标签键值对】进行过滤。 tag-key使用具体的标签键进行替换。 每次请求的 Filters 的上限为 10，Filter.Values 的上限为 100。参数不支持同时指定 DiskIds 和 Filters。

Parameters:

Filters - 过滤器列表。 disk-id 按照【云硬盘 ID】进行过滤。 类型：String 必选：否 instance-id 按照【实例ID】进行过滤。 类型：String 必选：否 disk-name 按照【云硬盘名称】进行过滤。 类型：String 必选：否 zone 按照【可用区】进行过滤。 类型：String 必选：否 disk-usage 按照【云硬盘类型】进行过滤。 类型：String 必选：否 取值：SYSTEM_DISK（系统盘）或 DATA_DISK（数据盘） disk-state 按照【云硬盘状态】进行过滤。 类型：String 必选：否 取值：参考数据结构[Disk](https://cloud.tencent.com/document/api/1207/47576#Disk)中DiskState取值。 tag-key 按照【标签键】进行过滤。 类型：String 必选：否 tag-value 按照【标签值】进行过滤。 类型：String 必选：否 tag:tag-key 按照【标签键值对】进行过滤。 tag-key使用具体的标签键进行替换。 每次请求的 Filters 的上限为 10，Filter.Values 的上限为 100。参数不支持同时指定 DiskIds 和 Filters。

getLimit

public Long getLimit()

Get 返回数量，默认为20，最大值为100。

Returns:

Limit 返回数量，默认为20，最大值为100。

setLimit

public void setLimit(Long Limit)

Set 返回数量，默认为20，最大值为100。

Parameters:

Limit - 返回数量，默认为20，最大值为100。

getOffset

public Long getOffset()

Get 偏移量，默认为0。

Returns:

Offset 偏移量，默认为0。

setOffset

public void setOffset(Long Offset)

Set 偏移量，默认为0。

Parameters:

Offset - 偏移量，默认为0。

getOrderField

public String getOrderField()

Get 云硬盘列表排序的依据字段。取值范围："CREATED_TIME"：依据云硬盘的创建时间排序。 "EXPIRED_TIME"：依据云硬盘的到期时间排序。"DISK_SIZE"：依据云硬盘的大小排序。默认按云硬盘创建时间排序。

Returns:

OrderField 云硬盘列表排序的依据字段。取值范围："CREATED_TIME"：依据云硬盘的创建时间排序。 "EXPIRED_TIME"：依据云硬盘的到期时间排序。"DISK_SIZE"：依据云硬盘的大小排序。默认按云硬盘创建时间排序。

setOrderField

public void setOrderField(String OrderField)

Set 云硬盘列表排序的依据字段。取值范围："CREATED_TIME"：依据云硬盘的创建时间排序。 "EXPIRED_TIME"：依据云硬盘的到期时间排序。"DISK_SIZE"：依据云硬盘的大小排序。默认按云硬盘创建时间排序。

Parameters:

OrderField - 云硬盘列表排序的依据字段。取值范围："CREATED_TIME"：依据云硬盘的创建时间排序。 "EXPIRED_TIME"：依据云硬盘的到期时间排序。"DISK_SIZE"：依据云硬盘的大小排序。默认按云硬盘创建时间排序。

getOrder

public String getOrder()

Get 输出云硬盘列表的排列顺序。取值范围："ASC"：升序排列。 "DESC"：降序排列。默认按降序排列。

Returns:

Order 输出云硬盘列表的排列顺序。取值范围："ASC"：升序排列。 "DESC"：降序排列。默认按降序排列。

setOrder

public void setOrder(String Order)

Set 输出云硬盘列表的排列顺序。取值范围："ASC"：升序排列。 "DESC"：降序排列。默认按降序排列。

Parameters:

Order - 输出云硬盘列表的排列顺序。取值范围："ASC"：升序排列。 "DESC"：降序排列。默认按降序排列。

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.