Class GetDurableExecutionResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.lambda.model.LambdaResponse
software.amazon.awssdk.services.lambda.model.GetDurableExecutionResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetDurableExecutionResponse.Builder,GetDurableExecutionResponse>
@Generated("software.amazon.awssdk:codegen") public final class GetDurableExecutionResponse extends LambdaResponse implements ToCopyableBuilder<GetDurableExecutionResponse.Builder,GetDurableExecutionResponse>

The response from the GetDurableExecution operation, containing detailed information about the durable execution.

  • Method Details

    • durableExecutionArn

      public final String durableExecutionArn()

      The Amazon Resource Name (ARN) of the durable execution.

      Returns:
      The Amazon Resource Name (ARN) of the durable execution.

    • durableExecutionName

      public final String durableExecutionName()

      The name of the durable execution. This is either the name you provided when invoking the function, or a system-generated unique identifier if no name was provided.

      Returns:
      The name of the durable execution. This is either the name you provided when invoking the function, or a system-generated unique identifier if no name was provided.

    • functionArn

      public final String functionArn()

      The Amazon Resource Name (ARN) of the Lambda function that was invoked to start this durable execution.

      Returns:
      The Amazon Resource Name (ARN) of the Lambda function that was invoked to start this durable execution.

    • inputPayload

      public final String inputPayload()

      The JSON input payload that was provided when the durable execution was started. For asynchronous invocations, this is limited to 256 KB. For synchronous invocations, this can be up to 6 MB.

      Returns:
      The JSON input payload that was provided when the durable execution was started. For asynchronous invocations, this is limited to 256 KB. For synchronous invocations, this can be up to 6 MB.

    • result

      public final String result()

      The JSON result returned by the durable execution if it completed successfully. This field is only present when the execution status is SUCCEEDED. The result is limited to 256 KB.

      Returns:
      The JSON result returned by the durable execution if it completed successfully. This field is only present when the execution status is SUCCEEDED. The result is limited to 256 KB.

    • error

      public final ErrorObject error()

      Error information if the durable execution failed. This field is only present when the execution status is FAILED, TIMED_OUT, or STOPPED. The combined size of all error fields is limited to 256 KB.

      Returns:
      Error information if the durable execution failed. This field is only present when the execution status is FAILED, TIMED_OUT, or STOPPED. The combined size of all error fields is limited to 256 KB.

    • startTimestamp

      public final Instant startTimestamp()

      The date and time when the durable execution started, in Unix timestamp format.

      Returns:
      The date and time when the durable execution started, in Unix timestamp format.

    • status

      public final ExecutionStatus status()

      The current status of the durable execution. Valid values are RUNNING, SUCCEEDED, FAILED, TIMED_OUT, and STOPPED.

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

      Returns:
      The current status of the durable execution. Valid values are RUNNING, SUCCEEDED, FAILED, TIMED_OUT, and STOPPED.
      See Also:

    • statusAsString

      public final String statusAsString()

      The current status of the durable execution. Valid values are RUNNING, SUCCEEDED, FAILED, TIMED_OUT, and STOPPED.

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

      Returns:
      The current status of the durable execution. Valid values are RUNNING, SUCCEEDED, FAILED, TIMED_OUT, and STOPPED.
      See Also:

    • endTimestamp

      public final Instant endTimestamp()

      The date and time when the durable execution ended, in Unix timestamp format. This field is only present if the execution has completed (status is SUCCEEDED, FAILED, TIMED_OUT, or STOPPED).

      Returns:
      The date and time when the durable execution ended, in Unix timestamp format. This field is only present if the execution has completed (status is SUCCEEDED, FAILED, TIMED_OUT, or STOPPED).

    • version

      public final String version()

      The version of the Lambda function that was invoked for this durable execution. This ensures that all replays during the execution use the same function version.

      Returns:
      The version of the Lambda function that was invoked for this durable execution. This ensures that all replays during the execution use the same function version.

    • traceHeader

      public final TraceHeader traceHeader()

      The trace headers associated with the durable execution.

      Returns:
      The trace headers associated with the durable execution.

    • toBuilder

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

    • builder

      public static GetDurableExecutionResponse.Builder builder()

    • serializableBuilderClass

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