com.tencentcloudapi.cdb.v20170320.models

Class ModifyBackupConfigRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.cdb.v20170320.models.ModifyBackupConfigRequest

public class ModifyBackupConfigRequest
extends AbstractModel

Constructor Summary

Constructors

Constructor and Description
ModifyBackupConfigRequest()
ModifyBackupConfigRequest(ModifyBackupConfigRequest 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	getBackupMethod() Get Automatic backup mode.
Long	getBackupPeriodSaveCount() Get Number of archive backups.
Long	getBackupPeriodSaveDays() Get Maximum days of archive backup retention.
String	getBackupPeriodSaveInterval() Get Archive backup retention period.
CommonTimeWindow	getBackupTimeWindow() Get Backup time window; for example, to set up backup between 10:00 and 14:00 on every Tuesday and Sunday, you should set this parameter as follows: {"Monday": "", "Tuesday": "10:00-14:00", "Wednesday": "", "Thursday": "", "Friday": "", "Saturday": "", "Sunday": "10:00-14:00"} (Note: You can set up backup on different days, but the backup time windows need to be the same.
Long	getBinlogExpireDays() Get Binlog retention period in days.
String	getEnableBackupPeriodLongTermSave() Get Switch for long-term backup retention (This field can be ignored, for its feature hasn’t been launched).
String	getEnableBackupPeriodSave() Get Switch for periodic archive.
Long	getExpireDays() Get Backup file retention period in days.
String	getInstanceId() Get Instance ID in the format of cdb-c1nl9rpv.
String	getStartBackupPeriodSaveDate() Get The start time in the format of yyyy-mm-dd HH:MM:SS, which is used to enable archive backup retention policy.
String	getStartTime() Get (This parameter will be disused.
void	setBackupMethod(String BackupMethod) Set Automatic backup mode.
void	setBackupPeriodSaveCount(Long BackupPeriodSaveCount) Set Number of archive backups.
void	setBackupPeriodSaveDays(Long BackupPeriodSaveDays) Set Maximum days of archive backup retention.
void	setBackupPeriodSaveInterval(String BackupPeriodSaveInterval) Set Archive backup retention period.
void	setBackupTimeWindow(CommonTimeWindow BackupTimeWindow) Set Backup time window; for example, to set up backup between 10:00 and 14:00 on every Tuesday and Sunday, you should set this parameter as follows: {"Monday": "", "Tuesday": "10:00-14:00", "Wednesday": "", "Thursday": "", "Friday": "", "Saturday": "", "Sunday": "10:00-14:00"} (Note: You can set up backup on different days, but the backup time windows need to be the same.
void	setBinlogExpireDays(Long BinlogExpireDays) Set Binlog retention period in days.
void	setEnableBackupPeriodLongTermSave(String EnableBackupPeriodLongTermSave) Set Switch for long-term backup retention (This field can be ignored, for its feature hasn’t been launched).
void	setEnableBackupPeriodSave(String EnableBackupPeriodSave) Set Switch for periodic archive.
void	setExpireDays(Long ExpireDays) Set Backup file retention period in days.
void	setInstanceId(String InstanceId) Set Instance ID in the format of cdb-c1nl9rpv.
void	setStartBackupPeriodSaveDate(String StartBackupPeriodSaveDate) Set The start time in the format of yyyy-mm-dd HH:MM:SS, which is used to enable archive backup retention policy.
void	setStartTime(String StartTime) Set (This parameter will be disused.
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

ModifyBackupConfigRequest

public ModifyBackupConfigRequest()

ModifyBackupConfigRequest

public ModifyBackupConfigRequest(ModifyBackupConfigRequest 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. It is the same as the instance ID displayed on the TencentDB Console page.

Returns:

InstanceId Instance ID in the format of cdb-c1nl9rpv. It is the same as the instance ID displayed on the TencentDB Console page.

setInstanceId

public void setInstanceId(String InstanceId)

Set Instance ID in the format of cdb-c1nl9rpv. It is the same as the instance ID displayed on the TencentDB Console page.

Parameters:

InstanceId - Instance ID in the format of cdb-c1nl9rpv. It is the same as the instance ID displayed on the TencentDB Console page.

getExpireDays

public Long getExpireDays()

Get Backup file retention period in days. Value range: 7-1830.

Returns:

ExpireDays Backup file retention period in days. Value range: 7-1830.

setExpireDays

public void setExpireDays(Long ExpireDays)

Set Backup file retention period in days. Value range: 7-1830.

Parameters:

ExpireDays - Backup file retention period in days. Value range: 7-1830.

getStartTime

public String getStartTime()

Get (This parameter will be disused. The `BackupTimeWindow` parameter is recommended.) Backup time range in the format of 02:00-06:00, with the start time and end time on the hour. Valid values: 00:00-12:00, 02:00-06:00, 06:00-10:00, 10:00-14:00, 14:00-18:00, 18:00-22:00, 22:00-02:00.

Returns:

StartTime (This parameter will be disused. The `BackupTimeWindow` parameter is recommended.) Backup time range in the format of 02:00-06:00, with the start time and end time on the hour. Valid values: 00:00-12:00, 02:00-06:00, 06:00-10:00, 10:00-14:00, 14:00-18:00, 18:00-22:00, 22:00-02:00.

setStartTime

public void setStartTime(String StartTime)

Set (This parameter will be disused. The `BackupTimeWindow` parameter is recommended.) Backup time range in the format of 02:00-06:00, with the start time and end time on the hour. Valid values: 00:00-12:00, 02:00-06:00, 06:00-10:00, 10:00-14:00, 14:00-18:00, 18:00-22:00, 22:00-02:00.

Parameters:

StartTime - (This parameter will be disused. The `BackupTimeWindow` parameter is recommended.) Backup time range in the format of 02:00-06:00, with the start time and end time on the hour. Valid values: 00:00-12:00, 02:00-06:00, 06:00-10:00, 10:00-14:00, 14:00-18:00, 18:00-22:00, 22:00-02:00.

getBackupMethod

public String getBackupMethod()

Get Automatic backup mode. Only `physical` (physical cold backup) is supported

Returns:

BackupMethod Automatic backup mode. Only `physical` (physical cold backup) is supported

setBackupMethod

public void setBackupMethod(String BackupMethod)

Set Automatic backup mode. Only `physical` (physical cold backup) is supported

Parameters:

BackupMethod - Automatic backup mode. Only `physical` (physical cold backup) is supported

getBinlogExpireDays

public Long getBinlogExpireDays()

Get Binlog retention period in days. Value range: 7-1830. It can’t be greater than the retention period of backup files.

Returns:

BinlogExpireDays Binlog retention period in days. Value range: 7-1830. It can’t be greater than the retention period of backup files.

setBinlogExpireDays

public void setBinlogExpireDays(Long BinlogExpireDays)

Set Binlog retention period in days. Value range: 7-1830. It can’t be greater than the retention period of backup files.

Parameters:

BinlogExpireDays - Binlog retention period in days. Value range: 7-1830. It can’t be greater than the retention period of backup files.

getBackupTimeWindow

public CommonTimeWindow getBackupTimeWindow()

Get Backup time window; for example, to set up backup between 10:00 and 14:00 on every Tuesday and Sunday, you should set this parameter as follows: {"Monday": "", "Tuesday": "10:00-14:00", "Wednesday": "", "Thursday": "", "Friday": "", "Saturday": "", "Sunday": "10:00-14:00"} (Note: You can set up backup on different days, but the backup time windows need to be the same. If this field is set, the `StartTime` field will be ignored)

Returns:

BackupTimeWindow Backup time window; for example, to set up backup between 10:00 and 14:00 on every Tuesday and Sunday, you should set this parameter as follows: {"Monday": "", "Tuesday": "10:00-14:00", "Wednesday": "", "Thursday": "", "Friday": "", "Saturday": "", "Sunday": "10:00-14:00"} (Note: You can set up backup on different days, but the backup time windows need to be the same. If this field is set, the `StartTime` field will be ignored)

setBackupTimeWindow

public void setBackupTimeWindow(CommonTimeWindow BackupTimeWindow)

Set Backup time window; for example, to set up backup between 10:00 and 14:00 on every Tuesday and Sunday, you should set this parameter as follows: {"Monday": "", "Tuesday": "10:00-14:00", "Wednesday": "", "Thursday": "", "Friday": "", "Saturday": "", "Sunday": "10:00-14:00"} (Note: You can set up backup on different days, but the backup time windows need to be the same. If this field is set, the `StartTime` field will be ignored)

Parameters:

BackupTimeWindow - Backup time window; for example, to set up backup between 10:00 and 14:00 on every Tuesday and Sunday, you should set this parameter as follows: {"Monday": "", "Tuesday": "10:00-14:00", "Wednesday": "", "Thursday": "", "Friday": "", "Saturday": "", "Sunday": "10:00-14:00"} (Note: You can set up backup on different days, but the backup time windows need to be the same. If this field is set, the `StartTime` field will be ignored)

getEnableBackupPeriodSave

public String getEnableBackupPeriodSave()

Get Switch for periodic archive. Valid values: `off` (disable), `on` (enable). Default value:`off`. When you enable the periodic archive policy for the first time, you need to enter the `BackupPeriodSaveDays`, `BackupPeriodSaveInterval`, `BackupPeriodSaveCount`, and `StartBackupPeriodSaveDate` parameters; otherwise, the policy will not take effect.

Returns:

EnableBackupPeriodSave Switch for periodic archive. Valid values: `off` (disable), `on` (enable). Default value:`off`. When you enable the periodic archive policy for the first time, you need to enter the `BackupPeriodSaveDays`, `BackupPeriodSaveInterval`, `BackupPeriodSaveCount`, and `StartBackupPeriodSaveDate` parameters; otherwise, the policy will not take effect.

setEnableBackupPeriodSave

public void setEnableBackupPeriodSave(String EnableBackupPeriodSave)

Set Switch for periodic archive. Valid values: `off` (disable), `on` (enable). Default value:`off`. When you enable the periodic archive policy for the first time, you need to enter the `BackupPeriodSaveDays`, `BackupPeriodSaveInterval`, `BackupPeriodSaveCount`, and `StartBackupPeriodSaveDate` parameters; otherwise, the policy will not take effect.

Parameters:

EnableBackupPeriodSave - Switch for periodic archive. Valid values: `off` (disable), `on` (enable). Default value:`off`. When you enable the periodic archive policy for the first time, you need to enter the `BackupPeriodSaveDays`, `BackupPeriodSaveInterval`, `BackupPeriodSaveCount`, and `StartBackupPeriodSaveDate` parameters; otherwise, the policy will not take effect.

getEnableBackupPeriodLongTermSave

public String getEnableBackupPeriodLongTermSave()

Get Switch for long-term backup retention (This field can be ignored, for its feature hasn’t been launched). Valid values: `off` (disable), `on` (enable). Default value: `off`. Once enabled, the parameters (BackupPeriodSaveDays, BackupPeriodSaveInterval, and BackupPeriodSaveCount) will be invalid.

Returns:

EnableBackupPeriodLongTermSave Switch for long-term backup retention (This field can be ignored, for its feature hasn’t been launched). Valid values: `off` (disable), `on` (enable). Default value: `off`. Once enabled, the parameters (BackupPeriodSaveDays, BackupPeriodSaveInterval, and BackupPeriodSaveCount) will be invalid.

setEnableBackupPeriodLongTermSave

public void setEnableBackupPeriodLongTermSave(String EnableBackupPeriodLongTermSave)

Set Switch for long-term backup retention (This field can be ignored, for its feature hasn’t been launched). Valid values: `off` (disable), `on` (enable). Default value: `off`. Once enabled, the parameters (BackupPeriodSaveDays, BackupPeriodSaveInterval, and BackupPeriodSaveCount) will be invalid.

Parameters:

EnableBackupPeriodLongTermSave - Switch for long-term backup retention (This field can be ignored, for its feature hasn’t been launched). Valid values: `off` (disable), `on` (enable). Default value: `off`. Once enabled, the parameters (BackupPeriodSaveDays, BackupPeriodSaveInterval, and BackupPeriodSaveCount) will be invalid.

getBackupPeriodSaveDays

public Long getBackupPeriodSaveDays()

Get Maximum days of archive backup retention. Valid range: 90-3650. Default value: 1080.

Returns:

BackupPeriodSaveDays Maximum days of archive backup retention. Valid range: 90-3650. Default value: 1080.

setBackupPeriodSaveDays

public void setBackupPeriodSaveDays(Long BackupPeriodSaveDays)

Set Maximum days of archive backup retention. Valid range: 90-3650. Default value: 1080.

Parameters:

BackupPeriodSaveDays - Maximum days of archive backup retention. Valid range: 90-3650. Default value: 1080.

getBackupPeriodSaveInterval

public String getBackupPeriodSaveInterval()

Get Archive backup retention period. Valid values: `weekly` (a week), `monthly` (a month), `quarterly` (a quarter), `yearly` (a year). Default value: `monthly`.

Returns:

BackupPeriodSaveInterval Archive backup retention period. Valid values: `weekly` (a week), `monthly` (a month), `quarterly` (a quarter), `yearly` (a year). Default value: `monthly`.

setBackupPeriodSaveInterval

public void setBackupPeriodSaveInterval(String BackupPeriodSaveInterval)

Set Archive backup retention period. Valid values: `weekly` (a week), `monthly` (a month), `quarterly` (a quarter), `yearly` (a year). Default value: `monthly`.

Parameters:

BackupPeriodSaveInterval - Archive backup retention period. Valid values: `weekly` (a week), `monthly` (a month), `quarterly` (a quarter), `yearly` (a year). Default value: `monthly`.

getBackupPeriodSaveCount

public Long getBackupPeriodSaveCount()

Get Number of archive backups. Minimum value: `1`, Maximum value: Number of non-archive backups in archive backup retention period. Default value: `1`.

Returns:

BackupPeriodSaveCount Number of archive backups. Minimum value: `1`, Maximum value: Number of non-archive backups in archive backup retention period. Default value: `1`.

setBackupPeriodSaveCount

public void setBackupPeriodSaveCount(Long BackupPeriodSaveCount)

Set Number of archive backups. Minimum value: `1`, Maximum value: Number of non-archive backups in archive backup retention period. Default value: `1`.

Parameters:

BackupPeriodSaveCount - Number of archive backups. Minimum value: `1`, Maximum value: Number of non-archive backups in archive backup retention period. Default value: `1`.

getStartBackupPeriodSaveDate

public String getStartBackupPeriodSaveDate()

Get The start time in the format of yyyy-mm-dd HH:MM:SS, which is used to enable archive backup retention policy.

Returns:

StartBackupPeriodSaveDate The start time in the format of yyyy-mm-dd HH:MM:SS, which is used to enable archive backup retention policy.

setStartBackupPeriodSaveDate

public void setStartBackupPeriodSaveDate(String StartBackupPeriodSaveDate)

Set The start time in the format of yyyy-mm-dd HH:MM:SS, which is used to enable archive backup retention policy.

Parameters:

StartBackupPeriodSaveDate - The start time in the format of yyyy-mm-dd HH:MM:SS, which is used to enable archive backup retention policy.

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel