Class TerminateWorkflowExecutionRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.swf.model.SwfRequest
software.amazon.awssdk.services.swf.model.TerminateWorkflowExecutionRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<TerminateWorkflowExecutionRequest.Builder,TerminateWorkflowExecutionRequest>
@Generated("software.amazon.awssdk:codegen") public final class TerminateWorkflowExecutionRequest extends SwfRequest implements ToCopyableBuilder<TerminateWorkflowExecutionRequest.Builder,TerminateWorkflowExecutionRequest>

  • Method Details

    • domain

      public final String domain()

      The domain of the workflow execution to terminate.

      Returns:
      The domain of the workflow execution to terminate.

    • workflowId

      public final String workflowId()

      The workflowId of the workflow execution to terminate.

      Returns:
      The workflowId of the workflow execution to terminate.

    • runId

      public final String runId()

      The runId of the workflow execution to terminate.

      Returns:
      The runId of the workflow execution to terminate.

    • reason

      public final String reason()

      A descriptive reason for terminating the workflow execution.

      Returns:
      A descriptive reason for terminating the workflow execution.

    • details

      public final String details()

      Details for terminating the workflow execution.

      Returns:
      Details for terminating the workflow execution.

    • childPolicy

      public final ChildPolicy childPolicy()

      If set, specifies the policy to use for the child workflow executions of the workflow execution being terminated. This policy overrides the child policy specified for the workflow execution at registration time or when starting the 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.

      A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault is returned.

      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:
      If set, specifies the policy to use for the child workflow executions of the workflow execution being terminated. This policy overrides the child policy specified for the workflow execution at registration time or when starting the 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.

      A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault is returned.

      See Also:

    • childPolicyAsString

      public final String childPolicyAsString()

      If set, specifies the policy to use for the child workflow executions of the workflow execution being terminated. This policy overrides the child policy specified for the workflow execution at registration time or when starting the 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.

      A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault is returned.

      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:
      If set, specifies the policy to use for the child workflow executions of the workflow execution being terminated. This policy overrides the child policy specified for the workflow execution at registration time or when starting the 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.

      A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault is returned.

      See Also:

    • toBuilder

      public TerminateWorkflowExecutionRequest.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<TerminateWorkflowExecutionRequest.Builder,TerminateWorkflowExecutionRequest>
      Specified by:
      toBuilder in class SwfRequest
      Returns:
      a builder for type T

    • builder

      public static TerminateWorkflowExecutionRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • 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.