com.tencentcloudapi.ecm.v20190719.models

Class DescribeModuleRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.ecm.v20190719.models.DescribeModuleRequest

public class DescribeModuleRequest
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
DescribeModuleRequest()
DescribeModuleRequest(DescribeModuleRequest 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
Filter[]	getFilters() Get Filter.
Long	getLimit() Get Number of returned results.
Long	getOffset() Get Offset.
String	getOrderByField() Get Specified sort by field.
Long	getOrderDirection() Get Sorting order.
void	setFilters(Filter[] Filters) Set Filter.
void	setLimit(Long Limit) Set Number of returned results.
void	setOffset(Long Offset) Set Offset.
void	setOrderByField(String OrderByField) Set Specified sort by field.
void	setOrderDirection(Long OrderDirection) Set Sorting order.
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

DescribeModuleRequest

public DescribeModuleRequest()

DescribeModuleRequest

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

getFilters

public Filter[] getFilters()

Get Filter. module-name - string - Required: no - (Filter) Filter by module name. module-id - string - Required: no - (Filter) Filter by module ID. image-id String Required: no (Filter) Filter by image ID. instance-family String Required: no (Filter) Filter by model family. security-group-id - string Required: no - (Filter) Filter by ID of the security group bound to the module. Each request can contain up to 10 `Filters` and 5 `Filter.Values`.

Returns:

Filters Filter. module-name - string - Required: no - (Filter) Filter by module name. module-id - string - Required: no - (Filter) Filter by module ID. image-id String Required: no (Filter) Filter by image ID. instance-family String Required: no (Filter) Filter by model family. security-group-id - string Required: no - (Filter) Filter by ID of the security group bound to the module. Each request can contain up to 10 `Filters` and 5 `Filter.Values`.

setFilters

public void setFilters(Filter[] Filters)

Set Filter. module-name - string - Required: no - (Filter) Filter by module name. module-id - string - Required: no - (Filter) Filter by module ID. image-id String Required: no (Filter) Filter by image ID. instance-family String Required: no (Filter) Filter by model family. security-group-id - string Required: no - (Filter) Filter by ID of the security group bound to the module. Each request can contain up to 10 `Filters` and 5 `Filter.Values`.

Parameters:

Filters - Filter. module-name - string - Required: no - (Filter) Filter by module name. module-id - string - Required: no - (Filter) Filter by module ID. image-id String Required: no (Filter) Filter by image ID. instance-family String Required: no (Filter) Filter by model family. security-group-id - string Required: no - (Filter) Filter by ID of the security group bound to the module. Each request can contain up to 10 `Filters` and 5 `Filter.Values`.

getOffset

public Long getOffset()

Get Offset. Default value: 0. For more information on `Offset`, see the relevant section of the API overview.

Returns:

Offset Offset. Default value: 0. For more information on `Offset`, see the relevant section of the API overview.

setOffset

public void setOffset(Long Offset)

Set Offset. Default value: 0. For more information on `Offset`, see the relevant section of the API overview.

Parameters:

Offset - Offset. Default value: 0. For more information on `Offset`, see the relevant section of the API overview.

getLimit

public Long getLimit()

Get Number of returned results. Default value: 20. Maximum value: 100. For more information on `Limit`, see the relevant section of the API overview.

Returns:

Limit Number of returned results. Default value: 20. Maximum value: 100. For more information on `Limit`, see the relevant section of the API overview.

setLimit

public void setLimit(Long Limit)

Set Number of returned results. Default value: 20. Maximum value: 100. For more information on `Limit`, see the relevant section of the API overview.

Parameters:

Limit - Number of returned results. Default value: 20. Maximum value: 100. For more information on `Limit`, see the relevant section of the API overview.

getOrderByField

public String getOrderByField()

Get Specified sort by field. Currently, valid values are as follows: instance-num: sort by the number of instances. node-num: sort by the number of nodes. timestamp: sort by instance creation time. If this parameter is not specified, instances will be sorted by creation time by default.

Returns:

OrderByField Specified sort by field. Currently, valid values are as follows: instance-num: sort by the number of instances. node-num: sort by the number of nodes. timestamp: sort by instance creation time. If this parameter is not specified, instances will be sorted by creation time by default.

setOrderByField

public void setOrderByField(String OrderByField)

Set Specified sort by field. Currently, valid values are as follows: instance-num: sort by the number of instances. node-num: sort by the number of nodes. timestamp: sort by instance creation time. If this parameter is not specified, instances will be sorted by creation time by default.

Parameters:

OrderByField - Specified sort by field. Currently, valid values are as follows: instance-num: sort by the number of instances. node-num: sort by the number of nodes. timestamp: sort by instance creation time. If this parameter is not specified, instances will be sorted by creation time by default.

getOrderDirection

public Long getOrderDirection()

Get Sorting order. 0: descending; 1: ascending. If this parameter is not specified, it will be descending by default.

Returns:

OrderDirection Sorting order. 0: descending; 1: ascending. If this parameter is not specified, it will be descending by default.

setOrderDirection

public void setOrderDirection(Long OrderDirection)

Set Sorting order. 0: descending; 1: ascending. If this parameter is not specified, it will be descending by default.

Parameters:

OrderDirection - Sorting order. 0: descending; 1: ascending. If this parameter is not specified, it will be descending by default.

toMap

public void toMap(HashMap<String,String> map,
                  String prefix)

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel