Interface WorkflowExecutionTerminatedEventAttributes.Builder

All Superinterfaces:
Buildable, CopyableBuilder<WorkflowExecutionTerminatedEventAttributes.Builder,WorkflowExecutionTerminatedEventAttributes>, SdkBuilder<WorkflowExecutionTerminatedEventAttributes.Builder,WorkflowExecutionTerminatedEventAttributes>, SdkPojo
Enclosing class:
WorkflowExecutionTerminatedEventAttributes
@Mutable @NotThreadSafe public static interface WorkflowExecutionTerminatedEventAttributes.Builder extends SdkPojo, CopyableBuilder<WorkflowExecutionTerminatedEventAttributes.Builder,WorkflowExecutionTerminatedEventAttributes>

  • Method Details

    • reason

      WorkflowExecutionTerminatedEventAttributes.Builder reason(String reason)

      The reason provided for the termination.

      Parameters:
      reason - The reason provided for the termination.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • details

      WorkflowExecutionTerminatedEventAttributes.Builder details(String details)

      The details provided for the termination.

      Parameters:
      details - The details provided for the termination.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • childPolicy

      WorkflowExecutionTerminatedEventAttributes.Builder childPolicy(String 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • childPolicy

      WorkflowExecutionTerminatedEventAttributes.Builder childPolicy(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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • cause

      WorkflowExecutionTerminatedEventAttributes.Builder cause(String causeValue)

      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.

      Parameters:
      causeValue - 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • cause

      WorkflowExecutionTerminatedEventAttributes.Builder cause(WorkflowExecutionTerminatedCause causeValue)

      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.

      Parameters:
      causeValue - 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: