Interface WorkflowExecutionCancelRequestedEventAttributes.Builder

All Superinterfaces:
Buildable, CopyableBuilder<WorkflowExecutionCancelRequestedEventAttributes.Builder,WorkflowExecutionCancelRequestedEventAttributes>, SdkBuilder<WorkflowExecutionCancelRequestedEventAttributes.Builder,WorkflowExecutionCancelRequestedEventAttributes>, SdkPojo
Enclosing class:
WorkflowExecutionCancelRequestedEventAttributes

public static interface WorkflowExecutionCancelRequestedEventAttributes.Builder extends SdkPojo, CopyableBuilder<WorkflowExecutionCancelRequestedEventAttributes.Builder,WorkflowExecutionCancelRequestedEventAttributes>
  • Method Details

    • externalWorkflowExecution

      WorkflowExecutionCancelRequestedEventAttributes.Builder externalWorkflowExecution(WorkflowExecution externalWorkflowExecution)

      The external workflow execution for which the cancellation was requested.

      Parameters:
      externalWorkflowExecution - The external workflow execution for which the cancellation was requested.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • externalWorkflowExecution

      default WorkflowExecutionCancelRequestedEventAttributes.Builder externalWorkflowExecution(Consumer<WorkflowExecution.Builder> externalWorkflowExecution)

      The external workflow execution for which the cancellation was requested.

      This is a convenience method that creates an instance of the WorkflowExecution.Builder avoiding the need to create one manually via WorkflowExecution.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to externalWorkflowExecution(WorkflowExecution).

      Parameters:
      externalWorkflowExecution - a consumer that will call methods on WorkflowExecution.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • externalInitiatedEventId

      WorkflowExecutionCancelRequestedEventAttributes.Builder externalInitiatedEventId(Long externalInitiatedEventId)

      The ID of the RequestCancelExternalWorkflowExecutionInitiated event corresponding to the RequestCancelExternalWorkflowExecution decision to cancel this workflow execution.The source event with this ID can be found in the history of the source workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

      Parameters:
      externalInitiatedEventId - The ID of the RequestCancelExternalWorkflowExecutionInitiated event corresponding to the RequestCancelExternalWorkflowExecution decision to cancel this workflow execution.The source event with this ID can be found in the history of the source workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • cause

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

      Parameters:
      causeValue - If set, indicates that the request to cancel the workflow execution was automatically generated, and specifies the cause. This happens if the parent workflow execution times out or is terminated, and the child policy is set to cancel child executions.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • cause

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

      Parameters:
      causeValue - If set, indicates that the request to cancel the workflow execution was automatically generated, and specifies the cause. This happens if the parent workflow execution times out or is terminated, and the child policy is set to cancel child executions.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: