software.amazon.awssdk.services.sfn.model

Class StartExecutionRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.sfn.model.SFNRequest

software.amazon.awssdk.services.sfn.model.StartExecutionRequest

All Implemented Interfaces:

ToCopyableBuilder<StartExecutionRequest.Builder,StartExecutionRequest>

@Generated(value="software.amazon.awssdk:codegen")
public class StartExecutionRequest
extends SFNRequest
implements ToCopyableBuilder<StartExecutionRequest.Builder,StartExecutionRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	StartExecutionRequest.Builder

Method Summary

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()

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

requestOverrideConfig

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

stateMachineArn

public String stateMachineArn()

The Amazon Resource Name (ARN) of the state machine to execute.

Returns:

The Amazon Resource Name (ARN) of the state machine to execute.

name

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)

Returns:

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)

input

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": "{}"

Returns:

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": "{}"

toBuilder

public StartExecutionRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<StartExecutionRequest.Builder,StartExecutionRequest>

Specified by:

toBuilder in class SFNRequest

Returns:

a builder for type T

builder

public static StartExecutionRequest.Builder builder()

serializableBuilderClass

public static Class<? extends StartExecutionRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends 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.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value