Class WorkflowExecutionTerminatedEventAttributes

java.lang.Object
software.amazon.awssdk.services.swf.model.WorkflowExecutionTerminatedEventAttributes
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<WorkflowExecutionTerminatedEventAttributes.Builder,WorkflowExecutionTerminatedEventAttributes>
@Generated("software.amazon.awssdk:codegen") public final class WorkflowExecutionTerminatedEventAttributes extends Object implements SdkPojo, Serializable, ToCopyableBuilder<WorkflowExecutionTerminatedEventAttributes.Builder,WorkflowExecutionTerminatedEventAttributes>

Provides the details of the WorkflowExecutionTerminated event.

See Also:

  • Method Details

    • reason

      public final String reason()

      The reason provided for the termination.

      Returns:
      The reason provided for the termination.

    • details

      public final String details()

      The details provided for the termination.

      Returns:
      The details provided for the termination.

    • childPolicy

      public final ChildPolicy childPolicy()

      The policy used for the child workflow executions of this workflow execution.

      The supported child policies are:

      • TERMINATE – The child executions are terminated.

      • REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.

      • ABANDON – No action is taken. The child executions continue to run.

      If the service returns an enum value that is not available in the current SDK version, childPolicy will return ChildPolicy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from childPolicyAsString().

      Returns:
      The policy used for the child workflow executions of this workflow execution.

      The supported child policies are:

      • TERMINATE – The child executions are terminated.

      • REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.

      • ABANDON – No action is taken. The child executions continue to run.

      See Also:

    • childPolicyAsString

      public final String childPolicyAsString()

      The policy used for the child workflow executions of this workflow execution.

      The supported child policies are:

      • TERMINATE – The child executions are terminated.

      • REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.

      • ABANDON – No action is taken. The child executions continue to run.

      If the service returns an enum value that is not available in the current SDK version, childPolicy will return ChildPolicy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from childPolicyAsString().

      Returns:
      The policy used for the child workflow executions of this workflow execution.

      The supported child policies are:

      • TERMINATE – The child executions are terminated.

      • REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.

      • ABANDON – No action is taken. The child executions continue to run.

      See Also:

    • cause

      public final WorkflowExecutionTerminatedCause cause()

      If set, indicates that the workflow execution was automatically terminated, and specifies the cause. This happens if the parent workflow execution times out or is terminated and the child policy is set to terminate child executions.

      If the service returns an enum value that is not available in the current SDK version, cause() will return WorkflowExecutionTerminatedCause.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from causeAsString().

      Returns:
      If set, indicates that the workflow execution was automatically terminated, and specifies the cause. This happens if the parent workflow execution times out or is terminated and the child policy is set to terminate child executions.
      See Also:

    • causeAsString

      public final String causeAsString()

      If set, indicates that the workflow execution was automatically terminated, and specifies the cause. This happens if the parent workflow execution times out or is terminated and the child policy is set to terminate child executions.

      If the service returns an enum value that is not available in the current SDK version, cause() will return WorkflowExecutionTerminatedCause.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from causeAsString().

      Returns:
      If set, indicates that the workflow execution was automatically terminated, and specifies the cause. This happens if the parent workflow execution times out or is terminated and the child policy is set to terminate child executions.
      See Also:

    • toBuilder

      public WorkflowExecutionTerminatedEventAttributes.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<WorkflowExecutionTerminatedEventAttributes.Builder,WorkflowExecutionTerminatedEventAttributes>
      Returns:
      a builder for type T

    • builder

      public static WorkflowExecutionTerminatedEventAttributes.Builder builder()

    • serializableBuilderClass

      public static Class<? extends WorkflowExecutionTerminatedEventAttributes.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.