com.tencentcloudapi.mongodb.v20180408.models

Class DescribeDBInstancesRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.mongodb.v20180408.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 集群类型，取值范围：0-副本集实例，1-分片实例，-1-所有实例
String[]	getInstanceIds() Get 实例ID列表，格式如：cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同
Long	getInstanceType() Get 实例类型，取值范围：0-所有实例,1-正式实例，2-临时实例, 3-只读实例，-1-正式实例+只读+灾备实例
Long	getLimit() Get 单次请求返回的数量，最小值为1，最大值为100，默认值为20
Long	getOffset() Get 偏移量，默认值为0
String	getOrderBy() Get 返回结果集排序的字段，目前支持："ProjectId", "InstanceName", "CreateTime"，默认为升序排序
String	getOrderByType() Get 返回结果集排序方式，目前支持："ASC"或者"DESC"
Long	getPayMode() Get 付费类型，取值范围：0-按量计费，1-包年包月，-1-按量计费+包年包月
Long[]	getStatus() Get 实例状态，取值范围：0-待初始化，1-流程执行中，2-实例有效，-2-实例已过期
String	getSubnetId() Get 私有网络的子网ID，基础网络则不传该参数。入参设置该参数的同时，必须设置相应的VpcId
String	getVpcId() Get 私有网络的ID，基础网络则不传该参数
void	setClusterType(Long ClusterType) Set 集群类型，取值范围：0-副本集实例，1-分片实例，-1-所有实例
void	setInstanceIds(String[] InstanceIds) Set 实例ID列表，格式如：cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同
void	setInstanceType(Long InstanceType) Set 实例类型，取值范围：0-所有实例,1-正式实例，2-临时实例, 3-只读实例，-1-正式实例+只读+灾备实例
void	setLimit(Long Limit) Set 单次请求返回的数量，最小值为1，最大值为100，默认值为20
void	setOffset(Long Offset) Set 偏移量，默认值为0
void	setOrderBy(String OrderBy) Set 返回结果集排序的字段，目前支持："ProjectId", "InstanceName", "CreateTime"，默认为升序排序
void	setOrderByType(String OrderByType) Set 返回结果集排序方式，目前支持："ASC"或者"DESC"
void	setPayMode(Long PayMode) Set 付费类型，取值范围：0-按量计费，1-包年包月，-1-按量计费+包年包月
void	setStatus(Long[] Status) Set 实例状态，取值范围：0-待初始化，1-流程执行中，2-实例有效，-2-实例已过期
void	setSubnetId(String SubnetId) Set 私有网络的子网ID，基础网络则不传该参数。入参设置该参数的同时，必须设置相应的VpcId
void	setVpcId(String VpcId) Set 私有网络的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 实例ID列表，格式如：cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同

Returns:

InstanceIds 实例ID列表，格式如：cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同

setInstanceIds

public void setInstanceIds(String[] InstanceIds)

Set 实例ID列表，格式如：cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同

Parameters:

InstanceIds - 实例ID列表，格式如：cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同

getInstanceType

public Long getInstanceType()

Get 实例类型，取值范围：0-所有实例,1-正式实例，2-临时实例, 3-只读实例，-1-正式实例+只读+灾备实例

Returns:

InstanceType 实例类型，取值范围：0-所有实例,1-正式实例，2-临时实例, 3-只读实例，-1-正式实例+只读+灾备实例

setInstanceType

public void setInstanceType(Long InstanceType)

Set 实例类型，取值范围：0-所有实例,1-正式实例，2-临时实例, 3-只读实例，-1-正式实例+只读+灾备实例

Parameters:

InstanceType - 实例类型，取值范围：0-所有实例,1-正式实例，2-临时实例, 3-只读实例，-1-正式实例+只读+灾备实例

getClusterType

public Long getClusterType()

Get 集群类型，取值范围：0-副本集实例，1-分片实例，-1-所有实例

Returns:

ClusterType 集群类型，取值范围：0-副本集实例，1-分片实例，-1-所有实例

setClusterType

public void setClusterType(Long ClusterType)

Set 集群类型，取值范围：0-副本集实例，1-分片实例，-1-所有实例

Parameters:

ClusterType - 集群类型，取值范围：0-副本集实例，1-分片实例，-1-所有实例

getStatus

public Long[] getStatus()

Get 实例状态，取值范围：0-待初始化，1-流程执行中，2-实例有效，-2-实例已过期

Returns:

Status 实例状态，取值范围：0-待初始化，1-流程执行中，2-实例有效，-2-实例已过期

setStatus

public void setStatus(Long[] Status)

Set 实例状态，取值范围：0-待初始化，1-流程执行中，2-实例有效，-2-实例已过期

Parameters:

Status - 实例状态，取值范围：0-待初始化，1-流程执行中，2-实例有效，-2-实例已过期

getVpcId

public String getVpcId()

Get 私有网络的ID，基础网络则不传该参数

Returns:

VpcId 私有网络的ID，基础网络则不传该参数

setVpcId

public void setVpcId(String VpcId)

Set 私有网络的ID，基础网络则不传该参数

Parameters:

VpcId - 私有网络的ID，基础网络则不传该参数

getSubnetId

public String getSubnetId()

Get 私有网络的子网ID，基础网络则不传该参数。入参设置该参数的同时，必须设置相应的VpcId

Returns:

SubnetId 私有网络的子网ID，基础网络则不传该参数。入参设置该参数的同时，必须设置相应的VpcId

setSubnetId

public void setSubnetId(String SubnetId)

Set 私有网络的子网ID，基础网络则不传该参数。入参设置该参数的同时，必须设置相应的VpcId

Parameters:

SubnetId - 私有网络的子网ID，基础网络则不传该参数。入参设置该参数的同时，必须设置相应的VpcId

getPayMode

public Long getPayMode()

Get 付费类型，取值范围：0-按量计费，1-包年包月，-1-按量计费+包年包月

Returns:

PayMode 付费类型，取值范围：0-按量计费，1-包年包月，-1-按量计费+包年包月

setPayMode

public void setPayMode(Long PayMode)

Set 付费类型，取值范围：0-按量计费，1-包年包月，-1-按量计费+包年包月

Parameters:

PayMode - 付费类型，取值范围：0-按量计费，1-包年包月，-1-按量计费+包年包月

getLimit

public Long getLimit()

Get 单次请求返回的数量，最小值为1，最大值为100，默认值为20

Returns:

Limit 单次请求返回的数量，最小值为1，最大值为100，默认值为20

setLimit

public void setLimit(Long Limit)

Set 单次请求返回的数量，最小值为1，最大值为100，默认值为20

Parameters:

Limit - 单次请求返回的数量，最小值为1，最大值为100，默认值为20

getOffset

public Long getOffset()

Get 偏移量，默认值为0

Returns:

Offset 偏移量，默认值为0

setOffset

public void setOffset(Long Offset)

Set 偏移量，默认值为0

Parameters:

Offset - 偏移量，默认值为0

getOrderBy

public String getOrderBy()

Get 返回结果集排序的字段，目前支持："ProjectId", "InstanceName", "CreateTime"，默认为升序排序

Returns:

OrderBy 返回结果集排序的字段，目前支持："ProjectId", "InstanceName", "CreateTime"，默认为升序排序

setOrderBy

public void setOrderBy(String OrderBy)

Set 返回结果集排序的字段，目前支持："ProjectId", "InstanceName", "CreateTime"，默认为升序排序

Parameters:

OrderBy - 返回结果集排序的字段，目前支持："ProjectId", "InstanceName", "CreateTime"，默认为升序排序

getOrderByType

public String getOrderByType()

Get 返回结果集排序方式，目前支持："ASC"或者"DESC"

Returns:

OrderByType 返回结果集排序方式，目前支持："ASC"或者"DESC"

setOrderByType

public void setOrderByType(String OrderByType)

Set 返回结果集排序方式，目前支持："ASC"或者"DESC"

Parameters:

OrderByType - 返回结果集排序方式，目前支持："ASC"或者"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