com.tencentcloudapi.postgres.v20170312.models

Class UpgradeDBInstanceMajorVersionRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.postgres.v20170312.models.UpgradeDBInstanceMajorVersionRequest

public class UpgradeDBInstanceMajorVersionRequest
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
UpgradeDBInstanceMajorVersionRequest()
UpgradeDBInstanceMajorVersionRequest(UpgradeDBInstanceMajorVersionRequest 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
Boolean	getBackupBeforeUpgrade() Get Pre-upgrade backup option: True means a full backup is required before upgrade, and False means a full backup is not required before upgrade.
String	getDBInstanceId() Get Instance ID.
Long	getExtensionUpgradeOption() Get Plugin upgrade option.
Long	getStatisticsRefreshOption() Get Statistics collection option, which is used to run ANALYZE on the primary instance to update system statistics after the upgrade.
String	getTargetDBKernelVersion() Get Target kernel version number, where upgradeable target kernel version numbers can be acquired through API DescribeDBVersions.
Boolean	getUpgradeCheck() Get Whether it is verification mode: if UpgradeCheck is True, it means only kernel version compatibility check will be conducted, without actual upgrade operations, and there will be no affect on the original instance.
String	getUpgradeTimeBegin() Get Upgrade window start time, and the time format is HH:MM:SS, for example: 01:00:00.
String	getUpgradeTimeEnd() Get Upgrade window end time, and the time format is HH:MM:SS, for example: 2:00:00 AM.
Long	getUpgradeTimeOption() Get Upgrade time option.
void	setBackupBeforeUpgrade(Boolean BackupBeforeUpgrade) Set Pre-upgrade backup option: True means a full backup is required before upgrade, and False means a full backup is not required before upgrade.
void	setDBInstanceId(String DBInstanceId) Set Instance ID.
void	setExtensionUpgradeOption(Long ExtensionUpgradeOption) Set Plugin upgrade option.
void	setStatisticsRefreshOption(Long StatisticsRefreshOption) Set Statistics collection option, which is used to run ANALYZE on the primary instance to update system statistics after the upgrade.
void	setTargetDBKernelVersion(String TargetDBKernelVersion) Set Target kernel version number, where upgradeable target kernel version numbers can be acquired through API DescribeDBVersions.
void	setUpgradeCheck(Boolean UpgradeCheck) Set Whether it is verification mode: if UpgradeCheck is True, it means only kernel version compatibility check will be conducted, without actual upgrade operations, and there will be no affect on the original instance.
void	setUpgradeTimeBegin(String UpgradeTimeBegin) Set Upgrade window start time, and the time format is HH:MM:SS, for example: 01:00:00.
void	setUpgradeTimeEnd(String UpgradeTimeEnd) Set Upgrade window end time, and the time format is HH:MM:SS, for example: 2:00:00 AM.
void	setUpgradeTimeOption(Long UpgradeTimeOption) Set Upgrade time option.
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

UpgradeDBInstanceMajorVersionRequest

public UpgradeDBInstanceMajorVersionRequest()

UpgradeDBInstanceMajorVersionRequest

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

getDBInstanceId

public String getDBInstanceId()

Get Instance ID.

Returns:

DBInstanceId Instance ID.

setDBInstanceId

public void setDBInstanceId(String DBInstanceId)

Set Instance ID.

Parameters:

DBInstanceId - Instance ID.

getTargetDBKernelVersion

public String getTargetDBKernelVersion()

Get Target kernel version number, where upgradeable target kernel version numbers can be acquired through API DescribeDBVersions.

Returns:

TargetDBKernelVersion Target kernel version number, where upgradeable target kernel version numbers can be acquired through API DescribeDBVersions.

setTargetDBKernelVersion

public void setTargetDBKernelVersion(String TargetDBKernelVersion)

Set Target kernel version number, where upgradeable target kernel version numbers can be acquired through API DescribeDBVersions.

Parameters:

TargetDBKernelVersion - Target kernel version number, where upgradeable target kernel version numbers can be acquired through API DescribeDBVersions.

getUpgradeCheck

public Boolean getUpgradeCheck()

Get Whether it is verification mode: if UpgradeCheck is True, it means only kernel version compatibility check will be conducted, without actual upgrade operations, and there will be no affect on the original instance. The check results can be viewed through the upgrade logs.

Returns:

UpgradeCheck Whether it is verification mode: if UpgradeCheck is True, it means only kernel version compatibility check will be conducted, without actual upgrade operations, and there will be no affect on the original instance. The check results can be viewed through the upgrade logs.

setUpgradeCheck

public void setUpgradeCheck(Boolean UpgradeCheck)

Set Whether it is verification mode: if UpgradeCheck is True, it means only kernel version compatibility check will be conducted, without actual upgrade operations, and there will be no affect on the original instance. The check results can be viewed through the upgrade logs.

Parameters:

UpgradeCheck - Whether it is verification mode: if UpgradeCheck is True, it means only kernel version compatibility check will be conducted, without actual upgrade operations, and there will be no affect on the original instance. The check results can be viewed through the upgrade logs.

getBackupBeforeUpgrade

public Boolean getBackupBeforeUpgrade()

Get Pre-upgrade backup option: True means a full backup is required before upgrade, and False means a full backup is not required before upgrade. If there is an existing backup set that can restore the instance to its pre-upgrade state, False can be selected; otherwise, True should be specified. This parameter is invalid when UpgradeCheck is True.

Returns:

BackupBeforeUpgrade Pre-upgrade backup option: True means a full backup is required before upgrade, and False means a full backup is not required before upgrade. If there is an existing backup set that can restore the instance to its pre-upgrade state, False can be selected; otherwise, True should be specified. This parameter is invalid when UpgradeCheck is True.

setBackupBeforeUpgrade

public void setBackupBeforeUpgrade(Boolean BackupBeforeUpgrade)

Set Pre-upgrade backup option: True means a full backup is required before upgrade, and False means a full backup is not required before upgrade. If there is an existing backup set that can restore the instance to its pre-upgrade state, False can be selected; otherwise, True should be specified. This parameter is invalid when UpgradeCheck is True.

Parameters:

BackupBeforeUpgrade - Pre-upgrade backup option: True means a full backup is required before upgrade, and False means a full backup is not required before upgrade. If there is an existing backup set that can restore the instance to its pre-upgrade state, False can be selected; otherwise, True should be specified. This parameter is invalid when UpgradeCheck is True.

getStatisticsRefreshOption

public Long getStatisticsRefreshOption()

Get Statistics collection option, which is used to run ANALYZE on the primary instance to update system statistics after the upgrade. Valid values include: 0: No statistics collection required; 1: Collect statistics before instance recovery write; 3: Collect statistics after instance recovery write. This parameter is invalid when UpgradeCheck is True.

Returns:

StatisticsRefreshOption Statistics collection option, which is used to run ANALYZE on the primary instance to update system statistics after the upgrade. Valid values include: 0: No statistics collection required; 1: Collect statistics before instance recovery write; 3: Collect statistics after instance recovery write. This parameter is invalid when UpgradeCheck is True.

setStatisticsRefreshOption

public void setStatisticsRefreshOption(Long StatisticsRefreshOption)

Set Statistics collection option, which is used to run ANALYZE on the primary instance to update system statistics after the upgrade. Valid values include: 0: No statistics collection required; 1: Collect statistics before instance recovery write; 3: Collect statistics after instance recovery write. This parameter is invalid when UpgradeCheck is True.

Parameters:

StatisticsRefreshOption - Statistics collection option, which is used to run ANALYZE on the primary instance to update system statistics after the upgrade. Valid values include: 0: No statistics collection required; 1: Collect statistics before instance recovery write; 3: Collect statistics after instance recovery write. This parameter is invalid when UpgradeCheck is True.

getExtensionUpgradeOption

public Long getExtensionUpgradeOption()

Get Plugin upgrade option. pg_upgrade does not upgrade any plugins, and "ALTER EXTENSION UPDATE" needs to be executed on the database where the plugins were created after the upgrade. When initiating a major version upgrade of an instance, you can specify whether the upgrade task automatically upgrades the plugin version before/after the instance recovery write. Valid values include: 0: No automatic plugin upgrade required; 1: Upgrade plugins before recovery write; 2: Upgrade plugins after recovery write. This parameter is invalid when UpgradeCheck is True.

Returns:

ExtensionUpgradeOption Plugin upgrade option. pg_upgrade does not upgrade any plugins, and "ALTER EXTENSION UPDATE" needs to be executed on the database where the plugins were created after the upgrade. When initiating a major version upgrade of an instance, you can specify whether the upgrade task automatically upgrades the plugin version before/after the instance recovery write. Valid values include: 0: No automatic plugin upgrade required; 1: Upgrade plugins before recovery write; 2: Upgrade plugins after recovery write. This parameter is invalid when UpgradeCheck is True.

setExtensionUpgradeOption

public void setExtensionUpgradeOption(Long ExtensionUpgradeOption)

Set Plugin upgrade option. pg_upgrade does not upgrade any plugins, and "ALTER EXTENSION UPDATE" needs to be executed on the database where the plugins were created after the upgrade. When initiating a major version upgrade of an instance, you can specify whether the upgrade task automatically upgrades the plugin version before/after the instance recovery write. Valid values include: 0: No automatic plugin upgrade required; 1: Upgrade plugins before recovery write; 2: Upgrade plugins after recovery write. This parameter is invalid when UpgradeCheck is True.

Parameters:

ExtensionUpgradeOption - Plugin upgrade option. pg_upgrade does not upgrade any plugins, and "ALTER EXTENSION UPDATE" needs to be executed on the database where the plugins were created after the upgrade. When initiating a major version upgrade of an instance, you can specify whether the upgrade task automatically upgrades the plugin version before/after the instance recovery write. Valid values include: 0: No automatic plugin upgrade required; 1: Upgrade plugins before recovery write; 2: Upgrade plugins after recovery write. This parameter is invalid when UpgradeCheck is True.

getUpgradeTimeOption

public Long getUpgradeTimeOption()

Get Upgrade time option. During the upgrade process, there will be a period when the instance is read-only, and there will be a second-level flash disconnection. When initiating an upgrade, you need to choose the time window for this impact. Valid values include: 0: Execute automatically, no specific time window required; 1: Specify the time window for this upgrade task, which is set via UpgradeTimeBegin and UpgradeTimeEnd parameters; 2: Execute during the instance operation and maintenance time window. This parameter is invalid when UpgradeCheck is True.

Returns:

UpgradeTimeOption Upgrade time option. During the upgrade process, there will be a period when the instance is read-only, and there will be a second-level flash disconnection. When initiating an upgrade, you need to choose the time window for this impact. Valid values include: 0: Execute automatically, no specific time window required; 1: Specify the time window for this upgrade task, which is set via UpgradeTimeBegin and UpgradeTimeEnd parameters; 2: Execute during the instance operation and maintenance time window. This parameter is invalid when UpgradeCheck is True.

setUpgradeTimeOption

public void setUpgradeTimeOption(Long UpgradeTimeOption)

Set Upgrade time option. During the upgrade process, there will be a period when the instance is read-only, and there will be a second-level flash disconnection. When initiating an upgrade, you need to choose the time window for this impact. Valid values include: 0: Execute automatically, no specific time window required; 1: Specify the time window for this upgrade task, which is set via UpgradeTimeBegin and UpgradeTimeEnd parameters; 2: Execute during the instance operation and maintenance time window. This parameter is invalid when UpgradeCheck is True.

Parameters:

UpgradeTimeOption - Upgrade time option. During the upgrade process, there will be a period when the instance is read-only, and there will be a second-level flash disconnection. When initiating an upgrade, you need to choose the time window for this impact. Valid values include: 0: Execute automatically, no specific time window required; 1: Specify the time window for this upgrade task, which is set via UpgradeTimeBegin and UpgradeTimeEnd parameters; 2: Execute during the instance operation and maintenance time window. This parameter is invalid when UpgradeCheck is True.

getUpgradeTimeBegin

public String getUpgradeTimeBegin()

Get Upgrade window start time, and the time format is HH:MM:SS, for example: 01:00:00. This parameter is valid when UpgradeTimeOption is set to `1`. This parameter is invalid when UpgradeCheck is True.

Returns:

UpgradeTimeBegin Upgrade window start time, and the time format is HH:MM:SS, for example: 01:00:00. This parameter is valid when UpgradeTimeOption is set to `1`. This parameter is invalid when UpgradeCheck is True.

setUpgradeTimeBegin

public void setUpgradeTimeBegin(String UpgradeTimeBegin)

Set Upgrade window start time, and the time format is HH:MM:SS, for example: 01:00:00. This parameter is valid when UpgradeTimeOption is set to `1`. This parameter is invalid when UpgradeCheck is True.

Parameters:

UpgradeTimeBegin - Upgrade window start time, and the time format is HH:MM:SS, for example: 01:00:00. This parameter is valid when UpgradeTimeOption is set to `1`. This parameter is invalid when UpgradeCheck is True.

getUpgradeTimeEnd

public String getUpgradeTimeEnd()

Get Upgrade window end time, and the time format is HH:MM:SS, for example: 2:00:00 AM. This parameter is valid when UpgradeTimeOption is set to `1`. This parameter is invalid when UpgradeCheck is True.

Returns:

UpgradeTimeEnd Upgrade window end time, and the time format is HH:MM:SS, for example: 2:00:00 AM. This parameter is valid when UpgradeTimeOption is set to `1`. This parameter is invalid when UpgradeCheck is True.

setUpgradeTimeEnd

public void setUpgradeTimeEnd(String UpgradeTimeEnd)

Set Upgrade window end time, and the time format is HH:MM:SS, for example: 2:00:00 AM. This parameter is valid when UpgradeTimeOption is set to `1`. This parameter is invalid when UpgradeCheck is True.

Parameters:

UpgradeTimeEnd - Upgrade window end time, and the time format is HH:MM:SS, for example: 2:00:00 AM. This parameter is valid when UpgradeTimeOption is set to `1`. This parameter is invalid when UpgradeCheck is True.

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel