Class StartSyncExecutionResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<StartSyncExecutionResponse.Builder,
StartSyncExecutionResponse>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal BillingDetails
An object that describes workflow billing details, including billed duration and memory use.builder()
final String
cause()
A more detailed explanation of the cause of the failure.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
error()
The error code of the failure.final String
The Amazon Resource Name (ARN) that identifies the execution.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkResponse
.final int
hashCode()
final String
input()
The string that contains the JSON input data of the execution.Returns the value of the InputDetails property for this object.final String
name()
The name of the execution.final String
output()
The JSON output data of the execution.Returns the value of the OutputDetails property for this object.static Class
<? extends StartSyncExecutionResponse.Builder> final Instant
The date the execution is started.final String
The Amazon Resource Name (ARN) that identifies the state machine.final SyncExecutionStatus
status()
The current status of the execution.final String
The current status of the execution.final Instant
stopDate()
If the execution has already ended, the date the execution stopped.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
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 interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
executionArn
The Amazon Resource Name (ARN) that identifies the execution.
- Returns:
- The Amazon Resource Name (ARN) that identifies the execution.
-
stateMachineArn
The Amazon Resource Name (ARN) that identifies the state machine.
- Returns:
- The Amazon Resource Name (ARN) that identifies the state machine.
-
name
The name of the execution.
- Returns:
- The name of the execution.
-
startDate
The date the execution is started.
- Returns:
- The date the execution is started.
-
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
The current status of the execution.
If the service returns an enum value that is not available in the current SDK version,
status
will returnSyncExecutionStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The current status of the execution.
- See Also:
-
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 returnSyncExecutionStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The current status of the execution.
- See Also:
-
error
The error code of the failure.
- Returns:
- The error code of the failure.
-
cause
A more detailed explanation of the cause of the failure.
- Returns:
- A more detailed explanation of the cause of the failure.
-
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
Returns the value of the InputDetails property for this object.- Returns:
- The value of the InputDetails property for this object.
-
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
Returns the value of the OutputDetails property for this object.- Returns:
- The value of the OutputDetails property for this object.
-
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
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
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 interfaceToCopyableBuilder<StartSyncExecutionResponse.Builder,
StartSyncExecutionResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkResponse
Used to retrieve the value of a field from any class that extendsSdkResponse
. 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, theSdkResponse.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkResponse
- 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
-
sdkFields
-