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

Class StartSyncExecutionResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.sfn.model.SfnResponse

software.amazon.awssdk.services.sfn.model.StartSyncExecutionResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<StartSyncExecutionResponse.Builder,StartSyncExecutionResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	StartSyncExecutionResponse.Builder

Method Summary

Modifier and Type	Method	Description
BillingDetails	billingDetails()	An object that describes workflow billing details, including billed duration and memory use.
static StartSyncExecutionResponse.Builder	builder()
String	cause()	A more detailed explanation of the cause of the failure.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	error()	The error code of the failure.
String	executionArn()	The Amazon Resource Name (ARN) that identifies the execution.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	input()	The string that contains the JSON input data of the execution.
CloudWatchEventsExecutionDataDetails	inputDetails()	Returns the value of the InputDetails property for this object.
String	name()	The name of the execution.
String	output()	The JSON output data of the execution.
CloudWatchEventsExecutionDataDetails	outputDetails()	Returns the value of the OutputDetails property for this object.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends StartSyncExecutionResponse.Builder>	serializableBuilderClass()
Instant	startDate()	The date the execution is started.
String	stateMachineArn()	The Amazon Resource Name (ARN) that identifies the state machine.
SyncExecutionStatus	status()	The current status of the execution.
String	statusAsString()	The current status of the execution.
Instant	stopDate()	If the execution has already ended, the date the execution stopped.
StartSyncExecutionResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	traceHeader()	The X-Ray trace header that was passed to the execution.

Methods inherited from class software.amazon.awssdk.services.sfn.model.SfnResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

executionArn

public final String executionArn()

The Amazon Resource Name (ARN) that identifies the execution.

Returns:

The Amazon Resource Name (ARN) that identifies the execution.

stateMachineArn

public final String stateMachineArn()

The Amazon Resource Name (ARN) that identifies the state machine.

Returns:

The Amazon Resource Name (ARN) that identifies the state machine.

name

public final String name()

The name of the execution.

Returns:

The name of the execution.

startDate

public final Instant startDate()

The date the execution is started.

Returns:

The date the execution is started.

stopDate

public final Instant stopDate()

If the execution has already ended, the date the execution stopped.

Returns:

If the execution has already ended, the date the execution stopped.

status

public final SyncExecutionStatus status()

The current status of the execution.

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

Returns:

The current status of the execution.

See Also:

SyncExecutionStatus

statusAsString

public final String statusAsString()

The current status of the execution.

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

Returns:

The current status of the execution.

See Also:

SyncExecutionStatus

error

public final String error()

The error code of the failure.

Returns:

The error code of the failure.

cause

public final String cause()

A more detailed explanation of the cause of the failure.

Returns:

A more detailed explanation of the cause of the failure.

input

public final String input()

The string that contains the JSON input data of the execution. 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 of the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

inputDetails

public final CloudWatchEventsExecutionDataDetails inputDetails()

Returns the value of the InputDetails property for this object.

Returns:

The value of the InputDetails property for this object.

output

public final String output()

The JSON output data of the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

This field is set only if the execution succeeds. If the execution fails, this field is null.

Returns:

The JSON output data of the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

This field is set only if the execution succeeds. If the execution fails, this field is null.

outputDetails

public final CloudWatchEventsExecutionDataDetails outputDetails()

Returns the value of the OutputDetails property for this object.

Returns:

The value of the OutputDetails property for this object.

traceHeader

public final String traceHeader()

The X-Ray trace header that was passed to the execution.

Returns:

The X-Ray trace header that was passed to the execution.

billingDetails

public final BillingDetails billingDetails()

An object that describes workflow billing details, including billed duration and memory use.

Returns:

An object that describes workflow billing details, including billed duration and memory use.

toBuilder

public StartSyncExecutionResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<StartSyncExecutionResponse.Builder,StartSyncExecutionResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static StartSyncExecutionResponse.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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 SdkResponse

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