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, 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
com.netflix.conductor.common.metadata.tasks.Task	get(java.lang.String taskId)
com.netflix.conductor.common.metadata.tasks.Task	getPendingTaskForWorkflow(java.lang.String workflowId, java.lang.String taskReferenceName)
java.util.List<com.netflix.conductor.common.metadata.tasks.TaskDef>	getTaskDef()
com.netflix.conductor.common.metadata.tasks.TaskDef	getTaskDef(java.lang.String taskType)
java.util.List<com.netflix.conductor.common.metadata.tasks.Task>	getTasks(java.lang.String taskType, java.lang.String startKey, java.lang.Integer count)
java.util.List<com.netflix.conductor.common.metadata.tasks.Task>	poll(java.lang.String taskType, java.lang.String workerId, int count, int timeoutInMillisecond) Poll for tasks
void	registerTaskDefs(java.util.List<com.netflix.conductor.common.metadata.tasks.TaskDef> taskDefs) Registers a set of task types with the conductor server
void	unregisterTaskDef(java.lang.String taskType)
void	updateTask(com.netflix.conductor.common.metadata.tasks.TaskResult task) Updates the result of a task execution

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

delete, delete, getForEntity, getForEntity, objectMapper, postForEntity, postForEntity, postForEntity, postForEntity1, 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

poll

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

Poll for tasks

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. Can be less.

timeoutInMillisecond - Long poll wait timeout.

Returns:

List of tasks awaiting to be executed.

get

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

Parameters:

taskId - ID of the task

Returns:

Task details

getTasks

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

Parameters:

taskType - Type of task

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

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)

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 task)

Updates the result of a task execution

Parameters:

task - TaskResults to be updated.

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.

getTaskDef

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

Returns:

List of all the task definitions registered with the server

getTaskDef

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

Parameters:

taskType - type of task for which to retrieve the definition

Returns:

Task Definition for the given task type

unregisterTaskDef

public void unregisterTaskDef(java.lang.String taskType)

Parameters:

taskType - Task type to be unregistered. Use with caution.

registerTaskDefs

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

Registers a set of task types with the conductor server

Parameters:

taskDefs - List of task types to be registered.