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 List of cloud disk IDs.
Filter[]	getFilters() Get Filter list disk-id Filter by **cloud disk ID**.
Long	getLimit() Get Number of returned results.
Long	getOffset() Get Offset.
String	getOrder() Get Sorting order of the output cloud disks.
String	getOrderField() Get The field by which the cloud disks are sorted.
void	setDiskIds(String[] DiskIds) Set List of cloud disk IDs.
void	setFilters(Filter[] Filters) Set Filter list disk-id Filter by **cloud disk ID**.
void	setLimit(Long Limit) Set Number of returned results.
void	setOffset(Long Offset) Set Offset.
void	setOrder(String Order) Set Sorting order of the output cloud disks.
void	setOrderField(String OrderField) Set The field by which the cloud disks are sorted.
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, 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 List of cloud disk IDs.

Returns:

DiskIds List of cloud disk IDs.

setDiskIds

public void setDiskIds(String[] DiskIds)

Set List of cloud disk IDs.

Parameters:

DiskIds - List of cloud disk IDs.

getFilters

public Filter[] getFilters()

Get Filter list disk-id Filter by **cloud disk ID**. Type: String Required: No instance-id Filter by **instance ID**. Type: String Required: No disk-name Filter by **cloud disk name**. Type: String Required: No zone Filter by **availability zone**. Type: String Required: No disk-usage Filter by **cloud disk type**. Type: String Required: No Values: `SYSTEM_DISK` and `DATA_DISK` disk-state Filter by **cloud disk status**. Type: String Required: No Values: See `DiskState` in [Disk](https://intl.cloud.tencent.com/document/api/1207/47576?from_cn_redirect=1#Disk) Each request can contain up to 10 `Filters` and 100 `Filter.Values`. `DiskIds` and `Filters` cannot be specified at the same time.

Returns:

Filters Filter list disk-id Filter by **cloud disk ID**. Type: String Required: No instance-id Filter by **instance ID**. Type: String Required: No disk-name Filter by **cloud disk name**. Type: String Required: No zone Filter by **availability zone**. Type: String Required: No disk-usage Filter by **cloud disk type**. Type: String Required: No Values: `SYSTEM_DISK` and `DATA_DISK` disk-state Filter by **cloud disk status**. Type: String Required: No Values: See `DiskState` in [Disk](https://intl.cloud.tencent.com/document/api/1207/47576?from_cn_redirect=1#Disk) Each request can contain up to 10 `Filters` and 100 `Filter.Values`. `DiskIds` and `Filters` cannot be specified at the same time.

setFilters

public void setFilters(Filter[] Filters)

Set Filter list disk-id Filter by **cloud disk ID**. Type: String Required: No instance-id Filter by **instance ID**. Type: String Required: No disk-name Filter by **cloud disk name**. Type: String Required: No zone Filter by **availability zone**. Type: String Required: No disk-usage Filter by **cloud disk type**. Type: String Required: No Values: `SYSTEM_DISK` and `DATA_DISK` disk-state Filter by **cloud disk status**. Type: String Required: No Values: See `DiskState` in [Disk](https://intl.cloud.tencent.com/document/api/1207/47576?from_cn_redirect=1#Disk) Each request can contain up to 10 `Filters` and 100 `Filter.Values`. `DiskIds` and `Filters` cannot be specified at the same time.

Parameters:

Filters - Filter list disk-id Filter by **cloud disk ID**. Type: String Required: No instance-id Filter by **instance ID**. Type: String Required: No disk-name Filter by **cloud disk name**. Type: String Required: No zone Filter by **availability zone**. Type: String Required: No disk-usage Filter by **cloud disk type**. Type: String Required: No Values: `SYSTEM_DISK` and `DATA_DISK` disk-state Filter by **cloud disk status**. Type: String Required: No Values: See `DiskState` in [Disk](https://intl.cloud.tencent.com/document/api/1207/47576?from_cn_redirect=1#Disk) Each request can contain up to 10 `Filters` and 100 `Filter.Values`. `DiskIds` and `Filters` cannot be specified at the same time.

getLimit

public Long getLimit()

Get Number of returned results. Default value: 20. Maximum value: 100.

Returns:

Limit Number of returned results. Default value: 20. Maximum value: 100.

setLimit

public void setLimit(Long Limit)

Set Number of returned results. Default value: 20. Maximum value: 100.

Parameters:

Limit - Number of returned results. Default value: 20. Maximum value: 100.

getOffset

public Long getOffset()

Get Offset. Default value: 0.

Returns:

Offset Offset. Default value: 0.

setOffset

public void setOffset(Long Offset)

Set Offset. Default value: 0.

Parameters:

Offset - Offset. Default value: 0.

getOrderField

public String getOrderField()

Get The field by which the cloud disks are sorted. Valid values: "CREATED_TIME" (creation time), "EXPIRED_TIME" (expiration time), "DISK_SIZE" (size of cloud disks). Default value: "CREATED_TIME".

Returns:

OrderField The field by which the cloud disks are sorted. Valid values: "CREATED_TIME" (creation time), "EXPIRED_TIME" (expiration time), "DISK_SIZE" (size of cloud disks). Default value: "CREATED_TIME".

setOrderField

public void setOrderField(String OrderField)

Set The field by which the cloud disks are sorted. Valid values: "CREATED_TIME" (creation time), "EXPIRED_TIME" (expiration time), "DISK_SIZE" (size of cloud disks). Default value: "CREATED_TIME".

Parameters:

OrderField - The field by which the cloud disks are sorted. Valid values: "CREATED_TIME" (creation time), "EXPIRED_TIME" (expiration time), "DISK_SIZE" (size of cloud disks). Default value: "CREATED_TIME".

getOrder

public String getOrder()

Get Sorting order of the output cloud disks. Valid values: "ASC" (ascending order), "DESC" (descending order). Default value: "DESC".

Returns:

Order Sorting order of the output cloud disks. Valid values: "ASC" (ascending order), "DESC" (descending order). Default value: "DESC".

setOrder

public void setOrder(String Order)

Set Sorting order of the output cloud disks. Valid values: "ASC" (ascending order), "DESC" (descending order). Default value: "DESC".

Parameters:

Order - Sorting order of the output cloud disks. Valid values: "ASC" (ascending order), "DESC" (descending order). Default value: "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