Class WorkflowExecutionStartedEventAttributes
- All Implemented Interfaces:
Serializable
,Cloneable
Provides details of WorkflowExecutionStarted
event.
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
boolean
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.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.The maximum duration for this workflow execution.getInput()
The input provided to the workflow execution (if any).The IAM role attached to this workflow execution to use when invoking AWS Lambda functions.The ID of theStartChildWorkflowExecutionInitiated
event corresponding to theStartChildWorkflowExecution
decision to start this workflow execution.The source workflow execution that started this workflow execution.The list of tags associated with this workflow execution.The name of the task list for scheduling the decision tasks for this workflow execution.The maximum duration of decision tasks for this workflow type.The workflow type of this execution.int
hashCode()
void
setChildPolicy
(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.void
setChildPolicy
(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.void
setContinuedExecutionRunId
(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.void
setExecutionStartToCloseTimeout
(String executionStartToCloseTimeout) The maximum duration for this workflow execution.void
The input provided to the workflow execution (if any).void
setLambdaRole
(String lambdaRole) The IAM role attached to this workflow execution to use when invoking AWS Lambda functions.void
setParentInitiatedEventId
(Long parentInitiatedEventId) The ID of theStartChildWorkflowExecutionInitiated
event corresponding to theStartChildWorkflowExecution
decision to start this workflow execution.void
setParentWorkflowExecution
(WorkflowExecution parentWorkflowExecution) The source workflow execution that started this workflow execution.void
setTagList
(Collection<String> tagList) The list of tags associated with this workflow execution.void
setTaskList
(TaskList taskList) The name of the task list for scheduling the decision tasks for this workflow execution.void
setTaskPriority
(String taskPriority) void
setTaskStartToCloseTimeout
(String taskStartToCloseTimeout) The maximum duration of decision tasks for this workflow type.void
setWorkflowType
(WorkflowType workflowType) The workflow type of this execution.toString()
Returns a string representation of this object; useful for testing and debugging.withChildPolicy
(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.withChildPolicy
(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.withContinuedExecutionRunId
(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.withExecutionStartToCloseTimeout
(String executionStartToCloseTimeout) The maximum duration for this workflow execution.The input provided to the workflow execution (if any).withLambdaRole
(String lambdaRole) The IAM role attached to this workflow execution to use when invoking AWS Lambda functions.withParentInitiatedEventId
(Long parentInitiatedEventId) The ID of theStartChildWorkflowExecutionInitiated
event corresponding to theStartChildWorkflowExecution
decision to start this workflow execution.withParentWorkflowExecution
(WorkflowExecution parentWorkflowExecution) The source workflow execution that started this workflow execution.withTagList
(String... tagList) The list of tags associated with this workflow execution.withTagList
(Collection<String> tagList) The list of tags associated with this workflow execution.withTaskList
(TaskList taskList) The name of the task list for scheduling the decision tasks for this workflow execution.withTaskPriority
(String taskPriority) withTaskStartToCloseTimeout
(String taskStartToCloseTimeout) The maximum duration of decision tasks for this workflow type.withWorkflowType
(WorkflowType workflowType) The workflow type of this execution.
-
Constructor Details
-
WorkflowExecutionStartedEventAttributes
public WorkflowExecutionStartedEventAttributes()
-
-
Method Details
-
setInput
The input provided to the workflow execution (if any).
- Parameters:
input
- The input provided to the workflow execution (if any).
-
getInput
The input provided to the workflow execution (if any).
- Returns:
- The input provided to the workflow execution (if any).
-
withInput
The input provided to the workflow execution (if any).
- Parameters:
input
- The input provided to the workflow execution (if any).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setExecutionStartToCloseTimeout
The maximum duration 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.
- Parameters:
executionStartToCloseTimeout
- The maximum duration 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.
-
getExecutionStartToCloseTimeout
The maximum duration 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 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.
-
withExecutionStartToCloseTimeout
public WorkflowExecutionStartedEventAttributes withExecutionStartToCloseTimeout(String executionStartToCloseTimeout) The maximum duration 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.
- Parameters:
executionStartToCloseTimeout
- The maximum duration 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:
- Returns a reference to this object so that method calls can be chained together.
-
setTaskStartToCloseTimeout
The maximum duration of decision tasks for this workflow type.
The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used 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. The value "NONE" can be used to specify unlimited duration.
-
getTaskStartToCloseTimeout
The maximum duration of decision tasks for this workflow type.
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 of decision tasks for this workflow
type.
The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
-
withTaskStartToCloseTimeout
public WorkflowExecutionStartedEventAttributes withTaskStartToCloseTimeout(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. The value "NONE" can be used 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. The value "NONE" can be used to specify unlimited duration.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setChildPolicy
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 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.
- 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 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:
-
getChildPolicy
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 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
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 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:
-
withChildPolicy
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 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.
- 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 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:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
setChildPolicy
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 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.
- 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 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:
-
withChildPolicy
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 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.
- 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 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:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
setTaskList
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.
-
getTaskList
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.
-
withTaskList
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.
-
setWorkflowType
The workflow type of this execution.
- Parameters:
workflowType
- The workflow type of this execution.
-
getWorkflowType
The workflow type of this execution.
- Returns:
- The workflow type of this execution.
-
withWorkflowType
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.
-
getTagList
The list of tags associated with this workflow execution. An execution can have up to 5 tags.
- Returns:
- The list of tags associated with this workflow execution. An execution can have up to 5 tags.
-
setTagList
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.
-
withTagList
The list of tags associated with this workflow execution. An execution can have up to 5 tags.
NOTE: This method appends the values to the existing list (if any). Use
setTagList(java.util.Collection)
orwithTagList(java.util.Collection)
if you want to override the existing values.- 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.
-
withTagList
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.
-
setTaskPriority
- Parameters:
taskPriority
-
-
getTaskPriority
- Returns:
-
withTaskPriority
- Parameters:
taskPriority
-- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setContinuedExecutionRunId
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.
-
getContinuedExecutionRunId
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.- Returns:
- 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.
-
withContinuedExecutionRunId
public WorkflowExecutionStartedEventAttributes withContinuedExecutionRunId(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.
-
setParentWorkflowExecution
The source workflow execution that started this workflow execution. The member is not set if the workflow execution was not started by a workflow.
- Parameters:
parentWorkflowExecution
- The source workflow execution that started this workflow execution. The member is not set if the workflow execution was not started by a workflow.
-
getParentWorkflowExecution
The source workflow execution that started this workflow execution. The member is not set if the workflow execution was not started by a workflow.
- Returns:
- The source workflow execution that started this workflow execution. The member is not set if the workflow execution was not started by a workflow.
-
withParentWorkflowExecution
public WorkflowExecutionStartedEventAttributes withParentWorkflowExecution(WorkflowExecution parentWorkflowExecution) The source workflow execution that started this workflow execution. The member is not set if the workflow execution was not started by a workflow.
- Parameters:
parentWorkflowExecution
- The source workflow execution that started this workflow execution. The member is not 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.
-
setParentInitiatedEventId
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.
-
getParentInitiatedEventId
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.- Returns:
- 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.
-
withParentInitiatedEventId
public WorkflowExecutionStartedEventAttributes withParentInitiatedEventId(Long 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.
-
setLambdaRole
The IAM role attached to this workflow execution to use when invoking AWS Lambda functions.
- Parameters:
lambdaRole
- The IAM role attached to this workflow execution to use when invoking AWS Lambda functions.
-
getLambdaRole
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.
-
withLambdaRole
The IAM role attached to this workflow execution to use when invoking AWS Lambda functions.
- Parameters:
lambdaRole
- The IAM role attached to this workflow execution to use when invoking AWS Lambda functions.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
-