Class: TencentCloud::Mongodb::V20190725::DescribeBackupDownloadTaskRequest

Inherits:
Common::AbstractModel
  • Object
show all
Defined in:
lib/v20190725/models.rb

Overview

DescribeBackupDownloadTask请求参数结构体

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(instanceid = nil, backupname = nil, starttime = nil, endtime = nil, limit = nil, offset = nil, orderby = nil, orderbytype = nil, status = nil) ⇒ DescribeBackupDownloadTaskRequest

Returns a new instance of DescribeBackupDownloadTaskRequest.



1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
 
# File 'lib/v20190725/models.rb', line 1705

def initialize(instanceid=nil, backupname=nil, starttime=nil, endtime=nil, limit=nil, offset=nil, orderby=nil, orderbytype=nil, status=nil)
  @InstanceId = instanceid
  @BackupName = backupname
  @StartTime = starttime
  @EndTime = endtime
  @Limit = limit
  @Offset = offset
  @OrderBy = orderby
  @OrderByType = orderbytype
  @Status = status
end

Instance Attribute Details

#BackupName ⇒ Object

  • createTime：按照备份下载任务的创建时间排序。默认为 createTime。
  • finishTime：按照备份下载任务的完成时间排序。
  • asc：升序排列。
  • desc：降序排列。默认为 desc。
  • 0：等待执行。
  • 1：正在下载。
  • 2：下载完成。
  • 3：下载失败。
  • 4：等待重试。

Parameters:

  • InstanceId: —

    实例ID。请登录 MongoDB 控制台在实例列表复制实例 ID。

  • BackupName: —

    指定备份文件名，用于过滤指定文件的下载任务。请通过接口 DescribeDBBackups 获取备份文件名。

  • StartTime: —

    指定查询时间范围内的任务，StartTime 指定开始时间。若不指定开始时间，则默认不限制开始时间。

  • EndTime: —

    指定查询时间范围内的任务，EndTime 指定截止时间。若不指定截止时间，则默认不限制截止时间。

  • Limit: —

    此次查询返回的条数，取值范围为1-100，默认为20。

  • Offset: —

    指定此次查询返回的页数，默认为0。

  • OrderBy: —

    排序字段。

  • OrderByType: —

    排序方式。

  • Status: —

    指定任务状态，用于过滤下载任务。若不配置该参数，则返回所有状态类型的任务。



1703
1704
1705
 
# File 'lib/v20190725/models.rb', line 1703

def BackupName
  @BackupName
end

#EndTime ⇒ Object

  • createTime：按照备份下载任务的创建时间排序。默认为 createTime。
  • finishTime：按照备份下载任务的完成时间排序。
  • asc：升序排列。
  • desc：降序排列。默认为 desc。
  • 0：等待执行。
  • 1：正在下载。
  • 2：下载完成。
  • 3：下载失败。
  • 4：等待重试。

Parameters:

  • InstanceId: —

    实例ID。请登录 MongoDB 控制台在实例列表复制实例 ID。

  • BackupName: —

    指定备份文件名，用于过滤指定文件的下载任务。请通过接口 DescribeDBBackups 获取备份文件名。

  • StartTime: —

    指定查询时间范围内的任务，StartTime 指定开始时间。若不指定开始时间，则默认不限制开始时间。

  • EndTime: —

    指定查询时间范围内的任务，EndTime 指定截止时间。若不指定截止时间，则默认不限制截止时间。

  • Limit: —

    此次查询返回的条数，取值范围为1-100，默认为20。

  • Offset: —

    指定此次查询返回的页数，默认为0。

  • OrderBy: —

    排序字段。

  • OrderByType: —

    排序方式。

  • Status: —

    指定任务状态，用于过滤下载任务。若不配置该参数，则返回所有状态类型的任务。



1703
1704
1705
 
# File 'lib/v20190725/models.rb', line 1703

def EndTime
  @EndTime
end

#InstanceId ⇒ Object

  • createTime：按照备份下载任务的创建时间排序。默认为 createTime。
  • finishTime：按照备份下载任务的完成时间排序。
  • asc：升序排列。
  • desc：降序排列。默认为 desc。
  • 0：等待执行。
  • 1：正在下载。
  • 2：下载完成。
  • 3：下载失败。
  • 4：等待重试。

Parameters:

  • InstanceId: —

    实例ID。请登录 MongoDB 控制台在实例列表复制实例 ID。

  • BackupName: —

    指定备份文件名，用于过滤指定文件的下载任务。请通过接口 DescribeDBBackups 获取备份文件名。

  • StartTime: —

    指定查询时间范围内的任务，StartTime 指定开始时间。若不指定开始时间，则默认不限制开始时间。

  • EndTime: —

    指定查询时间范围内的任务，EndTime 指定截止时间。若不指定截止时间，则默认不限制截止时间。

  • Limit: —

    此次查询返回的条数，取值范围为1-100，默认为20。

  • Offset: —

    指定此次查询返回的页数，默认为0。

  • OrderBy: —

    排序字段。

  • OrderByType: —

    排序方式。

  • Status: —

    指定任务状态，用于过滤下载任务。若不配置该参数，则返回所有状态类型的任务。



1703
1704
1705
 
# File 'lib/v20190725/models.rb', line 1703

def InstanceId
  @InstanceId
end

#Limit ⇒ Object

  • createTime：按照备份下载任务的创建时间排序。默认为 createTime。
  • finishTime：按照备份下载任务的完成时间排序。
  • asc：升序排列。
  • desc：降序排列。默认为 desc。
  • 0：等待执行。
  • 1：正在下载。
  • 2：下载完成。
  • 3：下载失败。
  • 4：等待重试。

Parameters:

  • InstanceId: —

    实例ID。请登录 MongoDB 控制台在实例列表复制实例 ID。

  • BackupName: —

    指定备份文件名，用于过滤指定文件的下载任务。请通过接口 DescribeDBBackups 获取备份文件名。

  • StartTime: —

    指定查询时间范围内的任务，StartTime 指定开始时间。若不指定开始时间，则默认不限制开始时间。

  • EndTime: —

    指定查询时间范围内的任务，EndTime 指定截止时间。若不指定截止时间，则默认不限制截止时间。

  • Limit: —

    此次查询返回的条数，取值范围为1-100，默认为20。

  • Offset: —

    指定此次查询返回的页数，默认为0。

  • OrderBy: —

    排序字段。

  • OrderByType: —

    排序方式。

  • Status: —

    指定任务状态，用于过滤下载任务。若不配置该参数，则返回所有状态类型的任务。



1703
1704
1705
 
# File 'lib/v20190725/models.rb', line 1703

def Limit
  @Limit
end

#Offset ⇒ Object

  • createTime：按照备份下载任务的创建时间排序。默认为 createTime。
  • finishTime：按照备份下载任务的完成时间排序。
  • asc：升序排列。
  • desc：降序排列。默认为 desc。
  • 0：等待执行。
  • 1：正在下载。
  • 2：下载完成。
  • 3：下载失败。
  • 4：等待重试。

Parameters:

  • InstanceId: —

    实例ID。请登录 MongoDB 控制台在实例列表复制实例 ID。

  • BackupName: —

    指定备份文件名，用于过滤指定文件的下载任务。请通过接口 DescribeDBBackups 获取备份文件名。

  • StartTime: —

    指定查询时间范围内的任务，StartTime 指定开始时间。若不指定开始时间，则默认不限制开始时间。

  • EndTime: —

    指定查询时间范围内的任务，EndTime 指定截止时间。若不指定截止时间，则默认不限制截止时间。

  • Limit: —

    此次查询返回的条数，取值范围为1-100，默认为20。

  • Offset: —

    指定此次查询返回的页数，默认为0。

  • OrderBy: —

    排序字段。

  • OrderByType: —

    排序方式。

  • Status: —

    指定任务状态，用于过滤下载任务。若不配置该参数，则返回所有状态类型的任务。



1703
1704
1705
 
# File 'lib/v20190725/models.rb', line 1703

def Offset
  @Offset
end

#OrderBy ⇒ Object

  • createTime：按照备份下载任务的创建时间排序。默认为 createTime。
  • finishTime：按照备份下载任务的完成时间排序。
  • asc：升序排列。
  • desc：降序排列。默认为 desc。
  • 0：等待执行。
  • 1：正在下载。
  • 2：下载完成。
  • 3：下载失败。
  • 4：等待重试。

Parameters:

  • InstanceId: —

    实例ID。请登录 MongoDB 控制台在实例列表复制实例 ID。

  • BackupName: —

    指定备份文件名，用于过滤指定文件的下载任务。请通过接口 DescribeDBBackups 获取备份文件名。

  • StartTime: —

    指定查询时间范围内的任务，StartTime 指定开始时间。若不指定开始时间，则默认不限制开始时间。

  • EndTime: —

    指定查询时间范围内的任务，EndTime 指定截止时间。若不指定截止时间，则默认不限制截止时间。

  • Limit: —

    此次查询返回的条数，取值范围为1-100，默认为20。

  • Offset: —

    指定此次查询返回的页数，默认为0。

  • OrderBy: —

    排序字段。

  • OrderByType: —

    排序方式。

  • Status: —

    指定任务状态，用于过滤下载任务。若不配置该参数，则返回所有状态类型的任务。



1703
1704
1705
 
# File 'lib/v20190725/models.rb', line 1703

def OrderBy
  @OrderBy
end

#OrderByType ⇒ Object

  • createTime：按照备份下载任务的创建时间排序。默认为 createTime。
  • finishTime：按照备份下载任务的完成时间排序。
  • asc：升序排列。
  • desc：降序排列。默认为 desc。
  • 0：等待执行。
  • 1：正在下载。
  • 2：下载完成。
  • 3：下载失败。
  • 4：等待重试。

Parameters:

  • InstanceId: —

    实例ID。请登录 MongoDB 控制台在实例列表复制实例 ID。

  • BackupName: —

    指定备份文件名，用于过滤指定文件的下载任务。请通过接口 DescribeDBBackups 获取备份文件名。

  • StartTime: —

    指定查询时间范围内的任务，StartTime 指定开始时间。若不指定开始时间，则默认不限制开始时间。

  • EndTime: —

    指定查询时间范围内的任务，EndTime 指定截止时间。若不指定截止时间，则默认不限制截止时间。

  • Limit: —

    此次查询返回的条数，取值范围为1-100，默认为20。

  • Offset: —

    指定此次查询返回的页数，默认为0。

  • OrderBy: —

    排序字段。

  • OrderByType: —

    排序方式。

  • Status: —

    指定任务状态，用于过滤下载任务。若不配置该参数，则返回所有状态类型的任务。



1703
1704
1705
 
# File 'lib/v20190725/models.rb', line 1703

def OrderByType
  @OrderByType
end

#StartTime ⇒ Object

  • createTime：按照备份下载任务的创建时间排序。默认为 createTime。
  • finishTime：按照备份下载任务的完成时间排序。
  • asc：升序排列。
  • desc：降序排列。默认为 desc。
  • 0：等待执行。
  • 1：正在下载。
  • 2：下载完成。
  • 3：下载失败。
  • 4：等待重试。

Parameters:

  • InstanceId: —

    实例ID。请登录 MongoDB 控制台在实例列表复制实例 ID。

  • BackupName: —

    指定备份文件名，用于过滤指定文件的下载任务。请通过接口 DescribeDBBackups 获取备份文件名。

  • StartTime: —

    指定查询时间范围内的任务，StartTime 指定开始时间。若不指定开始时间，则默认不限制开始时间。

  • EndTime: —

    指定查询时间范围内的任务，EndTime 指定截止时间。若不指定截止时间，则默认不限制截止时间。

  • Limit: —

    此次查询返回的条数，取值范围为1-100，默认为20。

  • Offset: —

    指定此次查询返回的页数，默认为0。

  • OrderBy: —

    排序字段。

  • OrderByType: —

    排序方式。

  • Status: —

    指定任务状态，用于过滤下载任务。若不配置该参数，则返回所有状态类型的任务。



1703
1704
1705
 
# File 'lib/v20190725/models.rb', line 1703

def StartTime
  @StartTime
end

#Status ⇒ Object

  • createTime：按照备份下载任务的创建时间排序。默认为 createTime。
  • finishTime：按照备份下载任务的完成时间排序。
  • asc：升序排列。
  • desc：降序排列。默认为 desc。
  • 0：等待执行。
  • 1：正在下载。
  • 2：下载完成。
  • 3：下载失败。
  • 4：等待重试。

Parameters:

  • InstanceId: —

    实例ID。请登录 MongoDB 控制台在实例列表复制实例 ID。

  • BackupName: —

    指定备份文件名，用于过滤指定文件的下载任务。请通过接口 DescribeDBBackups 获取备份文件名。

  • StartTime: —

    指定查询时间范围内的任务，StartTime 指定开始时间。若不指定开始时间，则默认不限制开始时间。

  • EndTime: —

    指定查询时间范围内的任务，EndTime 指定截止时间。若不指定截止时间，则默认不限制截止时间。

  • Limit: —

    此次查询返回的条数，取值范围为1-100，默认为20。

  • Offset: —

    指定此次查询返回的页数，默认为0。

  • OrderBy: —

    排序字段。

  • OrderByType: —

    排序方式。

  • Status: —

    指定任务状态，用于过滤下载任务。若不配置该参数，则返回所有状态类型的任务。



1703
1704
1705
 
# File 'lib/v20190725/models.rb', line 1703

def Status
  @Status
end

Instance Method Details

#deserialize(params) ⇒ Object 



1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
 
# File 'lib/v20190725/models.rb', line 1717

def deserialize(params)
  @InstanceId = params['InstanceId']
  @BackupName = params['BackupName']
  @StartTime = params['StartTime']
  @EndTime = params['EndTime']
  @Limit = params['Limit']
  @Offset = params['Offset']
  @OrderBy = params['OrderBy']
  @OrderByType = params['OrderByType']
  @Status = params['Status']
end