Class CalculationStatus

java.lang.Object
software.amazon.awssdk.services.athena.model.CalculationStatus
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<CalculationStatus.Builder,CalculationStatus>
@Generated("software.amazon.awssdk:codegen") public final class CalculationStatus extends Object implements SdkPojo, Serializable, ToCopyableBuilder<CalculationStatus.Builder,CalculationStatus>

Contains information about the status of a notebook calculation.

See Also:

  • Method Details

    • submissionDateTime

      public final Instant submissionDateTime()

      The date and time the calculation was submitted for processing.

      Returns:
      The date and time the calculation was submitted for processing.

    • completionDateTime

      public final Instant completionDateTime()

      The date and time the calculation completed processing.

      Returns:
      The date and time the calculation completed processing.

    • state

      public final CalculationExecutionState state()

      The state of the calculation execution. A description of each state follows.

      CREATING - The calculation is in the process of being created.

      CREATED - The calculation has been created and is ready to run.

      QUEUED - The calculation has been queued for processing.

      RUNNING - The calculation is running.

      CANCELING - A request to cancel the calculation has been received and the system is working to stop it.

      CANCELED - The calculation is no longer running as the result of a cancel request.

      COMPLETED - The calculation has completed without error.

      FAILED - The calculation failed and is no longer running.

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

      Returns:
      The state of the calculation execution. A description of each state follows.

      CREATING - The calculation is in the process of being created.

      CREATED - The calculation has been created and is ready to run.

      QUEUED - The calculation has been queued for processing.

      RUNNING - The calculation is running.

      CANCELING - A request to cancel the calculation has been received and the system is working to stop it.

      CANCELED - The calculation is no longer running as the result of a cancel request.

      COMPLETED - The calculation has completed without error.

      FAILED - The calculation failed and is no longer running.

      See Also:

    • stateAsString

      public final String stateAsString()

      The state of the calculation execution. A description of each state follows.

      CREATING - The calculation is in the process of being created.

      CREATED - The calculation has been created and is ready to run.

      QUEUED - The calculation has been queued for processing.

      RUNNING - The calculation is running.

      CANCELING - A request to cancel the calculation has been received and the system is working to stop it.

      CANCELED - The calculation is no longer running as the result of a cancel request.

      COMPLETED - The calculation has completed without error.

      FAILED - The calculation failed and is no longer running.

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

      Returns:
      The state of the calculation execution. A description of each state follows.

      CREATING - The calculation is in the process of being created.

      CREATED - The calculation has been created and is ready to run.

      QUEUED - The calculation has been queued for processing.

      RUNNING - The calculation is running.

      CANCELING - A request to cancel the calculation has been received and the system is working to stop it.

      CANCELED - The calculation is no longer running as the result of a cancel request.

      COMPLETED - The calculation has completed without error.

      FAILED - The calculation failed and is no longer running.

      See Also:

    • stateChangeReason

      public final String stateChangeReason()

      The reason for the calculation state change (for example, the calculation was canceled because the session was terminated).

      Returns:
      The reason for the calculation state change (for example, the calculation was canceled because the session was terminated).

    • toBuilder

      public CalculationStatus.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<CalculationStatus.Builder,CalculationStatus>
      Returns:
      a builder for type T

    • builder

      public static CalculationStatus.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

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

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