com.tencentcloudapi.teo.v20220901.models

Class DescribeZonesRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.teo.v20220901.models.DescribeZonesRequest

public class DescribeZonesRequest
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
DescribeZonesRequest()
DescribeZonesRequest(DescribeZonesRequest 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	getDirection() Get Sort direction.
AdvancedFilter[]	getFilters() Get Filter criteria.
Long	getLimit() Get Limit on paginated queries.
Long	getOffset() Get The page offset.
String	getOrder() Get Sort the returned results according to this field.
void	setDirection(String Direction) Set Sort direction.
void	setFilters(AdvancedFilter[] Filters) Set Filter criteria.
void	setLimit(Long Limit) Set Limit on paginated queries.
void	setOffset(Long Offset) Set The page offset.
void	setOrder(String Order) Set Sort the returned results according to this field.
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

DescribeZonesRequest

public DescribeZonesRequest()

DescribeZonesRequest

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

getOffset

public Long getOffset()

Get The page offset. Default value: 0

Returns:

Offset The page offset. Default value: 0

setOffset

public void setOffset(Long Offset)

Set The page offset. Default value: 0

Parameters:

Offset - The page offset. Default value: 0

getLimit

public Long getLimit()

Get Limit on paginated queries. Default value: 20. Maximum value: 100.

Returns:

Limit Limit on paginated queries. Default value: 20. Maximum value: 100.

setLimit

public void setLimit(Long Limit)

Set Limit on paginated queries. Default value: 20. Maximum value: 100.

Parameters:

Limit - Limit on paginated queries. Default value: 20. Maximum value: 100.

getFilters

public AdvancedFilter[] getFilters()

Get Filter criteria. the maximum value of Filters.Values is 20. if this parameter is left empty, all site information authorized under the current appid will be returned. detailed filter criteria are as follows:.

zone-name: filter by site name; zone-id: filter by site id. the site id is in the format of zone-2noz78a8ev6k; status: filter by site status; tag-key: filter by tag key; tag-value: filter by tag value; alias-zone-name: filter by identical site identifier. when performing a fuzzy query, the fields that support filtering are named zone-name or alias-zone-name.

Returns:

Filters Filter criteria. the maximum value of Filters.Values is 20. if this parameter is left empty, all site information authorized under the current appid will be returned. detailed filter criteria are as follows:.

zone-name: filter by site name;

zone-id: filter by site id. the site id is in the format of zone-2noz78a8ev6k;

status: filter by site status;

tag-key: filter by tag key;

tag-value: filter by tag value;

alias-zone-name: filter by identical site identifier.

when performing a fuzzy query, the fields that support filtering are named zone-name or alias-zone-name.

setFilters

public void setFilters(AdvancedFilter[] Filters)

Set Filter criteria. the maximum value of Filters.Values is 20. if this parameter is left empty, all site information authorized under the current appid will be returned. detailed filter criteria are as follows:.

zone-name: filter by site name; zone-id: filter by site id. the site id is in the format of zone-2noz78a8ev6k; status: filter by site status; tag-key: filter by tag key; tag-value: filter by tag value; alias-zone-name: filter by identical site identifier. when performing a fuzzy query, the fields that support filtering are named zone-name or alias-zone-name.