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.TaskResult> executor)
com.netflix.conductor.common.metadata.tasks.TaskResult	execute(com.netflix.conductor.common.metadata.tasks.Task task) Executes a task and returns the updated task.
default java.lang.String	getIdentity() Override this method to app specific rules.
default int	getLongPollTimeoutInMS() Deprecated.
default int	getPollCount() Deprecated.
default int	getPollingInterval() Override this method to change the interval between polls.
java.lang.String	getTaskDefName() Retrieve the name of the task definition the worker is currently working on.
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.
default boolean	preAck(com.netflix.conductor.common.metadata.tasks.Task task) Deprecated.

Method Detail

getTaskDefName

java.lang.String getTaskDefName()

Retrieve the name of the task definition the worker is currently working on.

Returns:

the name of the task definition.

execute

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

Executes a task and returns the updated task.

Parameters:

task - Task to be executed.

Returns:

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

preAck

@Deprecated
default boolean preAck(com.netflix.conductor.common.metadata.tasks.Task task)

Deprecated.

This method has been marked as deprecated and will be removed in a future release.

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.

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

Override this method to app specific rules.

Returns:

returns the serverId as the id of the instance that the worker is running.

getPollCount

@Deprecated
default int getPollCount()

Deprecated.

This method has been marked as deprecated and will be removed in a future release.

getPollingInterval

default int getPollingInterval()

Override this method to change the interval between polls.

Returns:

interval in millisecond at which the server should be polled for worker tasks.

getLongPollTimeoutInMS

@Deprecated
default int getLongPollTimeoutInMS()

Deprecated.

This method has been marked as deprecated and will be removed in a future release.

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.TaskResult> executor)