java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.swf.model.SwfRequest
    - - software.amazon.awssdk.services.swf.model.StartWorkflowExecutionRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<StartWorkflowExecutionRequest.Builder,StartWorkflowExecutionRequest>

@Generated("software.amazon.awssdk:codegen")
public final class StartWorkflowExecutionRequest
extends SwfRequest
implements ToCopyableBuilder<StartWorkflowExecutionRequest.Builder,StartWorkflowExecutionRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface StartWorkflowExecutionRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static StartWorkflowExecutionRequest.Builder`	`builder()`
`ChildPolicy`	`childPolicy()`	If set, specifies the policy to use for the child workflow executions of this workflow execution if it is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout.
`String`	`childPolicyAsString()`	If set, specifies the policy to use for the child workflow executions of this workflow execution if it is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout.
`String`	`domain()`	The name of the domain in which the workflow execution is created.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`executionStartToCloseTimeout()`	The total duration for this 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 input for the workflow execution.
`String`	`lambdaRole()`	The IAM role to attach to this workflow execution.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends StartWorkflowExecutionRequest.Builder>`	`serializableBuilderClass()`
`List<String>`	`tagList()`	The list of tags to associate with the workflow execution.
`TaskList`	`taskList()`	The task list to use for the decision tasks generated for this workflow execution.
`String`	`taskPriority()`	The task priority to use for this workflow execution.
`String`	`taskStartToCloseTimeout()`	Specifies the maximum duration of decision tasks for this workflow execution.
`StartWorkflowExecutionRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`String`	`workflowId()`	The user defined identifier associated with the workflow execution.
`WorkflowType`	`workflowType()`	The type of the workflow to start.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

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
  - domain
```
public final String domain()
```
    The name of the domain in which the workflow execution is created.
    
    The specified string must not contain a : (colon), / (slash), | (vertical bar), or any control characters (- | -). Also, it must not be the literal string arn.
    
    Returns:
    
    The name of the domain in which the workflow execution is created.
    
    The specified string must not contain a : (colon), / (slash), | (vertical bar), or any control characters (- | -). Also, it must not be the literal string arn.
  - workflowId
```
public final String workflowId()
```
    The user defined identifier associated with the workflow execution. You can use this to associate a custom identifier with the workflow execution. You may specify the same identifier if a workflow execution is logically a restart of a previous execution. You cannot have two open workflow executions with the same workflowId at the same time within the same domain.
    
    The specified string must not contain a : (colon), / (slash), | (vertical bar), or any control characters (- | -). Also, it must not be the literal string arn.
    
    Returns:
    
    The user defined identifier associated with the workflow execution. You can use this to associate a custom identifier with the workflow execution. You may specify the same identifier if a workflow execution is logically a restart of a previous execution. You cannot have two open workflow executions with the same workflowId at the same time within the same domain.
    
    The specified string must not contain a : (colon), / (slash), | (vertical bar), or any control characters (- | -). Also, it must not be the literal string arn.
  - workflowType
```
public final WorkflowType workflowType()
```
    The type of the workflow to start.
    
    Returns:
    
    The type of the workflow to start.
  - taskList
```
public final TaskList taskList()
```
    The task list to use for the decision tasks generated for this workflow execution. This overrides the defaultTaskList specified when registering the workflow type.
    
    A task list for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task list was specified at registration time then a fault is returned.
    
    The specified string must not contain a : (colon), / (slash), | (vertical bar), or any control characters (- | -). Also, it must not be the literal string arn.
    
    Returns:
    
    The task list to use for the decision tasks generated for this workflow execution. This overrides the defaultTaskList specified when registering the workflow type.
    
    A task list for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task list was specified at registration time then a fault is returned.
    
    The specified string must not contain a : (colon), / (slash), | (vertical bar), or any control characters (- | -). Also, it must not be the literal string arn.
  - taskPriority
```
public final String taskPriority()
```
    The task priority to use for this workflow execution. This overrides any default priority that was assigned when the workflow type was registered. If not set, then the default task priority for the workflow type is used. 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 SWF Developer Guide.
    
    Returns:
    
    The task priority to use for this workflow execution. This overrides any default priority that was assigned when the workflow type was registered. If not set, then the default task priority for the workflow type is used. 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 SWF Developer Guide.
  - input
```
public final String input()
```
    The input for the workflow execution. This is a free form string which should be meaningful to the workflow you are starting. This input is made available to the new workflow execution in the WorkflowExecutionStarted history event.
    
    Returns:
    
    The input for the workflow execution. This is a free form string which should be meaningful to the workflow you are starting. This input is made available to the new workflow execution in the WorkflowExecutionStarted history event.
  - executionStartToCloseTimeout
```
public final String executionStartToCloseTimeout()
```
    The total duration for this workflow execution. This overrides the defaultExecutionStartToCloseTimeout specified when registering the workflow type.
    
    The duration is specified in seconds; an integer greater than or equal to 0. Exceeding this limit causes the workflow execution to time out. Unlike some of the other timeout parameters in Amazon SWF, you cannot specify a value of "NONE" for this timeout; there is a one-year max limit on the time that a workflow execution can run.
    
    An execution start-to-close timeout must be specified either through this parameter or as a default when the workflow type is registered. If neither this parameter nor a default execution start-to-close timeout is specified, a fault is returned.
    
    Returns:
    
    The total duration for this workflow execution. This overrides the defaultExecutionStartToCloseTimeout specified when registering the workflow type.
    
    The duration is specified in seconds; an integer greater than or equal to 0. Exceeding this limit causes the workflow execution to time out. Unlike some of the other timeout parameters in Amazon SWF, you cannot specify a value of "NONE" for this timeout; there is a one-year max limit on the time that a workflow execution can run.
    
    An execution start-to-close timeout must be specified either through this parameter or as a default when the workflow type is registered. If neither this parameter nor a default execution start-to-close timeout is specified, a fault is returned.
  - 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 the isEmpty() 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 associate with the workflow execution. You can specify a maximum of 5 tags. You can list workflow executions with a specific tag by calling ListOpenWorkflowExecutions or ListClosedWorkflowExecutions and specifying a TagFilter.
    
    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 associate with the workflow execution. You can specify a maximum of 5 tags. You can list workflow executions with a specific tag by calling ListOpenWorkflowExecutions or ListClosedWorkflowExecutions and specifying a TagFilter.
  - taskStartToCloseTimeout
```
public final String taskStartToCloseTimeout()
```
    Specifies the maximum duration of decision tasks for this workflow execution. This parameter overrides the defaultTaskStartToCloseTimout specified when registering the workflow type using RegisterWorkflowType.
    
    The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.
    
    A task start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task start-to-close timeout was specified at registration time then a fault is returned.
    
    Returns:
    
    Specifies the maximum duration of decision tasks for this workflow execution. This parameter overrides the defaultTaskStartToCloseTimout specified when registering the workflow type using RegisterWorkflowType.
    
    The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.
    
    A task start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task start-to-close timeout was specified at registration time then a fault is returned.
  - childPolicy
```
public final ChildPolicy childPolicy()
```
    If set, specifies the policy to use for the child workflow executions of this workflow execution if it is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This policy overrides the default child policy specified when registering the workflow type using RegisterWorkflowType.
    
    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 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 is taken. The child executions continue to run.
    
    A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault is returned.
    
    If the service returns an enum value that is not available in the current SDK version, childPolicy will return ChildPolicy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from childPolicyAsString().
    Returns:
    
    If set, specifies the policy to use for the child workflow executions of this workflow execution if it is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This policy overrides the default child policy specified when registering the workflow type using RegisterWorkflowType.
    
    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 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 is taken. The child executions continue to run.
    
    A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault is returned.
    
    See Also:
    
    ChildPolicy
  - childPolicyAsString
```
public final String childPolicyAsString()
```
    If set, specifies the policy to use for the child workflow executions of this workflow execution if it is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This policy overrides the default child policy specified when registering the workflow type using RegisterWorkflowType.
    
    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 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 is taken. The child executions continue to run.
    
    A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault is returned.
    
    If the service returns an enum value that is not available in the current SDK version, childPolicy will return ChildPolicy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from childPolicyAsString().
    Returns:
    
    If set, specifies the policy to use for the child workflow executions of this workflow execution if it is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This policy overrides the default child policy specified when registering the workflow type using RegisterWorkflowType.
    
    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 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 is taken. The child executions continue to run.
    
    A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault is returned.
    
    See Also:
    
    ChildPolicy
  - lambdaRole
```
public final String lambdaRole()
```
    The IAM role to attach to this workflow execution.
    
    Executions of this workflow type need IAM roles to invoke Lambda functions. If you don't attach an IAM role, any attempt to schedule a Lambda task fails. This results in a ScheduleLambdaFunctionFailed history event. For more information, see https://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html in the Amazon SWF Developer Guide.
    
    Returns:
    
    The IAM role to attach to this workflow execution.
    
    Executions of this workflow type need IAM roles to invoke Lambda functions. If you don't attach an IAM role, any attempt to schedule a Lambda task fails. This results in a ScheduleLambdaFunctionFailed history event. For more information, see https://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html in the Amazon SWF Developer Guide.
  - toBuilder
```
public StartWorkflowExecutionRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<StartWorkflowExecutionRequest.Builder,StartWorkflowExecutionRequest>
    
    Specified by:
    
    toBuilder in class SwfRequest
  - builder
```
public static StartWorkflowExecutionRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends StartWorkflowExecutionRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class StartWorkflowExecutionRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

domain

workflowId

workflowType

taskList

taskPriority

input

executionStartToCloseTimeout

hasTagList

tagList

taskStartToCloseTimeout

childPolicy

childPolicyAsString

lambdaRole

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField