com.tencentcloudapi.es.v20180416.models

Class DescribeIndexListRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.es.v20180416.models.DescribeIndexListRequest

public class DescribeIndexListRequest
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
DescribeIndexListRequest()
DescribeIndexListRequest(DescribeIndexListRequest 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	getIndexName() Get Index name.
String[]	getIndexStatusList() Get Filtering by index status
String	getIndexType() Get Index type.
String	getInstanceId() Get ES cluster ID
Long	getLimit() Get The number of results per page
Long	getOffset() Get The starting position of paging
String	getOrder() Get Sorting mode, which can be `asc` and `desc`.
String	getOrderBy() Get Sorting condition field, which can be `IndexName`, `IndexStorage`, or `IndexCreateTime`.
String	getPassword() Get Password for cluster access
String	getUsername() Get Username for cluster access
void	setIndexName(String IndexName) Set Index name.
void	setIndexStatusList(String[] IndexStatusList) Set Filtering by index status
void	setIndexType(String IndexType) Set Index type.
void	setInstanceId(String InstanceId) Set ES cluster ID
void	setLimit(Long Limit) Set The number of results per page
void	setOffset(Long Offset) Set The starting position of paging
void	setOrder(String Order) Set Sorting mode, which can be `asc` and `desc`.
void	setOrderBy(String OrderBy) Set Sorting condition field, which can be `IndexName`, `IndexStorage`, or `IndexCreateTime`.
void	setPassword(String Password) Set Password for cluster access
void	setUsername(String Username) Set Username for cluster access
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

DescribeIndexListRequest

public DescribeIndexListRequest()

DescribeIndexListRequest

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

getIndexType

public String getIndexType()

Get Index type. `auto`: Automated; `normal`: General.

Returns:

IndexType Index type. `auto`: Automated; `normal`: General.

setIndexType

public void setIndexType(String IndexType)

Set Index type. `auto`: Automated; `normal`: General.

Parameters:

IndexType - Index type. `auto`: Automated; `normal`: General.

getInstanceId

public String getInstanceId()

Get ES cluster ID

Returns:

InstanceId ES cluster ID

setInstanceId

public void setInstanceId(String InstanceId)

Set ES cluster ID

Parameters:

InstanceId - ES cluster ID

getIndexName

public String getIndexName()

Get Index name. `null` indicates that all indexes are requested.

Returns:

IndexName Index name. `null` indicates that all indexes are requested.

setIndexName

public void setIndexName(String IndexName)

Set Index name. `null` indicates that all indexes are requested.

Parameters:

IndexName - Index name. `null` indicates that all indexes are requested.

getUsername

public String getUsername()

Get Username for cluster access

Returns:

Username Username for cluster access

setUsername

public void setUsername(String Username)

Set Username for cluster access

Parameters:

Username - Username for cluster access

getPassword

public String getPassword()

Get Password for cluster access

Returns:

Password Password for cluster access

setPassword

public void setPassword(String Password)

Set Password for cluster access

Parameters:

Password - Password for cluster access

getOffset

public Long getOffset()

Get The starting position of paging

Returns:

Offset The starting position of paging

setOffset

public void setOffset(Long Offset)

Set The starting position of paging

Parameters:

Offset - The starting position of paging

getLimit

public Long getLimit()

Get The number of results per page

Returns:

Limit The number of results per page

setLimit

public void setLimit(Long Limit)

Set The number of results per page

Parameters:

Limit - The number of results per page

getOrderBy

public String getOrderBy()

Get Sorting condition field, which can be `IndexName`, `IndexStorage`, or `IndexCreateTime`.

Returns:

OrderBy Sorting condition field, which can be `IndexName`, `IndexStorage`, or `IndexCreateTime`.

setOrderBy

public void setOrderBy(String OrderBy)

Set Sorting condition field, which can be `IndexName`, `IndexStorage`, or `IndexCreateTime`.

Parameters:

OrderBy - Sorting condition field, which can be `IndexName`, `IndexStorage`, or `IndexCreateTime`.

getIndexStatusList

public String[] getIndexStatusList()

Get Filtering by index status

Returns:

IndexStatusList Filtering by index status

setIndexStatusList

public void setIndexStatusList(String[] IndexStatusList)

Set Filtering by index status

Parameters:

IndexStatusList - Filtering by index status

getOrder

public String getOrder()

Get Sorting mode, which can be `asc` and `desc`.

Returns:

Order Sorting mode, which can be `asc` and `desc`.

setOrder

public void setOrder(String Order)

Set Sorting mode, which can be `asc` and `desc`.

Parameters:

Order - Sorting mode, which can be `asc` and `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.