Enum Class ActivityExecutionStatus

java.lang.Object
java.lang.Enum<ActivityExecutionStatus>
io.temporal.api.enums.v1.ActivityExecutionStatus
All Implemented Interfaces:
com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<ActivityExecutionStatus>, Constable
@Generated(value="protoc", comments="annotations:ActivityExecutionStatus.java.pb.meta") public enum ActivityExecutionStatus extends Enum<ActivityExecutionStatus> implements com.google.protobuf.ProtocolMessageEnum
 Status of a standalone activity.
 The status is updated when the activity is originally scheduled, paused, unpaused, and when the
 activity reaches a terminal state.
 (-- api-linter: core::0216::synonyms=disabled
     aip.dev/not-precedent: Named consistently with WorkflowExecutionStatus. --)
Protobuf enum temporal.api.enums.v1.ActivityExecutionStatus

  • Enum Constant Details

    • ACTIVITY_EXECUTION_STATUS_UNSPECIFIED

      public static final ActivityExecutionStatus ACTIVITY_EXECUTION_STATUS_UNSPECIFIED
      ACTIVITY_EXECUTION_STATUS_UNSPECIFIED = 0;

    • ACTIVITY_EXECUTION_STATUS_RUNNING

      public static final ActivityExecutionStatus ACTIVITY_EXECUTION_STATUS_RUNNING
       The activity has not reached a terminal status. See PendingActivityState for the run state
 (SCHEDULED, STARTED, or CANCEL_REQUESTED).
      ACTIVITY_EXECUTION_STATUS_RUNNING = 1;

    • ACTIVITY_EXECUTION_STATUS_COMPLETED

      public static final ActivityExecutionStatus ACTIVITY_EXECUTION_STATUS_COMPLETED
       The activity completed successfully. An activity can complete even after cancellation is
 requested if the worker calls RespondActivityTaskCompleted before acknowledging cancellation.
      ACTIVITY_EXECUTION_STATUS_COMPLETED = 2;

    • ACTIVITY_EXECUTION_STATUS_FAILED

      public static final ActivityExecutionStatus ACTIVITY_EXECUTION_STATUS_FAILED
       The activity failed. Causes:
 - Worker returned a non-retryable failure
 - RetryPolicy.maximum_attempts exhausted
 - Attempt failed after cancellation was requested (retries blocked)
      ACTIVITY_EXECUTION_STATUS_FAILED = 3;

    • ACTIVITY_EXECUTION_STATUS_CANCELED

      public static final ActivityExecutionStatus ACTIVITY_EXECUTION_STATUS_CANCELED
       The activity was canceled. Reached when:
 - Cancellation requested while SCHEDULED (immediate), or
 - Cancellation requested while STARTED and worker called RespondActivityTaskCanceled.

 Workers discover cancellation requests via heartbeat responses (cancel_requested=true).
 Activities that do not heartbeat will not learn of cancellation and may complete, fail, or
 time out normally. CANCELED requires explicit worker acknowledgment or immediate cancellation
 of a SCHEDULED activity.
      ACTIVITY_EXECUTION_STATUS_CANCELED = 4;

    • ACTIVITY_EXECUTION_STATUS_TERMINATED

      public static final ActivityExecutionStatus ACTIVITY_EXECUTION_STATUS_TERMINATED
       The activity was terminated. Immediate; does not wait for worker acknowledgment.
      ACTIVITY_EXECUTION_STATUS_TERMINATED = 5;

    • ACTIVITY_EXECUTION_STATUS_TIMED_OUT

      public static final ActivityExecutionStatus ACTIVITY_EXECUTION_STATUS_TIMED_OUT
       The activity timed out. See TimeoutType for the specific timeout.
 - SCHEDULE_TO_START and SCHEDULE_TO_CLOSE timeouts always result in TIMED_OUT.
 - START_TO_CLOSE and HEARTBEAT may retry if RetryPolicy permits; TIMED_OUT is
   reached when retry is blocked (RetryPolicy.maximum_attempts exhausted,
   SCHEDULE_TO_CLOSE would be exceeded, or cancellation has been requested).
      ACTIVITY_EXECUTION_STATUS_TIMED_OUT = 6;

    • ACTIVITY_EXECUTION_STATUS_PAUSED

      public static final ActivityExecutionStatus ACTIVITY_EXECUTION_STATUS_PAUSED
       The activity is paused. Paused state is only reachable after calling
 PauseActivityExecution on a standalone activity.
      ACTIVITY_EXECUTION_STATUS_PAUSED = 7;

    • UNRECOGNIZED

      public static final ActivityExecutionStatus UNRECOGNIZED

  • Field Details

    • ACTIVITY_EXECUTION_STATUS_UNSPECIFIED_VALUE

      public static final int ACTIVITY_EXECUTION_STATUS_UNSPECIFIED_VALUE
      ACTIVITY_EXECUTION_STATUS_UNSPECIFIED = 0;
      See Also:

    • ACTIVITY_EXECUTION_STATUS_RUNNING_VALUE

      public static final int ACTIVITY_EXECUTION_STATUS_RUNNING_VALUE
       The activity has not reached a terminal status. See PendingActivityState for the run state
 (SCHEDULED, STARTED, or CANCEL_REQUESTED).
      ACTIVITY_EXECUTION_STATUS_RUNNING = 1;
      See Also:

    • ACTIVITY_EXECUTION_STATUS_COMPLETED_VALUE

      public static final int ACTIVITY_EXECUTION_STATUS_COMPLETED_VALUE
       The activity completed successfully. An activity can complete even after cancellation is
 requested if the worker calls RespondActivityTaskCompleted before acknowledging cancellation.
      ACTIVITY_EXECUTION_STATUS_COMPLETED = 2;
      See Also:

    • ACTIVITY_EXECUTION_STATUS_FAILED_VALUE

      public static final int ACTIVITY_EXECUTION_STATUS_FAILED_VALUE
       The activity failed. Causes:
 - Worker returned a non-retryable failure
 - RetryPolicy.maximum_attempts exhausted
 - Attempt failed after cancellation was requested (retries blocked)
      ACTIVITY_EXECUTION_STATUS_FAILED = 3;
      See Also:

    • ACTIVITY_EXECUTION_STATUS_CANCELED_VALUE

      public static final int ACTIVITY_EXECUTION_STATUS_CANCELED_VALUE
       The activity was canceled. Reached when:
 - Cancellation requested while SCHEDULED (immediate), or
 - Cancellation requested while STARTED and worker called RespondActivityTaskCanceled.

 Workers discover cancellation requests via heartbeat responses (cancel_requested=true).
 Activities that do not heartbeat will not learn of cancellation and may complete, fail, or
 time out normally. CANCELED requires explicit worker acknowledgment or immediate cancellation
 of a SCHEDULED activity.
      ACTIVITY_EXECUTION_STATUS_CANCELED = 4;
      See Also:

    • ACTIVITY_EXECUTION_STATUS_TERMINATED_VALUE

      public static final int ACTIVITY_EXECUTION_STATUS_TERMINATED_VALUE
       The activity was terminated. Immediate; does not wait for worker acknowledgment.
      ACTIVITY_EXECUTION_STATUS_TERMINATED = 5;
      See Also:

    • ACTIVITY_EXECUTION_STATUS_TIMED_OUT_VALUE

      public static final int ACTIVITY_EXECUTION_STATUS_TIMED_OUT_VALUE
       The activity timed out. See TimeoutType for the specific timeout.
 - SCHEDULE_TO_START and SCHEDULE_TO_CLOSE timeouts always result in TIMED_OUT.
 - START_TO_CLOSE and HEARTBEAT may retry if RetryPolicy permits; TIMED_OUT is
   reached when retry is blocked (RetryPolicy.maximum_attempts exhausted,
   SCHEDULE_TO_CLOSE would be exceeded, or cancellation has been requested).
      ACTIVITY_EXECUTION_STATUS_TIMED_OUT = 6;
      See Also:

    • ACTIVITY_EXECUTION_STATUS_PAUSED_VALUE

      public static final int ACTIVITY_EXECUTION_STATUS_PAUSED_VALUE
       The activity is paused. Paused state is only reachable after calling
 PauseActivityExecution on a standalone activity.
      ACTIVITY_EXECUTION_STATUS_PAUSED = 7;
      See Also:

  • Method Details

    • values

      public static ActivityExecutionStatus[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static ActivityExecutionStatus valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • getNumber

      public final int getNumber()
      Specified by:
      getNumber in interface com.google.protobuf.Internal.EnumLite
      Specified by:
      getNumber in interface com.google.protobuf.ProtocolMessageEnum

    • valueOf

      @Deprecated public static ActivityExecutionStatus valueOf(int value)
      Deprecated.
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      value - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • forNumber

      public static ActivityExecutionStatus forNumber(int value)
      Parameters:
      value - The numeric wire value of the corresponding enum entry.
      Returns:
      The enum associated with the given numeric wire value.

    • internalGetValueMap

      public static com.google.protobuf.Internal.EnumLiteMap<ActivityExecutionStatus> internalGetValueMap()

    • getValueDescriptor

      public final com.google.protobuf.Descriptors.EnumValueDescriptor getValueDescriptor()
      Specified by:
      getValueDescriptor in interface com.google.protobuf.ProtocolMessageEnum

    • getDescriptorForType

      public final com.google.protobuf.Descriptors.EnumDescriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.ProtocolMessageEnum

    • getDescriptor

      public static final com.google.protobuf.Descriptors.EnumDescriptor getDescriptor()

    • valueOf

      public static ActivityExecutionStatus valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      desc - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null