DescribeDCDBInstancesRequest (tencentcloud-sdk-java-intl-en 3.0.233 API)

java.lang.Object
- com.tencentcloudapi.common.AbstractModel
- - com.tencentcloudapi.dcdb.v20180411.models.DescribeDCDBInstancesRequest

public class DescribeDCDBInstancesRequest
extends AbstractModel

Constructor Summary

Constructors
Constructor and Description
`DescribeDCDBInstancesRequest()`
`DescribeDCDBInstancesRequest(DescribeDCDBInstancesRequest 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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Long[]`	`getExcludeStatus()` Get Use this filter to exclude instances in specific statuses
`String[]`	`getExclusterIds()` Get Dedicated cluster ID
`Long`	`getExclusterType()` Get 1: non-dedicated cluster; 2: dedicated cluster; 0: all
`String`	`getFilterInstanceType()` Get Instance types used in filtering.
`String[]`	`getInstanceIds()` Get Query 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 returned results.
`Long`	`getOffset()` Get Offset.
`String`	`getOrderBy()` Get Sort by field.
`String`	`getOrderByType()` Get Sort by type.
`Long[]`	`getProjectIds()` Get Query 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 Dedicated cluster ID
`void`	`setExclusterType(Long ExclusterType)` Set 1: non-dedicated cluster; 2: dedicated cluster; 0: all
`void`	`setFilterInstanceType(String FilterInstanceType)` Set Instance types used in filtering.
`void`	`setInstanceIds(String[] InstanceIds)` Set Query 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 returned results.
`void`	`setOffset(Long Offset)` Set Offset.
`void`	`setOrderBy(String OrderBy)` Set Sort by field.
`void`	`setOrderByType(String OrderByType)` Set Sort by type.
`void`	`setProjectIds(Long[] ProjectIds)` Set Query 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, 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
  - DescribeDCDBInstancesRequest
```
public DescribeDCDBInstancesRequest()
```
  - DescribeDCDBInstancesRequest
```
public DescribeDCDBInstancesRequest(DescribeDCDBInstancesRequest 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 Query by instance ID or IDs. Instance ID is in the format of dcdbt-2t4cf98d
    
    Returns:
    
    InstanceIds Query by instance ID or IDs. Instance ID is in the format of dcdbt-2t4cf98d
  - setInstanceIds
```
public void setInstanceIds(String[] InstanceIds)
```
    Set Query by instance ID or IDs. Instance ID is in the format of dcdbt-2t4cf98d
    
    Parameters:
    
    InstanceIds - Query by instance ID or IDs. Instance ID is in the format of dcdbt-2t4cf98d
  - 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 Query by project ID
    
    Returns:
    
    ProjectIds Query by project ID
  - setProjectIds
```
public void setProjectIds(Long[] ProjectIds)
```
    Set Query by project ID
    
    Parameters:
    
    ProjectIds - Query 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 Sort by type. Valid values: desc; asc
    
    Returns:
    
    OrderByType Sort by type. Valid values: desc; asc
  - setOrderByType
```
public void setOrderByType(String OrderByType)
```
    Set Sort by type. Valid values: desc; asc
    
    Parameters:
    
    OrderByType - Sort by type. 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 returned results. Default value: 10. Maximum value: 100.
    
    Returns:
    
    Limit Number of returned results. Default value: 10. Maximum value: 100.
  - setLimit
```
public void setLimit(Long Limit)
```
    Set Number of returned results. Default value: 10. Maximum value: 100.
    
    Parameters:
    
    Limit - Number of returned results. Default value: 10. Maximum value: 100.
  - getExclusterType
```
public Long getExclusterType()
```
    Get 1: non-dedicated cluster; 2: dedicated cluster; 0: all
    
    Returns:
    
    ExclusterType 1: non-dedicated cluster; 2: dedicated cluster; 0: all
  - setExclusterType
```
public void setExclusterType(Long ExclusterType)
```
    Set 1: non-dedicated cluster; 2: dedicated cluster; 0: all
    
    Parameters:
    
    ExclusterType - 1: non-dedicated cluster; 2: dedicated cluster; 0: all
  - 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
  - getExclusterIds
```
public String[] getExclusterIds()
```
    Get Dedicated cluster ID
    
    Returns:
    
    ExclusterIds Dedicated cluster ID
  - setExclusterIds
```
public void setExclusterIds(String[] ExclusterIds)
```
    Set Dedicated cluster ID
    
    Parameters:
    
    ExclusterIds - Dedicated cluster ID
  - 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

Class DescribeDCDBInstancesRequest

Constructor Summary

Method Summary

Methods inherited from class com.tencentcloudapi.common.AbstractModel

Methods inherited from class java.lang.Object

Constructor Detail

DescribeDCDBInstancesRequest

DescribeDCDBInstancesRequest

Method Detail

getInstanceIds

setInstanceIds

getSearchName

setSearchName

getSearchKey

setSearchKey

getProjectIds

setProjectIds

getIsFilterVpc

setIsFilterVpc

getVpcId

setVpcId

getSubnetId

setSubnetId

getOrderBy

setOrderBy

getOrderByType

setOrderByType

getOffset

setOffset

getLimit

setLimit

getExclusterType

setExclusterType

getIsFilterExcluster

setIsFilterExcluster

getExclusterIds

setExclusterIds

getTagKeys

setTagKeys

getFilterInstanceType

setFilterInstanceType

getStatus

setStatus

getExcludeStatus

setExcludeStatus

toMap