Class StartChildWorkflowExecutionInitiatedEventAttributes
- java.lang.Object
-
- software.amazon.awssdk.services.swf.model.StartChildWorkflowExecutionInitiatedEventAttributes
-
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<StartChildWorkflowExecutionInitiatedEventAttributes.Builder,StartChildWorkflowExecutionInitiatedEventAttributes>
@Generated("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 Description static interface
StartChildWorkflowExecutionInitiatedEventAttributes.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method 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 theDecisionTaskCompleted
event corresponding to the decision task that resulted in theStartChildWorkflowExecution
Decision to request this child workflow execution.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
String
executionStartToCloseTimeout()
The maximum duration for the child workflow execution.<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
boolean
hasTagList()
For responses, this returns true if the service returned a value for the TagList property.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()
String
toString()
Returns a string representation of this object.String
workflowId()
TheworkflowId
of the child workflow execution.WorkflowType
workflowType()
The type of the child workflow execution.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
workflowId
public final String workflowId()
The
workflowId
of the child workflow execution.- Returns:
- The
workflowId
of the child workflow execution.
-
workflowType
public final WorkflowType workflowType()
The type of the child workflow execution.
- Returns:
- The type of the child workflow execution.
-
control
public final 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 final String input()
The inputs provided to the child workflow execution.
- Returns:
- The inputs provided to the child workflow execution.
-
executionStartToCloseTimeout
public final 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 useNONE
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 useNONE
to specify unlimited duration.
-
taskList
public final 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 final 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) toInteger.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) toInteger.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 final 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.- 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.
-
childPolicy
public final 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 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.
If the service returns an enum value that is not available in the current SDK version,
childPolicy
will returnChildPolicy.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromchildPolicyAsString()
.- 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 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.
-
- See Also:
ChildPolicy
-
-
childPolicyAsString
public final 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 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.
If the service returns an enum value that is not available in the current SDK version,
childPolicy
will returnChildPolicy.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromchildPolicyAsString()
.- 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 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.
-
- See Also:
ChildPolicy
-
-
taskStartToCloseTimeout
public final 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 useNONE
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 useNONE
to specify unlimited duration.
-
hasTagList
public final boolean hasTagList()
For responses, this returns true if the service returned a value for the TagList property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
tagList
public final 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.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasTagList()
method.- Returns:
- The list of tags to associated with the child workflow execution.
-
lambdaRole
public final 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()
-
builder
public static StartChildWorkflowExecutionInitiatedEventAttributes.Builder builder()
-
serializableBuilderClass
public static Class<? extends StartChildWorkflowExecutionInitiatedEventAttributes.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
toString
public final String toString()
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
-
-