DBInstance (tencentcloud-sdk-java-intl-en 3.0.868 API)

java.lang.Object
- com.tencentcloudapi.common.AbstractModel
- - com.tencentcloudapi.postgres.v20170312.models.DBInstance

public class DBInstance
extends AbstractModel

Field Summary
- Fields inherited from class com.tencentcloudapi.common.AbstractModel
  header, skipSign

Constructor Summary

Constructors
Constructor and Description
`DBInstance()`
`DBInstance(DBInstance 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`	`getAppId()` Get User `AppId`
`Long`	`getAutoRenew()` Get Whether auto-renewal is enabled.
`String`	`getCreateTime()` Get Instance creation time
`String`	`getDBCharset()` Get Instance character set.
`String`	`getDBEngine()` Get Database engines.
`String`	`getDBEngineConfig()` Get Configuration information of database engine in the following format: {"$key1":"$value1", "$key2":"$value2"} Valid values: mssql_compatible engine: `migrationMode`: Database mode.
`String`	`getDBInstanceClass()` Get Purchasable specification ID
`Long`	`getDBInstanceCpu()` Get Number of assigned CPUs
`String`	`getDBInstanceId()` Get Instance ID
`Long`	`getDBInstanceMemory()` Get Assigned instance memory size in GB
`String`	`getDBInstanceName()` Get Instance name
`DBInstanceNetInfo[]`	`getDBInstanceNetInfo()` Get Instance network connection information
`String`	`getDBInstanceStatus()` Get Instance status.
`Long`	`getDBInstanceStorage()` Get Assigned instance storage capacity in GB
`String`	`getDBInstanceType()` Get Instance type.
`String`	`getDBInstanceVersion()` Get Instance version.
`String`	`getDBKernelVersion()` Get PostgreSQL kernel version number (like v12.7_r1.8), which can be queried by the [DescribeDBVersions](https://intl.cloud.tencent.com/document/api/409/89018?from_cn_redirect=1) API.
`String`	`getDBMajorVersion()` Get The major PostgreSQL version number, which can be queried by the [DescribeDBVersions](https://intl.cloud.tencent.com/document/api/409/89018?from_cn_redirect=1) API.
`DBNode[]`	`getDBNodeSet()` Get Instance node information Note: u200dThis field may return null, indicating that no valid values can be obtained.
`String`	`getDBVersion()` Get Number of the major PostgreSQL community version and minor version, such as 12.4, which can be queried by the [DescribeDBVersions](https://intl.cloud.tencent.com/document/api/409/89018?from_cn_redirect=1) API.
`String`	`getExpireTime()` Get Instance expiration time
`String`	`getIsolatedTime()` Get Instance isolation time
`Long`	`getIsSupportTDE()` Get Whether the instance supports TDE.
`String`	`getMasterDBInstanceId()` Get Primary instance information, which is returned only when the instance is read-only.
`NetworkAccess[]`	`getNetworkAccessList()` Get Network access list of the instance (this field has been deprecated) Note: this field may return `null`, indicating that no valid values can be obtained.
`String`	`getOfflineTime()` Get Offline time Note: u200dThis field may return null, indicating that no valid values can be obtained.
`String`	`getPayType()` Get Billing mode.
`Long`	`getProjectId()` Get Project ID
`Long`	`getReadOnlyInstanceNum()` Get Number of read-only instances Note: u200dThis field may return null, indicating that no valid values can be obtained.
`String`	`getRegion()` Get Instance region such as ap-guangzhou, which corresponds to the`Region` field in `RegionSet`.
`String`	`getStatusInReadonlyGroup()` Get The status of a read-only instance in a read-only group Note: u200dThis field may return null, indicating that no valid values can be obtained.
`String`	`getSubnetId()` Get VPC subnet ID in the format of `subnet-xxxxxxxx`, which can be obtained in the console or from the `unSubnetId` field in the return value of the [DescribeSubnets ](https://intl.cloud.tencent.com/document/api/215/15784?from_cn_redirect=1) API.
`Long`	`getSupportIpv6()` Get Whether the instance supports IPv6.
`Tag[]`	`getTagList()` Get The information of tags associated with instances Note: u200dThis field may return null, indicating that no valid values can be obtained.
`String`	`getType()` Get Machine type
`Long`	`getUid()` Get Instance `Uid`
`String`	`getUpdateTime()` Get Last updated time of the instance attribute
`String`	`getVpcId()` Get VPC ID in the format of `vpc-xxxxxxx`, which can be obtained in the console or from the `unVpcId` field in the return value of the [DescribeVpcEx](https://intl.cloud.tencent.com/document/api/215/1372?from_cn_redirect=1) API.
`String`	`getZone()` Get Instance AZ such as ap-guangzhou-3, which corresponds to the `Zone` field of `ZoneSet`.
`void`	`setAppId(Long AppId)` Set User `AppId`
`void`	`setAutoRenew(Long AutoRenew)` Set Whether auto-renewal is enabled.
`void`	`setCreateTime(String CreateTime)` Set Instance creation time
`void`	`setDBCharset(String DBCharset)` Set Instance character set.
`void`	`setDBEngine(String DBEngine)` Set Database engines.
`void`	`setDBEngineConfig(String DBEngineConfig)` Set Configuration information of database engine in the following format: {"$key1":"$value1", "$key2":"$value2"} Valid values: mssql_compatible engine: `migrationMode`: Database mode.
`void`	`setDBInstanceClass(String DBInstanceClass)` Set Purchasable specification ID
`void`	`setDBInstanceCpu(Long DBInstanceCpu)` Set Number of assigned CPUs
`void`	`setDBInstanceId(String DBInstanceId)` Set Instance ID
`void`	`setDBInstanceMemory(Long DBInstanceMemory)` Set Assigned instance memory size in GB
`void`	`setDBInstanceName(String DBInstanceName)` Set Instance name
`void`	`setDBInstanceNetInfo(DBInstanceNetInfo[] DBInstanceNetInfo)` Set Instance network connection information
`void`	`setDBInstanceStatus(String DBInstanceStatus)` Set Instance status.
`void`	`setDBInstanceStorage(Long DBInstanceStorage)` Set Assigned instance storage capacity in GB
`void`	`setDBInstanceType(String DBInstanceType)` Set Instance type.
`void`	`setDBInstanceVersion(String DBInstanceVersion)` Set Instance version.
`void`	`setDBKernelVersion(String DBKernelVersion)` Set PostgreSQL kernel version number (like v12.7_r1.8), which can be queried by the [DescribeDBVersions](https://intl.cloud.tencent.com/document/api/409/89018?from_cn_redirect=1) API.
`void`	`setDBMajorVersion(String DBMajorVersion)` Set The major PostgreSQL version number, which can be queried by the [DescribeDBVersions](https://intl.cloud.tencent.com/document/api/409/89018?from_cn_redirect=1) API.
`void`	`setDBNodeSet(DBNode[] DBNodeSet)` Set Instance node information Note: u200dThis field may return null, indicating that no valid values can be obtained.
`void`	`setDBVersion(String DBVersion)` Set Number of the major PostgreSQL community version and minor version, such as 12.4, which can be queried by the [DescribeDBVersions](https://intl.cloud.tencent.com/document/api/409/89018?from_cn_redirect=1) API.
`void`	`setExpireTime(String ExpireTime)` Set Instance expiration time
`void`	`setIsolatedTime(String IsolatedTime)` Set Instance isolation time
`void`	`setIsSupportTDE(Long IsSupportTDE)` Set Whether the instance supports TDE.
`void`	`setMasterDBInstanceId(String MasterDBInstanceId)` Set Primary instance information, which is returned only when the instance is read-only.
`void`	`setNetworkAccessList(NetworkAccess[] NetworkAccessList)` Set Network access list of the instance (this field has been deprecated) Note: this field may return `null`, indicating that no valid values can be obtained.
`void`	`setOfflineTime(String OfflineTime)` Set Offline time Note: u200dThis field may return null, indicating that no valid values can be obtained.
`void`	`setPayType(String PayType)` Set Billing mode.
`void`	`setProjectId(Long ProjectId)` Set Project ID
`void`	`setReadOnlyInstanceNum(Long ReadOnlyInstanceNum)` Set Number of read-only instances Note: u200dThis field may return null, indicating that no valid values can be obtained.
`void`	`setRegion(String Region)` Set Instance region such as ap-guangzhou, which corresponds to the`Region` field in `RegionSet`.
`void`	`setStatusInReadonlyGroup(String StatusInReadonlyGroup)` Set The status of a read-only instance in a read-only group Note: u200dThis field may return null, indicating that no valid values can be obtained.
`void`	`setSubnetId(String SubnetId)` Set VPC subnet ID in the format of `subnet-xxxxxxxx`, which can be obtained in the console or from the `unSubnetId` field in the return value of the [DescribeSubnets ](https://intl.cloud.tencent.com/document/api/215/15784?from_cn_redirect=1) API.
`void`	`setSupportIpv6(Long SupportIpv6)` Set Whether the instance supports IPv6.
`void`	`setTagList(Tag[] TagList)` Set The information of tags associated with instances Note: u200dThis field may return null, indicating that no valid values can be obtained.
`void`	`setType(String Type)` Set Machine type
`void`	`setUid(Long Uid)` Set Instance `Uid`
`void`	`setUpdateTime(String UpdateTime)` Set Last updated time of the instance attribute
`void`	`setVpcId(String VpcId)` Set VPC ID in the format of `vpc-xxxxxxx`, which can be obtained in the console or from the `unVpcId` field in the return value of the [DescribeVpcEx](https://intl.cloud.tencent.com/document/api/215/1372?from_cn_redirect=1) API.
`void`	`setZone(String Zone)` Set Instance AZ such as ap-guangzhou-3, which corresponds to the `Zone` field of `ZoneSet`.
`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, 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
  - DBInstance
```
public DBInstance()
```
  - DBInstance
```
public DBInstance(DBInstance 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
  - getRegion
```
public String getRegion()
```
    Get Instance region such as ap-guangzhou, which corresponds to the`Region` field in `RegionSet`.
    
    Returns:
    
    Region Instance region such as ap-guangzhou, which corresponds to the`Region` field in `RegionSet`.
  - setRegion
```
public void setRegion(String Region)
```
    Set Instance region such as ap-guangzhou, which corresponds to the`Region` field in `RegionSet`.
    
    Parameters:
    
    Region - Instance region such as ap-guangzhou, which corresponds to the`Region` field in `RegionSet`.
  - getZone
```
public String getZone()
```
    Get Instance AZ such as ap-guangzhou-3, which corresponds to the `Zone` field of `ZoneSet`.
    
    Returns:
    
    Zone Instance AZ such as ap-guangzhou-3, which corresponds to the `Zone` field of `ZoneSet`.
  - setZone
```
public void setZone(String Zone)
```
    Set Instance AZ such as ap-guangzhou-3, which corresponds to the `Zone` field of `ZoneSet`.
    
    Parameters:
    
    Zone - Instance AZ such as ap-guangzhou-3, which corresponds to the `Zone` field of `ZoneSet`.
  - getVpcId
```
public String getVpcId()
```
    Get VPC ID in the format of `vpc-xxxxxxx`, which can be obtained in the console or from the `unVpcId` field in the return value of the [DescribeVpcEx](https://intl.cloud.tencent.com/document/api/215/1372?from_cn_redirect=1) API.
    
    Returns:
    
    VpcId VPC ID in the format of `vpc-xxxxxxx`, which can be obtained in the console or from the `unVpcId` field in the return value of the [DescribeVpcEx](https://intl.cloud.tencent.com/document/api/215/1372?from_cn_redirect=1) API.
  - setVpcId
```
public void setVpcId(String VpcId)
```
    Set VPC ID in the format of `vpc-xxxxxxx`, which can be obtained in the console or from the `unVpcId` field in the return value of the [DescribeVpcEx](https://intl.cloud.tencent.com/document/api/215/1372?from_cn_redirect=1) API.
    
    Parameters:
    
    VpcId - VPC ID in the format of `vpc-xxxxxxx`, which can be obtained in the console or from the `unVpcId` field in the return value of the [DescribeVpcEx](https://intl.cloud.tencent.com/document/api/215/1372?from_cn_redirect=1) API.
  - getSubnetId
```
public String getSubnetId()
```
    Get VPC subnet ID in the format of `subnet-xxxxxxxx`, which can be obtained in the console or from the `unSubnetId` field in the return value of the [DescribeSubnets ](https://intl.cloud.tencent.com/document/api/215/15784?from_cn_redirect=1) API.
    
    Returns:
    
    SubnetId VPC subnet ID in the format of `subnet-xxxxxxxx`, which can be obtained in the console or from the `unSubnetId` field in the return value of the [DescribeSubnets ](https://intl.cloud.tencent.com/document/api/215/15784?from_cn_redirect=1) API.
  - setSubnetId
```
public void setSubnetId(String SubnetId)
```
    Set VPC subnet ID in the format of `subnet-xxxxxxxx`, which can be obtained in the console or from the `unSubnetId` field in the return value of the [DescribeSubnets ](https://intl.cloud.tencent.com/document/api/215/15784?from_cn_redirect=1) API.
    
    Parameters:
    
    SubnetId - VPC subnet ID in the format of `subnet-xxxxxxxx`, which can be obtained in the console or from the `unSubnetId` field in the return value of the [DescribeSubnets ](https://intl.cloud.tencent.com/document/api/215/15784?from_cn_redirect=1) API.
  - getDBInstanceId
```
public String getDBInstanceId()
```
    Get Instance ID
    
    Returns:
    
    DBInstanceId Instance ID
  - setDBInstanceId
```
public void setDBInstanceId(String DBInstanceId)
```
    Set Instance ID
    
    Parameters:
    
    DBInstanceId - Instance ID
  - getDBInstanceName
```
public String getDBInstanceName()
```
    Get Instance name
    
    Returns:
    
    DBInstanceName Instance name
  - setDBInstanceName
```
public void setDBInstanceName(String DBInstanceName)
```
    Set Instance name
    
    Parameters:
    
    DBInstanceName - Instance name
  - getDBInstanceStatus
```
public String getDBInstanceStatus()
```
    Get Instance status. Valid values: `applying`, `init` (to be initialized), `initing` (initializing), `running`, `limited run`, `isolating`, `isolated`, `recycling`, `recycled`, `job running`, `offline`, `migrating`, `expanding`, `waitSwitch` (waiting for switch), `switching`, `readonly`, `restarting`, `network changing`, `upgrading` (upgrading kernel version), `audit-switching` (changing audit status), `primary-switching` (primary-standby switching).
    
    Returns:
    
    DBInstanceStatus Instance status. Valid values: `applying`, `init` (to be initialized), `initing` (initializing), `running`, `limited run`, `isolating`, `isolated`, `recycling`, `recycled`, `job running`, `offline`, `migrating`, `expanding`, `waitSwitch` (waiting for switch), `switching`, `readonly`, `restarting`, `network changing`, `upgrading` (upgrading kernel version), `audit-switching` (changing audit status), `primary-switching` (primary-standby switching).
  - setDBInstanceStatus
```
public void setDBInstanceStatus(String DBInstanceStatus)
```
    Set Instance status. Valid values: `applying`, `init` (to be initialized), `initing` (initializing), `running`, `limited run`, `isolating`, `isolated`, `recycling`, `recycled`, `job running`, `offline`, `migrating`, `expanding`, `waitSwitch` (waiting for switch), `switching`, `readonly`, `restarting`, `network changing`, `upgrading` (upgrading kernel version), `audit-switching` (changing audit status), `primary-switching` (primary-standby switching).
    
    Parameters:
    
    DBInstanceStatus - Instance status. Valid values: `applying`, `init` (to be initialized), `initing` (initializing), `running`, `limited run`, `isolating`, `isolated`, `recycling`, `recycled`, `job running`, `offline`, `migrating`, `expanding`, `waitSwitch` (waiting for switch), `switching`, `readonly`, `restarting`, `network changing`, `upgrading` (upgrading kernel version), `audit-switching` (changing audit status), `primary-switching` (primary-standby switching).
  - getDBInstanceMemory
```
public Long getDBInstanceMemory()
```
    Get Assigned instance memory size in GB
    
    Returns:
    
    DBInstanceMemory Assigned instance memory size in GB
  - setDBInstanceMemory
```
public void setDBInstanceMemory(Long DBInstanceMemory)
```
    Set Assigned instance memory size in GB
    
    Parameters:
    
    DBInstanceMemory - Assigned instance memory size in GB
  - getDBInstanceStorage
```
public Long getDBInstanceStorage()
```
    Get Assigned instance storage capacity in GB
    
    Returns:
    
    DBInstanceStorage Assigned instance storage capacity in GB
  - setDBInstanceStorage
```
public void setDBInstanceStorage(Long DBInstanceStorage)
```
    Set Assigned instance storage capacity in GB
    
    Parameters:
    
    DBInstanceStorage - Assigned instance storage capacity in GB
  - getDBInstanceCpu
```
public Long getDBInstanceCpu()
```
    Get Number of assigned CPUs
    
    Returns:
    
    DBInstanceCpu Number of assigned CPUs
  - setDBInstanceCpu
```
public void setDBInstanceCpu(Long DBInstanceCpu)
```
    Set Number of assigned CPUs
    
    Parameters:
    
    DBInstanceCpu - Number of assigned CPUs
  - getDBInstanceClass
```
public String getDBInstanceClass()
```
    Get Purchasable specification ID
    
    Returns:
    
    DBInstanceClass Purchasable specification ID
  - setDBInstanceClass
```
public void setDBInstanceClass(String DBInstanceClass)
```
    Set Purchasable specification ID
    
    Parameters:
    
    DBInstanceClass - Purchasable specification ID
  - getDBMajorVersion
```
public String getDBMajorVersion()
```
    Get The major PostgreSQL version number, which can be queried by the [DescribeDBVersions](https://intl.cloud.tencent.com/document/api/409/89018?from_cn_redirect=1) API. Valid values: `10`, `11`, `12`, `13`, `14`, `15`. Note: u200dThis field may return null, indicating that no valid values can be obtained.
    
    Returns:
    
    DBMajorVersion The major PostgreSQL version number, which can be queried by the [DescribeDBVersions](https://intl.cloud.tencent.com/document/api/409/89018?from_cn_redirect=1) API. Valid values: `10`, `11`, `12`, `13`, `14`, `15`. Note: u200dThis field may return null, indicating that no valid values can be obtained.
  - setDBMajorVersion
```
public void setDBMajorVersion(String DBMajorVersion)
```
    Set The major PostgreSQL version number, which can be queried by the [DescribeDBVersions](https://intl.cloud.tencent.com/document/api/409/89018?from_cn_redirect=1) API. Valid values: `10`, `11`, `12`, `13`, `14`, `15`. Note: u200dThis field may return null, indicating that no valid values can be obtained.
    
    Parameters:
    
    DBMajorVersion - The major PostgreSQL version number, which can be queried by the [DescribeDBVersions](https://intl.cloud.tencent.com/document/api/409/89018?from_cn_redirect=1) API. Valid values: `10`, `11`, `12`, `13`, `14`, `15`. Note: u200dThis field may return null, indicating that no valid values can be obtained.
  - getDBVersion
```
public String getDBVersion()
```
    Get Number of the major PostgreSQL community version and minor version, such as 12.4, which can be queried by the [DescribeDBVersions](https://intl.cloud.tencent.com/document/api/409/89018?from_cn_redirect=1) API.
    
    Returns:
    
    DBVersion Number of the major PostgreSQL community version and minor version, such as 12.4, which can be queried by the [DescribeDBVersions](https://intl.cloud.tencent.com/document/api/409/89018?from_cn_redirect=1) API.
  - setDBVersion
```
public void setDBVersion(String DBVersion)
```
    Set Number of the major PostgreSQL community version and minor version, such as 12.4, which can be queried by the [DescribeDBVersions](https://intl.cloud.tencent.com/document/api/409/89018?from_cn_redirect=1) API.
    
    Parameters:
    
    DBVersion - Number of the major PostgreSQL community version and minor version, such as 12.4, which can be queried by the [DescribeDBVersions](https://intl.cloud.tencent.com/document/api/409/89018?from_cn_redirect=1) API.
  - getDBKernelVersion
```
public String getDBKernelVersion()
```
    Get PostgreSQL kernel version number (like v12.7_r1.8), which can be queried by the [DescribeDBVersions](https://intl.cloud.tencent.com/document/api/409/89018?from_cn_redirect=1) API. Note: u200dThis field may return null, indicating that no valid values can be obtained.
    
    Returns:
    
    DBKernelVersion PostgreSQL kernel version number (like v12.7_r1.8), which can be queried by the [DescribeDBVersions](https://intl.cloud.tencent.com/document/api/409/89018?from_cn_redirect=1) API. Note: u200dThis field may return null, indicating that no valid values can be obtained.
  - setDBKernelVersion
```
public void setDBKernelVersion(String DBKernelVersion)
```
    Set PostgreSQL kernel version number (like v12.7_r1.8), which can be queried by the [DescribeDBVersions](https://intl.cloud.tencent.com/document/api/409/89018?from_cn_redirect=1) API. Note: u200dThis field may return null, indicating that no valid values can be obtained.
    
    Parameters:
    
    DBKernelVersion - PostgreSQL kernel version number (like v12.7_r1.8), which can be queried by the [DescribeDBVersions](https://intl.cloud.tencent.com/document/api/409/89018?from_cn_redirect=1) API. Note: u200dThis field may return null, indicating that no valid values can be obtained.
  - getDBInstanceType
```
public String getDBInstanceType()
```
    Get Instance type. Valid values:
  - `primary`: Primary instance
  - `readonly`: Read-only instance
  - `guard`: Disaster recovery instance
  - `temp`: Temp instance

Returns:: DBInstanceType Instance type. Valid values:
`primary`: Primary instance
`readonly`: Read-only instance
`guard`: Disaster recovery instance
`temp`: Temp instance

setDBInstanceType

public void setDBInstanceType(String DBInstanceType)

Set Instance type. Valid values:

`primary`: Primary instance
`readonly`: Read-only instance
`guard`: Disaster recovery instance
`temp`: Temp instance

Class DBInstance

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

Constructor Summary

Method Summary

Methods inherited from class com.tencentcloudapi.common.AbstractModel

Methods inherited from class java.lang.Object

Constructor Detail

DBInstance

DBInstance

Method Detail

getRegion

setRegion

getZone

setZone

getVpcId

setVpcId

getSubnetId

setSubnetId

getDBInstanceId

setDBInstanceId

getDBInstanceName

setDBInstanceName

getDBInstanceStatus

setDBInstanceStatus

getDBInstanceMemory

setDBInstanceMemory

getDBInstanceStorage

setDBInstanceStorage

getDBInstanceCpu

setDBInstanceCpu

getDBInstanceClass

setDBInstanceClass

getDBMajorVersion

setDBMajorVersion

getDBVersion

setDBVersion

getDBKernelVersion

setDBKernelVersion

getDBInstanceType

setDBInstanceType

getDBInstanceVersion

setDBInstanceVersion

getDBCharset

setDBCharset

getCreateTime

setCreateTime

getUpdateTime

setUpdateTime

getExpireTime

setExpireTime

getIsolatedTime

setIsolatedTime

getPayType

setPayType

getAutoRenew

setAutoRenew

getDBInstanceNetInfo

setDBInstanceNetInfo

getType

setType

getAppId

setAppId

getUid

setUid

getProjectId

setProjectId

getTagList

setTagList

getMasterDBInstanceId

setMasterDBInstanceId

getReadOnlyInstanceNum

setReadOnlyInstanceNum

getStatusInReadonlyGroup

setStatusInReadonlyGroup

getOfflineTime

setOfflineTime

getDBNodeSet

setDBNodeSet

getIsSupportTDE