com.uber.cadence.workflow

Annotation Type WorkflowMethod

@Retention(value=RUNTIME)
 @Target(value=METHOD)
public @interface WorkflowMethod

Indicates that the method is a workflow method. Workflow method is executed when workflow is started. Workflow completes when workflow method returns. This annotation applies only to workflow interface methods.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
int	executionStartToCloseTimeoutSeconds Maximum workflow execution time.
java.lang.String	name Name of the workflow type.
java.lang.String	taskList Task list to use when delivering workflow tasks.
int	taskStartToCloseTimeoutSeconds Maximum execution time of a single workflow task.
java.lang.String	workflowId Workflow ID to use.
WorkflowIdReusePolicy	workflowIdReusePolicy How to react if there is completed workflow with the same ID.

Element Detail

name

public abstract java.lang.String name

Name of the workflow type. Default is {short class name}::{method name}

Default:

""

workflowId

public abstract java.lang.String workflowId

Workflow ID to use. Default is random UUID. Specifying workflow in the annotation makes sense only for singleton workflows that would ever have one instance per type running. Make sure that WorkflowIdReusePolicy is AllowDuplicate in this case.

Default:

""

workflowIdReusePolicy

public abstract WorkflowIdReusePolicy workflowIdReusePolicy

How to react if there is completed workflow with the same ID.

AllowDuplicate - Always start a new run

RejectDuplicate - Never allow a second run

AllowDuplicateFailedOnly - Allow only if workflow didn't complete successfully.

Default is AllowDuplicateFailedOnly.

Default:

com.uber.cadence.WorkflowIdReusePolicy.AllowDuplicateFailedOnly

executionStartToCloseTimeoutSeconds

public abstract int executionStartToCloseTimeoutSeconds

Maximum workflow execution time. Must be specified either through executionStartToCloseTimeoutSeconds() or WorkflowOptions.getExecutionStartToCloseTimeout().

Default:

0

taskStartToCloseTimeoutSeconds

public abstract int taskStartToCloseTimeoutSeconds

Maximum execution time of a single workflow task. Workflow tasks are reactions to a new events in the workflow history. Usually they are pretty short. Default is 10 seconds. Maximum allowed value is 1 minute.

Default:

10

taskList

public abstract java.lang.String taskList

Task list to use when delivering workflow tasks. Must be specified either through this annotation or through WorkflowOptions.

Default:

""