com.tencentcloudapi.sqlserver.v20180328.models

Class DescribeBackupsRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.sqlserver.v20180328.models.DescribeBackupsRequest

public class DescribeBackupsRequest
extends AbstractModel

Constructor Summary

Constructors

Constructor and Description
DescribeBackupsRequest()
DescribeBackupsRequest(DescribeBackupsRequest 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 Filter by backup file format.
Long	getBackupId() Get Filter by backup ID.
String	getBackupName() Get Filter by backup name.
Long	getBackupWay() Get Filter by backup mode.
String	getDatabaseName() Get Filter backups by the database name.
String	getEndTime() Get End time (yyyy-MM-dd HH:mm:ss)
Long	getGroup() Get Whether to group backup files by backup task.
String	getInstanceId() Get Instance ID in the format of mssql-njj2mtpl
Long	getLimit() Get Number of results per page.
Long	getOffset() Get Page number.
String	getStartTime() Get Start name (yyyy-MM-dd HH:mm:ss)
Long	getStrategy() Get Filter by backup policy.
Long	getType() Get Backup type.
void	setBackupFormat(String BackupFormat) Set Filter by backup file format.
void	setBackupId(Long BackupId) Set Filter by backup ID.
void	setBackupName(String BackupName) Set Filter by backup name.
void	setBackupWay(Long BackupWay) Set Filter by backup mode.
void	setDatabaseName(String DatabaseName) Set Filter backups by the database name.
void	setEndTime(String EndTime) Set End time (yyyy-MM-dd HH:mm:ss)
void	setGroup(Long Group) Set Whether to group backup files by backup task.
void	setInstanceId(String InstanceId) Set Instance ID in the format of mssql-njj2mtpl
void	setLimit(Long Limit) Set Number of results per page.
void	setOffset(Long Offset) Set Page number.
void	setStartTime(String StartTime) Set Start name (yyyy-MM-dd HH:mm:ss)
void	setStrategy(Long Strategy) Set Filter by backup policy.
void	setType(Long Type) Set Backup type.
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

DescribeBackupsRequest

public DescribeBackupsRequest()

DescribeBackupsRequest

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

getStartTime

public String getStartTime()

Get Start name (yyyy-MM-dd HH:mm:ss)

Returns:

StartTime Start name (yyyy-MM-dd HH:mm:ss)

setStartTime

public void setStartTime(String StartTime)

Set Start name (yyyy-MM-dd HH:mm:ss)

Parameters:

StartTime - Start name (yyyy-MM-dd HH:mm:ss)

getEndTime

public String getEndTime()

Get End time (yyyy-MM-dd HH:mm:ss)

Returns:

EndTime End time (yyyy-MM-dd HH:mm:ss)

setEndTime

public void setEndTime(String EndTime)

Set End time (yyyy-MM-dd HH:mm:ss)

Parameters:

EndTime - End time (yyyy-MM-dd HH:mm:ss)

getInstanceId

public String getInstanceId()

Get Instance ID in the format of mssql-njj2mtpl

Returns:

InstanceId Instance ID in the format of mssql-njj2mtpl

setInstanceId

public void setInstanceId(String InstanceId)

Set Instance ID in the format of mssql-njj2mtpl

Parameters:

InstanceId - Instance ID in the format of mssql-njj2mtpl

getLimit

public Long getLimit()

Get Number of results per page. Value range: 1-100. Default value: 20

Returns:

Limit Number of results per page. Value range: 1-100. Default value: 20

setLimit

public void setLimit(Long Limit)

Set Number of results per page. Value range: 1-100. Default value: 20

Parameters:

Limit - Number of results per page. Value range: 1-100. Default value: 20

getOffset

public Long getOffset()

Get Page number. Default value: 0

Returns:

Offset Page number. Default value: 0

setOffset

public void setOffset(Long Offset)

Set Page number. Default value: 0

Parameters:

Offset - Page number. Default value: 0

getBackupName

public String getBackupName()

Get Filter by backup name. If this parameter is left empty, backup name will not be used in filtering.

Returns:

BackupName Filter by backup name. If this parameter is left empty, backup name will not be used in filtering.

setBackupName

public void setBackupName(String BackupName)

Set Filter by backup name. If this parameter is left empty, backup name will not be used in filtering.

Parameters:

BackupName - Filter by backup name. If this parameter is left empty, backup name will not be used in filtering.

getStrategy

public Long getStrategy()

Get Filter by backup policy. Valid values: 0 (instance backup), 1 (multi-database backup). If this parameter is left empty, backup policy will not be used in filtering.

Returns:

Strategy Filter by backup policy. Valid values: 0 (instance backup), 1 (multi-database backup). If this parameter is left empty, backup policy will not be used in filtering.

setStrategy

public void setStrategy(Long Strategy)

Set Filter by backup policy. Valid values: 0 (instance backup), 1 (multi-database backup). If this parameter is left empty, backup policy will not be used in filtering.

Parameters:

Strategy - Filter by backup policy. Valid values: 0 (instance backup), 1 (multi-database backup). If this parameter is left empty, backup policy will not be used in filtering.

getBackupWay

public Long getBackupWay()

Get Filter by backup mode. Valid values: `0` (scheduled backup); `1` (manual backup); `2` (archive backup). Default value: `2`.

Returns:

BackupWay Filter by backup mode. Valid values: `0` (scheduled backup); `1` (manual backup); `2` (archive backup). Default value: `2`.

setBackupWay

public void setBackupWay(Long BackupWay)

Set Filter by backup mode. Valid values: `0` (scheduled backup); `1` (manual backup); `2` (archive backup). Default value: `2`.

Parameters:

BackupWay - Filter by backup mode. Valid values: `0` (scheduled backup); `1` (manual backup); `2` (archive backup). Default value: `2`.

getBackupId

public Long getBackupId()

Get Filter by backup ID. If this parameter is left empty, backup ID will not be used in filtering.

Returns:

BackupId Filter by backup ID. If this parameter is left empty, backup ID will not be used in filtering.

setBackupId

public void setBackupId(Long BackupId)

Set Filter by backup ID. If this parameter is left empty, backup ID will not be used in filtering.

Parameters:

BackupId - Filter by backup ID. If this parameter is left empty, backup ID will not be used in filtering.

getDatabaseName

public String getDatabaseName()

Get Filter backups by the database name. If the parameter is left empty, this filter criteria will not take effect.

Returns:

DatabaseName Filter backups by the database name. If the parameter is left empty, this filter criteria will not take effect.

setDatabaseName

public void setDatabaseName(String DatabaseName)

Set Filter backups by the database name. If the parameter is left empty, this filter criteria will not take effect.

Parameters:

DatabaseName - Filter backups by the database name. If the parameter is left empty, this filter criteria will not take effect.

getGroup

public Long getGroup()

Get Whether to group backup files by backup task. Valid value: `0` (no), `1` (yes). Default value: `0`. This parameter is valid only for unarchived backup files.

Returns:

Group Whether to group backup files by backup task. Valid value: `0` (no), `1` (yes). Default value: `0`. This parameter is valid only for unarchived backup files.

setGroup

public void setGroup(Long Group)

Set Whether to group backup files by backup task. Valid value: `0` (no), `1` (yes). Default value: `0`. This parameter is valid only for unarchived backup files.

Parameters:

Group - Whether to group backup files by backup task. Valid value: `0` (no), `1` (yes). Default value: `0`. This parameter is valid only for unarchived backup files.

getType

public Long getType()

Get Backup type. Valid values: `1` (data backup), `2` (log backup). Default value: `1`.

Returns:

Type Backup type. Valid values: `1` (data backup), `2` (log backup). Default value: `1`.

setType

public void setType(Long Type)

Set Backup type. Valid values: `1` (data backup), `2` (log backup). Default value: `1`.

Parameters:

Type - Backup type. Valid values: `1` (data backup), `2` (log backup). Default value: `1`.

getBackupFormat

public String getBackupFormat()

Get Filter by backup file format. Valid values: `pkg` (archive file), `single` (Unarchived files).

Returns:

BackupFormat Filter by backup file format. Valid values: `pkg` (archive file), `single` (Unarchived files).

setBackupFormat

public void setBackupFormat(String BackupFormat)

Set Filter by backup file format. Valid values: `pkg` (archive file), `single` (Unarchived files).

Parameters:

BackupFormat - Filter by backup file format. Valid values: `pkg` (archive file), `single` (Unarchived files).

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel