com.tencentcloudapi.es.v20180416.models

Class DescribeInstancesRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.es.v20180416.models.DescribeInstancesRequest

public class DescribeInstancesRequest
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
DescribeInstancesRequest()
DescribeInstancesRequest(DescribeInstancesRequest 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
Long[]	getHealthStatus() Get The health status filter.
String[]	getInstanceIds() Get List of cluster instance IDs
String[]	getInstanceNames() Get List of cluster instance names
String[]	getIpList() Get VPC VIP list
Long	getLimit() Get Number of entries per page.
Long	getOffset() Get Pagination start value.
Long	getOrderByKey() Get The sorting field.
Long	getOrderByType() Get Sorting order 0: ascending 1: descending If orderByKey is passed in but orderByType is not, ascending order is used by default
TagInfo[]	getTagList() Get Node tag information list
String[]	getVpcIds() Get VPC IDs
String	getZone() Get AZ of the cluster instance.
String[]	getZoneList() Get List of availability zones
void	setHealthStatus(Long[] HealthStatus) Set The health status filter.
void	setInstanceIds(String[] InstanceIds) Set List of cluster instance IDs
void	setInstanceNames(String[] InstanceNames) Set List of cluster instance names
void	setIpList(String[] IpList) Set VPC VIP list
void	setLimit(Long Limit) Set Number of entries per page.
void	setOffset(Long Offset) Set Pagination start value.
void	setOrderByKey(Long OrderByKey) Set The sorting field.
void	setOrderByType(Long OrderByType) Set Sorting order 0: ascending 1: descending If orderByKey is passed in but orderByType is not, ascending order is used by default
void	setTagList(TagInfo[] TagList) Set Node tag information list
void	setVpcIds(String[] VpcIds) Set VPC IDs
void	setZone(String Zone) Set AZ of the cluster instance.
void	setZoneList(String[] ZoneList) Set List of availability zones
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

DescribeInstancesRequest

public DescribeInstancesRequest()

DescribeInstancesRequest

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

getZone

public String getZone()

Get AZ of the cluster instance. If this is not passed in, all AZs are used by default

Returns:

Zone AZ of the cluster instance. If this is not passed in, all AZs are used by default

setZone

public void setZone(String Zone)

Set AZ of the cluster instance. If this is not passed in, all AZs are used by default

Parameters:

Zone - AZ of the cluster instance. If this is not passed in, all AZs are used by default

getInstanceIds

public String[] getInstanceIds()

Get List of cluster instance IDs

Returns:

InstanceIds List of cluster instance IDs

setInstanceIds

public void setInstanceIds(String[] InstanceIds)

Set List of cluster instance IDs

Parameters:

InstanceIds - List of cluster instance IDs

getInstanceNames

public String[] getInstanceNames()

Get List of cluster instance names

Returns:

InstanceNames List of cluster instance names

setInstanceNames

public void setInstanceNames(String[] InstanceNames)

Set List of cluster instance names

Parameters:

InstanceNames - List of cluster instance names

getOffset

public Long getOffset()

Get Pagination start value. Default value: 0

Returns:

Offset Pagination start value. Default value: 0

setOffset

public void setOffset(Long Offset)

Set Pagination start value. Default value: 0

Parameters:

Offset - Pagination start value. Default value: 0

getLimit

public Long getLimit()

Get Number of entries per page. Default value: 20

Returns:

Limit Number of entries per page. Default value: 20

setLimit

public void setLimit(Long Limit)

Set Number of entries per page. Default value: 20

Parameters:

Limit - Number of entries per page. Default value: 20

getOrderByKey

public Long getOrderByKey()

Get The sorting field.

1: Instance ID 2: Instance name 3: AZ 4: Creation time If `OrderByKey` is not passed in, sorting is performed by creation time in descending order.

Returns:

OrderByKey The sorting field.

1: Instance ID

2: Instance name

3: AZ

4: Creation time

If `OrderByKey` is not passed in, sorting is performed by creation time in descending order.

setOrderByKey

public void setOrderByKey(Long OrderByKey)

Set The sorting field.

1: Instance ID 2: Instance name 3: AZ 4: Creation time If `OrderByKey` is not passed in, sorting is performed by creation time in descending order.