com.tencentcloudapi.dlc.v20210125.models

Class DescribeTasksRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.dlc.v20210125.models.DescribeTasksRequest

public class DescribeTasksRequest
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

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	getDataEngineName() Get The data engine name for filtering.
String	getEndTime() Get End time in the format of `yyyy-mm-dd HH:MM:SS`, which is the current time by default.
Filter[]	getFilters() Get Filter.
Long	getLimit() Get Number of returned results.
Long	getOffset() Get Offset.
String	getSortBy() Get Sorting field.
String	getSorting() Get Sorting order.
String	getStartTime() Get Start time in the format of `yyyy-mm-dd HH:MM:SS`, which is the current time seven days ago by default.
void	setDataEngineName(String DataEngineName) Set The data engine name for filtering.
void	setEndTime(String EndTime) Set End time in the format of `yyyy-mm-dd HH:MM:SS`, which is the current time by default.
void	setFilters(Filter[] Filters) Set Filter.
void	setLimit(Long Limit) Set Number of returned results.
void	setOffset(Long Offset) Set Offset.
void	setSortBy(String SortBy) Set Sorting field.
void	setSorting(String Sorting) Set Sorting order.
void	setStartTime(String StartTime) Set Start time in the format of `yyyy-mm-dd HH:MM:SS`, which is the current time seven days ago by default.
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, 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

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

getLimit

public Long getLimit()

Get Number of returned results. Default value: 10. Maximum value: 100.

Returns:

Limit Number of returned results. Default value: 10. Maximum value: 100.

setLimit

public void setLimit(Long Limit)

Set Number of returned results. Default value: 10. Maximum value: 100.

Parameters:

Limit - Number of returned results. Default value: 10. Maximum value: 100.

getOffset

public Long getOffset()

Get Offset. Default value: 0.

Returns:

Offset Offset. Default value: 0.

setOffset

public void setOffset(Long Offset)

Set Offset. Default value: 0.

Parameters:

Offset - Offset. Default value: 0.

getFilters

public Filter[] getFilters()

Get Filter. The following filters are supported, and the `Name` input parameter must be one of them. Up to 50 `task-id` values can be filtered, while up to 5 other parameters can be filtered in total. task-id - String - (filter by task ID). `task-id` format: e386471f-139a-4e59-877f-50ece8135b99. task-state - String - (filter exactly by task status). Valid values: `0` (initial), `1` (running), `2` (succeeded), `-1` (failed). task-sql-keyword - String - (filter fuzzily by SQL statement keyword, such as `DROP TABLE`). task-operator- string (filter by sub-UIN) task-kind - string (filter by task type)

Returns:

Filters Filter. The following filters are supported, and the `Name` input parameter must be one of them. Up to 50 `task-id` values can be filtered, while up to 5 other parameters can be filtered in total. task-id - String - (filter by task ID). `task-id` format: e386471f-139a-4e59-877f-50ece8135b99. task-state - String - (filter exactly by task status). Valid values: `0` (initial), `1` (running), `2` (succeeded), `-1` (failed). task-sql-keyword - String - (filter fuzzily by SQL statement keyword, such as `DROP TABLE`). task-operator- string (filter by sub-UIN) task-kind - string (filter by task type)

setFilters

public void setFilters(Filter[] Filters)

Set Filter. The following filters are supported, and the `Name` input parameter must be one of them. Up to 50 `task-id` values can be filtered, while up to 5 other parameters can be filtered in total. task-id - String - (filter by task ID). `task-id` format: e386471f-139a-4e59-877f-50ece8135b99. task-state - String - (filter exactly by task status). Valid values: `0` (initial), `1` (running), `2` (succeeded), `-1` (failed). task-sql-keyword - String - (filter fuzzily by SQL statement keyword, such as `DROP TABLE`). task-operator- string (filter by sub-UIN) task-kind - string (filter by task type)

Parameters:

Filters - Filter. The following filters are supported, and the `Name` input parameter must be one of them. Up to 50 `task-id` values can be filtered, while up to 5 other parameters can be filtered in total. task-id - String - (filter by task ID). `task-id` format: e386471f-139a-4e59-877f-50ece8135b99. task-state - String - (filter exactly by task status). Valid values: `0` (initial), `1` (running), `2` (succeeded), `-1` (failed). task-sql-keyword - String - (filter fuzzily by SQL statement keyword, such as `DROP TABLE`). task-operator- string (filter by sub-UIN) task-kind - string (filter by task type)

getSortBy

public String getSortBy()

Get Sorting field. Valid values: `create-time` (default value), `update-time`.

Returns:

SortBy Sorting field. Valid values: `create-time` (default value), `update-time`.

setSortBy

public void setSortBy(String SortBy)

Set Sorting field. Valid values: `create-time` (default value), `update-time`.

Parameters:

SortBy - Sorting field. Valid values: `create-time` (default value), `update-time`.

getSorting

public String getSorting()

Get Sorting order. Valid values: `asc` (ascending order), `desc` (descending order). Default value: `asc`.

Returns:

Sorting Sorting order. Valid values: `asc` (ascending order), `desc` (descending order). Default value: `asc`.

setSorting

public void setSorting(String Sorting)

Set Sorting order. Valid values: `asc` (ascending order), `desc` (descending order). Default value: `asc`.

Parameters:

Sorting - Sorting order. Valid values: `asc` (ascending order), `desc` (descending order). Default value: `asc`.

getStartTime

public String getStartTime()

Get Start time in the format of `yyyy-mm-dd HH:MM:SS`, which is the current time seven days ago by default.

Returns:

StartTime Start time in the format of `yyyy-mm-dd HH:MM:SS`, which is the current time seven days ago by default.

setStartTime

public void setStartTime(String StartTime)

Set Start time in the format of `yyyy-mm-dd HH:MM:SS`, which is the current time seven days ago by default.

Parameters:

StartTime - Start time in the format of `yyyy-mm-dd HH:MM:SS`, which is the current time seven days ago by default.

getEndTime

public String getEndTime()

Get End time in the format of `yyyy-mm-dd HH:MM:SS`, which is the current time by default. The time span is (0, 30] days. Data in the last 45 days can be queried.

Returns:

EndTime End time in the format of `yyyy-mm-dd HH:MM:SS`, which is the current time by default. The time span is (0, 30] days. Data in the last 45 days can be queried.

setEndTime

public void setEndTime(String EndTime)

Set End time in the format of `yyyy-mm-dd HH:MM:SS`, which is the current time by default. The time span is (0, 30] days. Data in the last 45 days can be queried.

Parameters:

EndTime - End time in the format of `yyyy-mm-dd HH:MM:SS`, which is the current time by default. The time span is (0, 30] days. Data in the last 45 days can be queried.

getDataEngineName

public String getDataEngineName()

Get The data engine name for filtering.

Returns:

DataEngineName The data engine name for filtering.

setDataEngineName

public void setDataEngineName(String DataEngineName)

Set The data engine name for filtering.

Parameters:

DataEngineName - The data engine name for filtering.

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel