com.tencentcloudapi.cdb.v20170320.models

Class DescribeTasksRequest

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()
DescribeTasksRequest(DescribeTasksRequest 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	getAsyncRequestId() Get ID of an async task request, i.e., `AsyncRequestId` returned by relevant TencentDB operations.
String	getInstanceId() Get Instance ID in the format of cdb-c1nl9rpv.
Long	getLimit() Get Number of results to be returned for a single request.
Long	getOffset() Get Record offset.
String	getStartTimeBegin() Get Start time of the first task in the format of yyyy-MM-dd HH:mm:ss, such as 2017-12-31 10:40:01.
String	getStartTimeEnd() Get End time of the last task in the format of yyyy-MM-dd HH:mm:ss, such as 2017-12-31 10:40:01.
Long[]	getTaskStatus() Get Task status.
Long[]	getTaskTypes() Get Task type.
void	setAsyncRequestId(String AsyncRequestId) Set ID of an async task request, i.e., `AsyncRequestId` returned by relevant TencentDB operations.
void	setInstanceId(String InstanceId) Set Instance ID in the format of cdb-c1nl9rpv.
void	setLimit(Long Limit) Set Number of results to be returned for a single request.
void	setOffset(Long Offset) Set Record offset.
void	setStartTimeBegin(String StartTimeBegin) Set Start time of the first task in the format of yyyy-MM-dd HH:mm:ss, such as 2017-12-31 10:40:01.
void	setStartTimeEnd(String StartTimeEnd) Set End time of the last task in the format of yyyy-MM-dd HH:mm:ss, such as 2017-12-31 10:40:01.
void	setTaskStatus(Long[] TaskStatus) Set Task status.
void	setTaskTypes(Long[] TaskTypes) Set Task type.
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()

DescribeTasksRequest

public DescribeTasksRequest(DescribeTasksRequest 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 cdb-c1nl9rpv. It is the same as the instance ID displayed on the TencentDB Console page. You can use the [instance list querying API](https://intl.cloud.tencent.com/document/api/236/15872?from_cn_redirect=1) to query the ID, whose value is the `InstanceId` value in output parameters.

Returns:

InstanceId Instance ID in the format of cdb-c1nl9rpv. It is the same as the instance ID displayed on the TencentDB Console page. You can use the [instance list querying API](https://intl.cloud.tencent.com/document/api/236/15872?from_cn_redirect=1) to query the ID, whose value is the `InstanceId` value in output parameters.

setInstanceId

public void setInstanceId(String InstanceId)

Set Instance ID in the format of cdb-c1nl9rpv. It is the same as the instance ID displayed on the TencentDB Console page. You can use the [instance list querying API](https://intl.cloud.tencent.com/document/api/236/15872?from_cn_redirect=1) to query the ID, whose value is the `InstanceId` value in output parameters.

Parameters:

InstanceId - Instance ID in the format of cdb-c1nl9rpv. It is the same as the instance ID displayed on the TencentDB Console page. You can use the [instance list querying API](https://intl.cloud.tencent.com/document/api/236/15872?from_cn_redirect=1) to query the ID, whose value is the `InstanceId` value in output parameters.

getAsyncRequestId

public String getAsyncRequestId()

Get ID of an async task request, i.e., `AsyncRequestId` returned by relevant TencentDB operations.

Returns:

AsyncRequestId ID of an async task request, i.e., `AsyncRequestId` returned by relevant TencentDB operations.

setAsyncRequestId

public void setAsyncRequestId(String AsyncRequestId)

Set ID of an async task request, i.e., `AsyncRequestId` returned by relevant TencentDB operations.

Parameters:

AsyncRequestId - ID of an async task request, i.e., `AsyncRequestId` returned by relevant TencentDB operations.

getTaskTypes

public Long[] getTaskTypes()

Get Task type. If no value is passed in, all task types will be queried. Valid values: 1 - rolling back a database; 2 - performing an SQL operation; 3 - importing data; 5 - setting a parameter; 6 - initializing a TencentDB instance; 7 - restarting a TencentDB instance; 8 - enabling GTID of a TencentDB instance; 9 - upgrading a read-only instance; 10 - rolling back databases in batches; 11 - upgrading a primary instance; 12 - deleting a TencentDB table; 13 - promoting a disaster recovery instance.

Returns:

TaskTypes Task type. If no value is passed in, all task types will be queried. Valid values: 1 - rolling back a database; 2 - performing an SQL operation; 3 - importing data; 5 - setting a parameter; 6 - initializing a TencentDB instance; 7 - restarting a TencentDB instance; 8 - enabling GTID of a TencentDB instance; 9 - upgrading a read-only instance; 10 - rolling back databases in batches; 11 - upgrading a primary instance; 12 - deleting a TencentDB table; 13 - promoting a disaster recovery instance.

setTaskTypes

public void setTaskTypes(Long[] TaskTypes)

Set Task type. If no value is passed in, all task types will be queried. Valid values: 1 - rolling back a database; 2 - performing an SQL operation; 3 - importing data; 5 - setting a parameter; 6 - initializing a TencentDB instance; 7 - restarting a TencentDB instance; 8 - enabling GTID of a TencentDB instance; 9 - upgrading a read-only instance; 10 - rolling back databases in batches; 11 - upgrading a primary instance; 12 - deleting a TencentDB table; 13 - promoting a disaster recovery instance.

Parameters:

TaskTypes - Task type. If no value is passed in, all task types will be queried. Valid values: 1 - rolling back a database; 2 - performing an SQL operation; 3 - importing data; 5 - setting a parameter; 6 - initializing a TencentDB instance; 7 - restarting a TencentDB instance; 8 - enabling GTID of a TencentDB instance; 9 - upgrading a read-only instance; 10 - rolling back databases in batches; 11 - upgrading a primary instance; 12 - deleting a TencentDB table; 13 - promoting a disaster recovery instance.

getTaskStatus

public Long[] getTaskStatus()

Get Task status. If no value is passed in, all task statuses will be queried. Valid values: -1 - undefined; 0 - initializing; 1 - running; 2 - succeeded; 3 - failed; 4 - terminated; 5 - deleted; 6 - paused.

Returns:

TaskStatus Task status. If no value is passed in, all task statuses will be queried. Valid values: -1 - undefined; 0 - initializing; 1 - running; 2 - succeeded; 3 - failed; 4 - terminated; 5 - deleted; 6 - paused.

setTaskStatus

public void setTaskStatus(Long[] TaskStatus)

Set Task status. If no value is passed in, all task statuses will be queried. Valid values: -1 - undefined; 0 - initializing; 1 - running; 2 - succeeded; 3 - failed; 4 - terminated; 5 - deleted; 6 - paused.

Parameters:

TaskStatus - Task status. If no value is passed in, all task statuses will be queried. Valid values: -1 - undefined; 0 - initializing; 1 - running; 2 - succeeded; 3 - failed; 4 - terminated; 5 - deleted; 6 - paused.

getStartTimeBegin

public String getStartTimeBegin()

Get Start time of the first task in the format of yyyy-MM-dd HH:mm:ss, such as 2017-12-31 10:40:01. It is used for queries by time range.

Returns:

StartTimeBegin Start time of the first task in the format of yyyy-MM-dd HH:mm:ss, such as 2017-12-31 10:40:01. It is used for queries by time range.

setStartTimeBegin

public void setStartTimeBegin(String StartTimeBegin)

Set Start time of the first task in the format of yyyy-MM-dd HH:mm:ss, such as 2017-12-31 10:40:01. It is used for queries by time range.

Parameters:

StartTimeBegin - Start time of the first task in the format of yyyy-MM-dd HH:mm:ss, such as 2017-12-31 10:40:01. It is used for queries by time range.

getStartTimeEnd

public String getStartTimeEnd()

Get End time of the last task in the format of yyyy-MM-dd HH:mm:ss, such as 2017-12-31 10:40:01. It is used for queries by time range.

Returns:

StartTimeEnd End time of the last task in the format of yyyy-MM-dd HH:mm:ss, such as 2017-12-31 10:40:01. It is used for queries by time range.

setStartTimeEnd

public void setStartTimeEnd(String StartTimeEnd)

Set End time of the last task in the format of yyyy-MM-dd HH:mm:ss, such as 2017-12-31 10:40:01. It is used for queries by time range.

Parameters:

StartTimeEnd - End time of the last task in the format of yyyy-MM-dd HH:mm:ss, such as 2017-12-31 10:40:01. It is used for queries by time range.

getOffset

public Long getOffset()

Get Record offset. Default value: 0.

Returns:

Offset Record offset. Default value: 0.

setOffset

public void setOffset(Long Offset)

Set Record offset. Default value: 0.

Parameters:

Offset - Record offset. Default value: 0.

getLimit

public Long getLimit()

Get Number of results to be returned for a single request. Default value: 20. Maximum value: 100.

Returns:

Limit Number of results to be returned for a single request. Default value: 20. Maximum value: 100.

setLimit

public void setLimit(Long Limit)

Set Number of results to be returned for a single request. Default value: 20. Maximum value: 100.

Parameters:

Limit - Number of results to be returned for a single request. Default value: 20. Maximum value: 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