Class WorkflowExecutionTerminatedEventAttributes
- java.lang.Object
-
- software.amazon.awssdk.services.swf.model.WorkflowExecutionTerminatedEventAttributes
-
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<WorkflowExecutionTerminatedEventAttributes.Builder,WorkflowExecutionTerminatedEventAttributes>
@Generated("software.amazon.awssdk:codegen") public final class WorkflowExecutionTerminatedEventAttributes extends Object implements SdkPojo, Serializable, ToCopyableBuilder<WorkflowExecutionTerminatedEventAttributes.Builder,WorkflowExecutionTerminatedEventAttributes>
Provides the details of the
WorkflowExecutionTerminated
event.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
WorkflowExecutionTerminatedEventAttributes.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static WorkflowExecutionTerminatedEventAttributes.Builder
builder()
WorkflowExecutionTerminatedCause
cause()
If set, indicates that the workflow execution was automatically terminated, and specifies the cause.String
causeAsString()
If set, indicates that the workflow execution was automatically terminated, and specifies the cause.ChildPolicy
childPolicy()
The policy used for the child workflow executions of this workflow execution.String
childPolicyAsString()
The policy used for the child workflow executions of this workflow execution.String
details()
The details provided for the termination.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
String
reason()
The reason provided for the termination.Map<String,SdkField<?>>
sdkFieldNameToField()
List<SdkField<?>>
sdkFields()
static Class<? extends WorkflowExecutionTerminatedEventAttributes.Builder>
serializableBuilderClass()
WorkflowExecutionTerminatedEventAttributes.Builder
toBuilder()
String
toString()
Returns a string representation of this object.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
reason
public final String reason()
The reason provided for the termination.
- Returns:
- The reason provided for the termination.
-
details
public final String details()
The details provided for the termination.
- Returns:
- The details provided for the termination.
-
childPolicy
public final 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 aWorkflowExecutionCancelRequested
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.
If the service returns an enum value that is not available in the current SDK version,
childPolicy
will returnChildPolicy.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromchildPolicyAsString()
.- Returns:
- 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 aWorkflowExecutionCancelRequested
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.
-
- See Also:
ChildPolicy
-
-
childPolicyAsString
public final String childPolicyAsString()
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 aWorkflowExecutionCancelRequested
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.
If the service returns an enum value that is not available in the current SDK version,
childPolicy
will returnChildPolicy.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromchildPolicyAsString()
.- Returns:
- 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 aWorkflowExecutionCancelRequested
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.
-
- See Also:
ChildPolicy
-
-
cause
public final WorkflowExecutionTerminatedCause cause()
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.
If the service returns an enum value that is not available in the current SDK version,
cause()
will returnWorkflowExecutionTerminatedCause.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcauseAsString()
.- Returns:
- 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.
- See Also:
WorkflowExecutionTerminatedCause
-
causeAsString
public final String causeAsString()
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.
If the service returns an enum value that is not available in the current SDK version,
cause()
will returnWorkflowExecutionTerminatedCause.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcauseAsString()
.- Returns:
- 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.
- See Also:
WorkflowExecutionTerminatedCause
-
toBuilder
public WorkflowExecutionTerminatedEventAttributes.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<WorkflowExecutionTerminatedEventAttributes.Builder,WorkflowExecutionTerminatedEventAttributes>
-
builder
public static WorkflowExecutionTerminatedEventAttributes.Builder builder()
-
serializableBuilderClass
public static Class<? extends WorkflowExecutionTerminatedEventAttributes.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
toString
public final String 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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
-
-