Package software.amazon.awssdk.services.swf.model

Interface TerminateWorkflowExecutionRequest.Builder

    • Method Detail

      • domain

        TerminateWorkflowExecutionRequest.Builder domain​(String domain)

        The domain of the workflow execution to terminate.

        Parameters:
        domain - The domain of the workflow execution to terminate.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • workflowId

        TerminateWorkflowExecutionRequest.Builder workflowId​(String workflowId)

        The workflowId of the workflow execution to terminate.

        Parameters:
        workflowId - The workflowId of the workflow execution to terminate.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • runId

        TerminateWorkflowExecutionRequest.Builder runId​(String runId)

        The runId of the workflow execution to terminate.

        Parameters:
        runId - The runId of the workflow execution to terminate.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • reason

        TerminateWorkflowExecutionRequest.Builder reason​(String reason)

        A descriptive reason for terminating the workflow execution.

        Parameters:
        reason - A descriptive reason for terminating the workflow execution.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • details

        TerminateWorkflowExecutionRequest.Builder details​(String details)

        Details for terminating the workflow execution.

        Parameters:
        details - Details for terminating the workflow execution.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • childPolicy

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

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

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

      • childPolicy

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

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

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