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

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

public class DBInstance
extends AbstractModel

Constructor Summary

Constructors
Constructor and Description

DBInstance()

Constructors
Constructor and Description
`DBInstance()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Long`	`getAppId()` Get Application ID of instance
`Long`	`getAutoRenewFlag()` Get Auto-renewal flag.
`Long`	`getCpu()` Get Number of CPU cores of instance
`String`	`getCreateTime()` Get Instance creation time in the format of `2006-01-02 15:04:05`
`String`	`getExclusterId()` Get Dedicated cluster ID.
`Long`	`getId()` Get Numeric ID of instance (this field is obsolete and should not be depended on)
`String`	`getInstanceId()` Get Instance ID, which uniquely identifies a TDSQL instance
`String`	`getInstanceName()` Get Customizable instance name
`Long`	`getIsAuditSupported()` Get Whether the instance supports audit.
`Long`	`getIsEncryptSupported()` Get Whether data encryption is supported.
`Long`	`getIsTmp()` Get Whether it is a temp instance.
`Long`	`getLocker()` Get Async task flow ID when an async task is in progress on an instance Note: this field may return null, indicating that no valid values can be obtained.
`String`	`getMachine()` Get Model
`Long`	`getMemory()` Get Instance memory size in GB
`Long`	`getNodeCount()` Get Number of nodes.
`String`	`getOriginSerialId()` Get Original ID of instance (this field is obsolete and should not be depended on)
`String`	`getPaymode()` Get Billing mode Note: this field may return null, indicating that no valid values can be obtained.
`String`	`getPeriodEndTime()` Get Instance expiration time in the format of `2006-01-02 15:04:05`
`Long`	`getPid()` Get Product type ID
`Long`	`getProjectId()` Get Project ID of instance
`Long`	`getQps()` Get Maximum QPS value
`String`	`getRegion()` Get Instance region name, such as ap-shanghai
`Long`	`getStatus()` Get Instance status.
`String`	`getStatusDesc()` Get Current instance running status description Note: this field may return null, indicating that no valid values can be obtained.
`Long`	`getStorage()` Get Instance storage capacity in GB
`Long`	`getSubnetId()` Get Subnet ID, which is 0 if the basic network is used
`String`	`getTdsqlVersion()` Get TDSQL version information
`String`	`getUin()` Get Instance account
`String`	`getUniqueSubnetId()` Get VPC subnet ID in string type
`String`	`getUniqueVpcId()` Get VPC ID in string type
`String`	`getUpdateTime()` Get Last updated time of instance in the format of `2006-01-02 15:04:05`
`String`	`getVip()` Get Private IP address
`Long`	`getVpcId()` Get VPC ID, which is 0 if the basic network is used
`Long`	`getVport()` Get Private network port
`String`	`getWanDomain()` Get Domain name for public network access, which can be resolved by the public network
`Long`	`getWanPort()` Get Public network port
`Long`	`getWanStatus()` Get Public network access status.
`String`	`getWanVip()` Get Public IP address, which can be accessed over the public network
`String`	`getZone()` Get Instance AZ name, such as ap-guangzhou-1
`void`	`setAppId(Long AppId)` Set Application ID of instance
`void`	`setAutoRenewFlag(Long AutoRenewFlag)` Set Auto-renewal flag.
`void`	`setCpu(Long Cpu)` Set Number of CPU cores of instance
`void`	`setCreateTime(String CreateTime)` Set Instance creation time in the format of `2006-01-02 15:04:05`
`void`	`setExclusterId(String ExclusterId)` Set Dedicated cluster ID.
`void`	`setId(Long Id)` Set Numeric ID of instance (this field is obsolete and should not be depended on)
`void`	`setInstanceId(String InstanceId)` Set Instance ID, which uniquely identifies a TDSQL instance
`void`	`setInstanceName(String InstanceName)` Set Customizable instance name
`void`	`setIsAuditSupported(Long IsAuditSupported)` Set Whether the instance supports audit.
`void`	`setIsEncryptSupported(Long IsEncryptSupported)` Set Whether data encryption is supported.
`void`	`setIsTmp(Long IsTmp)` Set Whether it is a temp instance.
`void`	`setLocker(Long Locker)` Set Async task flow ID when an async task is in progress on an instance Note: this field may return null, indicating that no valid values can be obtained.
`void`	`setMachine(String Machine)` Set Model
`void`	`setMemory(Long Memory)` Set Instance memory size in GB
`void`	`setNodeCount(Long NodeCount)` Set Number of nodes.
`void`	`setOriginSerialId(String OriginSerialId)` Set Original ID of instance (this field is obsolete and should not be depended on)
`void`	`setPaymode(String Paymode)` Set Billing mode Note: this field may return null, indicating that no valid values can be obtained.
`void`	`setPeriodEndTime(String PeriodEndTime)` Set Instance expiration time in the format of `2006-01-02 15:04:05`
`void`	`setPid(Long Pid)` Set Product type ID
`void`	`setProjectId(Long ProjectId)` Set Project ID of instance
`void`	`setQps(Long Qps)` Set Maximum QPS value
`void`	`setRegion(String Region)` Set Instance region name, such as ap-shanghai
`void`	`setStatus(Long Status)` Set Instance status.
`void`	`setStatusDesc(String StatusDesc)` Set Current instance running status description Note: this field may return null, indicating that no valid values can be obtained.
`void`	`setStorage(Long Storage)` Set Instance storage capacity in GB
`void`	`setSubnetId(Long SubnetId)` Set Subnet ID, which is 0 if the basic network is used
`void`	`setTdsqlVersion(String TdsqlVersion)` Set TDSQL version information
`void`	`setUin(String Uin)` Set Instance account
`void`	`setUniqueSubnetId(String UniqueSubnetId)` Set VPC subnet ID in string type
`void`	`setUniqueVpcId(String UniqueVpcId)` Set VPC ID in string type
`void`	`setUpdateTime(String UpdateTime)` Set Last updated time of instance in the format of `2006-01-02 15:04:05`
`void`	`setVip(String Vip)` Set Private IP address
`void`	`setVpcId(Long VpcId)` Set VPC ID, which is 0 if the basic network is used
`void`	`setVport(Long Vport)` Set Private network port
`void`	`setWanDomain(String WanDomain)` Set Domain name for public network access, which can be resolved by the public network
`void`	`setWanPort(Long WanPort)` Set Public network port
`void`	`setWanStatus(Long WanStatus)` Set Public network access status.
`void`	`setWanVip(String WanVip)` Set Public IP address, which can be accessed over the public network
`void`	`setZone(String Zone)` Set Instance AZ name, such as ap-guangzhou-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
  - DBInstance
```
public DBInstance()
```
- Method Detail
  - getInstanceId
```
public String getInstanceId()
```
    Get Instance ID, which uniquely identifies a TDSQL instance
    
    Returns:
    
    InstanceId Instance ID, which uniquely identifies a TDSQL instance
  - setInstanceId
```
public void setInstanceId(String InstanceId)
```
    Set Instance ID, which uniquely identifies a TDSQL instance
    
    Parameters:
    
    InstanceId - Instance ID, which uniquely identifies a TDSQL instance
  - getInstanceName
```
public String getInstanceName()
```
    Get Customizable instance name
    
    Returns:
    
    InstanceName Customizable instance name
  - setInstanceName
```
public void setInstanceName(String InstanceName)
```
    Set Customizable instance name
    
    Parameters:
    
    InstanceName - Customizable instance name
  - getAppId
```
public Long getAppId()
```
    Get Application ID of instance
    
    Returns:
    
    AppId Application ID of instance
  - setAppId
```
public void setAppId(Long AppId)
```
    Set Application ID of instance
    
    Parameters:
    
    AppId - Application ID of instance
  - getProjectId
```
public Long getProjectId()
```
    Get Project ID of instance
    
    Returns:
    
    ProjectId Project ID of instance
  - setProjectId
```
public void setProjectId(Long ProjectId)
```
    Set Project ID of instance
    
    Parameters:
    
    ProjectId - Project ID of instance
  - getRegion
```
public String getRegion()
```
    Get Instance region name, such as ap-shanghai
    
    Returns:
    
    Region Instance region name, such as ap-shanghai
  - setRegion
```
public void setRegion(String Region)
```
    Set Instance region name, such as ap-shanghai
    
    Parameters:
    
    Region - Instance region name, such as ap-shanghai
  - getZone
```
public String getZone()
```
    Get Instance AZ name, such as ap-guangzhou-1
    
    Returns:
    
    Zone Instance AZ name, such as ap-guangzhou-1
  - setZone
```
public void setZone(String Zone)
```
    Set Instance AZ name, such as ap-guangzhou-1
    
    Parameters:
    
    Zone - Instance AZ name, such as ap-guangzhou-1
  - getVpcId
```
public Long getVpcId()
```
    Get VPC ID, which is 0 if the basic network is used
    
    Returns:
    
    VpcId VPC ID, which is 0 if the basic network is used
  - setVpcId
```
public void setVpcId(Long VpcId)
```
    Set VPC ID, which is 0 if the basic network is used
    
    Parameters:
    
    VpcId - VPC ID, which is 0 if the basic network is used
  - getSubnetId
```
public Long getSubnetId()
```
    Get Subnet ID, which is 0 if the basic network is used
    
    Returns:
    
    SubnetId Subnet ID, which is 0 if the basic network is used
  - setSubnetId
```
public void setSubnetId(Long SubnetId)
```
    Set Subnet ID, which is 0 if the basic network is used
    
    Parameters:
    
    SubnetId - Subnet ID, which is 0 if the basic network is used
  - getStatus
```
public Long getStatus()
```
    Get Instance status. 0: creating, 1: processing, 2: running, 3: instance not initialized, -1: instance isolated, -2: instance deleted
    
    Returns:
    
    Status Instance status. 0: creating, 1: processing, 2: running, 3: instance not initialized, -1: instance isolated, -2: instance deleted
  - setStatus
```
public void setStatus(Long Status)
```
    Set Instance status. 0: creating, 1: processing, 2: running, 3: instance not initialized, -1: instance isolated, -2: instance deleted
    
    Parameters:
    
    Status - Instance status. 0: creating, 1: processing, 2: running, 3: instance not initialized, -1: instance isolated, -2: instance deleted
  - getVip
```
public String getVip()
```
    Get Private IP address
    
    Returns:
    
    Vip Private IP address
  - setVip
```
public void setVip(String Vip)
```
    Set Private IP address
    
    Parameters:
    
    Vip - Private IP address
  - getVport
```
public Long getVport()
```
    Get Private network port
    
    Returns:
    
    Vport Private network port
  - setVport
```
public void setVport(Long Vport)
```
    Set Private network port
    
    Parameters:
    
    Vport - Private network port
  - getWanDomain
```
public String getWanDomain()
```
    Get Domain name for public network access, which can be resolved by the public network
    
    Returns:
    
    WanDomain Domain name for public network access, which can be resolved by the public network
  - setWanDomain
```
public void setWanDomain(String WanDomain)
```
    Set Domain name for public network access, which can be resolved by the public network
    
    Parameters:
    
    WanDomain - Domain name for public network access, which can be resolved by the public network
  - getWanVip
```
public String getWanVip()
```
    Get Public IP address, which can be accessed over the public network
    
    Returns:
    
    WanVip Public IP address, which can be accessed over the public network
  - setWanVip
```
public void setWanVip(String WanVip)
```
    Set Public IP address, which can be accessed over the public network
    
    Parameters:
    
    WanVip - Public IP address, which can be accessed over the public network
  - getWanPort
```
public Long getWanPort()
```
    Get Public network port
    
    Returns:
    
    WanPort Public network port
  - setWanPort
```
public void setWanPort(Long WanPort)
```
    Set Public network port
    
    Parameters:
    
    WanPort - Public network port
  - getCreateTime
```
public String getCreateTime()
```
    Get Instance creation time in the format of `2006-01-02 15:04:05`
    
    Returns:
    
    CreateTime Instance creation time in the format of `2006-01-02 15:04:05`
  - setCreateTime
```
public void setCreateTime(String CreateTime)
```
    Set Instance creation time in the format of `2006-01-02 15:04:05`
    
    Parameters:
    
    CreateTime - Instance creation time in the format of `2006-01-02 15:04:05`
  - getUpdateTime
```
public String getUpdateTime()
```
    Get Last updated time of instance in the format of `2006-01-02 15:04:05`
    
    Returns:
    
    UpdateTime Last updated time of instance in the format of `2006-01-02 15:04:05`
  - setUpdateTime
```
public void setUpdateTime(String UpdateTime)
```
    Set Last updated time of instance in the format of `2006-01-02 15:04:05`
    
    Parameters:
    
    UpdateTime - Last updated time of instance in the format of `2006-01-02 15:04:05`
  - getAutoRenewFlag
```
public Long getAutoRenewFlag()
```
    Get Auto-renewal flag. 0: no, 1: yes
    
    Returns:
    
    AutoRenewFlag Auto-renewal flag. 0: no, 1: yes
  - setAutoRenewFlag
```
public void setAutoRenewFlag(Long AutoRenewFlag)
```
    Set Auto-renewal flag. 0: no, 1: yes
    
    Parameters:
    
    AutoRenewFlag - Auto-renewal flag. 0: no, 1: yes
  - getPeriodEndTime
```
public String getPeriodEndTime()
```
    Get Instance expiration time in the format of `2006-01-02 15:04:05`
    
    Returns:
    
    PeriodEndTime Instance expiration time in the format of `2006-01-02 15:04:05`
  - setPeriodEndTime
```
public void setPeriodEndTime(String PeriodEndTime)
```
    Set Instance expiration time in the format of `2006-01-02 15:04:05`
    
    Parameters:
    
    PeriodEndTime - Instance expiration time in the format of `2006-01-02 15:04:05`
  - getUin
```
public String getUin()
```
    Get Instance account
    
    Returns:
    
    Uin Instance account
  - setUin
```
public void setUin(String Uin)
```
    Set Instance account
    
    Parameters:
    
    Uin - Instance account
  - getTdsqlVersion
```
public String getTdsqlVersion()
```
    Get TDSQL version information
    
    Returns:
    
    TdsqlVersion TDSQL version information
  - setTdsqlVersion
```
public void setTdsqlVersion(String TdsqlVersion)
```
    Set TDSQL version information
    
    Parameters:
    
    TdsqlVersion - TDSQL version information
  - getMemory
```
public Long getMemory()
```
    Get Instance memory size in GB
    
    Returns:
    
    Memory Instance memory size in GB
  - setMemory
```
public void setMemory(Long Memory)
```
    Set Instance memory size in GB
    
    Parameters:
    
    Memory - Instance memory size in GB
  - getStorage
```
public Long getStorage()
```
    Get Instance storage capacity in GB
    
    Returns:
    
    Storage Instance storage capacity in GB
  - setStorage
```
public void setStorage(Long Storage)
```
    Set Instance storage capacity in GB
    
    Parameters:
    
    Storage - Instance storage capacity in GB
  - getUniqueVpcId
```
public String getUniqueVpcId()
```
    Get VPC ID in string type
    
    Returns:
    
    UniqueVpcId VPC ID in string type
  - setUniqueVpcId
```
public void setUniqueVpcId(String UniqueVpcId)
```
    Set VPC ID in string type
    
    Parameters:
    
    UniqueVpcId - VPC ID in string type
  - getUniqueSubnetId
```
public String getUniqueSubnetId()
```
    Get VPC subnet ID in string type
    
    Returns:
    
    UniqueSubnetId VPC subnet ID in string type
  - setUniqueSubnetId
```
public void setUniqueSubnetId(String UniqueSubnetId)
```
    Set VPC subnet ID in string type
    
    Parameters:
    
    UniqueSubnetId - VPC subnet ID in string type
  - getOriginSerialId
```
public String getOriginSerialId()
```
    Get Original ID of instance (this field is obsolete and should not be depended on)
    
    Returns:
    
    OriginSerialId Original ID of instance (this field is obsolete and should not be depended on)
  - setOriginSerialId
```
public void setOriginSerialId(String OriginSerialId)
```
    Set Original ID of instance (this field is obsolete and should not be depended on)
    
    Parameters:
    
    OriginSerialId - Original ID of instance (this field is obsolete and should not be depended on)
  - getNodeCount
```
public Long getNodeCount()
```
    Get Number of nodes. 2: one primary and one secondary, 3: one primary and two secondaries
    
    Returns:
    
    NodeCount Number of nodes. 2: one primary and one secondary, 3: one primary and two secondaries
  - setNodeCount
```
public void setNodeCount(Long NodeCount)
```
    Set Number of nodes. 2: one primary and one secondary, 3: one primary and two secondaries
    
    Parameters:
    
    NodeCount - Number of nodes. 2: one primary and one secondary, 3: one primary and two secondaries
  - getIsTmp
```
public Long getIsTmp()
```
    Get Whether it is a temp instance. 0: no, non-zero value: yes
    
    Returns:
    
    IsTmp Whether it is a temp instance. 0: no, non-zero value: yes
  - setIsTmp
```
public void setIsTmp(Long IsTmp)
```
    Set Whether it is a temp instance. 0: no, non-zero value: yes
    
    Parameters:
    
    IsTmp - Whether it is a temp instance. 0: no, non-zero value: yes
  - getExclusterId
```
public String getExclusterId()
```
    Get Dedicated cluster ID. If this parameter is empty, the instance is a general instance
    
    Returns:
    
    ExclusterId Dedicated cluster ID. If this parameter is empty, the instance is a general instance
  - setExclusterId
```
public void setExclusterId(String ExclusterId)
```
    Set Dedicated cluster ID. If this parameter is empty, the instance is a general instance
    
    Parameters:
    
    ExclusterId - Dedicated cluster ID. If this parameter is empty, the instance is a general instance
  - getId
```
public Long getId()
```
    Get Numeric ID of instance (this field is obsolete and should not be depended on)
    
    Returns:
    
    Id Numeric ID of instance (this field is obsolete and should not be depended on)
  - setId
```
public void setId(Long Id)
```
    Set Numeric ID of instance (this field is obsolete and should not be depended on)
    
    Parameters:
    
    Id - Numeric ID of instance (this field is obsolete and should not be depended on)
  - getPid
```
public Long getPid()
```
    Get Product type ID
    
    Returns:
    
    Pid Product type ID
  - setPid
```
public void setPid(Long Pid)
```
    Set Product type ID
    
    Parameters:
    
    Pid - Product type ID
  - getQps
```
public Long getQps()
```
    Get Maximum QPS value
    
    Returns:
    
    Qps Maximum QPS value
  - setQps
```
public void setQps(Long Qps)
```
    Set Maximum QPS value
    
    Parameters:
    
    Qps - Maximum QPS value
  - getPaymode
```
public String getPaymode()
```
    Get Billing mode Note: this field may return null, indicating that no valid values can be obtained.
    
    Returns:
    
    Paymode Billing mode Note: this field may return null, indicating that no valid values can be obtained.
  - setPaymode
```
public void setPaymode(String Paymode)
```
    Set Billing mode Note: this field may return null, indicating that no valid values can be obtained.
    
    Parameters:
    
    Paymode - Billing mode Note: this field may return null, indicating that no valid values can be obtained.
  - getLocker
```
public Long getLocker()
```
    Get Async task flow ID when an async task is in progress on an instance Note: this field may return null, indicating that no valid values can be obtained.
    
    Returns:
    
    Locker Async task flow ID when an async task is in progress on an instance Note: this field may return null, indicating that no valid values can be obtained.
  - setLocker
```
public void setLocker(Long Locker)
```
    Set Async task flow ID when an async task is in progress on an instance Note: this field may return null, indicating that no valid values can be obtained.
    
    Parameters:
    
    Locker - Async task flow ID when an async task is in progress on an instance Note: this field may return null, indicating that no valid values can be obtained.
  - getStatusDesc
```
public String getStatusDesc()
```
    Get Current instance running status description Note: this field may return null, indicating that no valid values can be obtained.
    
    Returns:
    
    StatusDesc Current instance running status description Note: this field may return null, indicating that no valid values can be obtained.
  - setStatusDesc
```
public void setStatusDesc(String StatusDesc)
```
    Set Current instance running status description Note: this field may return null, indicating that no valid values can be obtained.
    
    Parameters:
    
    StatusDesc - Current instance running status description Note: this field may return null, indicating that no valid values can be obtained.
  - getWanStatus
```
public Long getWanStatus()
```
    Get Public network access status. 0: not enabled, 1: enabled, 2: disabled, 3: enabling
    
    Returns:
    
    WanStatus Public network access status. 0: not enabled, 1: enabled, 2: disabled, 3: enabling
  - setWanStatus
```
public void setWanStatus(Long WanStatus)
```
    Set Public network access status. 0: not enabled, 1: enabled, 2: disabled, 3: enabling
    
    Parameters:
    
    WanStatus - Public network access status. 0: not enabled, 1: enabled, 2: disabled, 3: enabling
  - getIsAuditSupported
```
public Long getIsAuditSupported()
```
    Get Whether the instance supports audit. 1: yes, 0: no
    
    Returns:
    
    IsAuditSupported Whether the instance supports audit. 1: yes, 0: no
  - setIsAuditSupported
```
public void setIsAuditSupported(Long IsAuditSupported)
```
    Set Whether the instance supports audit. 1: yes, 0: no
    
    Parameters:
    
    IsAuditSupported - Whether the instance supports audit. 1: yes, 0: no
  - getMachine
```
public String getMachine()
```
    Get Model
    
    Returns:
    
    Machine Model
  - setMachine
```
public void setMachine(String Machine)
```
    Set Model
    
    Parameters:
    
    Machine - Model
  - getIsEncryptSupported
```
public Long getIsEncryptSupported()
```
    Get Whether data encryption is supported. 1: yes, 0: no
    
    Returns:
    
    IsEncryptSupported Whether data encryption is supported. 1: yes, 0: no
  - setIsEncryptSupported
```
public void setIsEncryptSupported(Long IsEncryptSupported)
```
    Set Whether data encryption is supported. 1: yes, 0: no
    
    Parameters:
    
    IsEncryptSupported - Whether data encryption is supported. 1: yes, 0: no
  - getCpu
```
public Long getCpu()
```
    Get Number of CPU cores of instance
    
    Returns:
    
    Cpu Number of CPU cores of instance
  - setCpu
```
public void setCpu(Long Cpu)
```
    Set Number of CPU cores of instance
    
    Parameters:
    
    Cpu - Number of CPU cores of instance
  - 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 DBInstance

Constructor Summary

Method Summary

Methods inherited from class com.tencentcloudapi.common.AbstractModel

Methods inherited from class java.lang.Object

Constructor Detail

DBInstance

Method Detail

getInstanceId

setInstanceId

getInstanceName

setInstanceName

getAppId

setAppId

getProjectId

setProjectId

getRegion

setRegion

getZone

setZone

getVpcId

setVpcId

getSubnetId

setSubnetId

getStatus

setStatus

getVip

setVip

getVport

setVport

getWanDomain

setWanDomain

getWanVip

setWanVip

getWanPort

setWanPort

getCreateTime

setCreateTime

getUpdateTime

setUpdateTime

getAutoRenewFlag

setAutoRenewFlag

getPeriodEndTime

setPeriodEndTime

getUin

setUin

getTdsqlVersion

setTdsqlVersion

getMemory

setMemory

getStorage

setStorage

getUniqueVpcId

setUniqueVpcId

getUniqueSubnetId

setUniqueSubnetId

getOriginSerialId

setOriginSerialId

getNodeCount

setNodeCount

getIsTmp

setIsTmp

getExclusterId

setExclusterId

getId

setId

getPid

setPid

getQps

setQps

getPaymode

setPaymode

getLocker

setLocker

getStatusDesc

setStatusDesc

getWanStatus

setWanStatus

getIsAuditSupported

setIsAuditSupported