software.amazon.awssdk.services.swf.model

Class WorkflowExecutionTerminatedEventAttributes

java.lang.Object

software.amazon.awssdk.services.swf.model.WorkflowExecutionTerminatedEventAttributes

All Implemented Interfaces:

StructuredPojo, ToCopyableBuilder<WorkflowExecutionTerminatedEventAttributes.Builder,WorkflowExecutionTerminatedEventAttributes>

@Generated(value="software.amazon.awssdk:codegen")
public class WorkflowExecutionTerminatedEventAttributes
extends Object
implements StructuredPojo, ToCopyableBuilder<WorkflowExecutionTerminatedEventAttributes.Builder,WorkflowExecutionTerminatedEventAttributes>

Provides the details of the WorkflowExecutionTerminated event.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	WorkflowExecutionTerminatedEventAttributes.Builder

Method Summary

Modifier and Type	Method and 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)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
String	reason() The reason provided for the termination.
static Class<? extends WorkflowExecutionTerminatedEventAttributes.Builder>	serializableBuilderClass()
WorkflowExecutionTerminatedEventAttributes.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

reason

public String reason()

The reason provided for the termination.

Returns:

The reason provided for the termination.

details

public String details()

The details provided for the termination.

Returns:

The details provided for the termination.

childPolicy

public 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 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.

If the service returns an enum value that is not available in the current SDK version, childPolicy will return ChildPolicy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from childPolicyAsString().

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

See Also:

ChildPolicy

childPolicyAsString

public 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 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.

If the service returns an enum value that is not available in the current SDK version, childPolicy will return ChildPolicy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from childPolicyAsString().

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

See Also:

ChildPolicy

cause

public 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 return WorkflowExecutionTerminatedCause.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from causeAsString().

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 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 return WorkflowExecutionTerminatedCause.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from causeAsString().

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()

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 interface ToCopyableBuilder<WorkflowExecutionTerminatedEventAttributes.Builder,WorkflowExecutionTerminatedEventAttributes>

Returns:

a builder for type T

builder

public static WorkflowExecutionTerminatedEventAttributes.Builder builder()

serializableBuilderClass

public static Class<? extends WorkflowExecutionTerminatedEventAttributes.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.