com.netflix.conductor.client.http

Class TaskClient

java.lang.Object

com.netflix.conductor.client.http.ClientBase

com.netflix.conductor.client.http.TaskClient

public class TaskClient
extends ClientBase

Field Summary

Fields inherited from class com.netflix.conductor.client.http.ClientBase

client, objectMapper, root

Constructor Summary

Constructors

Constructor and Description
TaskClient() Creates a default task client
TaskClient(com.sun.jersey.api.client.config.ClientConfig config)
TaskClient(com.sun.jersey.api.client.config.ClientConfig config, com.sun.jersey.api.client.ClientHandler handler)
TaskClient(com.sun.jersey.api.client.config.ClientConfig config, com.sun.jersey.api.client.ClientHandler handler, com.sun.jersey.api.client.filter.ClientFilter... filters)

Method Summary

Modifier and Type	Method and Description
java.lang.Boolean	ack(java.lang.String taskId, java.lang.String workerId) Ack for the task poll.
java.util.List<com.netflix.conductor.common.metadata.tasks.Task>	batchPollTasksByTaskType(java.lang.String taskType, java.lang.String workerId, int count, int timeoutInMillisecond) Perform a batch poll for tasks by task type.
java.util.List<com.netflix.conductor.common.metadata.tasks.Task>	batchPollTasksInDomain(java.lang.String taskType, java.lang.String domain, java.lang.String workerId, int count, int timeoutInMillisecond) Batch poll for tasks in a domain.
com.netflix.conductor.common.metadata.tasks.Task	get(java.lang.String taskId) Deprecated. This API is deprecated and will be removed in the next version use getTaskDetails(String) instead
java.util.List<com.netflix.conductor.common.metadata.tasks.PollData>	getAllPollData() Get the last poll data for all task types
com.netflix.conductor.common.metadata.tasks.Task	getPendingTaskForWorkflow(java.lang.String workflowId, java.lang.String taskReferenceName) Retrieve pending task identified by reference name for a workflow
java.util.List<com.netflix.conductor.common.metadata.tasks.Task>	getPendingTasksByType(java.lang.String taskType, java.lang.String startKey, java.lang.Integer count) Retrieve pending tasks by type
java.util.List<com.netflix.conductor.common.metadata.tasks.PollData>	getPollData(java.lang.String taskType) Get last poll data for a given task type
int	getQueueSizeForTask(java.lang.String taskType)
java.util.List<com.netflix.conductor.common.metadata.tasks.TaskDef>	getTaskDef() Deprecated. This API is deprecated and will be removed in the next version use MetadataClient.getAllTaskDefs() instead
com.netflix.conductor.common.metadata.tasks.TaskDef	getTaskDef(java.lang.String taskType) Deprecated. This API is deprecated and will be removed in the next version use MetadataClient.getTaskDef(String) instead
com.netflix.conductor.common.metadata.tasks.Task	getTaskDetails(java.lang.String taskId) Retrieve information about the task
java.util.List<com.netflix.conductor.common.metadata.tasks.TaskExecLog>	getTaskLogs(java.lang.String taskId) Fetch execution logs for a task.
java.util.List<com.netflix.conductor.common.metadata.tasks.Task>	getTasks(java.lang.String taskType, java.lang.String startKey, java.lang.Integer count) Deprecated. This API is deprecated and will be removed in the next version use getPendingTasksByType(String, String, Integer) instead
void	log(java.lang.String taskId, java.lang.String logMessage) Deprecated. This API is deprecated and will be removed in the next version use logMessageForTask(String, String) instead
void	logMessageForTask(java.lang.String taskId, java.lang.String logMessage) Log execution messages for a task.
java.util.List<com.netflix.conductor.common.metadata.tasks.Task>	poll(java.lang.String taskType, java.lang.String workerId, int count, int timeoutInMillisecond) Deprecated. This API is deprecated and will be removed in the next version use batchPollTasksByTaskType(String, String, int, int) instead
java.util.List<com.netflix.conductor.common.metadata.tasks.Task>	poll(java.lang.String taskType, java.lang.String domain, java.lang.String workerId, int count, int timeoutInMillisecond) Deprecated. This API is deprecated and will be removed in the next version use batchPollTasksInDomain(String, String, String, int, int) instead
com.netflix.conductor.common.metadata.tasks.Task	pollTask(java.lang.String taskType, java.lang.String workerId, java.lang.String domain) Perform a poll for a task of a specific task type.
void	registerTaskDefs(java.util.List<com.netflix.conductor.common.metadata.tasks.TaskDef> taskDefs) Deprecated. This API is deprecated and will be removed in the next version use MetadataClient.registerTaskDefs(List) instead
void	removeTaskFromQueue(java.lang.String taskType, java.lang.String taskId) Removes a task from a taskType queue
java.lang.String	requeueAllPendingTasks() Requeue pending tasks for all running workflows
java.lang.String	requeuePendingTasksByTaskType(java.lang.String taskType) Requeue pending tasks of a specific task type
com.netflix.conductor.common.run.SearchResult<com.netflix.conductor.common.run.TaskSummary>	search(java.lang.Integer start, java.lang.Integer size, java.lang.String sort, java.lang.String freeText, java.lang.String query) Paginated search for tasks based on payload
com.netflix.conductor.common.run.SearchResult<com.netflix.conductor.common.run.TaskSummary>	search(java.lang.String query) Search for tasks based on payload
void	unregisterTaskDef(java.lang.String taskType) Deprecated. This API is deprecated and will be removed in the next version use MetadataClient.unregisterTaskDef(String) instead
void	updateTask(com.netflix.conductor.common.metadata.tasks.TaskResult taskResult, java.lang.String taskType) Updates the result of a task execution.

Methods inherited from class com.netflix.conductor.client.http.ClientBase

delete, delete, getForEntity, getForEntity, postForEntity, postForEntity, postForEntity, postForEntity1, postForEntityWithRequestOnly, postForEntityWithUriVariablesOnly, put, setRootURI

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TaskClient

public TaskClient()

Creates a default task client

TaskClient

public TaskClient(com.sun.jersey.api.client.config.ClientConfig config)

Parameters:

config - REST Client configuration

TaskClient

public TaskClient(com.sun.jersey.api.client.config.ClientConfig config,
                  com.sun.jersey.api.client.ClientHandler handler)

Parameters:

config - REST Client configuration

handler - Jersey client handler. Useful when plugging in various http client interaction modules (e.g. ribbon)

TaskClient

public TaskClient(com.sun.jersey.api.client.config.ClientConfig config,
                  com.sun.jersey.api.client.ClientHandler handler,
                  com.sun.jersey.api.client.filter.ClientFilter... filters)

Parameters:

config - config REST Client configuration

handler - handler Jersey client handler. Useful when plugging in various http client interaction modules (e.g. ribbon)

filters - Chain of client side filters to be applied per request

Method Detail

pollTask

public com.netflix.conductor.common.metadata.tasks.Task pollTask(java.lang.String taskType,
                                                                 java.lang.String workerId,
                                                                 java.lang.String domain)

Perform a poll for a task of a specific task type.

Parameters:

taskType - The taskType to poll for

domain - The domain of the task type

workerId - Name of the client worker. Used for logging.

Returns:

Task waiting to be executed.

poll

@Deprecated
public java.util.List<com.netflix.conductor.common.metadata.tasks.Task> poll(java.lang.String taskType,
                                                                                         java.lang.String workerId,
                                                                                         int count,
                                                                                         int timeoutInMillisecond)

Deprecated. This API is deprecated and will be removed in the next version use batchPollTasksByTaskType(String, String, int, int) instead

batchPollTasksByTaskType

public java.util.List<com.netflix.conductor.common.metadata.tasks.Task> batchPollTasksByTaskType(java.lang.String taskType,
                                                                                                 java.lang.String workerId,
                                                                                                 int count,
                                                                                                 int timeoutInMillisecond)

Perform a batch poll for tasks by task type. Batch size is configurable by count.

Parameters:

taskType - Type of task to poll for

workerId - Name of the client worker. Used for logging.

count - Maximum number of tasks to be returned. Actual number of tasks returned can be less than this number.

timeoutInMillisecond - Long poll wait timeout.

Returns:

List of tasks awaiting to be executed.

poll

@Deprecated
public java.util.List<com.netflix.conductor.common.metadata.tasks.Task> poll(java.lang.String taskType,
                                                                                         java.lang.String domain,
                                                                                         java.lang.String workerId,
                                                                                         int count,
                                                                                         int timeoutInMillisecond)

Deprecated. This API is deprecated and will be removed in the next version use batchPollTasksInDomain(String, String, String, int, int) instead

batchPollTasksInDomain

public java.util.List<com.netflix.conductor.common.metadata.tasks.Task> batchPollTasksInDomain(java.lang.String taskType,
                                                                                               java.lang.String domain,
                                                                                               java.lang.String workerId,
                                                                                               int count,
                                                                                               int timeoutInMillisecond)

Batch poll for tasks in a domain. Batch size is configurable by count.

Parameters:

taskType - Type of task to poll for

domain - The domain of the task type

workerId - Name of the client worker. Used for logging.

count - Maximum number of tasks to be returned. Actual number of tasks returned can be less than this number.

timeoutInMillisecond - Long poll wait timeout.

Returns:

List of tasks awaiting to be executed.

getTasks

@Deprecated
public java.util.List<com.netflix.conductor.common.metadata.tasks.Task> getTasks(java.lang.String taskType,
                                                                                             java.lang.String startKey,
                                                                                             java.lang.Integer count)

Deprecated. This API is deprecated and will be removed in the next version use getPendingTasksByType(String, String, Integer) instead

getPendingTasksByType

public java.util.List<com.netflix.conductor.common.metadata.tasks.Task> getPendingTasksByType(java.lang.String taskType,
                                                                                              java.lang.String startKey,
                                                                                              java.lang.Integer count)

Retrieve pending tasks by type

Parameters:

taskType - Type of task

startKey - id of the task from where to return the results. NULL to start from the beginning.

count - number of tasks to retrieve

Returns:

Returns the list of PENDING tasks by type, starting with a given task Id.

getPendingTaskForWorkflow

public com.netflix.conductor.common.metadata.tasks.Task getPendingTaskForWorkflow(java.lang.String workflowId,
                                                                                  java.lang.String taskReferenceName)

Retrieve pending task identified by reference name for a workflow

Parameters:

workflowId - Workflow instance id

taskReferenceName - reference name of the task

Returns:

Returns the pending workflow task identified by the reference name

updateTask

public void updateTask(com.netflix.conductor.common.metadata.tasks.TaskResult taskResult,
                       java.lang.String taskType)

Updates the result of a task execution.

Parameters:

taskResult - TaskResults to be updated.

taskType -

ack

public java.lang.Boolean ack(java.lang.String taskId,
                             java.lang.String workerId)

Ack for the task poll.

Parameters:

taskId - Id of the task to be polled

workerId - user identified worker.

Returns:

true if the task was found with the given ID and acknowledged. False otherwise. If the server returns false, the client should NOT attempt to ack again.

log

@Deprecated
public void log(java.lang.String taskId,
                            java.lang.String logMessage)

Deprecated. This API is deprecated and will be removed in the next version use logMessageForTask(String, String) instead

logMessageForTask

public void logMessageForTask(java.lang.String taskId,
                              java.lang.String logMessage)

Log execution messages for a task.

Parameters:

taskId - id of the task

logMessage - the message to be logged

getTaskLogs

public java.util.List<com.netflix.conductor.common.metadata.tasks.TaskExecLog> getTaskLogs(java.lang.String taskId)

Fetch execution logs for a task.

Parameters:

taskId - id of the task.

get

@Deprecated
public com.netflix.conductor.common.metadata.tasks.Task get(java.lang.String taskId)

Deprecated. This API is deprecated and will be removed in the next version use getTaskDetails(String) instead

getTaskDetails

public com.netflix.conductor.common.metadata.tasks.Task getTaskDetails(java.lang.String taskId)

Retrieve information about the task

Parameters:

taskId - ID of the task

Returns:

Task details

removeTaskFromQueue

public void removeTaskFromQueue(java.lang.String taskType,
                                java.lang.String taskId)

Removes a task from a taskType queue

Parameters:

taskType - the taskType to identify the queue

taskId - the id of the task to be removed

getQueueSizeForTask

public int getQueueSizeForTask(java.lang.String taskType)

getPollData

public java.util.List<com.netflix.conductor.common.metadata.tasks.PollData> getPollData(java.lang.String taskType)

Get last poll data for a given task type

Parameters:

taskType - the task type for which poll data is to be fetched

Returns:

returns the list of poll data for the task type

getAllPollData

public java.util.List<com.netflix.conductor.common.metadata.tasks.PollData> getAllPollData()

Get the last poll data for all task types

Returns:

returns a list of poll data for all task types

requeueAllPendingTasks

public java.lang.String requeueAllPendingTasks()

Requeue pending tasks for all running workflows

Returns:

returns the number of tasks that have been requeued

requeuePendingTasksByTaskType

public java.lang.String requeuePendingTasksByTaskType(java.lang.String taskType)

Requeue pending tasks of a specific task type

Returns:

returns the number of tasks that have been requeued

search

public com.netflix.conductor.common.run.SearchResult<com.netflix.conductor.common.run.TaskSummary> search(java.lang.String query)

Search for tasks based on payload

Parameters:

query - the search string

Returns:

returns the SearchResult containing the TaskSummary matching the query

search

public com.netflix.conductor.common.run.SearchResult<com.netflix.conductor.common.run.TaskSummary> search(java.lang.Integer start,
                                                                                                          java.lang.Integer size,
                                                                                                          java.lang.String sort,
                                                                                                          java.lang.String freeText,
                                                                                                          java.lang.String query)

Paginated search for tasks based on payload

Parameters:

start - start value of page

size - number of tasks to be returned

sort - sort order

freeText - additional free text query

query - the search query

Returns:

the SearchResult containing the TaskSummary that match the query

getTaskDef

@Deprecated
public java.util.List<com.netflix.conductor.common.metadata.tasks.TaskDef> getTaskDef()

Deprecated. This API is deprecated and will be removed in the next version use MetadataClient.getAllTaskDefs() instead

getTaskDef

@Deprecated
public com.netflix.conductor.common.metadata.tasks.TaskDef getTaskDef(java.lang.String taskType)

Deprecated. This API is deprecated and will be removed in the next version use MetadataClient.getTaskDef(String) instead

unregisterTaskDef

@Deprecated
public void unregisterTaskDef(java.lang.String taskType)

Deprecated. This API is deprecated and will be removed in the next version use MetadataClient.unregisterTaskDef(String) instead

registerTaskDefs

@Deprecated
public void registerTaskDefs(java.util.List<com.netflix.conductor.common.metadata.tasks.TaskDef> taskDefs)

Deprecated. This API is deprecated and will be removed in the next version use MetadataClient.registerTaskDefs(List) instead