software.amazon.awssdk.services.swf.model

Class StartChildWorkflowExecutionInitiatedEventAttributes

java.lang.Object

software.amazon.awssdk.services.swf.model.StartChildWorkflowExecutionInitiatedEventAttributes

All Implemented Interfaces:

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

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

Provides the details of the StartChildWorkflowExecutionInitiated event.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	StartChildWorkflowExecutionInitiatedEventAttributes.Builder

Method Summary

Modifier and Type	Method and Description
static StartChildWorkflowExecutionInitiatedEventAttributes.Builder	builder()
ChildPolicy	childPolicy() The policy to use for the child workflow executions if this execution gets terminated by explicitly calling the TerminateWorkflowExecution action or due to an expired timeout.
String	childPolicyAsString() The policy to use for the child workflow executions if this execution gets terminated by explicitly calling the TerminateWorkflowExecution action or due to an expired timeout.
String	control() Data attached to the event that can be used by the decider in subsequent decision tasks.
Long	decisionTaskCompletedEventId() The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the StartChildWorkflowExecution Decision to request this child workflow execution.
boolean	equals(Object obj)
String	executionStartToCloseTimeout() The maximum duration for the child workflow execution.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	input() The inputs provided to the child workflow execution.
String	lambdaRole() The IAM role to attach to the child workflow execution.
List<SdkField<?>>	sdkFields()
static Class<? extends StartChildWorkflowExecutionInitiatedEventAttributes.Builder>	serializableBuilderClass()
List<String>	tagList() The list of tags to associated with the child workflow execution.
TaskList	taskList() The name of the task list used for the decision tasks of the child workflow execution.
String	taskPriority() The priority assigned for the decision tasks for this workflow execution.
String	taskStartToCloseTimeout() The maximum duration allowed for the decision tasks for this workflow execution.
StartChildWorkflowExecutionInitiatedEventAttributes.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
String	workflowId() The workflowId of the child workflow execution.
WorkflowType	workflowType() The type of the child workflow 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

workflowId

public String workflowId()

The workflowId of the child workflow execution.

Returns:

The workflowId of the child workflow execution.

workflowType

public WorkflowType workflowType()

The type of the child workflow execution.

Returns:

The type of the child workflow execution.

control

public String control()

Data attached to the event that can be used by the decider in subsequent decision tasks. This data isn't sent to the activity.

Returns:

Data attached to the event that can be used by the decider in subsequent decision tasks. This data isn't sent to the activity.

input

public String input()

The inputs provided to the child workflow execution.

Returns:

The inputs provided to the child workflow execution.

executionStartToCloseTimeout

public String executionStartToCloseTimeout()

The maximum duration for the child workflow execution. If the workflow execution isn't closed within this duration, it is timed out and force-terminated.

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 the child workflow execution. If the workflow execution isn't closed within this duration, it is timed out and force-terminated.

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

taskList

public TaskList taskList()

The name of the task list used for the decision tasks of the child workflow execution.

Returns:

The name of the task list used for the decision tasks of the child workflow execution.

taskPriority

public String taskPriority()

The priority assigned for the decision tasks for this workflow execution. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.

Returns:

The priority assigned for the decision tasks for this workflow execution. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.

decisionTaskCompletedEventId

public Long decisionTaskCompletedEventId()

The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the StartChildWorkflowExecution Decision to request this child workflow execution. This information can be useful for diagnosing problems by tracing back the cause of events.

Returns:

The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the StartChildWorkflowExecution Decision to request this child workflow execution. This information can be useful for diagnosing problems by tracing back the cause of events.

childPolicy

public ChildPolicy childPolicy()

The policy to use for the child workflow executions if this execution gets terminated by explicitly calling the TerminateWorkflowExecution action 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 execution gets terminated by explicitly calling the TerminateWorkflowExecution action 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 execution gets terminated by explicitly calling the TerminateWorkflowExecution action 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 execution gets terminated by explicitly calling the TerminateWorkflowExecution action 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

taskStartToCloseTimeout

public String taskStartToCloseTimeout()

The maximum duration allowed for the decision tasks 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 allowed for the decision tasks 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.

tagList

public List<String> tagList()

The list of tags to associated with the child workflow execution.

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

Returns:

The list of tags to associated with the child workflow execution.

lambdaRole

public String lambdaRole()

The IAM role to attach to the child workflow execution.

Returns:

The IAM role to attach to the child workflow execution.

toBuilder

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

Returns:

a builder for type T

builder

public static StartChildWorkflowExecutionInitiatedEventAttributes.Builder builder()

serializableBuilderClass

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