com.tencentcloudapi.redis.v20180412.models

Class DescribeInstancesRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.redis.v20180412.models.DescribeInstancesRequest

public class DescribeInstancesRequest
extends AbstractModel

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[]	getAutoRenew() Get Renewal mode.
String	getBillingMode() Get Billing mode.
String	getEngineName() Get Engine information: Redis-2.8, Redis-4.0, CKV
String	getInstanceId() Get Instance ID, such as crs-6ubhgouj
String[]	getInstanceIds() Get The specified instances for batch query
String	getInstanceName() Get Instance name
InstanceTagInfo[]	getInstanceTags() Get Filters resources by tag key and value.
Long	getLimit() Get Number of returned results.
String	getMonitorVersion() Get Internal parameter, which can be ignored.
Long	getOffset() Get Offset, which is an integral multiple of `Limit`.
String	getOrderBy() Get Enumerated values: projectId, createtime, instancename, type, curDeadline
Long	getOrderType() Get 1: reverse; 0: sequential; reverse by default
String[]	getProductVersions() Get Product editions to be filtered.
Long[]	getProjectIds() Get Array of project IDs.
Long[]	getRegionIds() Get Region ID, which has already been disused.
String	getSearchKey() Get ID of the instance to be searched for.
String[]	getSearchKeys() Get Search keywords, which can be instance ID, instance name, or complete IP.
Long[]	getStatus() Get Instance status.
String[]	getSubnetIds() Get Array of subnet IDs such as 56854.
String[]	getTagKeys() Get Filters resources by tag key.
Long	getType() Get Instance type.
Long[]	getTypeList() Get Internal parameter, which can be ignored.
Long	getTypeVersion() Get Type edition.
String[]	getUniqSubnetIds() Get Array of subnet IDs such as subnet-fdj24n34j2.
String[]	getUniqVpcIds() Get Array of VPC IDs such as vpc-sad23jfdfk.
String[]	getVpcIds() Get Array of VPC IDs such as 47525.
void	setAutoRenew(Long[] AutoRenew) Set Renewal mode.
void	setBillingMode(String BillingMode) Set Billing mode.
void	setEngineName(String EngineName) Set Engine information: Redis-2.8, Redis-4.0, CKV
void	setInstanceId(String InstanceId) Set Instance ID, such as crs-6ubhgouj
void	setInstanceIds(String[] InstanceIds) Set The specified instances for batch query
void	setInstanceName(String InstanceName) Set Instance name
void	setInstanceTags(InstanceTagInfo[] InstanceTags) Set Filters resources by tag key and value.
void	setLimit(Long Limit) Set Number of returned results.
void	setMonitorVersion(String MonitorVersion) Set Internal parameter, which can be ignored.
void	setOffset(Long Offset) Set Offset, which is an integral multiple of `Limit`.
void	setOrderBy(String OrderBy) Set Enumerated values: projectId, createtime, instancename, type, curDeadline
void	setOrderType(Long OrderType) Set 1: reverse; 0: sequential; reverse by default
void	setProductVersions(String[] ProductVersions) Set Product editions to be filtered.
void	setProjectIds(Long[] ProjectIds) Set Array of project IDs.
void	setRegionIds(Long[] RegionIds) Set Region ID, which has already been disused.
void	setSearchKey(String SearchKey) Set ID of the instance to be searched for.
void	setSearchKeys(String[] SearchKeys) Set Search keywords, which can be instance ID, instance name, or complete IP.
void	setStatus(Long[] Status) Set Instance status.
void	setSubnetIds(String[] SubnetIds) Set Array of subnet IDs such as 56854.
void	setTagKeys(String[] TagKeys) Set Filters resources by tag key.
void	setType(Long Type) Set Instance type.
void	setTypeList(Long[] TypeList) Set Internal parameter, which can be ignored.
void	setTypeVersion(Long TypeVersion) Set Type edition.
void	setUniqSubnetIds(String[] UniqSubnetIds) Set Array of subnet IDs such as subnet-fdj24n34j2.
void	setUniqVpcIds(String[] UniqVpcIds) Set Array of VPC IDs such as vpc-sad23jfdfk.
void	setVpcIds(String[] VpcIds) Set Array of VPC IDs such as 47525.
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, getMultipartRequestParams, set, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, 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

getLimit

public Long getLimit()

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

Returns:

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

setLimit

public void setLimit(Long Limit)

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

Parameters:

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

getOffset

public Long getOffset()

Get Offset, which is an integral multiple of `Limit`.

Returns:

Offset Offset, which is an integral multiple of `Limit`.

setOffset

public void setOffset(Long Offset)

Set Offset, which is an integral multiple of `Limit`.

Parameters:

Offset - Offset, which is an integral multiple of `Limit`.

getInstanceId

public String getInstanceId()

Get Instance ID, such as crs-6ubhgouj

Returns:

InstanceId Instance ID, such as crs-6ubhgouj

setInstanceId

public void setInstanceId(String InstanceId)

Set Instance ID, such as crs-6ubhgouj

Parameters:

InstanceId - Instance ID, such as crs-6ubhgouj

getOrderBy

public String getOrderBy()

Get Enumerated values: projectId, createtime, instancename, type, curDeadline

Returns:

OrderBy Enumerated values: projectId, createtime, instancename, type, curDeadline

setOrderBy

public void setOrderBy(String OrderBy)

Set Enumerated values: projectId, createtime, instancename, type, curDeadline

Parameters:

OrderBy - Enumerated values: projectId, createtime, instancename, type, curDeadline

getOrderType

public Long getOrderType()

Get 1: reverse; 0: sequential; reverse by default

Returns:

OrderType 1: reverse; 0: sequential; reverse by default

setOrderType

public void setOrderType(Long OrderType)

Set 1: reverse; 0: sequential; reverse by default

Parameters:

OrderType - 1: reverse; 0: sequential; reverse by default

getVpcIds

public String[] getVpcIds()

Get Array of VPC IDs such as 47525. The array subscript starts from 0. If this parameter is not passed in, the classic network will be selected by default

Returns:

VpcIds Array of VPC IDs such as 47525. The array subscript starts from 0. If this parameter is not passed in, the classic network will be selected by default

setVpcIds

public void setVpcIds(String[] VpcIds)

Set Array of VPC IDs such as 47525. The array subscript starts from 0. If this parameter is not passed in, the classic network will be selected by default

Parameters:

VpcIds - Array of VPC IDs such as 47525. The array subscript starts from 0. If this parameter is not passed in, the classic network will be selected by default

getSubnetIds

public String[] getSubnetIds()

Get Array of subnet IDs such as 56854. The array subscript starts from 0.

Returns:

SubnetIds Array of subnet IDs such as 56854. The array subscript starts from 0.

setSubnetIds

public void setSubnetIds(String[] SubnetIds)

Set Array of subnet IDs such as 56854. The array subscript starts from 0.

Parameters:

SubnetIds - Array of subnet IDs such as 56854. The array subscript starts from 0.

getProjectIds

public Long[] getProjectIds()

Get Array of project IDs. The array subscript starts from 0.

Returns:

ProjectIds Array of project IDs. The array subscript starts from 0.

setProjectIds

public void setProjectIds(Long[] ProjectIds)

Set Array of project IDs. The array subscript starts from 0.

Parameters:

ProjectIds - Array of project IDs. The array subscript starts from 0.

getSearchKey

public String getSearchKey()

Get ID of the instance to be searched for.

Returns:

SearchKey ID of the instance to be searched for.

setSearchKey

public void setSearchKey(String SearchKey)

Set ID of the instance to be searched for.

Parameters:

SearchKey - ID of the instance to be searched for.

getInstanceName

public String getInstanceName()

Get Instance name

Returns:

InstanceName Instance name

setInstanceName

public void setInstanceName(String InstanceName)

Set Instance name

Parameters:

InstanceName - Instance name

getUniqVpcIds

public String[] getUniqVpcIds()

Get Array of VPC IDs such as vpc-sad23jfdfk. The array subscript starts from 0. If this parameter is not passed in, the classic network will be selected by default

Returns:

UniqVpcIds Array of VPC IDs such as vpc-sad23jfdfk. The array subscript starts from 0. If this parameter is not passed in, the classic network will be selected by default

setUniqVpcIds

public void setUniqVpcIds(String[] UniqVpcIds)

Set Array of VPC IDs such as vpc-sad23jfdfk. The array subscript starts from 0. If this parameter is not passed in, the classic network will be selected by default

Parameters:

UniqVpcIds - Array of VPC IDs such as vpc-sad23jfdfk. The array subscript starts from 0. If this parameter is not passed in, the classic network will be selected by default

getUniqSubnetIds

public String[] getUniqSubnetIds()

Get Array of subnet IDs such as subnet-fdj24n34j2. The array subscript starts from 0.

Returns:

UniqSubnetIds Array of subnet IDs such as subnet-fdj24n34j2. The array subscript starts from 0.

setUniqSubnetIds

public void setUniqSubnetIds(String[] UniqSubnetIds)

Set Array of subnet IDs such as subnet-fdj24n34j2. The array subscript starts from 0.

Parameters:

UniqSubnetIds - Array of subnet IDs such as subnet-fdj24n34j2. The array subscript starts from 0.

getRegionIds

public Long[] getRegionIds()

Get Region ID, which has already been disused. The corresponding region can be queried through the common parameter `Region`.

Returns:

RegionIds Region ID, which has already been disused. The corresponding region can be queried through the common parameter `Region`.

setRegionIds

public void setRegionIds(Long[] RegionIds)

Set Region ID, which has already been disused. The corresponding region can be queried through the common parameter `Region`.

Parameters:

RegionIds - Region ID, which has already been disused. The corresponding region can be queried through the common parameter `Region`.

getStatus

public Long[] getStatus()

Get Instance status. 0: to be initialized; 1: in process; 2: running; -2: isolated; -3: to be deleted

Returns:

Status Instance status. 0: to be initialized; 1: in process; 2: running; -2: isolated; -3: to be deleted

setStatus

public void setStatus(Long[] Status)

Set Instance status. 0: to be initialized; 1: in process; 2: running; -2: isolated; -3: to be deleted

Parameters:

Status - Instance status. 0: to be initialized; 1: in process; 2: running; -2: isolated; -3: to be deleted

getTypeVersion

public Long getTypeVersion()

Get Type edition. 1: Standalone Edition; 2: Master-Replica Edition; 3: Cluster Edition

Returns:

TypeVersion Type edition. 1: Standalone Edition; 2: Master-Replica Edition; 3: Cluster Edition

setTypeVersion

public void setTypeVersion(Long TypeVersion)

Set Type edition. 1: Standalone Edition; 2: Master-Replica Edition; 3: Cluster Edition

Parameters:

TypeVersion - Type edition. 1: Standalone Edition; 2: Master-Replica Edition; 3: Cluster Edition

getEngineName

public String getEngineName()

Get Engine information: Redis-2.8, Redis-4.0, CKV

Returns:

EngineName Engine information: Redis-2.8, Redis-4.0, CKV

setEngineName

public void setEngineName(String EngineName)

Set Engine information: Redis-2.8, Redis-4.0, CKV

Parameters:

EngineName - Engine information: Redis-2.8, Redis-4.0, CKV

getAutoRenew

public Long[] getAutoRenew()

Get Renewal mode. 0: default status (manual renewal); 1: auto-renewal enabled; 2: auto-renewal disabled

Returns:

AutoRenew Renewal mode. 0: default status (manual renewal); 1: auto-renewal enabled; 2: auto-renewal disabled

setAutoRenew

public void setAutoRenew(Long[] AutoRenew)

Set Renewal mode. 0: default status (manual renewal); 1: auto-renewal enabled; 2: auto-renewal disabled

Parameters:

AutoRenew - Renewal mode. 0: default status (manual renewal); 1: auto-renewal enabled; 2: auto-renewal disabled

getBillingMode

public String getBillingMode()

Get Billing mode. postpaid: pay-as-you-go; prepaid: monthly subscription

Returns:

BillingMode Billing mode. postpaid: pay-as-you-go; prepaid: monthly subscription

setBillingMode

public void setBillingMode(String BillingMode)

Set Billing mode. postpaid: pay-as-you-go; prepaid: monthly subscription

Parameters:

BillingMode - Billing mode. postpaid: pay-as-you-go; prepaid: monthly subscription

getType

public Long getType()

Get Instance type. 1: legacy Redis Cluster Edition, 2: Redis 2.8 Master-Replica Edition, 3: CKV Master-Replica Edition, 4: CKV Cluster Edition, 5: Redis 2.8 Standalone Edition, 6: Redis 4.0 Master-Replica Edition, 7: Redis 4.0 Cluster Edition, 8: Redis 5.0 Master-Replica Edition, 9: Redis 5.0 Cluster Edition

Returns:

Type Instance type. 1: legacy Redis Cluster Edition, 2: Redis 2.8 Master-Replica Edition, 3: CKV Master-Replica Edition, 4: CKV Cluster Edition, 5: Redis 2.8 Standalone Edition, 6: Redis 4.0 Master-Replica Edition, 7: Redis 4.0 Cluster Edition, 8: Redis 5.0 Master-Replica Edition, 9: Redis 5.0 Cluster Edition

setType

public void setType(Long Type)

Set Instance type. 1: legacy Redis Cluster Edition, 2: Redis 2.8 Master-Replica Edition, 3: CKV Master-Replica Edition, 4: CKV Cluster Edition, 5: Redis 2.8 Standalone Edition, 6: Redis 4.0 Master-Replica Edition, 7: Redis 4.0 Cluster Edition, 8: Redis 5.0 Master-Replica Edition, 9: Redis 5.0 Cluster Edition

Parameters:

Type - Instance type. 1: legacy Redis Cluster Edition, 2: Redis 2.8 Master-Replica Edition, 3: CKV Master-Replica Edition, 4: CKV Cluster Edition, 5: Redis 2.8 Standalone Edition, 6: Redis 4.0 Master-Replica Edition, 7: Redis 4.0 Cluster Edition, 8: Redis 5.0 Master-Replica Edition, 9: Redis 5.0 Cluster Edition

getSearchKeys

public String[] getSearchKeys()

Get Search keywords, which can be instance ID, instance name, or complete IP.

Returns:

SearchKeys Search keywords, which can be instance ID, instance name, or complete IP.

setSearchKeys

public void setSearchKeys(String[] SearchKeys)

Set Search keywords, which can be instance ID, instance name, or complete IP.

Parameters:

SearchKeys - Search keywords, which can be instance ID, instance name, or complete IP.

getTypeList

public Long[] getTypeList()

Get Internal parameter, which can be ignored.

Returns:

TypeList Internal parameter, which can be ignored.

setTypeList

public void setTypeList(Long[] TypeList)

Set Internal parameter, which can be ignored.

Parameters:

TypeList - Internal parameter, which can be ignored.

getMonitorVersion

public String getMonitorVersion()

Get Internal parameter, which can be ignored.

Returns:

MonitorVersion Internal parameter, which can be ignored.

setMonitorVersion

public void setMonitorVersion(String MonitorVersion)

Set Internal parameter, which can be ignored.

Parameters:

MonitorVersion - Internal parameter, which can be ignored.

getInstanceTags

public InstanceTagInfo[] getInstanceTags()

Get Filters resources by tag key and value. If this parameter is not specified or is an empty array, resources will not be filtered.

Returns:

InstanceTags Filters resources by tag key and value. If this parameter is not specified or is an empty array, resources will not be filtered.

setInstanceTags

public void setInstanceTags(InstanceTagInfo[] InstanceTags)

Set Filters resources by tag key and value. If this parameter is not specified or is an empty array, resources will not be filtered.

Parameters:

InstanceTags - Filters resources by tag key and value. If this parameter is not specified or is an empty array, resources will not be filtered.

getTagKeys

public String[] getTagKeys()

Get Filters resources by tag key. If this parameter is not specified or is an empty array, resources will not be filtered.

Returns:

TagKeys Filters resources by tag key. If this parameter is not specified or is an empty array, resources will not be filtered.

setTagKeys

public void setTagKeys(String[] TagKeys)

Set Filters resources by tag key. If this parameter is not specified or is an empty array, resources will not be filtered.

Parameters:

TagKeys - Filters resources by tag key. If this parameter is not specified or is an empty array, resources will not be filtered.

getProductVersions

public String[] getProductVersions()

Get Product editions to be filtered. Valid values: `local` (local disk edition), `cloud` (cloud disk edition), `cdc` (dedicated cluster edition). If this parameter is not passed in, the product will not be filtered by default.

Returns:

ProductVersions Product editions to be filtered. Valid values: `local` (local disk edition), `cloud` (cloud disk edition), `cdc` (dedicated cluster edition). If this parameter is not passed in, the product will not be filtered by default.

setProductVersions

public void setProductVersions(String[] ProductVersions)

Set Product editions to be filtered. Valid values: `local` (local disk edition), `cloud` (cloud disk edition), `cdc` (dedicated cluster edition). If this parameter is not passed in, the product will not be filtered by default.

Parameters:

ProductVersions - Product editions to be filtered. Valid values: `local` (local disk edition), `cloud` (cloud disk edition), `cdc` (dedicated cluster edition). If this parameter is not passed in, the product will not be filtered by default.

getInstanceIds

public String[] getInstanceIds()

Get The specified instances for batch query

Returns:

InstanceIds The specified instances for batch query

setInstanceIds

public void setInstanceIds(String[] InstanceIds)

Set The specified instances for batch query

Parameters:

InstanceIds - The specified instances for batch query

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel