io.temporal.activity

Enum ActivityCancellationType

java.lang.Object

java.lang.Enum<ActivityCancellationType>

io.temporal.activity.ActivityCancellationType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ActivityCancellationType>

public enum ActivityCancellationType
extends java.lang.Enum<ActivityCancellationType>

Defines Activity Execution cancellation behavior.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ABANDON Do not request cancellation of the Activity Execution and immediately report cancellation to the Workflow Execution.
TRY_CANCEL Initiate a cancellation request and immediately report cancellation to the Workflow Execution.
WAIT_CANCELLATION_COMPLETED Wait for the Activity Execution to confirm any requested cancellation.

Method Summary

Modifier and Type	Method and Description
static ActivityCancellationType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ActivityCancellationType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

WAIT_CANCELLATION_COMPLETED

public static final ActivityCancellationType WAIT_CANCELLATION_COMPLETED

Wait for the Activity Execution to confirm any requested cancellation. An Activity Execution must Heartbeat to receive a cancellation notification. This can block the cancellation for a long time if the Activity Execution doesn't Heartbeat or chooses to ignore the cancellation request.

TRY_CANCEL

public static final ActivityCancellationType TRY_CANCEL

Initiate a cancellation request and immediately report cancellation to the Workflow Execution.

ABANDON

public static final ActivityCancellationType ABANDON

Do not request cancellation of the Activity Execution and immediately report cancellation to the Workflow Execution.

Method Detail

values

public static ActivityCancellationType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ActivityCancellationType c : ActivityCancellationType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ActivityCancellationType valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null