software.amazon.awssdk.services.swf.model

Class WorkflowExecutionStartedEventAttributes

java.lang.Object

software.amazon.awssdk.services.swf.model.WorkflowExecutionStartedEventAttributes

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<WorkflowExecutionStartedEventAttributes.Builder,WorkflowExecutionStartedEventAttributes>

@Generated(value="software.amazon.awssdk:codegen")
public final class WorkflowExecutionStartedEventAttributes
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<WorkflowExecutionStartedEventAttributes.Builder,WorkflowExecutionStartedEventAttributes>

Provides details of WorkflowExecutionStarted event.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	WorkflowExecutionStartedEventAttributes.Builder

Method Summary

Modifier and Type	Method and Description
static WorkflowExecutionStartedEventAttributes.Builder	builder()
ChildPolicy	childPolicy() The policy to use for the child workflow executions if this workflow execution is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout.
String	childPolicyAsString() The policy to use for the child workflow executions if this workflow execution is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout.
String	continuedExecutionRunId() If this workflow execution was started due to a ContinueAsNewWorkflowExecution decision, then it contains the runId of the previous workflow execution that was closed and continued as this execution.
boolean	equals(Object obj)
String	executionStartToCloseTimeout() The maximum duration for this workflow execution.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	input() The input provided to the workflow execution.
String	lambdaRole() The IAM role attached to the workflow execution.
Long	parentInitiatedEventId() The ID of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution Decision to start this workflow execution.
WorkflowExecution	parentWorkflowExecution() The source workflow execution that started this workflow execution.
List<SdkField<?>>	sdkFields()
static Class<? extends WorkflowExecutionStartedEventAttributes.Builder>	serializableBuilderClass()
List<String>	tagList() The list of tags associated with this workflow execution.
TaskList	taskList() The name of the task list for scheduling the decision tasks for this workflow execution.
String	taskPriority() The priority of the decision tasks in the workflow execution.
String	taskStartToCloseTimeout() The maximum duration of decision tasks for this workflow type.
WorkflowExecutionStartedEventAttributes.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
WorkflowType	workflowType() The workflow type of this execution.

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

input

public String input()

The input provided to the workflow execution.

Returns:

The input provided to the workflow execution.

executionStartToCloseTimeout

public String executionStartToCloseTimeout()

The maximum duration for this workflow execution.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

Returns:

The maximum duration for this workflow execution.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

taskStartToCloseTimeout

public String taskStartToCloseTimeout()

The maximum duration of decision tasks for this workflow type.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

Returns:

The maximum duration of decision tasks for this workflow type.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

childPolicy

public ChildPolicy childPolicy()

The policy to use for the child workflow executions if this workflow execution is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout.

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 to use for the child workflow executions if this workflow execution is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout.

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 to use for the child workflow executions if this workflow execution is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout.

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 to use for the child workflow executions if this workflow execution is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout.

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

taskList

public TaskList taskList()

The name of the task list for scheduling the decision tasks for this workflow execution.

Returns:

The name of the task list for scheduling the decision tasks for this workflow execution.

taskPriority

public String taskPriority()

The priority of the decision tasks in the workflow execution.

Returns:

The priority of the decision tasks in the workflow execution.

workflowType

public WorkflowType workflowType()

The workflow type of this execution.

Returns:

The workflow type of this execution.

tagList

public List<String> tagList()

The list of tags associated with this workflow execution. An execution can have up to 5 tags.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

The list of tags associated with this workflow execution. An execution can have up to 5 tags.

continuedExecutionRunId

public String continuedExecutionRunId()

If this workflow execution was started due to a ContinueAsNewWorkflowExecution decision, then it contains the runId of the previous workflow execution that was closed and continued as this execution.

Returns:

If this workflow execution was started due to a ContinueAsNewWorkflowExecution decision, then it contains the runId of the previous workflow execution that was closed and continued as this execution.

parentWorkflowExecution

public WorkflowExecution parentWorkflowExecution()

The source workflow execution that started this workflow execution. The member isn't set if the workflow execution was not started by a workflow.

Returns:

The source workflow execution that started this workflow execution. The member isn't set if the workflow execution was not started by a workflow.

parentInitiatedEventId

public Long parentInitiatedEventId()

The ID of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution Decision to start 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:

The ID of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution Decision to start 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.

lambdaRole

public String lambdaRole()

The IAM role attached to the workflow execution.

Returns:

The IAM role attached to the workflow execution.

toBuilder

public WorkflowExecutionStartedEventAttributes.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<WorkflowExecutionStartedEventAttributes.Builder,WorkflowExecutionStartedEventAttributes>

Returns:

a builder for type T

builder

public static WorkflowExecutionStartedEventAttributes.Builder builder()

serializableBuilderClass

public static Class<? extends WorkflowExecutionStartedEventAttributes.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)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.