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

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

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 Specifies the backup file name for filtering download tasks of the specified file.
String	getEndTime() Get Specifies the task within the query time range, and EndTime specifies the end time.
String	getInstanceId() Get Instance ID.
Long	getLimit() Get Number of entries returned for this query.
Long	getOffset() Get Specifies the number of pages returned for this query.
String	getOrderBy() Get Sorting field.
String	getOrderByType() Get Sorting method.
String	getStartTime() Get Specifies the task within the query time range, and StartTime specifies the start time.
Long[]	getStatus() Get Specifies the task status for filtering download tasks.
void	setBackupName(String BackupName) Set Specifies the backup file name for filtering download tasks of the specified file.
void	setEndTime(String EndTime) Set Specifies the task within the query time range, and EndTime specifies the end time.
void	setInstanceId(String InstanceId) Set Instance ID.
void	setLimit(Long Limit) Set Number of entries returned for this query.
void	setOffset(Long Offset) Set Specifies the number of pages returned for this query.
void	setOrderBy(String OrderBy) Set Sorting field.
void	setOrderByType(String OrderByType) Set Sorting method.
void	setStartTime(String StartTime) Set Specifies the task within the query time range, and StartTime specifies the start time.
void	setStatus(Long[] Status) Set Specifies the task status for filtering download tasks.
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, isStream, 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

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. Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/mongodb), and copy the instance ID from the instance list.

Returns:

InstanceId Instance ID. Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/mongodb), and copy the instance ID from the instance list.

setInstanceId

public void setInstanceId(String InstanceId)

Set Instance ID. Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/mongodb), and copy the instance ID from the instance list.

Parameters:

InstanceId - Instance ID. Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/mongodb), and copy the instance ID from the instance list.

getBackupName

public String getBackupName()

Get Specifies the backup file name for filtering download tasks of the specified file. The [DescribeDBBackups](https://www.tencentcloud.comom/document/product/240/38574?from_cn_redirect=1) API can be called to obtain the backup file name.

Returns:

BackupName Specifies the backup file name for filtering download tasks of the specified file. The [DescribeDBBackups](https://www.tencentcloud.comom/document/product/240/38574?from_cn_redirect=1) API can be called to obtain the backup file name.

setBackupName

public void setBackupName(String BackupName)

Set Specifies the backup file name for filtering download tasks of the specified file. The [DescribeDBBackups](https://www.tencentcloud.comom/document/product/240/38574?from_cn_redirect=1) API can be called to obtain the backup file name.

Parameters:

BackupName - Specifies the backup file name for filtering download tasks of the specified file. The [DescribeDBBackups](https://www.tencentcloud.comom/document/product/240/38574?from_cn_redirect=1) API can be called to obtain the backup file name.

getStartTime

public String getStartTime()

Get Specifies the task within the query time range, and StartTime specifies the start time. If not specified, there are no limitations on the start time by default.

Returns:

StartTime Specifies the task within the query time range, and StartTime specifies the start time. If not specified, there are no limitations on the start time by default.

setStartTime

public void setStartTime(String StartTime)

Set Specifies the task within the query time range, and StartTime specifies the start time. If not specified, there are no limitations on the start time by default.

Parameters:

StartTime - Specifies the task within the query time range, and StartTime specifies the start time. If not specified, there are no limitations on the start time by default.

getEndTime

public String getEndTime()

Get Specifies the task within the query time range, and EndTime specifies the end time. If not specified, there are no limitations on the end time by default.

Returns:

EndTime Specifies the task within the query time range, and EndTime specifies the end time. If not specified, there are no limitations on the end time by default.

setEndTime

public void setEndTime(String EndTime)

Set Specifies the task within the query time range, and EndTime specifies the end time. If not specified, there are no limitations on the end time by default.

Parameters:

EndTime - Specifies the task within the query time range, and EndTime specifies the end time. If not specified, there are no limitations on the end time by default.

getLimit

public Long getLimit()

Get Number of entries returned for this query. Value range: 1–100. The default value is 20.

Returns:

Limit Number of entries returned for this query. Value range: 1–100. The default value is 20.

setLimit

public void setLimit(Long Limit)

Set Number of entries returned for this query. Value range: 1–100. The default value is 20.

Parameters:

Limit - Number of entries returned for this query. Value range: 1–100. The default value is 20.

getOffset

public Long getOffset()

Get Specifies the number of pages returned for this query. The default value is 0.

Returns:

Offset Specifies the number of pages returned for this query. The default value is 0.

setOffset

public void setOffset(Long Offset)

Set Specifies the number of pages returned for this query. The default value is 0.

Parameters:

Offset - Specifies the number of pages returned for this query. The default value is 0.

getOrderBy

public String getOrderBy()

Get Sorting field. - createTime: sort by the creation time of the backup download task. The default value is createTime. - finishTime: sort by the completion time of the backup download task.

Returns:

OrderBy Sorting field. - createTime: sort by the creation time of the backup download task. The default value is createTime. - finishTime: sort by the completion time of the backup download task.

setOrderBy

public void setOrderBy(String OrderBy)

Set Sorting field. - createTime: sort by the creation time of the backup download task. The default value is createTime. - finishTime: sort by the completion time of the backup download task.

Parameters:

OrderBy - Sorting field. - createTime: sort by the creation time of the backup download task. The default value is createTime. - finishTime: sort by the completion time of the backup download task.

getOrderByType

public String getOrderByType()

Get Sorting method. - asc: ascending order. - desc: descending order. The default value is desc.

Returns:

OrderByType Sorting method. - asc: ascending order. - desc: descending order. The default value is desc.

setOrderByType

public void setOrderByType(String OrderByType)

Set Sorting method. - asc: ascending order. - desc: descending order. The default value is desc.

Parameters:

OrderByType - Sorting method. - asc: ascending order. - desc: descending order. The default value is desc.

getStatus

public Long[] getStatus()

Get Specifies the task status for filtering download tasks. If this parameter is not configured, tasks of all status types will be returned. - 0: wait for execution. - 1: downloading. - 2: download completed. - 3: download failed. - 4: wait for retry.

Returns:

Status Specifies the task status for filtering download tasks. If this parameter is not configured, tasks of all status types will be returned. - 0: wait for execution. - 1: downloading. - 2: download completed. - 3: download failed. - 4: wait for retry.

setStatus

public void setStatus(Long[] Status)

Set Specifies the task status for filtering download tasks. If this parameter is not configured, tasks of all status types will be returned. - 0: wait for execution. - 1: downloading. - 2: download completed. - 3: download failed. - 4: wait for retry.

Parameters:

Status - Specifies the task status for filtering download tasks. If this parameter is not configured, tasks of all status types will be returned. - 0: wait for execution. - 1: downloading. - 2: download completed. - 3: download failed. - 4: wait for retry.

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel

Parameters:

map - The map to populate with the model's parameters.

prefix - A string prefix for the keys.