com.tencentcloudapi.mongodb.v20190725.models

Class DescribeBackupDownloadTaskRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.mongodb.v20190725.models.DescribeBackupDownloadTaskRequest

public class DescribeBackupDownloadTaskRequest
extends AbstractModel

Constructor Summary

Constructors

Constructor and Description
DescribeBackupDownloadTaskRequest()
DescribeBackupDownloadTaskRequest(DescribeBackupDownloadTaskRequest 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	getBackupName() Get The name of a backup file with download tasks to be queried
String	getEndTime() Get The end time of the query period.
String	getInstanceId() Get Instance ID in the format of "cmgo-p8vnipr5", which is the same as the instance ID displayed in the TencentDB console
Long	getLimit() Get The maximum number of results returned per page.
Long	getOffset() Get Offset for pagination.
String	getOrderBy() Get The field used to sort the results.
String	getOrderByType() Get Sort order.
String	getStartTime() Get The start time of the query period.
Long[]	getStatus() Get The status of the tasks to be queried.
void	setBackupName(String BackupName) Set The name of a backup file with download tasks to be queried
void	setEndTime(String EndTime) Set The end time of the query period.
void	setInstanceId(String InstanceId) Set Instance ID in the format of "cmgo-p8vnipr5", which is the same as the instance ID displayed in the TencentDB console
void	setLimit(Long Limit) Set The maximum number of results returned per page.
void	setOffset(Long Offset) Set Offset for pagination.
void	setOrderBy(String OrderBy) Set The field used to sort the results.
void	setOrderByType(String OrderByType) Set Sort order.
void	setStartTime(String StartTime) Set The start time of the query period.
void	setStatus(Long[] Status) Set The status of the tasks to be queried.
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

DescribeBackupDownloadTaskRequest

public DescribeBackupDownloadTaskRequest()

DescribeBackupDownloadTaskRequest

public DescribeBackupDownloadTaskRequest(DescribeBackupDownloadTaskRequest 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 "cmgo-p8vnipr5", which is the same as the instance ID displayed in the TencentDB console

Returns:

InstanceId Instance ID in the format of "cmgo-p8vnipr5", which is the same as the instance ID displayed in the TencentDB console

setInstanceId

public void setInstanceId(String InstanceId)

Set Instance ID in the format of "cmgo-p8vnipr5", which is the same as the instance ID displayed in the TencentDB console

Parameters:

InstanceId - Instance ID in the format of "cmgo-p8vnipr5", which is the same as the instance ID displayed in the TencentDB console

getBackupName

public String getBackupName()

Get The name of a backup file with download tasks to be queried

Returns:

BackupName The name of a backup file with download tasks to be queried

setBackupName

public void setBackupName(String BackupName)

Set The name of a backup file with download tasks to be queried

Parameters:

BackupName - The name of a backup file with download tasks to be queried

getStartTime

public String getStartTime()

Get The start time of the query period. Tasks whose start time and end time fall within the query period will be queried. If it is left empty, the start time can be any time earlier than the end time.

Returns:

StartTime The start time of the query period. Tasks whose start time and end time fall within the query period will be queried. If it is left empty, the start time can be any time earlier than the end time.

setStartTime

public void setStartTime(String StartTime)

Set The start time of the query period. Tasks whose start time and end time fall within the query period will be queried. If it is left empty, the start time can be any time earlier than the end time.

Parameters:

StartTime - The start time of the query period. Tasks whose start time and end time fall within the query period will be queried. If it is left empty, the start time can be any time earlier than the end time.

getEndTime

public String getEndTime()

Get The end time of the query period. Tasks will be queried if their start and end times fall within the query period. If it is left empty, the end time can be any time later than the start time.

Returns:

EndTime The end time of the query period. Tasks will be queried if their start and end times fall within the query period. If it is left empty, the end time can be any time later than the start time.

setEndTime

public void setEndTime(String EndTime)

Set The end time of the query period. Tasks will be queried if their start and end times fall within the query period. If it is left empty, the end time can be any time later than the start time.

Parameters:

EndTime - The end time of the query period. Tasks will be queried if their start and end times fall within the query period. If it is left empty, the end time can be any time later than the start time.

getLimit

public Long getLimit()

Get The maximum number of results returned per page. Value range: 1-100. Default value: `20`.

Returns:

Limit The maximum number of results returned per page. Value range: 1-100. Default value: `20`.

setLimit

public void setLimit(Long Limit)

Set The maximum number of results returned per page. Value range: 1-100. Default value: `20`.

Parameters:

Limit - The maximum number of results returned per page. Value range: 1-100. Default value: `20`.

getOffset

public Long getOffset()

Get Offset for pagination. Default value: `0`.

Returns:

Offset Offset for pagination. Default value: `0`.

setOffset

public void setOffset(Long Offset)

Set Offset for pagination. Default value: `0`.

Parameters:

Offset - Offset for pagination. Default value: `0`.

getOrderBy

public String getOrderBy()

Get The field used to sort the results. Valid values: `createTime` (default), `finishTime`.

Returns:

OrderBy The field used to sort the results. Valid values: `createTime` (default), `finishTime`.

setOrderBy

public void setOrderBy(String OrderBy)

Set The field used to sort the results. Valid values: `createTime` (default), `finishTime`.

Parameters:

OrderBy - The field used to sort the results. Valid values: `createTime` (default), `finishTime`.

getOrderByType

public String getOrderByType()

Get Sort order. Valid values: `asc`, `desc` (default).

Returns:

OrderByType Sort order. Valid values: `asc`, `desc` (default).

setOrderByType

public void setOrderByType(String OrderByType)

Set Sort order. Valid values: `asc`, `desc` (default).

Parameters:

OrderByType - Sort order. Valid values: `asc`, `desc` (default).

getStatus

public Long[] getStatus()

Get The status of the tasks to be queried. Valid values: `0` (waiting for execution), `1` (downloading), `2` (downloaded), `3` (download failed), `4` (waiting for retry). If it is left empty, tasks in any status will be returned.

Returns:

Status The status of the tasks to be queried. Valid values: `0` (waiting for execution), `1` (downloading), `2` (downloaded), `3` (download failed), `4` (waiting for retry). If it is left empty, tasks in any status will be returned.

setStatus

public void setStatus(Long[] Status)

Set The status of the tasks to be queried. Valid values: `0` (waiting for execution), `1` (downloading), `2` (downloaded), `3` (download failed), `4` (waiting for retry). If it is left empty, tasks in any status will be returned.

Parameters:

Status - The status of the tasks to be queried. Valid values: `0` (waiting for execution), `1` (downloading), `2` (downloaded), `3` (download failed), `4` (waiting for retry). If it is left empty, tasks in any status will be returned.

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel