Interface WorkflowExecutionCancelRequestedEventAttributes.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<WorkflowExecutionCancelRequestedEventAttributes.Builder,
,WorkflowExecutionCancelRequestedEventAttributes> SdkBuilder<WorkflowExecutionCancelRequestedEventAttributes.Builder,
,WorkflowExecutionCancelRequestedEventAttributes> SdkPojo
- Enclosing class:
WorkflowExecutionCancelRequestedEventAttributes
-
Method Summary
Modifier and TypeMethodDescriptionIf set, indicates that the request to cancel the workflow execution was automatically generated, and specifies the cause.cause
(WorkflowExecutionCancelRequestedCause causeValue) If set, indicates that the request to cancel the workflow execution was automatically generated, and specifies the cause.externalInitiatedEventId
(Long externalInitiatedEventId) The ID of theRequestCancelExternalWorkflowExecutionInitiated
event corresponding to theRequestCancelExternalWorkflowExecution
decision to cancel this workflow execution.The source event with this ID can be found in the history of the source workflow execution.externalWorkflowExecution
(Consumer<WorkflowExecution.Builder> externalWorkflowExecution) The external workflow execution for which the cancellation was requested.externalWorkflowExecution
(WorkflowExecution externalWorkflowExecution) The external workflow execution for which the cancellation was requested.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
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 theWorkflowExecution.Builder
avoiding the need to create one manually viaWorkflowExecution.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toexternalWorkflowExecution(WorkflowExecution)
.- Parameters:
externalWorkflowExecution
- a consumer that will call methods onWorkflowExecution.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 theRequestCancelExternalWorkflowExecution
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 theRequestCancelExternalWorkflowExecutionInitiated
event corresponding to theRequestCancelExternalWorkflowExecution
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
WorkflowExecutionCancelRequestedEventAttributes.Builder cause(WorkflowExecutionCancelRequestedCause 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.
- 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:
-