DescribeTasksRequest (tencentcloud-sdk-java 3.1.68 API)

java.lang.Object
- com.tencentcloudapi.common.AbstractModel
- - com.tencentcloudapi.cdb.v20170320.models.DescribeTasksRequest

public class DescribeTasksRequest
extends AbstractModel

Constructor Summary

Constructors
Constructor and Description

DescribeTasksRequest()

Constructors
Constructor and Description
`DescribeTasksRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getAsyncRequestId()` Get 异步任务请求 ID，执行云数据库相关操作返回的 AsyncRequestId。
`String`	`getInstanceId()` Get 实例 ID，格式如：cdb-c1nl9rpv，与云数据库控制台页面中显示的实例 ID 相同，可使用 [查询实例列表](https://cloud.tencent.com/document/api/236/15872) 接口获取，其值为输出参数中字段 InstanceId 的值。
`Long`	`getLimit()` Get 单次请求返回的数量，默认值为20，最大值为100。
`Long`	`getOffset()` Get 记录偏移量，默认值为0。
`String`	`getStartTimeBegin()` Get 第一个任务的开始时间，用于范围查询，时间格式如：2017-12-31 10:40:01。
`String`	`getStartTimeEnd()` Get 最后一个任务的开始时间，用于范围查询，时间格式如：2017-12-31 10:40:01。
`Long[]`	`getTaskStatus()` Get 任务状态，不传值则查询所有任务状态，支持的值包括： -1 - 未定义； 0 - 初始化； 1 - 运行中； 2 - 执行成功； 3 - 执行失败； 4 - 已终止； 5 - 已删除； 6 - 已暂停。
`Long[]`	`getTaskTypes()` Get 任务类型，不传值则查询所有任务类型，支持的值包括： 1 - 数据库回档； 2 - SQL操作； 3 - 数据导入； 5 - 参数设置； 6 - 初始化云数据库实例； 7 - 重启云数据库实例； 8 - 开启云数据库实例GTID； 9 - 只读实例升级； 10 - 数据库批量回档； 11 - 主实例升级； 12 - 删除云数据库库表； 13 - 灾备实例提升为主。
`void`	`setAsyncRequestId(String AsyncRequestId)` Set 异步任务请求 ID，执行云数据库相关操作返回的 AsyncRequestId。
`void`	`setInstanceId(String InstanceId)` Set 实例 ID，格式如：cdb-c1nl9rpv，与云数据库控制台页面中显示的实例 ID 相同，可使用 [查询实例列表](https://cloud.tencent.com/document/api/236/15872) 接口获取，其值为输出参数中字段 InstanceId 的值。
`void`	`setLimit(Long Limit)` Set 单次请求返回的数量，默认值为20，最大值为100。
`void`	`setOffset(Long Offset)` Set 记录偏移量，默认值为0。
`void`	`setStartTimeBegin(String StartTimeBegin)` Set 第一个任务的开始时间，用于范围查询，时间格式如：2017-12-31 10:40:01。
`void`	`setStartTimeEnd(String StartTimeEnd)` Set 最后一个任务的开始时间，用于范围查询，时间格式如：2017-12-31 10:40:01。
`void`	`setTaskStatus(Long[] TaskStatus)` Set 任务状态，不传值则查询所有任务状态，支持的值包括： -1 - 未定义； 0 - 初始化； 1 - 运行中； 2 - 执行成功； 3 - 执行失败； 4 - 已终止； 5 - 已删除； 6 - 已暂停。
`void`	`setTaskTypes(Long[] TaskTypes)` Set 任务类型，不传值则查询所有任务类型，支持的值包括： 1 - 数据库回档； 2 - SQL操作； 3 - 数据导入； 5 - 参数设置； 6 - 初始化云数据库实例； 7 - 重启云数据库实例； 8 - 开启云数据库实例GTID； 9 - 只读实例升级； 10 - 数据库批量回档； 11 - 主实例升级； 12 - 删除云数据库库表； 13 - 灾备实例提升为主。
`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
  - DescribeTasksRequest
```
public DescribeTasksRequest()
```
- Method Detail
  - getInstanceId
```
public String getInstanceId()
```
    Get 实例 ID，格式如：cdb-c1nl9rpv，与云数据库控制台页面中显示的实例 ID 相同，可使用 [查询实例列表](https://cloud.tencent.com/document/api/236/15872) 接口获取，其值为输出参数中字段 InstanceId 的值。
    
    Returns:
    
    InstanceId 实例 ID，格式如：cdb-c1nl9rpv，与云数据库控制台页面中显示的实例 ID 相同，可使用 [查询实例列表](https://cloud.tencent.com/document/api/236/15872) 接口获取，其值为输出参数中字段 InstanceId 的值。
  - setInstanceId
```
public void setInstanceId(String InstanceId)
```
    Set 实例 ID，格式如：cdb-c1nl9rpv，与云数据库控制台页面中显示的实例 ID 相同，可使用 [查询实例列表](https://cloud.tencent.com/document/api/236/15872) 接口获取，其值为输出参数中字段 InstanceId 的值。
    
    Parameters:
    
    InstanceId - 实例 ID，格式如：cdb-c1nl9rpv，与云数据库控制台页面中显示的实例 ID 相同，可使用 [查询实例列表](https://cloud.tencent.com/document/api/236/15872) 接口获取，其值为输出参数中字段 InstanceId 的值。
  - getAsyncRequestId
```
public String getAsyncRequestId()
```
    Get 异步任务请求 ID，执行云数据库相关操作返回的 AsyncRequestId。
    
    Returns:
    
    AsyncRequestId 异步任务请求 ID，执行云数据库相关操作返回的 AsyncRequestId。
  - setAsyncRequestId
```
public void setAsyncRequestId(String AsyncRequestId)
```
    Set 异步任务请求 ID，执行云数据库相关操作返回的 AsyncRequestId。
    
    Parameters:
    
    AsyncRequestId - 异步任务请求 ID，执行云数据库相关操作返回的 AsyncRequestId。
  - getTaskTypes
```
public Long[] getTaskTypes()
```
    Get 任务类型，不传值则查询所有任务类型，支持的值包括： 1 - 数据库回档； 2 - SQL操作； 3 - 数据导入； 5 - 参数设置； 6 - 初始化云数据库实例； 7 - 重启云数据库实例； 8 - 开启云数据库实例GTID； 9 - 只读实例升级； 10 - 数据库批量回档； 11 - 主实例升级； 12 - 删除云数据库库表； 13 - 灾备实例提升为主。
    
    Returns:
    
    TaskTypes 任务类型，不传值则查询所有任务类型，支持的值包括： 1 - 数据库回档； 2 - SQL操作； 3 - 数据导入； 5 - 参数设置； 6 - 初始化云数据库实例； 7 - 重启云数据库实例； 8 - 开启云数据库实例GTID； 9 - 只读实例升级； 10 - 数据库批量回档； 11 - 主实例升级； 12 - 删除云数据库库表； 13 - 灾备实例提升为主。
  - setTaskTypes
```
public void setTaskTypes(Long[] TaskTypes)
```
    Set 任务类型，不传值则查询所有任务类型，支持的值包括： 1 - 数据库回档； 2 - SQL操作； 3 - 数据导入； 5 - 参数设置； 6 - 初始化云数据库实例； 7 - 重启云数据库实例； 8 - 开启云数据库实例GTID； 9 - 只读实例升级； 10 - 数据库批量回档； 11 - 主实例升级； 12 - 删除云数据库库表； 13 - 灾备实例提升为主。
    
    Parameters:
    
    TaskTypes - 任务类型，不传值则查询所有任务类型，支持的值包括： 1 - 数据库回档； 2 - SQL操作； 3 - 数据导入； 5 - 参数设置； 6 - 初始化云数据库实例； 7 - 重启云数据库实例； 8 - 开启云数据库实例GTID； 9 - 只读实例升级； 10 - 数据库批量回档； 11 - 主实例升级； 12 - 删除云数据库库表； 13 - 灾备实例提升为主。
  - getTaskStatus
```
public Long[] getTaskStatus()
```
    Get 任务状态，不传值则查询所有任务状态，支持的值包括： -1 - 未定义； 0 - 初始化； 1 - 运行中； 2 - 执行成功； 3 - 执行失败； 4 - 已终止； 5 - 已删除； 6 - 已暂停。
    
    Returns:
    
    TaskStatus 任务状态，不传值则查询所有任务状态，支持的值包括： -1 - 未定义； 0 - 初始化； 1 - 运行中； 2 - 执行成功； 3 - 执行失败； 4 - 已终止； 5 - 已删除； 6 - 已暂停。
  - setTaskStatus
```
public void setTaskStatus(Long[] TaskStatus)
```
    Set 任务状态，不传值则查询所有任务状态，支持的值包括： -1 - 未定义； 0 - 初始化； 1 - 运行中； 2 - 执行成功； 3 - 执行失败； 4 - 已终止； 5 - 已删除； 6 - 已暂停。
    
    Parameters:
    
    TaskStatus - 任务状态，不传值则查询所有任务状态，支持的值包括： -1 - 未定义； 0 - 初始化； 1 - 运行中； 2 - 执行成功； 3 - 执行失败； 4 - 已终止； 5 - 已删除； 6 - 已暂停。
  - getStartTimeBegin
```
public String getStartTimeBegin()
```
    Get 第一个任务的开始时间，用于范围查询，时间格式如：2017-12-31 10:40:01。
    
    Returns:
    
    StartTimeBegin 第一个任务的开始时间，用于范围查询，时间格式如：2017-12-31 10:40:01。
  - setStartTimeBegin
```
public void setStartTimeBegin(String StartTimeBegin)
```
    Set 第一个任务的开始时间，用于范围查询，时间格式如：2017-12-31 10:40:01。
    
    Parameters:
    
    StartTimeBegin - 第一个任务的开始时间，用于范围查询，时间格式如：2017-12-31 10:40:01。
  - getStartTimeEnd
```
public String getStartTimeEnd()
```
    Get 最后一个任务的开始时间，用于范围查询，时间格式如：2017-12-31 10:40:01。
    
    Returns:
    
    StartTimeEnd 最后一个任务的开始时间，用于范围查询，时间格式如：2017-12-31 10:40:01。
  - setStartTimeEnd
```
public void setStartTimeEnd(String StartTimeEnd)
```
    Set 最后一个任务的开始时间，用于范围查询，时间格式如：2017-12-31 10:40:01。
    
    Parameters:
    
    StartTimeEnd - 最后一个任务的开始时间，用于范围查询，时间格式如：2017-12-31 10:40:01。
  - getOffset
```
public Long getOffset()
```
    Get 记录偏移量，默认值为0。
    
    Returns:
    
    Offset 记录偏移量，默认值为0。
  - setOffset
```
public void setOffset(Long Offset)
```
    Set 记录偏移量，默认值为0。
    
    Parameters:
    
    Offset - 记录偏移量，默认值为0。
  - getLimit
```
public Long getLimit()
```
    Get 单次请求返回的数量，默认值为20，最大值为100。
    
    Returns:
    
    Limit 单次请求返回的数量，默认值为20，最大值为100。
  - setLimit
```
public void setLimit(Long Limit)
```
    Set 单次请求返回的数量，默认值为20，最大值为100。
    
    Parameters:
    
    Limit - 单次请求返回的数量，默认值为20，最大值为100。
  - toMap
```
public void toMap(HashMap<String,String> map,
                  String prefix)
```
    Internal implementation, normal users should not use it.
    
    Specified by:
    
    toMap in class AbstractModel

Class DescribeTasksRequest

Constructor Summary

Method Summary

Methods inherited from class com.tencentcloudapi.common.AbstractModel

Methods inherited from class java.lang.Object

Constructor Detail

DescribeTasksRequest

Method Detail

getInstanceId

setInstanceId

getAsyncRequestId

setAsyncRequestId

getTaskTypes

setTaskTypes

getTaskStatus

setTaskStatus

getStartTimeBegin

setStartTimeBegin

getStartTimeEnd

setStartTimeEnd

getOffset

setOffset

getLimit

setLimit

toMap