Class Decision
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Decision.Builder,
Decision>
Specifies a decision made by the decider. A decision can be one of these types:
-
CancelTimer
– Cancels a previously started timer and records aTimerCanceled
event in the history. -
CancelWorkflowExecution
– Closes the workflow execution and records aWorkflowExecutionCanceled
event in the history. -
CompleteWorkflowExecution
– Closes the workflow execution and records aWorkflowExecutionCompleted
event in the history . -
ContinueAsNewWorkflowExecution
– Closes the workflow execution and starts a new workflow execution of the same type using the same workflow ID and a unique run Id. AWorkflowExecutionContinuedAsNew
event is recorded in the history. -
FailWorkflowExecution
– Closes the workflow execution and records aWorkflowExecutionFailed
event in the history. -
RecordMarker
– Records aMarkerRecorded
event in the history. Markers can be used for adding custom information in the history for instance to let deciders know that they don't need to look at the history beyond the marker event. -
RequestCancelActivityTask
– Attempts to cancel a previously scheduled activity task. If the activity task was scheduled but has not been assigned to a worker, then it is canceled. If the activity task was already assigned to a worker, then the worker is informed that cancellation has been requested in the response to RecordActivityTaskHeartbeat. -
RequestCancelExternalWorkflowExecution
– Requests that a request be made to cancel the specified external workflow execution and records aRequestCancelExternalWorkflowExecutionInitiated
event in the history. -
ScheduleActivityTask
– Schedules an activity task. -
SignalExternalWorkflowExecution
– Requests a signal to be delivered to the specified external workflow execution and records aSignalExternalWorkflowExecutionInitiated
event in the history. -
StartChildWorkflowExecution
– Requests that a child workflow execution be started and records aStartChildWorkflowExecutionInitiated
event in the history. The child workflow execution is a separate workflow execution with its own history. -
StartTimer
– Starts a timer for this workflow execution and records aTimerStarted
event in the history. This timer fires after the specified delay and record aTimerFired
event.
Access Control
If you grant permission to use RespondDecisionTaskCompleted
, you can use IAM policies to express
permissions for the list of decisions returned by this action as if they were members of the API. Treating decisions
as a pseudo API maintains a uniform conceptual model and helps keep policies readable. For details and example IAM
policies, see Using IAM to
Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
Decision Failure
Decisions can fail for several reasons
-
The ordering of decisions should follow a logical flow. Some decisions might not make sense in the current context of the workflow execution and therefore fails.
-
A limit on your account was reached.
-
The decision lacks sufficient permissions.
One of the following events might be added to the history to indicate an error. The event attribute's
cause
parameter indicates the cause. If cause
is set to
OPERATION_NOT_PERMITTED
, the decision failed because it lacked sufficient permissions. For details and
example IAM policies, see Using IAM to Manage Access to
Amazon SWF Workflows in the Amazon SWF Developer Guide.
-
ScheduleActivityTaskFailed
– AScheduleActivityTask
decision failed. This could happen if the activity type specified in the decision isn't registered, is in a deprecated state, or the decision isn't properly configured. -
RequestCancelActivityTaskFailed
– ARequestCancelActivityTask
decision failed. This could happen if there is no open activity task with the specified activityId. -
StartTimerFailed
– AStartTimer
decision failed. This could happen if there is another open timer with the same timerId. -
CancelTimerFailed
– ACancelTimer
decision failed. This could happen if there is no open timer with the specified timerId. -
StartChildWorkflowExecutionFailed
– AStartChildWorkflowExecution
decision failed. This could happen if the workflow type specified isn't registered, is deprecated, or the decision isn't properly configured. -
SignalExternalWorkflowExecutionFailed
– ASignalExternalWorkflowExecution
decision failed. This could happen if theworkflowID
specified in the decision was incorrect. -
RequestCancelExternalWorkflowExecutionFailed
– ARequestCancelExternalWorkflowExecution
decision failed. This could happen if theworkflowID
specified in the decision was incorrect. -
CancelWorkflowExecutionFailed
– ACancelWorkflowExecution
decision failed. This could happen if there is an unhandled decision task pending in the workflow execution. -
CompleteWorkflowExecutionFailed
– ACompleteWorkflowExecution
decision failed. This could happen if there is an unhandled decision task pending in the workflow execution. -
ContinueAsNewWorkflowExecutionFailed
– AContinueAsNewWorkflowExecution
decision failed. This could happen if there is an unhandled decision task pending in the workflow execution or the ContinueAsNewWorkflowExecution decision was not configured correctly. -
FailWorkflowExecutionFailed
– AFailWorkflowExecution
decision failed. This could happen if there is an unhandled decision task pending in the workflow execution.
The preceding error events might occur due to an error in the decider logic, which might put the workflow execution in an unstable state The cause field in the event structure for the error event indicates the cause of the error.
A workflow execution may be closed by the decider by returning one of the following decisions when completing a
decision task: CompleteWorkflowExecution
, FailWorkflowExecution
,
CancelWorkflowExecution
and ContinueAsNewWorkflowExecution
. An
UnhandledDecision
fault is returned if a workflow closing decision is specified and a signal or activity
event had been added to the history while the decision task was being performed by the decider. Unlike the above
situations which are logic issues, this fault is always possible because of race conditions in a distributed system.
The right action here is to call RespondDecisionTaskCompleted without any decisions. This would result in
another decision task with these new events included in the history. The decider should handle the new events and may
decide to close the workflow execution.
How to Code a Decision
You code a decision by first setting the decision type field to one of the above decision values, and then set the corresponding attributes field shown below:
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic Decision.Builder
builder()
Provides the details of theCancelTimer
decision.Provides the details of theCancelWorkflowExecution
decision.Provides the details of theCompleteWorkflowExecution
decision.Provides the details of theContinueAsNewWorkflowExecution
decision.final DecisionType
Specifies the type of the decision.final String
Specifies the type of the decision.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.Provides the details of theFailWorkflowExecution
decision.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
Provides the details of theRecordMarker
decision.Provides the details of theRequestCancelActivityTask
decision.Provides the details of theRequestCancelExternalWorkflowExecution
decision.Provides the details of theScheduleActivityTask
decision.Provides the details of theScheduleLambdaFunction
decision.static Class
<? extends Decision.Builder> Provides the details of theSignalExternalWorkflowExecution
decision.Provides the details of theStartChildWorkflowExecution
decision.Provides the details of theStartTimer
decision.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
decisionType
Specifies the type of the decision.
If the service returns an enum value that is not available in the current SDK version,
decisionType
will returnDecisionType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdecisionTypeAsString()
.- Returns:
- Specifies the type of the decision.
- See Also:
-
decisionTypeAsString
Specifies the type of the decision.
If the service returns an enum value that is not available in the current SDK version,
decisionType
will returnDecisionType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdecisionTypeAsString()
.- Returns:
- Specifies the type of the decision.
- See Also:
-
scheduleActivityTaskDecisionAttributes
Provides the details of the
ScheduleActivityTask
decision. It isn't set for other decision types.- Returns:
- Provides the details of the
ScheduleActivityTask
decision. It isn't set for other decision types.
-
requestCancelActivityTaskDecisionAttributes
public final RequestCancelActivityTaskDecisionAttributes requestCancelActivityTaskDecisionAttributes()Provides the details of the
RequestCancelActivityTask
decision. It isn't set for other decision types.- Returns:
- Provides the details of the
RequestCancelActivityTask
decision. It isn't set for other decision types.
-
completeWorkflowExecutionDecisionAttributes
public final CompleteWorkflowExecutionDecisionAttributes completeWorkflowExecutionDecisionAttributes()Provides the details of the
CompleteWorkflowExecution
decision. It isn't set for other decision types.- Returns:
- Provides the details of the
CompleteWorkflowExecution
decision. It isn't set for other decision types.
-
failWorkflowExecutionDecisionAttributes
Provides the details of the
FailWorkflowExecution
decision. It isn't set for other decision types.- Returns:
- Provides the details of the
FailWorkflowExecution
decision. It isn't set for other decision types.
-
cancelWorkflowExecutionDecisionAttributes
Provides the details of the
CancelWorkflowExecution
decision. It isn't set for other decision types.- Returns:
- Provides the details of the
CancelWorkflowExecution
decision. It isn't set for other decision types.
-
continueAsNewWorkflowExecutionDecisionAttributes
public final ContinueAsNewWorkflowExecutionDecisionAttributes continueAsNewWorkflowExecutionDecisionAttributes()Provides the details of the
ContinueAsNewWorkflowExecution
decision. It isn't set for other decision types.- Returns:
- Provides the details of the
ContinueAsNewWorkflowExecution
decision. It isn't set for other decision types.
-
recordMarkerDecisionAttributes
Provides the details of the
RecordMarker
decision. It isn't set for other decision types.- Returns:
- Provides the details of the
RecordMarker
decision. It isn't set for other decision types.
-
startTimerDecisionAttributes
Provides the details of the
StartTimer
decision. It isn't set for other decision types.- Returns:
- Provides the details of the
StartTimer
decision. It isn't set for other decision types.
-
cancelTimerDecisionAttributes
Provides the details of the
CancelTimer
decision. It isn't set for other decision types.- Returns:
- Provides the details of the
CancelTimer
decision. It isn't set for other decision types.
-
signalExternalWorkflowExecutionDecisionAttributes
public final SignalExternalWorkflowExecutionDecisionAttributes signalExternalWorkflowExecutionDecisionAttributes()Provides the details of the
SignalExternalWorkflowExecution
decision. It isn't set for other decision types.- Returns:
- Provides the details of the
SignalExternalWorkflowExecution
decision. It isn't set for other decision types.
-
requestCancelExternalWorkflowExecutionDecisionAttributes
public final RequestCancelExternalWorkflowExecutionDecisionAttributes requestCancelExternalWorkflowExecutionDecisionAttributes()Provides the details of the
RequestCancelExternalWorkflowExecution
decision. It isn't set for other decision types.- Returns:
- Provides the details of the
RequestCancelExternalWorkflowExecution
decision. It isn't set for other decision types.
-
startChildWorkflowExecutionDecisionAttributes
public final StartChildWorkflowExecutionDecisionAttributes startChildWorkflowExecutionDecisionAttributes()Provides the details of the
StartChildWorkflowExecution
decision. It isn't set for other decision types.- Returns:
- Provides the details of the
StartChildWorkflowExecution
decision. It isn't set for other decision types.
-
scheduleLambdaFunctionDecisionAttributes
Provides the details of the
ScheduleLambdaFunction
decision. It isn't set for other decision types.- Returns:
- Provides the details of the
ScheduleLambdaFunction
decision. It isn't set for other decision types.
-
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 interfaceToCopyableBuilder<Decision.Builder,
Decision> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-