@Generated(value="software.amazon.awssdk:codegen") public class StartExecutionRequest extends SFNRequest implements ToCopyableBuilder<StartExecutionRequest.Builder,StartExecutionRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
StartExecutionRequest.Builder |
Modifier and Type | Method and Description |
---|---|
static StartExecutionRequest.Builder |
builder() |
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
int |
hashCode() |
String |
input()
The string that contains the JSON input data for the execution, for example:
|
String |
name()
The name of the execution.
|
static Class<? extends StartExecutionRequest.Builder> |
serializableBuilderClass() |
String |
stateMachineArn()
The Amazon Resource Name (ARN) of the state machine to execute.
|
StartExecutionRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
requestOverrideConfig
copy
public String stateMachineArn()
The Amazon Resource Name (ARN) of the state machine to execute.
public String name()
The name of the execution. This name must be unique for your AWS account and region for 90 days. For more information, see Limits Related to State Machine Executions in the AWS Step Functions Developer Guide.
An execution can't use the name of another execution for 90 days.
When you make multiple StartExecution
calls with the same name, the new execution doesn't run and
the following rules apply:
When the original execution is open and the execution input from the new call is different, the
ExecutionAlreadyExists
message is returned.
When the original execution is open and the execution input from the new call is identical, the
Success
message is returned.
When the original execution is closed, the ExecutionAlreadyExists
message is returned regardless of
input.
A name must not contain:
whitespace
brackets < > { } [ ]
wildcard characters ? *
special characters " # % \ ^ | ~ ` $ & , ; : /
control characters (U+0000-001F
, U+007F-009F
)
An execution can't use the name of another execution for 90 days.
When you make multiple StartExecution
calls with the same name, the new execution doesn't
run and the following rules apply:
When the original execution is open and the execution input from the new call is different, the
ExecutionAlreadyExists
message is returned.
When the original execution is open and the execution input from the new call is identical, the
Success
message is returned.
When the original execution is closed, the ExecutionAlreadyExists
message is returned
regardless of input.
A name must not contain:
whitespace
brackets < > { } [ ]
wildcard characters ? *
special characters " # % \ ^ | ~ ` $ & , ; : /
control characters (U+0000-001F
, U+007F-009F
)
public String input()
The string that contains the JSON input data for the execution, for example:
"input": "{\"first_name\" : \"test\"}"
If you don't include any JSON input data, you still must include the two braces, for example:
"input": "{}"
"input": "{\"first_name\" : \"test\"}"
If you don't include any JSON input data, you still must include the two braces, for example:
"input": "{}"
public StartExecutionRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<StartExecutionRequest.Builder,StartExecutionRequest>
toBuilder
in class SFNRequest
public static StartExecutionRequest.Builder builder()
public static Class<? extends StartExecutionRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.