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>

  • Method Details

    • 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:

    • 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:

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

      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:
      The X-Ray trace header that was passed to the execution.

      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.

    • 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()
      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<StartSyncExecutionResponse.Builder,StartSyncExecutionResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • 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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. 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 SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      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

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.