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 Use this filter to exclude instances in specific statuses
String[]	getExclusterIds() Get Filters instances by dedicated cluster ID in the format of `dbdc-4ih6uct9`
Long	getExclusterType() Get Instance cluster type.
String	getFilterInstanceType() Get Instance types used in filtering.
String[]	getInstanceIds() Get Queries by instance ID or IDs.
Boolean	getIsFilterExcluster() Get Identifies whether to use the `ExclusterType` field.
Boolean	getIsFilterVpc() Get Whether to search by VPC
Long	getLimit() Get Number of results to be returned.
Long	getOffset() Get Offset.
String	getOrderBy() Get Sort by field.
String	getOrderByType() Get Sorting order.
String[]	getOriginSerialIds() Get Queries by `OriginSerialId`
Long[]	getProjectIds() Get Queries by project ID
String	getSearchKey() Get Search keyword.
String	getSearchName() Get Search field name.
Long[]	getStatus() Get Use this filter to include instances in specific statuses
String	getSubnetId() Get VPC subnet ID, which is valid when `IsFilterVpc` is 1
String[]	getTagKeys() Get Tag key used in queries
String	getVpcId() Get VPC ID, which is valid when `IsFilterVpc` is 1
void	setExcludeStatus(Long[] ExcludeStatus) Set Use this filter to exclude instances in specific statuses
void	setExclusterIds(String[] ExclusterIds) Set Filters instances by dedicated cluster ID in the format of `dbdc-4ih6uct9`
void	setExclusterType(Long ExclusterType) Set Instance cluster type.
void	setFilterInstanceType(String FilterInstanceType) Set Instance types used in filtering.
void	setInstanceIds(String[] InstanceIds) Set Queries by instance ID or IDs.
void	setIsFilterExcluster(Boolean IsFilterExcluster) Set Identifies whether to use the `ExclusterType` field.
void	setIsFilterVpc(Boolean IsFilterVpc) Set Whether to search by VPC
void	setLimit(Long Limit) Set Number of results to be returned.
void	setOffset(Long Offset) Set Offset.
void	setOrderBy(String OrderBy) Set Sort by field.
void	setOrderByType(String OrderByType) Set Sorting order.
void	setOriginSerialIds(String[] OriginSerialIds) Set Queries by `OriginSerialId`
void	setProjectIds(Long[] ProjectIds) Set Queries by project ID
void	setSearchKey(String SearchKey) Set Search keyword.
void	setSearchName(String SearchName) Set Search field name.
void	setStatus(Long[] Status) Set Use this filter to include instances in specific statuses
void	setSubnetId(String SubnetId) Set VPC subnet ID, which is valid when `IsFilterVpc` is 1
void	setTagKeys(String[] TagKeys) Set Tag key used in queries
void	setVpcId(String VpcId) Set VPC ID, which is valid when `IsFilterVpc` is 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 Queries by instance ID or IDs. Instance ID is in the format of `tdsql-ow728lmc`. Up to 100 instances can be queried in one request.

Returns:

InstanceIds Queries by instance ID or IDs. Instance ID is in the format of `tdsql-ow728lmc`. Up to 100 instances can be queried in one request.

setInstanceIds

public void setInstanceIds(String[] InstanceIds)

Set Queries by instance ID or IDs. Instance ID is in the format of `tdsql-ow728lmc`. Up to 100 instances can be queried in one request.

Parameters:

InstanceIds - Queries by instance ID or IDs. Instance ID is in the format of `tdsql-ow728lmc`. Up to 100 instances can be queried in one request.

getSearchName

public String getSearchName()

Get Search field name. Valid values: instancename (search by instance name), vip (search by private IP), all (search by instance ID, instance name, and private IP).

Returns:

SearchName Search field name. Valid values: instancename (search by instance name), vip (search by private IP), all (search by instance ID, instance name, and private IP).

setSearchName

public void setSearchName(String SearchName)

Set Search field name. Valid values: instancename (search by instance name), vip (search by private IP), all (search by instance ID, instance name, and private IP).

Parameters:

SearchName - Search field name. Valid values: instancename (search by instance name), vip (search by private IP), all (search by instance ID, instance name, and private IP).

getSearchKey

public String getSearchKey()

Get Search keyword. Fuzzy search is supported. Multiple keywords should be separated by line breaks (`\n`).

Returns:

SearchKey Search keyword. Fuzzy search is supported. Multiple keywords should be separated by line breaks (`\n`).

setSearchKey

public void setSearchKey(String SearchKey)

Set Search keyword. Fuzzy search is supported. Multiple keywords should be separated by line breaks (`\n`).

Parameters:

SearchKey - Search keyword. Fuzzy search is supported. Multiple keywords should be separated by line breaks (`\n`).

getProjectIds

public Long[] getProjectIds()

Get Queries by project ID

Returns:

ProjectIds Queries by project ID

setProjectIds

public void setProjectIds(Long[] ProjectIds)

Set Queries by project ID

Parameters:

ProjectIds - Queries by project ID

getIsFilterVpc

public Boolean getIsFilterVpc()

Get Whether to search by VPC

Returns:

IsFilterVpc Whether to search by VPC

setIsFilterVpc

public void setIsFilterVpc(Boolean IsFilterVpc)

Set Whether to search by VPC

Parameters:

IsFilterVpc - Whether to search by VPC

getVpcId

public String getVpcId()

Get VPC ID, which is valid when `IsFilterVpc` is 1

Returns:

VpcId VPC ID, which is valid when `IsFilterVpc` is 1

setVpcId

public void setVpcId(String VpcId)

Set VPC ID, which is valid when `IsFilterVpc` is 1

Parameters:

VpcId - VPC ID, which is valid when `IsFilterVpc` is 1

getSubnetId

public String getSubnetId()

Get VPC subnet ID, which is valid when `IsFilterVpc` is 1

Returns:

SubnetId VPC subnet ID, which is valid when `IsFilterVpc` is 1

setSubnetId

public void setSubnetId(String SubnetId)

Set VPC subnet ID, which is valid when `IsFilterVpc` is 1

Parameters:

SubnetId - VPC subnet ID, which is valid when `IsFilterVpc` is 1

getOrderBy

public String getOrderBy()

Get Sort by field. Valid values: projectId, createtime, instancename

Returns:

OrderBy Sort by field. Valid values: projectId, createtime, instancename

setOrderBy

public void setOrderBy(String OrderBy)

Set Sort by field. Valid values: projectId, createtime, instancename

Parameters:

OrderBy - Sort by field. Valid values: projectId, createtime, instancename

getOrderByType

public String getOrderByType()

Get Sorting order. Valid values: desc, asc

Returns:

OrderByType Sorting order. Valid values: desc, asc

setOrderByType

public void setOrderByType(String OrderByType)

Set Sorting order. Valid values: desc, asc

Parameters:

OrderByType - Sorting order. Valid values: desc, asc

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

getLimit

public Long getLimit()

Get Number of results to be returned. Default value: 20. Maximum value: 100.

Returns:

Limit Number of results to be returned. Default value: 20. Maximum value: 100.

setLimit

public void setLimit(Long Limit)

Set Number of results to be returned. Default value: 20. Maximum value: 100.

Parameters:

Limit - Number of results to be returned. Default value: 20. Maximum value: 100.

getOriginSerialIds

public String[] getOriginSerialIds()

Get Queries by `OriginSerialId`

Returns:

OriginSerialIds Queries by `OriginSerialId`

setOriginSerialIds

public void setOriginSerialIds(String[] OriginSerialIds)

Set Queries by `OriginSerialId`

Parameters:

OriginSerialIds - Queries by `OriginSerialId`

getIsFilterExcluster

public Boolean getIsFilterExcluster()

Get Identifies whether to use the `ExclusterType` field. false: no, true: yes

Returns:

IsFilterExcluster Identifies whether to use the `ExclusterType` field. false: no, true: yes

setIsFilterExcluster

public void setIsFilterExcluster(Boolean IsFilterExcluster)

Set Identifies whether to use the `ExclusterType` field. false: no, true: yes

Parameters:

IsFilterExcluster - Identifies whether to use the `ExclusterType` field. false: no, true: yes

getExclusterType

public Long getExclusterType()

Get Instance cluster type. 1: non-dedicated cluster, 2: dedicated cluster, 0: all

Returns:

ExclusterType Instance cluster type. 1: non-dedicated cluster, 2: dedicated cluster, 0: all

setExclusterType

public void setExclusterType(Long ExclusterType)

Set Instance cluster type. 1: non-dedicated cluster, 2: dedicated cluster, 0: all

Parameters:

ExclusterType - Instance cluster type. 1: non-dedicated cluster, 2: dedicated cluster, 0: all

getExclusterIds

public String[] getExclusterIds()

Get Filters instances by dedicated cluster ID in the format of `dbdc-4ih6uct9`

Returns:

ExclusterIds Filters instances by dedicated cluster ID in the format of `dbdc-4ih6uct9`

setExclusterIds

public void setExclusterIds(String[] ExclusterIds)

Set Filters instances by dedicated cluster ID in the format of `dbdc-4ih6uct9`

Parameters:

ExclusterIds - Filters instances by dedicated cluster ID in the format of `dbdc-4ih6uct9`

getTagKeys

public String[] getTagKeys()

Get Tag key used in queries

Returns:

TagKeys Tag key used in queries

setTagKeys

public void setTagKeys(String[] TagKeys)

Set Tag key used in queries

Parameters:

TagKeys - Tag key used in queries

getFilterInstanceType

public String getFilterInstanceType()

Get Instance types used in filtering. Valid values: 1 (dedicated instance), 2 (primary instance), 3 (disaster recovery instance). Multiple values should be separated by commas.

Returns:

FilterInstanceType Instance types used in filtering. Valid values: 1 (dedicated instance), 2 (primary instance), 3 (disaster recovery instance). Multiple values should be separated by commas.

setFilterInstanceType

public void setFilterInstanceType(String FilterInstanceType)

Set Instance types used in filtering. Valid values: 1 (dedicated instance), 2 (primary instance), 3 (disaster recovery instance). Multiple values should be separated by commas.

Parameters:

FilterInstanceType - Instance types used in filtering. Valid values: 1 (dedicated instance), 2 (primary instance), 3 (disaster recovery instance). Multiple values should be separated by commas.

getStatus

public Long[] getStatus()

Get Use this filter to include instances in specific statuses

Returns:

Status Use this filter to include instances in specific statuses

setStatus

public void setStatus(Long[] Status)

Set Use this filter to include instances in specific statuses

Parameters:

Status - Use this filter to include instances in specific statuses

getExcludeStatus

public Long[] getExcludeStatus()

Get Use this filter to exclude instances in specific statuses

Returns:

ExcludeStatus Use this filter to exclude instances in specific statuses

setExcludeStatus

public void setExcludeStatus(Long[] ExcludeStatus)

Set Use this filter to exclude instances in specific statuses

Parameters:

ExcludeStatus - Use this filter to exclude instances in specific statuses

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel

Parameters:

map - The map to populate with the model's parameters.

prefix - A string prefix for the keys.