DescribeBackupDownloadTaskRequest (tencentcloud-sdk-java 3.1.1347 API)

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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getBackupName()` Get 指定备份文件名，用于过滤指定文件的下载任务。请通过接口 [DescribeDBBackups](https://cloud.tencent.com/document/product/240/38574) 获取备份文件名。
`String`	`getEndTime()` Get 指定查询时间范围内的任务，EndTime 指定截止时间。若不指定截止时间，则默认不限制截止时间。
`String`	`getInstanceId()` Get 实例ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
`Long`	`getLimit()` Get 此次查询返回的条数，取值范围为1-100，默认为20。
`Long`	`getOffset()` Get 指定此次查询返回的页数，默认为0。
`String`	`getOrderBy()` Get 排序字段。 - createTime：按照备份下载任务的创建时间排序。默认为 createTime。 - finishTime：按照备份下载任务的完成时间排序。
`String`	`getOrderByType()` Get 排序方式。 - asc：升序排列。 - desc：降序排列。默认为 desc。
`String`	`getStartTime()` Get 指定查询时间范围内的任务，StartTime 指定开始时间。若不指定开始时间，则默认不限制开始时间。
`Long[]`	`getStatus()` Get 指定任务状态，用于过滤下载任务。若不配置该参数，则返回所有状态类型的任务。 - 0：等待执行。 - 1：正在下载。 - 2：下载完成。 - 3：下载失败。 - 4：等待重试。
`void`	`setBackupName(String BackupName)` Set 指定备份文件名，用于过滤指定文件的下载任务。请通过接口 [DescribeDBBackups](https://cloud.tencent.com/document/product/240/38574) 获取备份文件名。
`void`	`setEndTime(String EndTime)` Set 指定查询时间范围内的任务，EndTime 指定截止时间。若不指定截止时间，则默认不限制截止时间。
`void`	`setInstanceId(String InstanceId)` Set 实例ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
`void`	`setLimit(Long Limit)` Set 此次查询返回的条数，取值范围为1-100，默认为20。
`void`	`setOffset(Long Offset)` Set 指定此次查询返回的页数，默认为0。
`void`	`setOrderBy(String OrderBy)` Set 排序字段。 - createTime：按照备份下载任务的创建时间排序。默认为 createTime。 - finishTime：按照备份下载任务的完成时间排序。
`void`	`setOrderByType(String OrderByType)` Set 排序方式。 - asc：升序排列。 - desc：降序排列。默认为 desc。
`void`	`setStartTime(String StartTime)` Set 指定查询时间范围内的任务，StartTime 指定开始时间。若不指定开始时间，则默认不限制开始时间。
`void`	`setStatus(Long[] Status)` Set 指定任务状态，用于过滤下载任务。若不配置该参数，则返回所有状态类型的任务。 - 0：等待执行。 - 1：正在下载。 - 2：下载完成。 - 3：下载失败。 - 4：等待重试。
`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 实例ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
    
    Returns:
    
    InstanceId 实例ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
  - setInstanceId
```
public void setInstanceId(String InstanceId)
```
    Set 实例ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
    
    Parameters:
    
    InstanceId - 实例ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
  - getBackupName
```
public String getBackupName()
```
    Get 指定备份文件名，用于过滤指定文件的下载任务。请通过接口 [DescribeDBBackups](https://cloud.tencent.com/document/product/240/38574) 获取备份文件名。
    
    Returns:
    
    BackupName 指定备份文件名，用于过滤指定文件的下载任务。请通过接口 [DescribeDBBackups](https://cloud.tencent.com/document/product/240/38574) 获取备份文件名。
  - setBackupName
```
public void setBackupName(String BackupName)
```
    Set 指定备份文件名，用于过滤指定文件的下载任务。请通过接口 [DescribeDBBackups](https://cloud.tencent.com/document/product/240/38574) 获取备份文件名。
    
    Parameters:
    
    BackupName - 指定备份文件名，用于过滤指定文件的下载任务。请通过接口 [DescribeDBBackups](https://cloud.tencent.com/document/product/240/38574) 获取备份文件名。
  - getStartTime
```
public String getStartTime()
```
    Get 指定查询时间范围内的任务，StartTime 指定开始时间。若不指定开始时间，则默认不限制开始时间。
    
    Returns:
    
    StartTime 指定查询时间范围内的任务，StartTime 指定开始时间。若不指定开始时间，则默认不限制开始时间。
  - setStartTime
```
public void setStartTime(String StartTime)
```
    Set 指定查询时间范围内的任务，StartTime 指定开始时间。若不指定开始时间，则默认不限制开始时间。
    
    Parameters:
    
    StartTime - 指定查询时间范围内的任务，StartTime 指定开始时间。若不指定开始时间，则默认不限制开始时间。
  - getEndTime
```
public String getEndTime()
```
    Get 指定查询时间范围内的任务，EndTime 指定截止时间。若不指定截止时间，则默认不限制截止时间。
    
    Returns:
    
    EndTime 指定查询时间范围内的任务，EndTime 指定截止时间。若不指定截止时间，则默认不限制截止时间。
  - setEndTime
```
public void setEndTime(String EndTime)
```
    Set 指定查询时间范围内的任务，EndTime 指定截止时间。若不指定截止时间，则默认不限制截止时间。
    
    Parameters:
    
    EndTime - 指定查询时间范围内的任务，EndTime 指定截止时间。若不指定截止时间，则默认不限制截止时间。
  - getLimit
```
public Long getLimit()
```
    Get 此次查询返回的条数，取值范围为1-100，默认为20。
    
    Returns:
    
    Limit 此次查询返回的条数，取值范围为1-100，默认为20。
  - setLimit
```
public void setLimit(Long Limit)
```
    Set 此次查询返回的条数，取值范围为1-100，默认为20。
    
    Parameters:
    
    Limit - 此次查询返回的条数，取值范围为1-100，默认为20。
  - getOffset
```
public Long getOffset()
```
    Get 指定此次查询返回的页数，默认为0。
    
    Returns:
    
    Offset 指定此次查询返回的页数，默认为0。
  - setOffset
```
public void setOffset(Long Offset)
```
    Set 指定此次查询返回的页数，默认为0。
    
    Parameters:
    
    Offset - 指定此次查询返回的页数，默认为0。
  - getOrderBy
```
public String getOrderBy()
```
    Get 排序字段。 - createTime：按照备份下载任务的创建时间排序。默认为 createTime。 - finishTime：按照备份下载任务的完成时间排序。
    
    Returns:
    
    OrderBy 排序字段。 - createTime：按照备份下载任务的创建时间排序。默认为 createTime。 - finishTime：按照备份下载任务的完成时间排序。
  - setOrderBy
```
public void setOrderBy(String OrderBy)
```
    Set 排序字段。 - createTime：按照备份下载任务的创建时间排序。默认为 createTime。 - finishTime：按照备份下载任务的完成时间排序。
    
    Parameters:
    
    OrderBy - 排序字段。 - createTime：按照备份下载任务的创建时间排序。默认为 createTime。 - finishTime：按照备份下载任务的完成时间排序。
  - getOrderByType
```
public String getOrderByType()
```
    Get 排序方式。 - asc：升序排列。 - desc：降序排列。默认为 desc。
    
    Returns:
    
    OrderByType 排序方式。 - asc：升序排列。 - desc：降序排列。默认为 desc。
  - setOrderByType
```
public void setOrderByType(String OrderByType)
```
    Set 排序方式。 - asc：升序排列。 - desc：降序排列。默认为 desc。
    
    Parameters:
    
    OrderByType - 排序方式。 - asc：升序排列。 - desc：降序排列。默认为 desc。
  - getStatus
```
public Long[] getStatus()
```
    Get 指定任务状态，用于过滤下载任务。若不配置该参数，则返回所有状态类型的任务。 - 0：等待执行。 - 1：正在下载。 - 2：下载完成。 - 3：下载失败。 - 4：等待重试。
    
    Returns:
    
    Status 指定任务状态，用于过滤下载任务。若不配置该参数，则返回所有状态类型的任务。 - 0：等待执行。 - 1：正在下载。 - 2：下载完成。 - 3：下载失败。 - 4：等待重试。
  - setStatus
```
public void setStatus(Long[] Status)
```
    Set 指定任务状态，用于过滤下载任务。若不配置该参数，则返回所有状态类型的任务。 - 0：等待执行。 - 1：正在下载。 - 2：下载完成。 - 3：下载失败。 - 4：等待重试。
    
    Parameters:
    
    Status - 指定任务状态，用于过滤下载任务。若不配置该参数，则返回所有状态类型的任务。 - 0：等待执行。 - 1：正在下载。 - 2：下载完成。 - 3：下载失败。 - 4：等待重试。
  - 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.

Class DescribeBackupDownloadTaskRequest

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

Constructor Summary

Method Summary

Methods inherited from class com.tencentcloudapi.common.AbstractModel

Methods inherited from class java.lang.Object

Constructor Detail

DescribeBackupDownloadTaskRequest

DescribeBackupDownloadTaskRequest

Method Detail

getInstanceId

setInstanceId

getBackupName

setBackupName

getStartTime

setStartTime

getEndTime

setEndTime

getLimit

setLimit

getOffset

setOffset

getOrderBy

setOrderBy

getOrderByType

setOrderByType

getStatus

setStatus

toMap