com.tencentcloudapi.wedata.v20210820.models

Class ListInstancesRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.wedata.v20210820.models.ListInstancesRequest

public class ListInstancesRequest
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
ListInstancesRequest()
ListInstancesRequest(ListInstancesRequest 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[]	getExecutorGroupIdList() Get Execution resource group Id.
String[]	getInChargeList() Get Task owner.
Long[]	getInstanceStateList() Get Instance execution status.
Long	getInstanceType() Get Instance type.
String	getKeyword() Get Task name or task ID.
Long	getPageNumber() Get Page number, integer.
Long	getPageSize() Get Number of items per page, integer.
String	getProjectId() Get **Project ID**.
String	getScheduleTimeFrom() Get Filter criteria for instance planned scheduling time.
String	getScheduleTimeTo() Get Filter criteria for instance planned scheduling time.
String	getScheduleTimeZone() Get Time zone.
String	getSortColumn() Get Sorting field for query results.
String	getSortType() Get Instance sorting order.
String	getStartTimeFrom() Get Instance execution start time filter criteria.
String	getStartTimeTo() Get Instance execution start time filter criteria.
String[]	getTaskCycleList() Get Task cycle type.
String[]	getTaskFolderIdList() Get File to which the task belongs.
Long[]	getTaskTypeIdList() Get **Task type Id** specifies the identifier for the task type.
String[]	getWorkflowIdList() Get **Associated workflow of the task**.
void	setExecutorGroupIdList(String[] ExecutorGroupIdList) Set Execution resource group Id.
void	setInChargeList(String[] InChargeList) Set Task owner.
void	setInstanceStateList(Long[] InstanceStateList) Set Instance execution status.
void	setInstanceType(Long InstanceType) Set Instance type.
void	setKeyword(String Keyword) Set Task name or task ID.
void	setPageNumber(Long PageNumber) Set Page number, integer.
void	setPageSize(Long PageSize) Set Number of items per page, integer.
void	setProjectId(String ProjectId) Set **Project ID**.
void	setScheduleTimeFrom(String ScheduleTimeFrom) Set Filter criteria for instance planned scheduling time.
void	setScheduleTimeTo(String ScheduleTimeTo) Set Filter criteria for instance planned scheduling time.
void	setScheduleTimeZone(String ScheduleTimeZone) Set Time zone.
void	setSortColumn(String SortColumn) Set Sorting field for query results.
void	setSortType(String SortType) Set Instance sorting order.
void	setStartTimeFrom(String StartTimeFrom) Set Instance execution start time filter criteria.
void	setStartTimeTo(String StartTimeTo) Set Instance execution start time filter criteria.
void	setTaskCycleList(String[] TaskCycleList) Set Task cycle type.
void	setTaskFolderIdList(String[] TaskFolderIdList) Set File to which the task belongs.
void	setTaskTypeIdList(Long[] TaskTypeIdList) Set **Task type Id** specifies the identifier for the task type.
void	setWorkflowIdList(String[] WorkflowIdList) Set **Associated workflow of the task**.
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

ListInstancesRequest

public ListInstancesRequest()

ListInstancesRequest

public ListInstancesRequest(ListInstancesRequest 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

getProjectId

public String getProjectId()

Get **Project ID**.

Returns:

ProjectId **Project ID**.

setProjectId

public void setProjectId(String ProjectId)

Set **Project ID**.

Parameters:

ProjectId - **Project ID**.

getScheduleTimeFrom

public String getScheduleTimeFrom()

Get Filter criteria for instance planned scheduling time. Specifies the start time for filtering. the time format is yyyy-MM-dd HH:MM:ss.

Returns:

ScheduleTimeFrom Filter criteria for instance planned scheduling time. Specifies the start time for filtering. the time format is yyyy-MM-dd HH:MM:ss.

setScheduleTimeFrom

public void setScheduleTimeFrom(String ScheduleTimeFrom)

Set Filter criteria for instance planned scheduling time. Specifies the start time for filtering. the time format is yyyy-MM-dd HH:MM:ss.

Parameters:

ScheduleTimeFrom - Filter criteria for instance planned scheduling time. Specifies the start time for filtering. the time format is yyyy-MM-dd HH:MM:ss.

getScheduleTimeTo

public String getScheduleTimeTo()

Get Filter criteria for instance planned scheduling time. Filter expiration time. the time format is yyyy-MM-dd HH:MM:ss.

Returns:

ScheduleTimeTo Filter criteria for instance planned scheduling time. Filter expiration time. the time format is yyyy-MM-dd HH:MM:ss.

setScheduleTimeTo

public void setScheduleTimeTo(String ScheduleTimeTo)

Set Filter criteria for instance planned scheduling time. Filter expiration time. the time format is yyyy-MM-dd HH:MM:ss.

Parameters:

ScheduleTimeTo - Filter criteria for instance planned scheduling time. Filter expiration time. the time format is yyyy-MM-dd HH:MM:ss.

getPageNumber

public Long getPageNumber()

Get Page number, integer. Use in conjunction with pageSize and cannot be less than 1. the default value is 1.

Returns:

PageNumber Page number, integer. Use in conjunction with pageSize and cannot be less than 1. the default value is 1.

setPageNumber

public void setPageNumber(Long PageNumber)

Set Page number, integer. Use in conjunction with pageSize and cannot be less than 1. the default value is 1.

Parameters:

PageNumber - Page number, integer. Use in conjunction with pageSize and cannot be less than 1. the default value is 1.

getPageSize

public Long getPageSize()

Get Number of items per page, integer. Use in conjunction with pageNumber and should not exceed 200. default value: 10.

Returns:

PageSize Number of items per page, integer. Use in conjunction with pageNumber and should not exceed 200. default value: 10.

setPageSize

public void setPageSize(Long PageSize)

Set Number of items per page, integer. Use in conjunction with pageNumber and should not exceed 200. default value: 10.

Parameters:

PageSize - Number of items per page, integer. Use in conjunction with pageNumber and should not exceed 200. default value: 10.

getSortColumn

public String getSortColumn()

Get Sorting field for query results. -SCHEDULE_DATE indicates sorting based on the planned scheduling time. -START_TIME indicates sorting by the instance's start execution time. -END_TIME indicates sorting based on the instance execution end time. -COST_TIME indicates sorting based on instance execution duration.

Returns:

SortColumn Sorting field for query results. -SCHEDULE_DATE indicates sorting based on the planned scheduling time. -START_TIME indicates sorting by the instance's start execution time. -END_TIME indicates sorting based on the instance execution end time. -COST_TIME indicates sorting based on instance execution duration.

setSortColumn

public void setSortColumn(String SortColumn)

Set Sorting field for query results. -SCHEDULE_DATE indicates sorting based on the planned scheduling time. -START_TIME indicates sorting by the instance's start execution time. -END_TIME indicates sorting based on the instance execution end time. -COST_TIME indicates sorting based on instance execution duration.

Parameters:

SortColumn - Sorting field for query results. -SCHEDULE_DATE indicates sorting based on the planned scheduling time. -START_TIME indicates sorting by the instance's start execution time. -END_TIME indicates sorting based on the instance execution end time. -COST_TIME indicates sorting based on instance execution duration.

getSortType

public String getSortType()

Get Instance sorting order. - ASC - DESC

Returns:

SortType Instance sorting order. - ASC - DESC

setSortType

public void setSortType(String SortType)

Set Instance sorting order. - ASC - DESC

Parameters:

SortType - Instance sorting order. - ASC - DESC

getInstanceType

public Long getInstanceType()

Get Instance type. -0 indicates Replenished Instance. -1 indicates Periodic Instance. -2 indicates Non-Periodic instance.

Returns:

InstanceType Instance type. -0 indicates Replenished Instance. -1 indicates Periodic Instance. -2 indicates Non-Periodic instance.

setInstanceType

public void setInstanceType(Long InstanceType)

Set Instance type. -0 indicates Replenished Instance. -1 indicates Periodic Instance. -2 indicates Non-Periodic instance.

Parameters:

InstanceType - Instance type. -0 indicates Replenished Instance. -1 indicates Periodic Instance. -2 indicates Non-Periodic instance.

getInstanceStateList

public Long[] getInstanceStateList()

Get Instance execution status. Support filtering multiple items with an "or" relationship between conditions. -[0] Indicates waiting for event. -[12] indicates waiting for upstream. -[6, 7, 9, 10, 18] indicates awaiting execution. -[1, 19, 22] indicate running. -[21] indicates skipping running. -[3] indicates retry on failure. -[8, 4, 5, 13] indicates a failure. -[2] indicates a success.

Returns:

InstanceStateList Instance execution status. Support filtering multiple items with an "or" relationship between conditions. -[0] Indicates waiting for event. -[12] indicates waiting for upstream. -[6, 7, 9, 10, 18] indicates awaiting execution. -[1, 19, 22] indicate running. -[21] indicates skipping running. -[3] indicates retry on failure. -[8, 4, 5, 13] indicates a failure. -[2] indicates a success.

setInstanceStateList

public void setInstanceStateList(Long[] InstanceStateList)

Set Instance execution status. Support filtering multiple items with an "or" relationship between conditions. -[0] Indicates waiting for event. -[12] indicates waiting for upstream. -[6, 7, 9, 10, 18] indicates awaiting execution. -[1, 19, 22] indicate running. -[21] indicates skipping running. -[3] indicates retry on failure. -[8, 4, 5, 13] indicates a failure. -[2] indicates a success.

Parameters:

InstanceStateList - Instance execution status. Support filtering multiple items with an "or" relationship between conditions. -[0] Indicates waiting for event. -[12] indicates waiting for upstream. -[6, 7, 9, 10, 18] indicates awaiting execution. -[1, 19, 22] indicate running. -[21] indicates skipping running. -[3] indicates retry on failure. -[8, 4, 5, 13] indicates a failure. -[2] indicates a success.

getTaskTypeIdList

public Long[] getTaskTypeIdList()

Get **Task type Id** specifies the identifier for the task type. -Supports filtering multiple items with an or relationship between conditions. -You can use the DescribeAllTaskType API to obtain all task types supported by the project.

Returns:

TaskTypeIdList **Task type Id** specifies the identifier for the task type. -Supports filtering multiple items with an or relationship between conditions. -You can use the DescribeAllTaskType API to obtain all task types supported by the project.

setTaskTypeIdList

public void setTaskTypeIdList(Long[] TaskTypeIdList)

Set **Task type Id** specifies the identifier for the task type. -Supports filtering multiple items with an or relationship between conditions. -You can use the DescribeAllTaskType API to obtain all task types supported by the project.

Parameters:

TaskTypeIdList - **Task type Id** specifies the identifier for the task type. -Supports filtering multiple items with an or relationship between conditions. -You can use the DescribeAllTaskType API to obtain all task types supported by the project.

getTaskCycleList

public String[] getTaskCycleList()

Get Task cycle type. Supports filtering multiple conditions with an or relationship between them. O: ONEOFF_CYCLE Y: YEAR_CYCLE M: MONTH_CYCLE W: WEEK_CYCLE D: DAY_CYCLE H: HOUR_CYCLE I: MINUTE_CYCLE C: CRONTAB_CYCLE

Returns:

TaskCycleList Task cycle type. Supports filtering multiple conditions with an or relationship between them. O: ONEOFF_CYCLE Y: YEAR_CYCLE M: MONTH_CYCLE W: WEEK_CYCLE D: DAY_CYCLE H: HOUR_CYCLE I: MINUTE_CYCLE C: CRONTAB_CYCLE

setTaskCycleList

public void setTaskCycleList(String[] TaskCycleList)

Set Task cycle type. Supports filtering multiple conditions with an or relationship between them. O: ONEOFF_CYCLE Y: YEAR_CYCLE M: MONTH_CYCLE W: WEEK_CYCLE D: DAY_CYCLE H: HOUR_CYCLE I: MINUTE_CYCLE C: CRONTAB_CYCLE

Parameters:

TaskCycleList - Task cycle type. Supports filtering multiple conditions with an or relationship between them. O: ONEOFF_CYCLE Y: YEAR_CYCLE M: MONTH_CYCLE W: WEEK_CYCLE D: DAY_CYCLE H: HOUR_CYCLE I: MINUTE_CYCLE C: CRONTAB_CYCLE

getKeyword

public String getKeyword()

Get Task name or task ID. Supports fuzzy search filtering. multiple items are separated by english commas.

Returns:

Keyword Task name or task ID. Supports fuzzy search filtering. multiple items are separated by english commas.

setKeyword

public void setKeyword(String Keyword)

Set Task name or task ID. Supports fuzzy search filtering. multiple items are separated by english commas.

Parameters:

Keyword - Task name or task ID. Supports fuzzy search filtering. multiple items are separated by english commas.

getInChargeList

public String[] getInChargeList()

Get Task owner. Support filtering multiple items with an or relationship between conditions.

Returns:

InChargeList Task owner. Support filtering multiple items with an or relationship between conditions.

setInChargeList

public void setInChargeList(String[] InChargeList)

Set Task owner. Support filtering multiple items with an or relationship between conditions.

Parameters:

InChargeList - Task owner. Support filtering multiple items with an or relationship between conditions.

getTaskFolderIdList

public String[] getTaskFolderIdList()

Get File to which the task belongs. Supports filtering multiple conditions with an or relationship between them. The FindAllFolder API can be used to obtain the folder list under a project.

Returns:

TaskFolderIdList File to which the task belongs. Supports filtering multiple conditions with an or relationship between them. The FindAllFolder API can be used to obtain the folder list under a project.

setTaskFolderIdList

public void setTaskFolderIdList(String[] TaskFolderIdList)

Set File to which the task belongs. Supports filtering multiple conditions with an or relationship between them. The FindAllFolder API can be used to obtain the folder list under a project.

Parameters:

TaskFolderIdList - File to which the task belongs. Supports filtering multiple conditions with an or relationship between them. The FindAllFolder API can be used to obtain the folder list under a project.

getWorkflowIdList

public String[] getWorkflowIdList()

Get **Associated workflow of the task**. Supports filtering multiple conditions with an or relationship between them. The workflow list under a project can be obtained through the DescribeOpsWorkflows api.

Returns:

WorkflowIdList **Associated workflow of the task**. Supports filtering multiple conditions with an or relationship between them. The workflow list under a project can be obtained through the DescribeOpsWorkflows api.

setWorkflowIdList

public void setWorkflowIdList(String[] WorkflowIdList)

Set **Associated workflow of the task**. Supports filtering multiple conditions with an or relationship between them. The workflow list under a project can be obtained through the DescribeOpsWorkflows api.

Parameters:

WorkflowIdList - **Associated workflow of the task**. Supports filtering multiple conditions with an or relationship between them. The workflow list under a project can be obtained through the DescribeOpsWorkflows api.

getExecutorGroupIdList

public String[] getExecutorGroupIdList()

Get Execution resource group Id. Supports filtering multiple conditions with an or relationship between them. The scheduling resource group list under the project can be obtained through the DescribeNormalSchedulerExecutorGroups api. The DescribeNormalIntegrationExecutorGroups API can be used to obtain the list of all integration resource groups under a project.

Returns:

ExecutorGroupIdList Execution resource group Id. Supports filtering multiple conditions with an or relationship between them. The scheduling resource group list under the project can be obtained through the DescribeNormalSchedulerExecutorGroups api. The DescribeNormalIntegrationExecutorGroups API can be used to obtain the list of all integration resource groups under a project.

setExecutorGroupIdList

public void setExecutorGroupIdList(String[] ExecutorGroupIdList)

Set Execution resource group Id. Supports filtering multiple conditions with an or relationship between them. The scheduling resource group list under the project can be obtained through the DescribeNormalSchedulerExecutorGroups api. The DescribeNormalIntegrationExecutorGroups API can be used to obtain the list of all integration resource groups under a project.

Parameters:

ExecutorGroupIdList - Execution resource group Id. Supports filtering multiple conditions with an or relationship between them. The scheduling resource group list under the project can be obtained through the DescribeNormalSchedulerExecutorGroups api. The DescribeNormalIntegrationExecutorGroups API can be used to obtain the list of all integration resource groups under a project.

getStartTimeFrom

public String getStartTimeFrom()

Get Instance execution start time filter criteria. Specifies the start time for filtering. the time format is yyyy-MM-dd HH:MM:ss.

Returns:

StartTimeFrom Instance execution start time filter criteria. Specifies the start time for filtering. the time format is yyyy-MM-dd HH:MM:ss.

setStartTimeFrom

public void setStartTimeFrom(String StartTimeFrom)

Set Instance execution start time filter criteria. Specifies the start time for filtering. the time format is yyyy-MM-dd HH:MM:ss.

Parameters:

StartTimeFrom - Instance execution start time filter criteria. Specifies the start time for filtering. the time format is yyyy-MM-dd HH:MM:ss.

getStartTimeTo

public String getStartTimeTo()

Get Instance execution start time filter criteria. Filter expiration time. the time format is yyyy-MM-dd HH:MM:ss.

Returns:

StartTimeTo Instance execution start time filter criteria. Filter expiration time. the time format is yyyy-MM-dd HH:MM:ss.

setStartTimeTo

public void setStartTimeTo(String StartTimeTo)

Set Instance execution start time filter criteria. Filter expiration time. the time format is yyyy-MM-dd HH:MM:ss.

Parameters:

StartTimeTo - Instance execution start time filter criteria. Filter expiration time. the time format is yyyy-MM-dd HH:MM:ss.

getScheduleTimeZone

public String getScheduleTimeZone()

Get Time zone. Time zone. specifies the time zone. the default value is UTC+8.

Returns:

ScheduleTimeZone Time zone. Time zone. specifies the time zone. the default value is UTC+8.

setScheduleTimeZone

public void setScheduleTimeZone(String ScheduleTimeZone)

Set Time zone. Time zone. specifies the time zone. the default value is UTC+8.

Parameters:

ScheduleTimeZone - Time zone. Time zone. specifies the time zone. the default value is UTC+8.

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.