com.uber.cadence.activity

Annotation Type ActivityMethod

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

Indicates that the method is an activity method. This annotation applies only to activity interface methods. Not required. Use it to override default activity type name or other options. When both ActivityOptions and ActivityMethod have non default value for some parameter the ActivityOptions one takes precedence.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
int	heartbeatTimeoutSeconds Heartbeat interval.
java.lang.String	name Name of the workflow type.
int	scheduleToCloseTimeoutSeconds Overall timeout workflow is willing to wait for activity to complete.
int	scheduleToStartTimeoutSeconds Time activity can stay in task list before it is picked up by a worker.
int	startToCloseTimeoutSeconds Maximum activity execution time after it was sent to a worker.
java.lang.String	taskList Task list to use when dispatching activity task to a worker.

Element Detail

name

public abstract java.lang.String name

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

Default:

""

scheduleToCloseTimeoutSeconds

public abstract int scheduleToCloseTimeoutSeconds

Overall timeout workflow is willing to wait for activity to complete. It includes time in a task list (use scheduleToStartTimeoutSeconds() to limit it) plus activity execution time (use startToCloseTimeoutSeconds() to limit it). Either this option or both schedule to start and start to close are required.

Default:

0

scheduleToStartTimeoutSeconds

public abstract int scheduleToStartTimeoutSeconds

Time activity can stay in task list before it is picked up by a worker. If schedule to close is not provided then both this and start to close are required.

Default:

0

startToCloseTimeoutSeconds

public abstract int startToCloseTimeoutSeconds

Maximum activity execution time after it was sent to a worker. If schedule to close is not provided then both this and schedule to start are required.

Default:

0

heartbeatTimeoutSeconds

public abstract int heartbeatTimeoutSeconds

Heartbeat interval. Activity must heartbeat before this interval passes after a last heartbeat or activity start.

Default:

0

taskList

public abstract java.lang.String taskList

Task list to use when dispatching activity task to a worker. By default it is the same task list name the workflow was started with.

Default:

""