Package software.amazon.awssdk.services.sfn.model

Class StartSyncExecutionRequest

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.StartSyncExecutionRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<StartSyncExecutionRequest.Builder,StartSyncExecutionRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	StartSyncExecutionRequest.Builder

Method Summary

Modifier and Type	Method	Description
static StartSyncExecutionRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
IncludedData	includedData()	If your state machine definition is encrypted with a KMS key, callers must have kms:Decrypt permission to decrypt the definition.
String	includedDataAsString()	If your state machine definition is encrypted with a KMS key, callers must have kms:Decrypt permission to decrypt the definition.
String	input()	The string that contains the JSON input data for the execution, for example:
String	name()	The name of the execution.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends StartSyncExecutionRequest.Builder>	serializableBuilderClass()
String	stateMachineArn()	The Amazon Resource Name (ARN) of the state machine to execute.
StartSyncExecutionRequest.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.

Returns:

The name of the execution.

input

public final String input()

The string that contains the JSON input data for the execution, for example:

"{\"first_name\" : \"Alejandro\"}"

If you don't include any JSON input data, you still must include the two braces, for example: "{}"

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:

"{\"first_name\" : \"Alejandro\"}"

If you don't include any JSON input data, you still must include the two braces, for example: "{}"

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.

For X-Ray traces, all Amazon Web Services services use the X-Amzn-Trace-Id header from the HTTP request. Using the header is the preferred mechanism to identify a trace. StartExecution and StartSyncExecution API operations can also use traceHeader from the body of the request payload. If both sources are provided, Step Functions will use the header value (preferred) over the value in the request body.

Returns:

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

For X-Ray traces, all Amazon Web Services services use the X-Amzn-Trace-Id header from the HTTP request. Using the header is the preferred mechanism to identify a trace. StartExecution and StartSyncExecution API operations can also use traceHeader from the body of the request payload. If both sources are provided, Step Functions will use the header value (preferred) over the value in the request body.

includedData

public final IncludedData includedData()

If your state machine definition is encrypted with a KMS key, callers must have kms:Decrypt permission to decrypt the definition. Alternatively, you can call the API with includedData = METADATA_ONLY to get a successful response without the encrypted definition.

If the service returns an enum value that is not available in the current SDK version, includedData will return IncludedData.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from includedDataAsString().

Returns:

If your state machine definition is encrypted with a KMS key, callers must have kms:Decrypt permission to decrypt the definition. Alternatively, you can call the API with includedData = METADATA_ONLY to get a successful response without the encrypted definition.

See Also:

IncludedData

includedDataAsString

public final String includedDataAsString()

If your state machine definition is encrypted with a KMS key, callers must have kms:Decrypt permission to decrypt the definition. Alternatively, you can call the API with includedData = METADATA_ONLY to get a successful response without the encrypted definition.

If the service returns an enum value that is not available in the current SDK version, includedData will return IncludedData.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from includedDataAsString().

Returns:

If your state machine definition is encrypted with a KMS key, callers must have kms:Decrypt permission to decrypt the definition. Alternatively, you can call the API with includedData = METADATA_ONLY to get a successful response without the encrypted definition.

See Also:

IncludedData

toBuilder

public StartSyncExecutionRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<StartSyncExecutionRequest.Builder,StartSyncExecutionRequest>

Specified by:

toBuilder in class SfnRequest

builder

public static StartSyncExecutionRequest.Builder builder()

serializableBuilderClass

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