com.tencentcloudapi.sqlserver.v20180328.models

Class Backup

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.sqlserver.v20180328.models.Backup

public class Backup
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
Backup()
Backup(Backup 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	getBackupFormat() Get Backup file format.
String	getBackupName() Get Backup task name (customizable)
Long	getBackupWay() Get Backup Mode.
CrossBackupAddr[]	getCrossBackupAddr() Get The download address of cross-region backup in target region
CrossRegionStatus[]	getCrossBackupStatus() Get The target region and status of cross-region backup
String[]	getDBs() Get List of databases for multi-database backup
String	getEndTime() Get Backup end time
String	getExternalAddr() Get Public network download address.
String	getFileName() Get File name.
String	getGroupId() Get Group ID of unarchived backup files, which can be used as a request parameter in the `DescribeBackupFiles` API to get details of unarchived backup files in the specified group.
Long	getId() Get Unique ID of a backup file, which is used by the `RestoreInstance` API.
String	getInternalAddr() Get Private network download address.
String	getRegion() Get The code of current region where the instance resides
Long	getSize() Get File size in KB.
String	getStartTime() Get Backup start time
Long	getStatus() Get Backup file status (0: creating, 1: succeeded, 2: failed)
Long	getStrategy() Get Backup policy (0: instance backup, 1: multi-database backup)
void	setBackupFormat(String BackupFormat) Set Backup file format.
void	setBackupName(String BackupName) Set Backup task name (customizable)
void	setBackupWay(Long BackupWay) Set Backup Mode.
void	setCrossBackupAddr(CrossBackupAddr[] CrossBackupAddr) Set The download address of cross-region backup in target region
void	setCrossBackupStatus(CrossRegionStatus[] CrossBackupStatus) Set The target region and status of cross-region backup
void	setDBs(String[] DBs) Set List of databases for multi-database backup
void	setEndTime(String EndTime) Set Backup end time
void	setExternalAddr(String ExternalAddr) Set Public network download address.
void	setFileName(String FileName) Set File name.
void	setGroupId(String GroupId) Set Group ID of unarchived backup files, which can be used as a request parameter in the `DescribeBackupFiles` API to get details of unarchived backup files in the specified group.
void	setId(Long Id) Set Unique ID of a backup file, which is used by the `RestoreInstance` API.
void	setInternalAddr(String InternalAddr) Set Private network download address.
void	setRegion(String Region) Set The code of current region where the instance resides
void	setSize(Long Size) Set File size in KB.
void	setStartTime(String StartTime) Set Backup start time
void	setStatus(Long Status) Set Backup file status (0: creating, 1: succeeded, 2: failed)
void	setStrategy(Long Strategy) Set Backup policy (0: instance backup, 1: multi-database backup)
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

Backup

public Backup()

Backup

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

getFileName

public String getFileName()

Get File name. The name of an unarchived backup file is returned by the `DescribeBackupFiles` API instead of this parameter.

Returns:

FileName File name. The name of an unarchived backup file is returned by the `DescribeBackupFiles` API instead of this parameter.

setFileName

public void setFileName(String FileName)

Set File name. The name of an unarchived backup file is returned by the `DescribeBackupFiles` API instead of this parameter.

Parameters:

FileName - File name. The name of an unarchived backup file is returned by the `DescribeBackupFiles` API instead of this parameter.

getSize

public Long getSize()

Get File size in KB. The size of an unarchived backup file is returned by the `DescribeBackupFiles` API instead of this parameter.

Returns:

Size File size in KB. The size of an unarchived backup file is returned by the `DescribeBackupFiles` API instead of this parameter.

setSize

public void setSize(Long Size)

Set File size in KB. The size of an unarchived backup file is returned by the `DescribeBackupFiles` API instead of this parameter.

Parameters:

Size - File size in KB. The size of an unarchived backup file is returned by the `DescribeBackupFiles` API instead of this parameter.

getStartTime

public String getStartTime()

Get Backup start time

Returns:

StartTime Backup start time

setStartTime

public void setStartTime(String StartTime)

Set Backup start time

Parameters:

StartTime - Backup start time

getEndTime

public String getEndTime()

Get Backup end time

Returns:

EndTime Backup end time

setEndTime

public void setEndTime(String EndTime)

Set Backup end time

Parameters:

EndTime - Backup end time

getInternalAddr

public String getInternalAddr()

Get Private network download address. The download address of an unarchived backup file is returned by the `DescribeBackupFiles` API instead of this parameter.

Returns:

InternalAddr Private network download address. The download address of an unarchived backup file is returned by the `DescribeBackupFiles` API instead of this parameter.

setInternalAddr

public void setInternalAddr(String InternalAddr)

Set Private network download address. The download address of an unarchived backup file is returned by the `DescribeBackupFiles` API instead of this parameter.

Parameters:

InternalAddr - Private network download address. The download address of an unarchived backup file is returned by the `DescribeBackupFiles` API instead of this parameter.

getExternalAddr

public String getExternalAddr()

Get Public network download address. The download address of an unarchived backup file is returned by the `DescribeBackupFiles` API instead of this parameter.

Returns:

ExternalAddr Public network download address. The download address of an unarchived backup file is returned by the `DescribeBackupFiles` API instead of this parameter.

setExternalAddr

public void setExternalAddr(String ExternalAddr)

Set Public network download address. The download address of an unarchived backup file is returned by the `DescribeBackupFiles` API instead of this parameter.

Parameters:

ExternalAddr - Public network download address. The download address of an unarchived backup file is returned by the `DescribeBackupFiles` API instead of this parameter.

getId

public Long getId()

Get Unique ID of a backup file, which is used by the `RestoreInstance` API. The unique ID of an unarchived backup file is returned by the `DescribeBackupFiles` API instead of this parameter.

Returns:

Id Unique ID of a backup file, which is used by the `RestoreInstance` API. The unique ID of an unarchived backup file is returned by the `DescribeBackupFiles` API instead of this parameter.

setId

public void setId(Long Id)

Set Unique ID of a backup file, which is used by the `RestoreInstance` API. The unique ID of an unarchived backup file is returned by the `DescribeBackupFiles` API instead of this parameter.

Parameters:

Id - Unique ID of a backup file, which is used by the `RestoreInstance` API. The unique ID of an unarchived backup file is returned by the `DescribeBackupFiles` API instead of this parameter.

getStatus

public Long getStatus()

Get Backup file status (0: creating, 1: succeeded, 2: failed)

Returns:

Status Backup file status (0: creating, 1: succeeded, 2: failed)

setStatus

public void setStatus(Long Status)

Set Backup file status (0: creating, 1: succeeded, 2: failed)

Parameters:

Status - Backup file status (0: creating, 1: succeeded, 2: failed)

getDBs

public String[] getDBs()

Get List of databases for multi-database backup

Returns:

DBs List of databases for multi-database backup

setDBs

public void setDBs(String[] DBs)

Set List of databases for multi-database backup

Parameters:

DBs - List of databases for multi-database backup

getStrategy

public Long getStrategy()

Get Backup policy (0: instance backup, 1: multi-database backup)

Returns:

Strategy Backup policy (0: instance backup, 1: multi-database backup)

setStrategy

public void setStrategy(Long Strategy)

Set Backup policy (0: instance backup, 1: multi-database backup)

Parameters:

Strategy - Backup policy (0: instance backup, 1: multi-database backup)

getBackupWay

public Long getBackupWay()

Get Backup Mode. Valid values: `0` (scheduled backup); `1` (manual backup); `2` (archive backup).

Returns:

BackupWay Backup Mode. Valid values: `0` (scheduled backup); `1` (manual backup); `2` (archive backup).

setBackupWay

public void setBackupWay(Long BackupWay)

Set Backup Mode. Valid values: `0` (scheduled backup); `1` (manual backup); `2` (archive backup).

Parameters:

BackupWay - Backup Mode. Valid values: `0` (scheduled backup); `1` (manual backup); `2` (archive backup).

getBackupName

public String getBackupName()

Get Backup task name (customizable)

Returns:

BackupName Backup task name (customizable)

setBackupName

public void setBackupName(String BackupName)

Set Backup task name (customizable)

Parameters:

BackupName - Backup task name (customizable)

getGroupId

public String getGroupId()

Get Group ID of unarchived backup files, which can be used as a request parameter in the `DescribeBackupFiles` API to get details of unarchived backup files in the specified group. This parameter is invalid for archived backup files.

Returns:

GroupId Group ID of unarchived backup files, which can be used as a request parameter in the `DescribeBackupFiles` API to get details of unarchived backup files in the specified group. This parameter is invalid for archived backup files.

setGroupId

public void setGroupId(String GroupId)

Set Group ID of unarchived backup files, which can be used as a request parameter in the `DescribeBackupFiles` API to get details of unarchived backup files in the specified group. This parameter is invalid for archived backup files.

Parameters:

GroupId - Group ID of unarchived backup files, which can be used as a request parameter in the `DescribeBackupFiles` API to get details of unarchived backup files in the specified group. This parameter is invalid for archived backup files.

getBackupFormat

public String getBackupFormat()

Get Backup file format. Valid values:`pkg` (archive file), `single` (unarchived files).

Returns:

BackupFormat Backup file format. Valid values:`pkg` (archive file), `single` (unarchived files).

setBackupFormat

public void setBackupFormat(String BackupFormat)

Set Backup file format. Valid values:`pkg` (archive file), `single` (unarchived files).

Parameters:

BackupFormat - Backup file format. Valid values:`pkg` (archive file), `single` (unarchived files).

getRegion

public String getRegion()

Get The code of current region where the instance resides

Returns:

Region The code of current region where the instance resides

setRegion

public void setRegion(String Region)

Set The code of current region where the instance resides

Parameters:

Region - The code of current region where the instance resides

getCrossBackupAddr

public CrossBackupAddr[] getCrossBackupAddr()

Get The download address of cross-region backup in target region

Returns:

CrossBackupAddr The download address of cross-region backup in target region

setCrossBackupAddr

public void setCrossBackupAddr(CrossBackupAddr[] CrossBackupAddr)

Set The download address of cross-region backup in target region

Parameters:

CrossBackupAddr - The download address of cross-region backup in target region

getCrossBackupStatus

public CrossRegionStatus[] getCrossBackupStatus()

Get The target region and status of cross-region backup

Returns:

CrossBackupStatus The target region and status of cross-region backup

setCrossBackupStatus

public void setCrossBackupStatus(CrossRegionStatus[] CrossBackupStatus)

Set The target region and status of cross-region backup

Parameters:

CrossBackupStatus - The target region and status of cross-region backup

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel