com.netflix.conductor.client.worker

Interface Worker

public interface Worker

Method Summary

Modifier and Type	Method and Description
static Worker	create(java.lang.String taskType, java.util.function.Function<com.netflix.conductor.common.metadata.tasks.Task,com.netflix.conductor.common.metadata.tasks.Task> executor)
static Worker	create(java.lang.String taskType, java.util.function.Function<com.netflix.conductor.common.metadata.tasks.Task,com.netflix.conductor.common.metadata.tasks.Task> executor, java.util.function.Supplier<java.lang.Boolean> paused)
com.netflix.conductor.common.metadata.tasks.Task	execute(com.netflix.conductor.common.metadata.tasks.Task task) Executes a task and returns the updated task.
default java.lang.String	getIdentity()
default int	getLongPollTimeoutInMS()
default int	getPollCount()
java.lang.String	getTaskDefName()
default void	onErrorUpdate(com.netflix.conductor.common.metadata.tasks.Task task) Called when the task coordinator fails to update the task to the server.
default boolean	paused() Override this method to pause the worker from polling.

Method Detail

getTaskDefName

java.lang.String getTaskDefName()

execute

com.netflix.conductor.common.metadata.tasks.Task execute(com.netflix.conductor.common.metadata.tasks.Task task)

Executes a task and returns the updated task.

Parameters:

task - Task to be executed.

Returns:

If the task is not completed yet, return with the status as IN_PROGRESS.

onErrorUpdate

default void onErrorUpdate(com.netflix.conductor.common.metadata.tasks.Task task)

Called when the task coordinator fails to update the task to the server. Client should store the task id (in a database) and retry the update later

Parameters:

task - Task which cannot be updated back to the server.

See Also:

TaskClient.updateTask(Task)

paused

default boolean paused()

Override this method to pause the worker from polling.

Returns:

true if the worker is paused and no more tasks should be polled from server.

getIdentity

default java.lang.String getIdentity()

Returns:

returns NetflixConfiguration.getServerId(). Override this method to app specific rules

getPollCount

default int getPollCount()

Returns:

Number of tasks to be polled for.

getLongPollTimeoutInMS

default int getLongPollTimeoutInMS()

Returns:

Time to wait when making a poll to workflow server for tasks. The client will wait for at-least specified seconds for task queue to be "filled". Use a higher number here as opposed to more frequent polls. Helps reduce the excessive calls.

create

static Worker create(java.lang.String taskType,
                     java.util.function.Function<com.netflix.conductor.common.metadata.tasks.Task,com.netflix.conductor.common.metadata.tasks.Task> executor)

create

static Worker create(java.lang.String taskType,
                     java.util.function.Function<com.netflix.conductor.common.metadata.tasks.Task,com.netflix.conductor.common.metadata.tasks.Task> executor,
                     java.util.function.Supplier<java.lang.Boolean> paused)