Class StartChildWorkflowExecutionInitiatedEventAttributes
- All Implemented Interfaces:
Serializable
,Cloneable
Provides details of the StartChildWorkflowExecutionInitiated
event.
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
boolean
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.Optional. Data attached to the event that can be used by the decider in subsequent decision tasks.The ID of theDecisionTaskCompleted
event corresponding to the decision task that resulted in theStartChildWorkflowExecution
decision to request this child workflow execution.The maximum duration for the child workflow execution.getInput()
The inputs provided to the child workflow execution (if any).The IAM role attached to this workflow execution to use when invoking AWS Lambda functions.The list of tags to associated with the child workflow execution.The name of the task list used for the decision tasks of the child workflow execution.Optional. The priority assigned for the decision tasks for this workflow execution.The maximum duration allowed for the decision tasks for this workflow execution.TheworkflowId
of the child workflow execution.The type of the child workflow execution.int
hashCode()
void
setChildPolicy
(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.void
setChildPolicy
(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.void
setControl
(String control) Optional. Data attached to the event that can be used by the decider in subsequent decision tasks.void
setDecisionTaskCompletedEventId
(Long decisionTaskCompletedEventId) The ID of theDecisionTaskCompleted
event corresponding to the decision task that resulted in theStartChildWorkflowExecution
decision to request this child workflow execution.void
setExecutionStartToCloseTimeout
(String executionStartToCloseTimeout) The maximum duration for the child workflow execution.void
The inputs provided to the child workflow execution (if any).void
setLambdaRole
(String lambdaRole) The IAM role attached to this workflow execution to use when invoking AWS Lambda functions.void
setTagList
(Collection<String> tagList) The list of tags to associated with the child workflow execution.void
setTaskList
(TaskList taskList) The name of the task list used for the decision tasks of the child workflow execution.void
setTaskPriority
(String taskPriority) Optional. The priority assigned for the decision tasks for this workflow execution.void
setTaskStartToCloseTimeout
(String taskStartToCloseTimeout) The maximum duration allowed for the decision tasks for this workflow execution.void
setWorkflowId
(String workflowId) TheworkflowId
of the child workflow execution.void
setWorkflowType
(WorkflowType workflowType) The type of the child workflow 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 execution gets terminated by explicitly calling the TerminateWorkflowExecution action or due to an expired timeout.withChildPolicy
(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.withControl
(String control) Optional. Data attached to the event that can be used by the decider in subsequent decision tasks.withDecisionTaskCompletedEventId
(Long decisionTaskCompletedEventId) The ID of theDecisionTaskCompleted
event corresponding to the decision task that resulted in theStartChildWorkflowExecution
decision to request this child workflow execution.withExecutionStartToCloseTimeout
(String executionStartToCloseTimeout) The maximum duration for the child workflow execution.The inputs provided to the child workflow execution (if any).withLambdaRole
(String lambdaRole) The IAM role attached to this workflow execution to use when invoking AWS Lambda functions.withTagList
(String... tagList) The list of tags to associated with the child workflow execution.withTagList
(Collection<String> tagList) The list of tags to associated with the child workflow execution.withTaskList
(TaskList taskList) The name of the task list used for the decision tasks of the child workflow execution.withTaskPriority
(String taskPriority) Optional. The priority assigned for the decision tasks for this workflow execution.withTaskStartToCloseTimeout
(String taskStartToCloseTimeout) The maximum duration allowed for the decision tasks for this workflow execution.withWorkflowId
(String workflowId) TheworkflowId
of the child workflow execution.withWorkflowType
(WorkflowType workflowType) The type of the child workflow execution.
-
Constructor Details
-
StartChildWorkflowExecutionInitiatedEventAttributes
public StartChildWorkflowExecutionInitiatedEventAttributes()
-
-
Method Details
-
setWorkflowId
The
workflowId
of the child workflow execution.- Parameters:
workflowId
- TheworkflowId
of the child workflow execution.
-
getWorkflowId
The
workflowId
of the child workflow execution.- Returns:
- The
workflowId
of the child workflow execution.
-
withWorkflowId
The
workflowId
of the child workflow execution.- Parameters:
workflowId
- TheworkflowId
of the child workflow execution.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setWorkflowType
The type of the child workflow execution.
- Parameters:
workflowType
- The type of the child workflow execution.
-
getWorkflowType
The type of the child workflow execution.
- Returns:
- The type of the child workflow execution.
-
withWorkflowType
public StartChildWorkflowExecutionInitiatedEventAttributes withWorkflowType(WorkflowType workflowType) The type of the child workflow execution.
- Parameters:
workflowType
- The type of the child workflow execution.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setControl
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.
- Parameters:
control
- Optional.
-
getControl
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.
-
withControl
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.
- Parameters:
control
- Optional.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setInput
The inputs provided to the child workflow execution (if any).
- Parameters:
input
- The inputs provided to the child workflow execution (if any).
-
getInput
The inputs provided to the child workflow execution (if any).
- Returns:
- The inputs provided to the child workflow execution (if any).
-
withInput
The inputs provided to the child workflow execution (if any).
- Parameters:
input
- The inputs provided to the child workflow execution (if any).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setExecutionStartToCloseTimeout
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.
- Parameters:
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.
-
getExecutionStartToCloseTimeout
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.
-
withExecutionStartToCloseTimeout
public StartChildWorkflowExecutionInitiatedEventAttributes withExecutionStartToCloseTimeout(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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
setTaskList
The name of the task list used for the decision tasks of the child workflow execution.
- Parameters:
taskList
- The name of the task list used for the decision tasks of the child workflow execution.
-
getTaskList
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.
-
withTaskList
The name of the task list used for the decision tasks of the child workflow execution.
- Parameters:
taskList
- The name of the task list used for the decision tasks of the child workflow execution.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setTaskPriority
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) toInteger.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.
- Parameters:
taskPriority
- Optional. The priority assigned for the decision tasks for this workflow execution. Valid values are integers that range from Java'sInteger.MIN_VALUE
(-2147483648) toInteger.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
-
getTaskPriority
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) toInteger.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) toInteger.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
-
withTaskPriority
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) toInteger.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.
- Parameters:
taskPriority
- Optional. The priority assigned for the decision tasks for this workflow execution. Valid values are integers that range from Java'sInteger.MIN_VALUE
(-2147483648) toInteger.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:
- Returns a reference to this object so that method calls can be chained together.
-
setDecisionTaskCompletedEventId
The ID of the
DecisionTaskCompleted
event corresponding to the decision task that resulted in theStartChildWorkflowExecution
decision to request this child workflow execution. This information can be useful for diagnosing problems by tracing back the cause of events.- Parameters:
decisionTaskCompletedEventId
- The ID of theDecisionTaskCompleted
event corresponding to the decision task that resulted in theStartChildWorkflowExecution
decision to request this child workflow execution. This information can be useful for diagnosing problems by tracing back the cause of events.
-
getDecisionTaskCompletedEventId
The ID of the
DecisionTaskCompleted
event corresponding to the decision task that resulted in theStartChildWorkflowExecution
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 theStartChildWorkflowExecution
decision to request this child workflow execution. This information can be useful for diagnosing problems by tracing back the cause of events.
-
withDecisionTaskCompletedEventId
public StartChildWorkflowExecutionInitiatedEventAttributes withDecisionTaskCompletedEventId(Long decisionTaskCompletedEventId) The ID of the
DecisionTaskCompleted
event corresponding to the decision task that resulted in theStartChildWorkflowExecution
decision to request this child workflow execution. This information can be useful for diagnosing problems by tracing back the cause of events.- Parameters:
decisionTaskCompletedEventId
- The ID of theDecisionTaskCompleted
event corresponding to the decision task that resulted in theStartChildWorkflowExecution
decision to request this child workflow execution. This information can be useful for diagnosing problems by tracing back the cause of events.- 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 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.
- Parameters:
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.
- See Also:
-
getChildPolicy
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:
-
withChildPolicy
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.
- Parameters:
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:
- 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 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.
- Parameters:
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.
- See Also:
-
withChildPolicy
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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
setTaskStartToCloseTimeout
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.
- Parameters:
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.
-
getTaskStartToCloseTimeout
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.
-
withTaskStartToCloseTimeout
public StartChildWorkflowExecutionInitiatedEventAttributes withTaskStartToCloseTimeout(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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
getTagList
The list of tags to associated with the child workflow execution.
- Returns:
- The list of tags to associated with the child workflow execution.
-
setTagList
The list of tags to associated with the child workflow execution.
- Parameters:
tagList
- The list of tags to associated with the child workflow execution.
-
withTagList
The list of tags to associated with the child workflow execution.
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 to associated with the child workflow execution.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withTagList
The list of tags to associated with the child workflow execution.
- Parameters:
tagList
- The list of tags to associated with the child workflow execution.- 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
-