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

Method Summary

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

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

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

Returns:

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

setInstanceIds

public void setInstanceIds(String[] InstanceIds)

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

Parameters:

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

getInstanceType

public Integer getInstanceType()

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

Returns:

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

setInstanceType

public void setInstanceType(Integer InstanceType)

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

Parameters:

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

getClusterType

public Integer getClusterType()

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

Returns:

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

setClusterType

public void setClusterType(Integer ClusterType)

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

Parameters:

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

getStatus

public Integer[] getStatus()

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

Returns:

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

setStatus

public void setStatus(Integer[] Status)

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

Parameters:

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

getVpcId

public String getVpcId()

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

Returns:

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

setVpcId

public void setVpcId(String VpcId)

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

Parameters:

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

getSubnetId

public String getSubnetId()

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

Returns:

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

setSubnetId

public void setSubnetId(String SubnetId)

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

Parameters:

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

getPayMode

public Integer getPayMode()

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

Returns:

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

setPayMode

public void setPayMode(Integer PayMode)

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

Parameters:

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

getLimit

public Integer getLimit()

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

Returns:

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

setLimit

public void setLimit(Integer Limit)

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

Parameters:

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

getOffset

public Integer getOffset()

获取偏移量，默认值为0

Returns:

Offset 偏移量，默认值为0

setOffset

public void setOffset(Integer Offset)

设置偏移量，默认值为0

Parameters:

Offset - 偏移量，默认值为0

getOrderBy

public String getOrderBy()

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

Returns:

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

setOrderBy

public void setOrderBy(String OrderBy)

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

Parameters:

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

getOrderByType

public String getOrderByType()

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

Returns:

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

setOrderByType

public void setOrderByType(String OrderByType)

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

Parameters:

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

toMap

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

内部实现，用户禁止调用

Specified by:

toMap in class AbstractModel