Package software.amazon.awssdk.services.swf.model

Class StartChildWorkflowExecutionInitiatedEventAttributes

java.lang.Object

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

All Implemented Interfaces:

StructuredPojo, ToCopyableBuilder<StartChildWorkflowExecutionInitiatedEventAttributes.Builder,StartChildWorkflowExecutionInitiatedEventAttributes>

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

Provides details of the StartChildWorkflowExecutionInitiated event.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	StartChildWorkflowExecutionInitiatedEventAttributes.Builder

Method Summary

Modifier and Type	Method	Description
static StartChildWorkflowExecutionInitiatedEventAttributes.Builder	builder()
String	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	control()	Optional. 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.
int	hashCode()
String	input()	The inputs provided to the child workflow execution (if any).
String	lambdaRole()	The IAM role attached to this workflow execution to use when invoking AWS Lambda functions.
void	marshall(ProtocolMarshaller protocolMarshaller)	Marshalls this structured data using the given ProtocolMarshaller.
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()	Optional. 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

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

Optional. Data attached to the event that can be used by the decider in subsequent decision tasks. This data is not sent to the activity.

Returns:

Optional.

input

public String input()

The inputs provided to the child workflow execution (if any).

Returns:

The inputs provided to the child workflow execution (if any).

executionStartToCloseTimeout

public String executionStartToCloseTimeout()

The maximum duration for the child workflow execution. If the workflow execution is not closed within this duration, it will be timed out and force terminated.

The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.

Returns:

The maximum duration for the child workflow execution. If the workflow execution is not closed within this duration, it will be timed out and force terminated.

The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used 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()

Optional. 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 Simple Workflow Developer Guide.

Returns:

Optional. 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 Simple Workflow 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 String 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 will be terminated.
• REQUEST_CANCEL: a request to cancel will be 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 will be taken. The child executions will continue to run.

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 will be terminated.
• REQUEST_CANCEL: a request to cancel will be 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 will be taken. The child executions will 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. The value "NONE" can be used 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. The value "NONE" can be used to specify unlimited duration.

tagList

public List<String> tagList()

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

Returns:

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

lambdaRole

public String lambdaRole()

The IAM role attached to this workflow execution to use when invoking AWS Lambda functions.

Returns:

The IAM role attached to this workflow execution to use when invoking AWS Lambda functions.

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

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.