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:

SdkPojo, ToCopyableBuilder<StartExecutionRequest.Builder,StartExecutionRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final 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)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	input() The string that contains the JSON input data for the execution, for example:
String	name() The name of the execution.
List<SdkField<?>>	sdkFields()
static Class<? extends StartExecutionRequest.Builder>	serializableBuilderClass()
String	stateMachineArn() The Amazon Resource Name (ARN) of the state machine to execute.
StartExecutionRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	traceHeader() Passes the X-Ray trace header.

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

stateMachineArn

public final 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 final String name()

The name of the execution. This name must be unique for your Amazon Web Services account, region, and state machine for 90 days. For more information, see Limits Related to State Machine Executions in the Step Functions Developer Guide.

A name must not contain:

• white space

• brackets < > { } [ ]

• wildcard characters ? *

• special characters " # % \ ^ | ~ ` $ & , ; : /

• control characters (U+0000-001F, U+007F-009F)

To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

Returns:

The name of the execution. This name must be unique for your Amazon Web Services account, region, and state machine for 90 days. For more information, see Limits Related to State Machine Executions in the Step Functions Developer Guide.

A name must not contain:

• white space

• brackets < > { } [ ]

• wildcard characters ? *

• special characters " # % \ ^ | ~ ` $ & , ; : /

• control characters (U+0000-001F, U+007F-009F)

To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

input

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

Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

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

Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

traceHeader

public final String traceHeader()

Passes the X-Ray trace header. The trace header can also be passed in the request payload.

Returns:

Passes the X-Ray trace header. The trace header can also be passed in the request payload.

toBuilder

public StartExecutionRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<StartExecutionRequest.Builder,StartExecutionRequest>

Specified by:

toBuilder in class SfnRequest

builder

public static StartExecutionRequest.Builder builder()

serializableBuilderClass

public static Class<? extends StartExecutionRequest.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