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

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

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 Specifies the cluster type of the queried instance.0: replica set instance.1: sharded cluster instance.-1: replica set and sharded cluster instance.
String[]	getInstanceIds() Get Instance ID list.
Long	getInstanceType() Get Specifies the instance type for querying.0: all instances.1: formal instance.3: read-only instance.4: disaster recovery instance.
Long	getLimit() Get Number of results returned per request.
Long	getOffset() Get Offset.
String	getOrderBy() Get Configures the field for sorting returned results.
String	getOrderByType() Get Configures the method for sorting returned results.
Long	getPayMode() Get Billing type.
Long[]	getProjectIds() Get Project ID.
String	getSearchKey() Get Specifies the keyword for search.
Long[]	getStatus() Get Specify the current status of the queried instance.0: pending initialization.1: processing, such as modifying specifications or modifying parameters.2: instance running normally.-2: instance expired.
String	getSubnetId() Get VPC subnet ID.
TagInfo[]	getTags() Get Tag information, including the tag key and tag value.
String	getVpcId() Get VPC ID.
void	setClusterType(Long ClusterType) Set Specifies the cluster type of the queried instance.0: replica set instance.1: sharded cluster instance.-1: replica set and sharded cluster instance.
void	setInstanceIds(String[] InstanceIds) Set Instance ID list.
void	setInstanceType(Long InstanceType) Set Specifies the instance type for querying.0: all instances.1: formal instance.3: read-only instance.4: disaster recovery instance.
void	setLimit(Long Limit) Set Number of results returned per request.
void	setOffset(Long Offset) Set Offset.
void	setOrderBy(String OrderBy) Set Configures the field for sorting returned results.
void	setOrderByType(String OrderByType) Set Configures the method for sorting returned results.
void	setPayMode(Long PayMode) Set Billing type.
void	setProjectIds(Long[] ProjectIds) Set Project ID.
void	setSearchKey(String SearchKey) Set Specifies the keyword for search.
void	setStatus(Long[] Status) Set Specify the current status of the queried instance.0: pending initialization.1: processing, such as modifying specifications or modifying parameters.2: instance running normally.-2: instance expired.
void	setSubnetId(String SubnetId) Set VPC subnet ID.
void	setTags(TagInfo[] Tags) Set Tag information, including the tag key and tag value.
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, GetHeader, getMultipartRequestParams, getSkipSign, 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

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 Instance ID list. For example, cmgo-p8vn****. Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/MongoDB) and copy the instance ID from the instance list.

Returns:

InstanceIds Instance ID list. For example, cmgo-p8vn****. Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/MongoDB) and copy the instance ID from the instance list.

setInstanceIds

public void setInstanceIds(String[] InstanceIds)

Set Instance ID list. For example, cmgo-p8vn****. Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/MongoDB) and copy the instance ID from the instance list.

Parameters:

InstanceIds - Instance ID list. For example, cmgo-p8vn****. Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/MongoDB) and copy the instance ID from the instance list.

getInstanceType

public Long getInstanceType()

Get Specifies the instance type for querying.

• 0: all instances.
• 1: formal instance.
• 3: read-only instance.
• 4: disaster recovery instance.

Returns:

InstanceType Specifies the instance type for querying.

• 0: all instances.
• 1: formal instance.
• 3: read-only instance.
• 4: disaster recovery instance.

setInstanceType

public void setInstanceType(Long InstanceType)

Set Specifies the instance type for querying.

• 0: all instances.
• 1: formal instance.
• 3: read-only instance.
• 4: disaster recovery instance.

Parameters:

InstanceType - Specifies the instance type for querying.

• 0: all instances.
• 1: formal instance.
• 3: read-only instance.
• 4: disaster recovery instance.

getClusterType

public Long getClusterType()

Get Specifies the cluster type of the queried instance.

• 0: replica set instance.
• 1: sharded cluster instance.
• -1: replica set and sharded cluster instance.

Returns:

ClusterType Specifies the cluster type of the queried instance.

• 0: replica set instance.
• 1: sharded cluster instance.
• -1: replica set and sharded cluster instance.

setClusterType

public void setClusterType(Long ClusterType)

Set Specifies the cluster type of the queried instance.

• 0: replica set instance.
• 1: sharded cluster instance.
• -1: replica set and sharded cluster instance.

Parameters:

ClusterType - Specifies the cluster type of the queried instance.

• 0: replica set instance.
• 1: sharded cluster instance.
• -1: replica set and sharded cluster instance.

getStatus

public Long[] getStatus()

Get Specify the current status of the queried instance.

• 0: pending initialization.
• 1: processing, such as modifying specifications or modifying parameters.
• 2: instance running normally.
• -2: instance expired.

Returns:

Status Specify the current status of the queried instance.

• 0: pending initialization.
• 1: processing, such as modifying specifications or modifying parameters.
• 2: instance running normally.
• -2: instance expired.

setStatus

public void setStatus(Long[] Status)

Set Specify the current status of the queried instance.

• 0: pending initialization.
• 1: processing, such as modifying specifications or modifying parameters.
• 2: instance running normally.
• -2: instance expired.

Parameters:

Status - Specify the current status of the queried instance.

• 0: pending initialization.
• 1: processing, such as modifying specifications or modifying parameters.
• 2: instance running normally.
• -2: instance expired.

getVpcId

public String getVpcId()

Get VPC ID. - You do not need to specify this parameter for basic networks. - Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/MongoDB), click a VPC name in the instance list, and obtain the ID on the **VPC** page.

Returns:

VpcId VPC ID. - You do not need to specify this parameter for basic networks. - Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/MongoDB), click a VPC name in the instance list, and obtain the ID on the **VPC** page.

setVpcId

public void setVpcId(String VpcId)

Set VPC ID. - You do not need to specify this parameter for basic networks. - Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/MongoDB), click a VPC name in the instance list, and obtain the ID on the **VPC** page.

Parameters:

VpcId - VPC ID. - You do not need to specify this parameter for basic networks. - Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/MongoDB), click a VPC name in the instance list, and obtain the ID on the **VPC** page.

getSubnetId

public String getSubnetId()

Get VPC subnet ID. - You do not need to specify this parameter for basic networks. - Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/MongoDB), click a VPC name in the instance list, and obtain the subnet ID on the **VPC** page.

Returns:

SubnetId VPC subnet ID. - You do not need to specify this parameter for basic networks. - Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/MongoDB), click a VPC name in the instance list, and obtain the subnet ID on the **VPC** page.

setSubnetId

public void setSubnetId(String SubnetId)

Set VPC subnet ID. - You do not need to specify this parameter for basic networks. - Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/MongoDB), click a VPC name in the instance list, and obtain the subnet ID on the **VPC** page.

Parameters:

SubnetId - VPC subnet ID. - You do not need to specify this parameter for basic networks. - Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/MongoDB), click a VPC name in the instance list, and obtain the subnet ID on the **VPC** page.

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 Configures the field for sorting returned results. Currently, "ProjectId", "InstanceName", and "CreateTime" are supported for sorting.

Returns:

OrderBy Configures the field for sorting returned results. Currently, "ProjectId", "InstanceName", and "CreateTime" are supported for sorting.

setOrderBy

public void setOrderBy(String OrderBy)

Set Configures the field for sorting returned results. Currently, "ProjectId", "InstanceName", and "CreateTime" are supported for sorting.

Parameters:

OrderBy - Configures the field for sorting returned results. Currently, "ProjectId", "InstanceName", and "CreateTime" are supported for sorting.

getOrderByType

public String getOrderByType()

Get Configures the method for sorting returned results. - ASC: ascending order. - DESC: descending order.

Returns:

OrderByType Configures the method for sorting returned results. - ASC: ascending order. - DESC: descending order.

setOrderByType

public void setOrderByType(String OrderByType)

Set Configures the method for sorting returned results. - ASC: ascending order. - DESC: descending order.

Parameters:

OrderByType - Configures the method for sorting returned results. - ASC: ascending order. - DESC: descending order.

getProjectIds

public Long[] getProjectIds()

Get Project ID. Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/MongoDB) and select Project Management in the account information drop-down menu at the top right corner to query projects.

Returns:

ProjectIds Project ID. Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/MongoDB) and select Project Management in the account information drop-down menu at the top right corner to query projects.

setProjectIds

public void setProjectIds(Long[] ProjectIds)

Set Project ID. Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/MongoDB) and select Project Management in the account information drop-down menu at the top right corner to query projects.

Parameters:

ProjectIds - Project ID. Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/MongoDB) and select Project Management in the account information drop-down menu at the top right corner to query projects.

getSearchKey

public String getSearchKey()

Get Specifies the keyword for search. Specific instance IDs, instance names, or private IP addresses are supported.

Returns:

SearchKey Specifies the keyword for search. Specific instance IDs, instance names, or private IP addresses are supported.

setSearchKey

public void setSearchKey(String SearchKey)

Set Specifies the keyword for search. Specific instance IDs, instance names, or private IP addresses are supported.

Parameters:

SearchKey - Specifies the keyword for search. Specific instance IDs, instance names, or private IP addresses are supported.

getTags

public TagInfo[] getTags()

Get Tag information, including the tag key and tag value.

Returns:

Tags Tag information, including the tag key and tag value.

setTags

public void setTags(TagInfo[] Tags)

Set Tag information, including the tag key and tag value.

Parameters:

Tags - Tag information, including the tag key and tag value.

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel