com.tencentcloudapi.mariadb.v20170312.models

Class DescribeDBInstancesRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.mariadb.v20170312.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[]	getExcludeStatus() Get 排除实例状态
String[]	getExclusterIds() Get 按独享集群ID过滤实例，独享集群ID形如dbdc-4ih6uct9
Long	getExclusterType() Get 实例所属独享集群类型。取值范围：1-非独享集群，2-独享集群， 0-全部
String	getFilterInstanceType() Get 实例类型过滤，1-独享实例，2-主实例，3-灾备实例，多个按逗号分隔
String[]	getInstanceIds() Get 按照一个或者多个实例 ID 查询。实例 ID 形如：tdsql-ow728lmc。每次请求的实例的上限为100。
Boolean	getIsFilterExcluster() Get 标识是否使用ExclusterType字段, false不使用，true使用
Boolean	getIsFilterVpc() Get 是否根据 VPC 网络来搜索
Long	getLimit() Get 返回数量，默认为 20，最大值为 100。
Long	getOffset() Get 偏移量，默认为 0
String	getOrderBy() Get 排序字段， projectId， createtime， instancename 三者之一
String	getOrderByType() Get 排序类型， desc 或者 asc
String[]	getOriginSerialIds() Get 按 OriginSerialId 查询
Long[]	getProjectIds() Get 按项目 ID 查询
String	getSearchKey() Get 搜索的关键字，支持模糊搜索。多个关键字使用换行符（'\n'）分割。
String	getSearchName() Get 搜索的字段名，当前支持的值有：instancename、vip、all。传 instancename 表示按实例名进行搜索；传 vip 表示按内网IP进行搜索；传 all 将会按实例ID、实例名和内网IP进行搜索。
Long[]	getStatus() Get 按照实例状态进行筛选
String	getSubnetId() Get 私有网络的子网 ID， IsFilterVpc 为 1 时有效
String[]	getTagKeys() Get 按标签key查询
Tag[]	getTags() Get 标签
String	getVpcId() Get 私有网络 ID， IsFilterVpc 为 1 时有效
void	setExcludeStatus(Long[] ExcludeStatus) Set 排除实例状态
void	setExclusterIds(String[] ExclusterIds) Set 按独享集群ID过滤实例，独享集群ID形如dbdc-4ih6uct9
void	setExclusterType(Long ExclusterType) Set 实例所属独享集群类型。取值范围：1-非独享集群，2-独享集群， 0-全部
void	setFilterInstanceType(String FilterInstanceType) Set 实例类型过滤，1-独享实例，2-主实例，3-灾备实例，多个按逗号分隔
void	setInstanceIds(String[] InstanceIds) Set 按照一个或者多个实例 ID 查询。实例 ID 形如：tdsql-ow728lmc。每次请求的实例的上限为100。
void	setIsFilterExcluster(Boolean IsFilterExcluster) Set 标识是否使用ExclusterType字段, false不使用，true使用
void	setIsFilterVpc(Boolean IsFilterVpc) Set 是否根据 VPC 网络来搜索
void	setLimit(Long Limit) Set 返回数量，默认为 20，最大值为 100。
void	setOffset(Long Offset) Set 偏移量，默认为 0
void	setOrderBy(String OrderBy) Set 排序字段， projectId， createtime， instancename 三者之一
void	setOrderByType(String OrderByType) Set 排序类型， desc 或者 asc
void	setOriginSerialIds(String[] OriginSerialIds) Set 按 OriginSerialId 查询
void	setProjectIds(Long[] ProjectIds) Set 按项目 ID 查询
void	setSearchKey(String SearchKey) Set 搜索的关键字，支持模糊搜索。多个关键字使用换行符（'\n'）分割。
void	setSearchName(String SearchName) Set 搜索的字段名，当前支持的值有：instancename、vip、all。传 instancename 表示按实例名进行搜索；传 vip 表示按内网IP进行搜索；传 all 将会按实例ID、实例名和内网IP进行搜索。
void	setStatus(Long[] Status) Set 按照实例状态进行筛选
void	setSubnetId(String SubnetId) Set 私有网络的子网 ID， IsFilterVpc 为 1 时有效
void	setTagKeys(String[] TagKeys) Set 按标签key查询
void	setTags(Tag[] Tags) Set 标签
void	setVpcId(String VpcId) Set 私有网络 ID， IsFilterVpc 为 1 时有效
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, isStream, 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 按照一个或者多个实例 ID 查询。实例 ID 形如：tdsql-ow728lmc。每次请求的实例的上限为100。

Returns:

InstanceIds 按照一个或者多个实例 ID 查询。实例 ID 形如：tdsql-ow728lmc。每次请求的实例的上限为100。

setInstanceIds

public void setInstanceIds(String[] InstanceIds)

Set 按照一个或者多个实例 ID 查询。实例 ID 形如：tdsql-ow728lmc。每次请求的实例的上限为100。

Parameters:

InstanceIds - 按照一个或者多个实例 ID 查询。实例 ID 形如：tdsql-ow728lmc。每次请求的实例的上限为100。

getSearchName

public String getSearchName()

Get 搜索的字段名，当前支持的值有：instancename、vip、all。传 instancename 表示按实例名进行搜索；传 vip 表示按内网IP进行搜索；传 all 将会按实例ID、实例名和内网IP进行搜索。

Returns:

SearchName 搜索的字段名，当前支持的值有：instancename、vip、all。传 instancename 表示按实例名进行搜索；传 vip 表示按内网IP进行搜索；传 all 将会按实例ID、实例名和内网IP进行搜索。

setSearchName

public void setSearchName(String SearchName)

Set 搜索的字段名，当前支持的值有：instancename、vip、all。传 instancename 表示按实例名进行搜索；传 vip 表示按内网IP进行搜索；传 all 将会按实例ID、实例名和内网IP进行搜索。

Parameters:

SearchName - 搜索的字段名，当前支持的值有：instancename、vip、all。传 instancename 表示按实例名进行搜索；传 vip 表示按内网IP进行搜索；传 all 将会按实例ID、实例名和内网IP进行搜索。

getSearchKey

public String getSearchKey()

Get 搜索的关键字，支持模糊搜索。多个关键字使用换行符（'\n'）分割。

Returns:

SearchKey 搜索的关键字，支持模糊搜索。多个关键字使用换行符（'\n'）分割。

setSearchKey

public void setSearchKey(String SearchKey)

Set 搜索的关键字，支持模糊搜索。多个关键字使用换行符（'\n'）分割。

Parameters:

SearchKey - 搜索的关键字，支持模糊搜索。多个关键字使用换行符（'\n'）分割。

getProjectIds

public Long[] getProjectIds()

Get 按项目 ID 查询

Returns:

ProjectIds 按项目 ID 查询

setProjectIds

public void setProjectIds(Long[] ProjectIds)

Set 按项目 ID 查询

Parameters:

ProjectIds - 按项目 ID 查询

getIsFilterVpc

public Boolean getIsFilterVpc()

Get 是否根据 VPC 网络来搜索

Returns:

IsFilterVpc 是否根据 VPC 网络来搜索

setIsFilterVpc

public void setIsFilterVpc(Boolean IsFilterVpc)

Set 是否根据 VPC 网络来搜索

Parameters:

IsFilterVpc - 是否根据 VPC 网络来搜索

getVpcId

public String getVpcId()

Get 私有网络 ID， IsFilterVpc 为 1 时有效

Returns:

VpcId 私有网络 ID， IsFilterVpc 为 1 时有效

setVpcId

public void setVpcId(String VpcId)

Set 私有网络 ID， IsFilterVpc 为 1 时有效

Parameters:

VpcId - 私有网络 ID， IsFilterVpc 为 1 时有效

getSubnetId

public String getSubnetId()

Get 私有网络的子网 ID， IsFilterVpc 为 1 时有效

Returns:

SubnetId 私有网络的子网 ID， IsFilterVpc 为 1 时有效

setSubnetId

public void setSubnetId(String SubnetId)

Set 私有网络的子网 ID， IsFilterVpc 为 1 时有效

Parameters:

SubnetId - 私有网络的子网 ID， IsFilterVpc 为 1 时有效

getOrderBy

public String getOrderBy()

Get 排序字段， projectId， createtime， instancename 三者之一

Returns:

OrderBy 排序字段， projectId， createtime， instancename 三者之一

setOrderBy

public void setOrderBy(String OrderBy)

Set 排序字段， projectId， createtime， instancename 三者之一

Parameters:

OrderBy - 排序字段， projectId， createtime， instancename 三者之一

getOrderByType

public String getOrderByType()

Get 排序类型， desc 或者 asc

Returns:

OrderByType 排序类型， desc 或者 asc

setOrderByType

public void setOrderByType(String OrderByType)

Set 排序类型， desc 或者 asc

Parameters:

OrderByType - 排序类型， desc 或者 asc

getOffset

public Long getOffset()

Get 偏移量，默认为 0

Returns:

Offset 偏移量，默认为 0

setOffset

public void setOffset(Long Offset)

Set 偏移量，默认为 0

Parameters:

Offset - 偏移量，默认为 0

getLimit

public Long getLimit()

Get 返回数量，默认为 20，最大值为 100。

Returns:

Limit 返回数量，默认为 20，最大值为 100。

setLimit

public void setLimit(Long Limit)

Set 返回数量，默认为 20，最大值为 100。

Parameters:

Limit - 返回数量，默认为 20，最大值为 100。

getOriginSerialIds

public String[] getOriginSerialIds()

Get 按 OriginSerialId 查询

Returns:

OriginSerialIds 按 OriginSerialId 查询

setOriginSerialIds

public void setOriginSerialIds(String[] OriginSerialIds)

Set 按 OriginSerialId 查询

Parameters:

OriginSerialIds - 按 OriginSerialId 查询

getIsFilterExcluster

public Boolean getIsFilterExcluster()

Get 标识是否使用ExclusterType字段, false不使用，true使用

Returns:

IsFilterExcluster 标识是否使用ExclusterType字段, false不使用，true使用

setIsFilterExcluster

public void setIsFilterExcluster(Boolean IsFilterExcluster)

Set 标识是否使用ExclusterType字段, false不使用，true使用

Parameters:

IsFilterExcluster - 标识是否使用ExclusterType字段, false不使用，true使用

getExclusterType

public Long getExclusterType()

Get 实例所属独享集群类型。取值范围：1-非独享集群，2-独享集群， 0-全部

Returns:

ExclusterType 实例所属独享集群类型。取值范围：1-非独享集群，2-独享集群， 0-全部

setExclusterType

public void setExclusterType(Long ExclusterType)

Set 实例所属独享集群类型。取值范围：1-非独享集群，2-独享集群， 0-全部

Parameters:

ExclusterType - 实例所属独享集群类型。取值范围：1-非独享集群，2-独享集群， 0-全部

getExclusterIds

public String[] getExclusterIds()

Get 按独享集群ID过滤实例，独享集群ID形如dbdc-4ih6uct9

Returns:

ExclusterIds 按独享集群ID过滤实例，独享集群ID形如dbdc-4ih6uct9

setExclusterIds

public void setExclusterIds(String[] ExclusterIds)

Set 按独享集群ID过滤实例，独享集群ID形如dbdc-4ih6uct9

Parameters:

ExclusterIds - 按独享集群ID过滤实例，独享集群ID形如dbdc-4ih6uct9

getTagKeys

public String[] getTagKeys()

Get 按标签key查询

Returns:

TagKeys 按标签key查询

setTagKeys

public void setTagKeys(String[] TagKeys)

Set 按标签key查询

Parameters:

TagKeys - 按标签key查询

getTags

public Tag[] getTags()

Get 标签

Returns:

Tags 标签

setTags

public void setTags(Tag[] Tags)

Set 标签

Parameters:

Tags - 标签

getFilterInstanceType

public String getFilterInstanceType()

Get 实例类型过滤，1-独享实例，2-主实例，3-灾备实例，多个按逗号分隔

Returns:

FilterInstanceType 实例类型过滤，1-独享实例，2-主实例，3-灾备实例，多个按逗号分隔

setFilterInstanceType

public void setFilterInstanceType(String FilterInstanceType)

Set 实例类型过滤，1-独享实例，2-主实例，3-灾备实例，多个按逗号分隔

Parameters:

FilterInstanceType - 实例类型过滤，1-独享实例，2-主实例，3-灾备实例，多个按逗号分隔

getStatus

public Long[] getStatus()

Get 按照实例状态进行筛选

Returns:

Status 按照实例状态进行筛选

setStatus

public void setStatus(Long[] Status)

Set 按照实例状态进行筛选

Parameters:

Status - 按照实例状态进行筛选

getExcludeStatus

public Long[] getExcludeStatus()

Get 排除实例状态

Returns:

ExcludeStatus 排除实例状态

setExcludeStatus

public void setExcludeStatus(Long[] ExcludeStatus)

Set 排除实例状态

Parameters:

ExcludeStatus - 排除实例状态

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel