com.netflix.conductor.core.execution.tasks

Class WorkflowSystemTask

java.lang.Object

com.netflix.conductor.core.execution.tasks.WorkflowSystemTask

Direct Known Subclasses:

Decision, Event, Fork, Join, SubWorkflow, Wait

public class WorkflowSystemTask
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
WorkflowSystemTask(java.lang.String name)

Method Summary

Modifier and Type	Method and Description
static java.util.Collection<WorkflowSystemTask>	all()
void	cancel(com.netflix.conductor.common.run.Workflow workflow, com.netflix.conductor.common.metadata.tasks.Task task, WorkflowExecutor executor) Cancel task execution
boolean	execute(com.netflix.conductor.common.run.Workflow workflow, com.netflix.conductor.common.metadata.tasks.Task task, WorkflowExecutor executor)
static WorkflowSystemTask	get(java.lang.String type)
java.lang.String	getName()
int	getRetryTimeInSecond()
static boolean	is(java.lang.String type)
boolean	isAsync()
void	start(com.netflix.conductor.common.run.Workflow workflow, com.netflix.conductor.common.metadata.tasks.Task task, WorkflowExecutor executor) Start the task execution
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

WorkflowSystemTask

public WorkflowSystemTask(java.lang.String name)

Method Detail

start

public void start(com.netflix.conductor.common.run.Workflow workflow,
                  com.netflix.conductor.common.metadata.tasks.Task task,
                  WorkflowExecutor executor)
           throws java.lang.Exception

Start the task execution

Parameters:

workflow - Workflow for which the task is being started

task - Instance of the Task

executor - Workflow Executor

Throws:

java.lang.Exception - If there is an error when starting the task

execute

public boolean execute(com.netflix.conductor.common.run.Workflow workflow,
                       com.netflix.conductor.common.metadata.tasks.Task task,
                       WorkflowExecutor executor)
                throws java.lang.Exception

Parameters:

workflow - Workflow for which the task is being started

task - Instance of the Task

executor - Workflow Executor

Returns:

true, if the execution has changed the task status. return false otherwise.

Throws:

java.lang.Exception - If there is an error when starting the task

cancel

public void cancel(com.netflix.conductor.common.run.Workflow workflow,
                   com.netflix.conductor.common.metadata.tasks.Task task,
                   WorkflowExecutor executor)
            throws java.lang.Exception

Cancel task execution

Parameters:

workflow - Workflow for which the task is being started

task - Instance of the Task

executor - Workflow Executor

Throws:

java.lang.Exception - If there is an error when starting the task

isAsync

public boolean isAsync()

Returns:

True if the task is supposed to be started asynchronously using internal queues.

getRetryTimeInSecond

public int getRetryTimeInSecond()

Returns:

Time in seconds after which the task should be retried if rate limited or remains in in_progress after start method execution.

getName

public java.lang.String getName()

Returns:

name of the system task

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

is

public static boolean is(java.lang.String type)

get

public static WorkflowSystemTask get(java.lang.String type)

all

public static java.util.Collection<WorkflowSystemTask> all()