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()

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 to be returned for a single 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.
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 to be returned for a single 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	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()

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 (promoted), 2 (temp), 3 (read-only), -1 (promoted + read-only + disaster recovery)

Returns:

InstanceType Instance type. Valid values: 0 (all instances), 1 (promoted), 2 (temp), 3 (read-only), -1 (promoted + read-only + disaster recovery)

setInstanceType

public void setInstanceType(Long InstanceType)

Set Instance type. Valid values: 0 (all instances), 1 (promoted), 2 (temp), 3 (read-only), -1 (promoted + read-only + disaster recovery)

Parameters:

InstanceType - Instance type. Valid values: 0 (all instances), 1 (promoted), 2 (temp), 3 (read-only), -1 (promoted + read-only + disaster recovery)

getClusterType

public Long getClusterType()

Get Cluster type. Valid values: 0 (replica set instance), 1 (sharding instance), -1 (all instances)

Returns:

ClusterType Cluster type. Valid values: 0 (replica set instance), 1 (sharding instance), -1 (all instances)

setClusterType

public void setClusterType(Long ClusterType)

Set Cluster type. Valid values: 0 (replica set instance), 1 (sharding instance), -1 (all instances)

Parameters:

ClusterType - Cluster type. Valid values: 0 (replica set instance), 1 (sharding instance), -1 (all instances)

getStatus

public Long[] getStatus()

Get Instance status. Valid values: 0 (to be initialized), 1 (in process), 2 (valid), -2 (expired)

Returns:

Status Instance status. Valid values: 0 (to be initialized), 1 (in process), 2 (valid), -2 (expired)

setStatus

public void setStatus(Long[] Status)

Set Instance status. Valid values: 0 (to be initialized), 1 (in process), 2 (valid), -2 (expired)

Parameters:

Status - Instance status. Valid values: 0 (to be initialized), 1 (in process), 2 (valid), -2 (expired)

getVpcId

public String getVpcId()

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

Returns:

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

setVpcId

public void setVpcId(String VpcId)

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

Parameters:

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

getSubnetId

public String getSubnetId()

Get Subnet ID of VPC. This parameter can be left empty for the basic 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 basic 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 basic 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 basic 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 to be returned for a single request. Valid values: 1-100. Default value: 20

Returns:

Limit Number of results to be returned for a single request. Valid values: 1-100. Default value: 20

setLimit

public void setLimit(Long Limit)

Set Number of results to be returned for a single request. Valid values: 1-100. Default value: 20

Parameters:

Limit - Number of results to be returned for a single request. Valid values: 1-100. Default value: 20

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. Currently, supported values include "ProjectId", "InstanceName", and "CreateTime". The return results are sorted in ascending order by default.

Returns:

OrderBy Sort by field of the returned result set. Currently, supported values include "ProjectId", "InstanceName", and "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. Currently, supported values include "ProjectId", "InstanceName", and "CreateTime". The return results are sorted in ascending order by default.

Parameters:

OrderBy - Sort by field of the returned result set. Currently, supported values include "ProjectId", "InstanceName", and "CreateTime". The return results are sorted in ascending order by default.

getOrderByType

public String getOrderByType()

Get Sorting method of the return result set. Currently, "ASC" or "DESC" is supported

Returns:

OrderByType Sorting method of the return result set. Currently, "ASC" or "DESC" is supported

setOrderByType

public void setOrderByType(String OrderByType)

Set Sorting method of the return result set. Currently, "ASC" or "DESC" is supported

Parameters:

OrderByType - Sorting method of the return result set. Currently, "ASC" or "DESC" is supported

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

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel