Interface WorkflowExecutionStartedEventAttributes.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<WorkflowExecutionStartedEventAttributes.Builder,
,WorkflowExecutionStartedEventAttributes> SdkBuilder<WorkflowExecutionStartedEventAttributes.Builder,
,WorkflowExecutionStartedEventAttributes> SdkPojo
- Enclosing class:
WorkflowExecutionStartedEventAttributes
-
Method Summary
Modifier and TypeMethodDescriptionchildPolicy
(String 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.childPolicy
(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.continuedExecutionRunId
(String continuedExecutionRunId) If this workflow execution was started due to aContinueAsNewWorkflowExecution
decision, then it contains therunId
of the previous workflow execution that was closed and continued as this execution.executionStartToCloseTimeout
(String executionStartToCloseTimeout) The maximum duration for this workflow execution.The input provided to the workflow execution.lambdaRole
(String lambdaRole) The IAM role attached to the workflow execution.parentInitiatedEventId
(Long parentInitiatedEventId) The ID of theStartChildWorkflowExecutionInitiated
event corresponding to theStartChildWorkflowExecution
Decision to start this workflow execution.parentWorkflowExecution
(Consumer<WorkflowExecution.Builder> parentWorkflowExecution) The source workflow execution that started this workflow execution.parentWorkflowExecution
(WorkflowExecution parentWorkflowExecution) The source workflow execution that started this workflow execution.The list of tags associated with this workflow execution.tagList
(Collection<String> tagList) The list of tags associated with this workflow execution.taskList
(Consumer<TaskList.Builder> taskList) The name of the task list for scheduling the decision tasks for this workflow execution.The name of the task list for scheduling the decision tasks for this workflow execution.taskPriority
(String taskPriority) The priority of the decision tasks in the workflow execution.taskStartToCloseTimeout
(String taskStartToCloseTimeout) The maximum duration of decision tasks for this workflow type.workflowType
(Consumer<WorkflowType.Builder> workflowType) The workflow type of this execution.workflowType
(WorkflowType workflowType) The workflow type of this execution.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
input
The input provided to the workflow execution.
- Parameters:
input
- The input provided to the workflow execution.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
executionStartToCloseTimeout
WorkflowExecutionStartedEventAttributes.Builder executionStartToCloseTimeout(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 useNONE
to specify unlimited duration.- Parameters:
executionStartToCloseTimeout
- The maximum duration for this workflow execution.The duration is specified in seconds, an integer greater than or equal to
0
. You can useNONE
to specify unlimited duration.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
taskStartToCloseTimeout
WorkflowExecutionStartedEventAttributes.Builder taskStartToCloseTimeout(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 useNONE
to specify unlimited duration.- Parameters:
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 useNONE
to specify unlimited duration.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 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.
- Parameters:
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 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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
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 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.
- Parameters:
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 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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
taskList
The name of the task list for scheduling the decision tasks for this workflow execution.
- Parameters:
taskList
- The name of the task list for scheduling the decision tasks for this workflow execution.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
taskList
default WorkflowExecutionStartedEventAttributes.Builder taskList(Consumer<TaskList.Builder> taskList) The name of the task list for scheduling the decision tasks for this workflow execution.
This is a convenience method that creates an instance of theTaskList.Builder
avoiding the need to create one manually viaTaskList.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totaskList(TaskList)
.- Parameters:
taskList
- a consumer that will call methods onTaskList.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
taskPriority
The priority of the decision tasks in the workflow execution.
- Parameters:
taskPriority
- The priority of the decision tasks in the workflow execution.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
workflowType
The workflow type of this execution.
- Parameters:
workflowType
- The workflow type of this execution.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
workflowType
default WorkflowExecutionStartedEventAttributes.Builder workflowType(Consumer<WorkflowType.Builder> workflowType) The workflow type of this execution.
This is a convenience method that creates an instance of theWorkflowType.Builder
avoiding the need to create one manually viaWorkflowType.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toworkflowType(WorkflowType)
.- Parameters:
workflowType
- a consumer that will call methods onWorkflowType.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
tagList
The list of tags associated with this workflow execution. An execution can have up to 5 tags.
- Parameters:
tagList
- The list of tags associated with this workflow execution. An execution can have up to 5 tags.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tagList
The list of tags associated with this workflow execution. An execution can have up to 5 tags.
- Parameters:
tagList
- The list of tags associated with this workflow execution. An execution can have up to 5 tags.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
continuedExecutionRunId
WorkflowExecutionStartedEventAttributes.Builder continuedExecutionRunId(String continuedExecutionRunId) If this workflow execution was started due to a
ContinueAsNewWorkflowExecution
decision, then it contains therunId
of the previous workflow execution that was closed and continued as this execution.- Parameters:
continuedExecutionRunId
- If this workflow execution was started due to aContinueAsNewWorkflowExecution
decision, then it contains therunId
of the previous workflow execution that was closed and continued as this execution.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
parentWorkflowExecution
WorkflowExecutionStartedEventAttributes.Builder parentWorkflowExecution(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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
parentWorkflowExecution
default WorkflowExecutionStartedEventAttributes.Builder parentWorkflowExecution(Consumer<WorkflowExecution.Builder> 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.
This is a convenience method that creates an instance of theWorkflowExecution.Builder
avoiding the need to create one manually viaWorkflowExecution.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toparentWorkflowExecution(WorkflowExecution)
.- Parameters:
parentWorkflowExecution
- a consumer that will call methods onWorkflowExecution.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
parentInitiatedEventId
The ID of the
StartChildWorkflowExecutionInitiated
event corresponding to theStartChildWorkflowExecution
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.- Parameters:
parentInitiatedEventId
- The ID of theStartChildWorkflowExecutionInitiated
event corresponding to theStartChildWorkflowExecution
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:
- Returns a reference to this object so that method calls can be chained together.
-
lambdaRole
The IAM role attached to the workflow execution.
- Parameters:
lambdaRole
- The IAM role attached to the workflow execution.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-