com.tencentcloudapi.mongodb.v20190725.models

Class DescribeDBInstancesRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.mongodb.v20190725.models.DescribeDBInstancesRequest

public class DescribeDBInstancesRequest
extends AbstractModel

Constructor Summary

Constructors

Constructor and Description
DescribeDBInstancesRequest()
DescribeDBInstancesRequest(DescribeDBInstancesRequest 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	getClusterType() Get Cluster type.
String[]	getInstanceIds() Get List of instance IDs in the format of cmgo-p8vnipr5.
Long	getInstanceType() Get Instance type.
Long	getLimit() Get Number of results returned per request.
Long	getOffset() Get Offset.
String	getOrderBy() Get Sort by field of the returned result set.
String	getOrderByType() Get Sorting method of the return result set.
Long	getPayMode() Get Billing type.
Long[]	getProjectIds() Get Project ID
String	getSearchKey() Get Search keyword, which can be instance ID, instance name, or complete IP.
Long[]	getStatus() Get Instance status.
String	getSubnetId() Get Subnet ID of VPC.
TagInfo[]	getTags() Get Tag information
String	getVpcId() Get VPC ID.
void	setClusterType(Long ClusterType) Set Cluster type.
void	setInstanceIds(String[] InstanceIds) Set List of instance IDs in the format of cmgo-p8vnipr5.
void	setInstanceType(Long InstanceType) Set Instance type.
void	setLimit(Long Limit) Set Number of results returned per request.
void	setOffset(Long Offset) Set Offset.
void	setOrderBy(String OrderBy) Set Sort by field of the returned result set.
void	setOrderByType(String OrderByType) Set Sorting method of the return result set.
void	setPayMode(Long PayMode) Set Billing type.
void	setProjectIds(Long[] ProjectIds) Set Project ID
void	setSearchKey(String SearchKey) Set Search keyword, which can be instance ID, instance name, or complete IP.
void	setStatus(Long[] Status) Set Instance status.
void	setSubnetId(String SubnetId) Set Subnet ID of VPC.
void	setTags(TagInfo[] Tags) Set Tag information
void	setVpcId(String VpcId) Set VPC ID.
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

DescribeDBInstancesRequest

public DescribeDBInstancesRequest()

DescribeDBInstancesRequest

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

getInstanceIds

public String[] getInstanceIds()

Get List of instance IDs in the format of cmgo-p8vnipr5. It is the same as the instance ID displayed on the TencentDB console page.

Returns:

InstanceIds List of instance IDs in the format of cmgo-p8vnipr5. It is the same as the instance ID displayed on the TencentDB console page.

setInstanceIds

public void setInstanceIds(String[] InstanceIds)

Set List of instance IDs in the format of cmgo-p8vnipr5. It is the same as the instance ID displayed on the TencentDB console page.

Parameters:

InstanceIds - List of instance IDs in the format of cmgo-p8vnipr5. It is the same as the instance ID displayed on the TencentDB console page.

getInstanceType

public Long getInstanceType()

Get Instance type. Valid values:

• `0`: All instances.
• `1`: Regular instances.
• `2`: Temp instances.
• `3`: Read-only instances.
• `-1`: Regular instances, read-only instances, disaster recovery instances.

Returns:

InstanceType Instance type. Valid values:

• `0`: All instances.
• `1`: Regular instances.
• `2`: Temp instances.
• `3`: Read-only instances.
• `-1`: Regular instances, read-only instances, disaster recovery instances.

setInstanceType

public void setInstanceType(Long InstanceType)

Set Instance type. Valid values:

• `0`: All instances.
• `1`: Regular instances.
• `2`: Temp instances.
• `3`: Read-only instances.
• `-1`: Regular instances, read-only instances, disaster recovery instances.

Parameters:

InstanceType - Instance type. Valid values:

• `0`: All instances.
• `1`: Regular instances.
• `2`: Temp instances.
• `3`: Read-only instances.
• `-1`: Regular instances, read-only instances, disaster recovery instances.

getClusterType

public Long getClusterType()

Get Cluster type. Valid values:

• `0`: Replica set instances.
• `1`: Sharded cluster instances.
• `-1`: All instances.

Returns:

ClusterType Cluster type. Valid values:

• `0`: Replica set instances.
• `1`: Sharded cluster instances.
• `-1`: All instances.

setClusterType

public void setClusterType(Long ClusterType)

Set Cluster type. Valid values:

• `0`: Replica set instances.
• `1`: Sharded cluster instances.
• `-1`: All instances.

Parameters:

ClusterType - Cluster type. Valid values:

• `0`: Replica set instances.
• `1`: Sharded cluster instances.
• `-1`: All instances.

getStatus

public Long[] getStatus()

Get Instance status. Valid values:

• `0`: To be initialized.
• `1`: In process.
• `2`: Valid.
• `-2`: Isolated (for monthly subscribed instances).
• `-3`: Isolated (for pay-as-you-go instances).

Returns:

Status Instance status. Valid values:

• `0`: To be initialized.
• `1`: In process.
• `2`: Valid.
• `-2`: Isolated (for monthly subscribed instances).
• `-3`: Isolated (for pay-as-you-go instances).

setStatus

public void setStatus(Long[] Status)

Set Instance status. Valid values:

• `0`: To be initialized.
• `1`: In process.
• `2`: Valid.
• `-2`: Isolated (for monthly subscribed instances).
• `-3`: Isolated (for pay-as-you-go instances).

Parameters:

Status - Instance status. Valid values:

• `0`: To be initialized.
• `1`: In process.
• `2`: Valid.
• `-2`: Isolated (for monthly subscribed instances).
• `-3`: Isolated (for pay-as-you-go instances).

getVpcId

public String getVpcId()

Get VPC ID. This parameter can be left empty for the classic network.

Returns:

VpcId VPC ID. This parameter can be left empty for the classic network.

setVpcId

public void setVpcId(String VpcId)

Set VPC ID. This parameter can be left empty for the classic network.

Parameters:

VpcId - VPC ID. This parameter can be left empty for the classic network.

getSubnetId

public String getSubnetId()

Get Subnet ID of VPC. This parameter can be left empty for the classic network. If it is passed in as an input parameter, the corresponding VpcId must be set.

Returns:

SubnetId Subnet ID of VPC. This parameter can be left empty for the classic network. If it is passed in as an input parameter, the corresponding VpcId must be set.

setSubnetId

public void setSubnetId(String SubnetId)

Set Subnet ID of VPC. This parameter can be left empty for the classic network. If it is passed in as an input parameter, the corresponding VpcId must be set.

Parameters:

SubnetId - Subnet ID of VPC. This parameter can be left empty for the classic network. If it is passed in as an input parameter, the corresponding VpcId must be set.

getPayMode

public Long getPayMode()

Get Billing type. Valid value: 0 (pay-as-you-go)

Returns:

PayMode Billing type. Valid value: 0 (pay-as-you-go)

setPayMode

public void setPayMode(Long PayMode)

Set Billing type. Valid value: 0 (pay-as-you-go)

Parameters:

PayMode - Billing type. Valid value: 0 (pay-as-you-go)

getLimit

public Long getLimit()

Get Number of results returned per request. Default value: `20`. Value range: [1,100].

Returns:

Limit Number of results returned per request. Default value: `20`. Value range: [1,100].

setLimit

public void setLimit(Long Limit)

Set Number of results returned per request. Default value: `20`. Value range: [1,100].

Parameters:

Limit - Number of results returned per request. Default value: `20`. Value range: [1,100].

getOffset

public Long getOffset()

Get Offset. Default value: `0`.

Returns:

Offset Offset. Default value: `0`.

setOffset

public void setOffset(Long Offset)

Set Offset. Default value: `0`.

Parameters:

Offset - Offset. Default value: `0`.

getOrderBy

public String getOrderBy()

Get Sort by field of the returned result set. Valid values: `ProjectId`, `InstanceName`, `CreateTime`. The return results are sorted in ascending order by default.

Returns:

OrderBy Sort by field of the returned result set. Valid values: `ProjectId`, `InstanceName`, `CreateTime`. The return results are sorted in ascending order by default.

setOrderBy

public void setOrderBy(String OrderBy)

Set Sort by field of the returned result set. Valid values: `ProjectId`, `InstanceName`, `CreateTime`. The return results are sorted in ascending order by default.

Parameters:

OrderBy - Sort by field of the returned result set. Valid values: `ProjectId`, `InstanceName`, `CreateTime`. The return results are sorted in ascending order by default.

getOrderByType

public String getOrderByType()

Get Sorting method of the return result set. Valid values: `ASC`, `DESC`.

Returns:

OrderByType Sorting method of the return result set. Valid values: `ASC`, `DESC`.

setOrderByType

public void setOrderByType(String OrderByType)

Set Sorting method of the return result set. Valid values: `ASC`, `DESC`.

Parameters:

OrderByType - Sorting method of the return result set. Valid values: `ASC`, `DESC`.

getProjectIds

public Long[] getProjectIds()

Get Project ID

Returns:

ProjectIds Project ID

setProjectIds

public void setProjectIds(Long[] ProjectIds)

Set Project ID

Parameters:

ProjectIds - Project ID

getSearchKey

public String getSearchKey()

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

Returns:

SearchKey Search keyword, which can be instance ID, instance name, or complete IP.

setSearchKey

public void setSearchKey(String SearchKey)

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

Parameters:

SearchKey - Search keyword, which can be instance ID, instance name, or complete IP.

getTags

public TagInfo[] getTags()

Get Tag information

Returns:

Tags Tag information

setTags

public void setTags(TagInfo[] Tags)

Set Tag information

Parameters:

Tags - Tag information

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel