com.tencentcloudapi.cdb.v20170320.models

Class UpgradeDBInstanceRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.cdb.v20170320.models.UpgradeDBInstanceRequest

public class UpgradeDBInstanceRequest
extends AbstractModel

Constructor Summary

Constructors

Constructor and Description
UpgradeDBInstanceRequest()
UpgradeDBInstanceRequest(UpgradeDBInstanceRequest 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
String	getBackupZone() Get AZ information of secondary database 2, which is empty by default.
Long	getCpu() Get The number of CPU cores after the instance is upgraded.
Long	getCrossCluster() Get Whether to migrate the source node across AZs.
Long	getDeployMode() Get Deployment mode.
String	getDeviceType() Get The resource isolation type after the instance is upgraded.
String	getEngineVersion() Get Version of primary instance database engine.
Long	getFastUpgrade() Get QuickChange options.
String	getInstanceId() Get Instance ID in the format of `cdb-c1nl9rpv` or `cdbro-c1nl9rpv`.
String	getInstanceRole() Get Instance type.
Long	getMaxDelayTime() Get Delay threshold.
Long	getMemory() Get Memory size in MB after upgrade.
Long	getProtectMode() Get Data replication mode.
String	getRoTransType() Get Processing logic of the intra-AZ read-only instance for cross-cluster migration.
String	getSlaveZone() Get AZ information of secondary database 1, which is the `Zone` value of the instance by default.
Long	getVolume() Get Disk size in GB after upgrade.
Long	getWaitSwitch() Get Mode of switch to new instance.
String	getZoneId() Get New AZ of the source node.
void	setBackupZone(String BackupZone) Set AZ information of secondary database 2, which is empty by default.
void	setCpu(Long Cpu) Set The number of CPU cores after the instance is upgraded.
void	setCrossCluster(Long CrossCluster) Set Whether to migrate the source node across AZs.
void	setDeployMode(Long DeployMode) Set Deployment mode.
void	setDeviceType(String DeviceType) Set The resource isolation type after the instance is upgraded.
void	setEngineVersion(String EngineVersion) Set Version of primary instance database engine.
void	setFastUpgrade(Long FastUpgrade) Set QuickChange options.
void	setInstanceId(String InstanceId) Set Instance ID in the format of `cdb-c1nl9rpv` or `cdbro-c1nl9rpv`.
void	setInstanceRole(String InstanceRole) Set Instance type.
void	setMaxDelayTime(Long MaxDelayTime) Set Delay threshold.
void	setMemory(Long Memory) Set Memory size in MB after upgrade.
void	setProtectMode(Long ProtectMode) Set Data replication mode.
void	setRoTransType(String RoTransType) Set Processing logic of the intra-AZ read-only instance for cross-cluster migration.
void	setSlaveZone(String SlaveZone) Set AZ information of secondary database 1, which is the `Zone` value of the instance by default.
void	setVolume(Long Volume) Set Disk size in GB after upgrade.
void	setWaitSwitch(Long WaitSwitch) Set Mode of switch to new instance.
void	setZoneId(String ZoneId) Set New AZ of the source node.
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

UpgradeDBInstanceRequest

public UpgradeDBInstanceRequest()

UpgradeDBInstanceRequest

public UpgradeDBInstanceRequest(UpgradeDBInstanceRequest 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

getInstanceId

public String getInstanceId()

Get Instance ID in the format of `cdb-c1nl9rpv` or `cdbro-c1nl9rpv`. It is the same as the instance ID displayed on the TencentDB Console page. You can use the [DescribeDBInstances](https://intl.cloud.tencent.com/document/api/236/15872?from_cn_redirect=1) API to query the ID, whose value is the `InstanceId` value in output parameters.

Returns:

InstanceId Instance ID in the format of `cdb-c1nl9rpv` or `cdbro-c1nl9rpv`. It is the same as the instance ID displayed on the TencentDB Console page. You can use the [DescribeDBInstances](https://intl.cloud.tencent.com/document/api/236/15872?from_cn_redirect=1) API to query the ID, whose value is the `InstanceId` value in output parameters.

setInstanceId

public void setInstanceId(String InstanceId)

Set Instance ID in the format of `cdb-c1nl9rpv` or `cdbro-c1nl9rpv`. It is the same as the instance ID displayed on the TencentDB Console page. You can use the [DescribeDBInstances](https://intl.cloud.tencent.com/document/api/236/15872?from_cn_redirect=1) API to query the ID, whose value is the `InstanceId` value in output parameters.

Parameters:

InstanceId - Instance ID in the format of `cdb-c1nl9rpv` or `cdbro-c1nl9rpv`. It is the same as the instance ID displayed on the TencentDB Console page. You can use the [DescribeDBInstances](https://intl.cloud.tencent.com/document/api/236/15872?from_cn_redirect=1) API to query the ID, whose value is the `InstanceId` value in output parameters.

getMemory

public Long getMemory()

Get Memory size in MB after upgrade. To ensure that the `Memory` value to be passed in is valid, please use the [DescribeDBZoneConfig](https://intl.cloud.tencent.com/document/product/236/17229?from_cn_redirect=1) API to query the specifications of the memory that can be upgraded to.

Returns:

Memory Memory size in MB after upgrade. To ensure that the `Memory` value to be passed in is valid, please use the [DescribeDBZoneConfig](https://intl.cloud.tencent.com/document/product/236/17229?from_cn_redirect=1) API to query the specifications of the memory that can be upgraded to.

setMemory

public void setMemory(Long Memory)

Set Memory size in MB after upgrade. To ensure that the `Memory` value to be passed in is valid, please use the [DescribeDBZoneConfig](https://intl.cloud.tencent.com/document/product/236/17229?from_cn_redirect=1) API to query the specifications of the memory that can be upgraded to.

Parameters:

Memory - Memory size in MB after upgrade. To ensure that the `Memory` value to be passed in is valid, please use the [DescribeDBZoneConfig](https://intl.cloud.tencent.com/document/product/236/17229?from_cn_redirect=1) API to query the specifications of the memory that can be upgraded to.

getVolume

public Long getVolume()

Get Disk size in GB after upgrade. To ensure that the `Volume` value to be passed in is valid, please use the [DescribeDBZoneConfig](https://intl.cloud.tencent.com/document/product/236/17229?from_cn_redirect=1) API to query the specifications of the disk that can be upgraded to.

Returns:

Volume Disk size in GB after upgrade. To ensure that the `Volume` value to be passed in is valid, please use the [DescribeDBZoneConfig](https://intl.cloud.tencent.com/document/product/236/17229?from_cn_redirect=1) API to query the specifications of the disk that can be upgraded to.

setVolume

public void setVolume(Long Volume)

Set Disk size in GB after upgrade. To ensure that the `Volume` value to be passed in is valid, please use the [DescribeDBZoneConfig](https://intl.cloud.tencent.com/document/product/236/17229?from_cn_redirect=1) API to query the specifications of the disk that can be upgraded to.

Parameters:

Volume - Disk size in GB after upgrade. To ensure that the `Volume` value to be passed in is valid, please use the [DescribeDBZoneConfig](https://intl.cloud.tencent.com/document/product/236/17229?from_cn_redirect=1) API to query the specifications of the disk that can be upgraded to.

getProtectMode

public Long getProtectMode()

Get Data replication mode. Valid values: 0 (async), 1 (semi-sync), 2 (strong sync). This parameter can be specified when upgrading primary instances and is meaningless for read-only or disaster recovery instances.

Returns:

ProtectMode Data replication mode. Valid values: 0 (async), 1 (semi-sync), 2 (strong sync). This parameter can be specified when upgrading primary instances and is meaningless for read-only or disaster recovery instances.

setProtectMode

public void setProtectMode(Long ProtectMode)

Set Data replication mode. Valid values: 0 (async), 1 (semi-sync), 2 (strong sync). This parameter can be specified when upgrading primary instances and is meaningless for read-only or disaster recovery instances.

Parameters:

ProtectMode - Data replication mode. Valid values: 0 (async), 1 (semi-sync), 2 (strong sync). This parameter can be specified when upgrading primary instances and is meaningless for read-only or disaster recovery instances.

getDeployMode

public Long getDeployMode()

Get Deployment mode. Valid values: 0 (single-AZ), 1 (multi-AZ). Default value: 0. This parameter can be specified when upgrading primary instances and is meaningless for read-only or disaster recovery instances.

Returns:

DeployMode Deployment mode. Valid values: 0 (single-AZ), 1 (multi-AZ). Default value: 0. This parameter can be specified when upgrading primary instances and is meaningless for read-only or disaster recovery instances.

setDeployMode

public void setDeployMode(Long DeployMode)

Set Deployment mode. Valid values: 0 (single-AZ), 1 (multi-AZ). Default value: 0. This parameter can be specified when upgrading primary instances and is meaningless for read-only or disaster recovery instances.

Parameters:

DeployMode - Deployment mode. Valid values: 0 (single-AZ), 1 (multi-AZ). Default value: 0. This parameter can be specified when upgrading primary instances and is meaningless for read-only or disaster recovery instances.

getSlaveZone

public String getSlaveZone()

Get AZ information of secondary database 1, which is the `Zone` value of the instance by default. This parameter can be specified when upgrading primary instances in multi-AZ mode and is meaningless for read-only or disaster recovery instances. You can use the [DescribeDBZoneConfig](https://intl.cloud.tencent.com/document/product/236/17229?from_cn_redirect=1) API to query the supported AZs.

Returns:

SlaveZone AZ information of secondary database 1, which is the `Zone` value of the instance by default. This parameter can be specified when upgrading primary instances in multi-AZ mode and is meaningless for read-only or disaster recovery instances. You can use the [DescribeDBZoneConfig](https://intl.cloud.tencent.com/document/product/236/17229?from_cn_redirect=1) API to query the supported AZs.

setSlaveZone

public void setSlaveZone(String SlaveZone)

Set AZ information of secondary database 1, which is the `Zone` value of the instance by default. This parameter can be specified when upgrading primary instances in multi-AZ mode and is meaningless for read-only or disaster recovery instances. You can use the [DescribeDBZoneConfig](https://intl.cloud.tencent.com/document/product/236/17229?from_cn_redirect=1) API to query the supported AZs.

Parameters:

SlaveZone - AZ information of secondary database 1, which is the `Zone` value of the instance by default. This parameter can be specified when upgrading primary instances in multi-AZ mode and is meaningless for read-only or disaster recovery instances. You can use the [DescribeDBZoneConfig](https://intl.cloud.tencent.com/document/product/236/17229?from_cn_redirect=1) API to query the supported AZs.

getEngineVersion

public String getEngineVersion()

Get Version of primary instance database engine. Valid values: 5.5, 5.6, 5.7.

Returns:

EngineVersion Version of primary instance database engine. Valid values: 5.5, 5.6, 5.7.

setEngineVersion

public void setEngineVersion(String EngineVersion)

Set Version of primary instance database engine. Valid values: 5.5, 5.6, 5.7.

Parameters:

EngineVersion - Version of primary instance database engine. Valid values: 5.5, 5.6, 5.7.

getWaitSwitch

public Long getWaitSwitch()

Get Mode of switch to new instance. Valid values: 0 (switch immediately), 1 (switch within a time window). Default value: 0. If the value is 1, the switch process will be performed within a time window. Or, you can call the [SwitchForUpgrade](https://intl.cloud.tencent.com/document/product/236/15864?from_cn_redirect=1) API to trigger the process.

Returns:

WaitSwitch Mode of switch to new instance. Valid values: 0 (switch immediately), 1 (switch within a time window). Default value: 0. If the value is 1, the switch process will be performed within a time window. Or, you can call the [SwitchForUpgrade](https://intl.cloud.tencent.com/document/product/236/15864?from_cn_redirect=1) API to trigger the process.

setWaitSwitch

public void setWaitSwitch(Long WaitSwitch)

Set Mode of switch to new instance. Valid values: 0 (switch immediately), 1 (switch within a time window). Default value: 0. If the value is 1, the switch process will be performed within a time window. Or, you can call the [SwitchForUpgrade](https://intl.cloud.tencent.com/document/product/236/15864?from_cn_redirect=1) API to trigger the process.

Parameters:

WaitSwitch - Mode of switch to new instance. Valid values: 0 (switch immediately), 1 (switch within a time window). Default value: 0. If the value is 1, the switch process will be performed within a time window. Or, you can call the [SwitchForUpgrade](https://intl.cloud.tencent.com/document/product/236/15864?from_cn_redirect=1) API to trigger the process.

getBackupZone

public String getBackupZone()

Get AZ information of secondary database 2, which is empty by default. This parameter can be specified when upgrading primary instances and is meaningless for read-only or disaster recovery instances.

Returns:

BackupZone AZ information of secondary database 2, which is empty by default. This parameter can be specified when upgrading primary instances and is meaningless for read-only or disaster recovery instances.

setBackupZone

public void setBackupZone(String BackupZone)

Set AZ information of secondary database 2, which is empty by default. This parameter can be specified when upgrading primary instances and is meaningless for read-only or disaster recovery instances.

Parameters:

BackupZone - AZ information of secondary database 2, which is empty by default. This parameter can be specified when upgrading primary instances and is meaningless for read-only or disaster recovery instances.

getInstanceRole

public String getInstanceRole()

Get Instance type. Valid values: master (primary instance), dr (disaster recovery instance), ro (read-only instance). Default value: master.

Returns:

InstanceRole Instance type. Valid values: master (primary instance), dr (disaster recovery instance), ro (read-only instance). Default value: master.

setInstanceRole

public void setInstanceRole(String InstanceRole)

Set Instance type. Valid values: master (primary instance), dr (disaster recovery instance), ro (read-only instance). Default value: master.

Parameters:

InstanceRole - Instance type. Valid values: master (primary instance), dr (disaster recovery instance), ro (read-only instance). Default value: master.

getDeviceType

public String getDeviceType()

Get The resource isolation type after the instance is upgraded. Valid values: `UNIVERSAL` (general instance), `EXCLUSIVE` (dedicated instance), `BASIC` (basic instance). If this parameter is left empty, the resource isolation type will be the same as the original one.

Returns:

DeviceType The resource isolation type after the instance is upgraded. Valid values: `UNIVERSAL` (general instance), `EXCLUSIVE` (dedicated instance), `BASIC` (basic instance). If this parameter is left empty, the resource isolation type will be the same as the original one.

setDeviceType

public void setDeviceType(String DeviceType)

Set The resource isolation type after the instance is upgraded. Valid values: `UNIVERSAL` (general instance), `EXCLUSIVE` (dedicated instance), `BASIC` (basic instance). If this parameter is left empty, the resource isolation type will be the same as the original one.

Parameters:

DeviceType - The resource isolation type after the instance is upgraded. Valid values: `UNIVERSAL` (general instance), `EXCLUSIVE` (dedicated instance), `BASIC` (basic instance). If this parameter is left empty, the resource isolation type will be the same as the original one.

getCpu

public Long getCpu()

Get The number of CPU cores after the instance is upgraded. If this parameter is left empty, it will be subject to the `Memory` value.

Returns:

Cpu The number of CPU cores after the instance is upgraded. If this parameter is left empty, it will be subject to the `Memory` value.

setCpu

public void setCpu(Long Cpu)

Set The number of CPU cores after the instance is upgraded. If this parameter is left empty, it will be subject to the `Memory` value.

Parameters:

Cpu - The number of CPU cores after the instance is upgraded. If this parameter is left empty, it will be subject to the `Memory` value.

getFastUpgrade

public Long getFastUpgrade()

Get QuickChange options. Valid values: `0` (common upgrade), `1` (QuickChange), `2` (QuickChange first). After QuickChange is enabled, the required resources will be checked. QuickChange will be performed only when the required resources support the feature; otherwise, an error message will be returned.

Returns:

FastUpgrade QuickChange options. Valid values: `0` (common upgrade), `1` (QuickChange), `2` (QuickChange first). After QuickChange is enabled, the required resources will be checked. QuickChange will be performed only when the required resources support the feature; otherwise, an error message will be returned.

setFastUpgrade

public void setFastUpgrade(Long FastUpgrade)

Set QuickChange options. Valid values: `0` (common upgrade), `1` (QuickChange), `2` (QuickChange first). After QuickChange is enabled, the required resources will be checked. QuickChange will be performed only when the required resources support the feature; otherwise, an error message will be returned.

Parameters:

FastUpgrade - QuickChange options. Valid values: `0` (common upgrade), `1` (QuickChange), `2` (QuickChange first). After QuickChange is enabled, the required resources will be checked. QuickChange will be performed only when the required resources support the feature; otherwise, an error message will be returned.

getMaxDelayTime

public Long getMaxDelayTime()

Get Delay threshold. Value range: 1-10. Default value: `10`.

Returns:

MaxDelayTime Delay threshold. Value range: 1-10. Default value: `10`.

setMaxDelayTime

public void setMaxDelayTime(Long MaxDelayTime)

Set Delay threshold. Value range: 1-10. Default value: `10`.

Parameters:

MaxDelayTime - Delay threshold. Value range: 1-10. Default value: `10`.

getCrossCluster

public Long getCrossCluster()

Get Whether to migrate the source node across AZs. Valid values: `0` (no), `1`(yes). Default value: `0`. If it is `1`, you can modify the source node AZ.

Returns:

CrossCluster Whether to migrate the source node across AZs. Valid values: `0` (no), `1`(yes). Default value: `0`. If it is `1`, you can modify the source node AZ.

setCrossCluster

public void setCrossCluster(Long CrossCluster)

Set Whether to migrate the source node across AZs. Valid values: `0` (no), `1`(yes). Default value: `0`. If it is `1`, you can modify the source node AZ.

Parameters:

CrossCluster - Whether to migrate the source node across AZs. Valid values: `0` (no), `1`(yes). Default value: `0`. If it is `1`, you can modify the source node AZ.

getZoneId

public String getZoneId()

Get New AZ of the source node. This field is only valid when `CrossCluster` is `1`. Only migration across AZs in the same region is supported.

Returns:

ZoneId New AZ of the source node. This field is only valid when `CrossCluster` is `1`. Only migration across AZs in the same region is supported.

setZoneId

public void setZoneId(String ZoneId)

Set New AZ of the source node. This field is only valid when `CrossCluster` is `1`. Only migration across AZs in the same region is supported.

Parameters:

ZoneId - New AZ of the source node. This field is only valid when `CrossCluster` is `1`. Only migration across AZs in the same region is supported.

getRoTransType

public String getRoTransType()

Get Processing logic of the intra-AZ read-only instance for cross-cluster migration. Valid values: `together` (intra-AZ read-only instances will be migrated to the target AZ with the source instance by default.), `severally` (intra-AZ read-only instances will maintain the original deployment mode and will not be migrated to the target AZ.).

Returns:

RoTransType Processing logic of the intra-AZ read-only instance for cross-cluster migration. Valid values: `together` (intra-AZ read-only instances will be migrated to the target AZ with the source instance by default.), `severally` (intra-AZ read-only instances will maintain the original deployment mode and will not be migrated to the target AZ.).

setRoTransType

public void setRoTransType(String RoTransType)

Set Processing logic of the intra-AZ read-only instance for cross-cluster migration. Valid values: `together` (intra-AZ read-only instances will be migrated to the target AZ with the source instance by default.), `severally` (intra-AZ read-only instances will maintain the original deployment mode and will not be migrated to the target AZ.).

Parameters:

RoTransType - Processing logic of the intra-AZ read-only instance for cross-cluster migration. Valid values: `together` (intra-AZ read-only instances will be migrated to the target AZ with the source instance by default.), `severally` (intra-AZ read-only instances will maintain the original deployment mode and will not be migrated to the target AZ.).

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel