Package software.amazon.awssdk.services.athena.model

Class SessionStatus

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

Contains information about the status of a session.

See Also:

  • Method Details

    • startDateTime

      public final Instant startDateTime()

      The date and time that the session started.

      Returns:
      The date and time that the session started.

    • lastModifiedDateTime

      public final Instant lastModifiedDateTime()

      The most recent date and time that the session was modified.

      Returns:
      The most recent date and time that the session was modified.

    • endDateTime

      public final Instant endDateTime()

      The date and time that the session ended.

      Returns:
      The date and time that the session ended.

    • idleSinceDateTime

      public final Instant idleSinceDateTime()

      The date and time starting at which the session became idle. Can be empty if the session is not currently idle.

      Returns:
      The date and time starting at which the session became idle. Can be empty if the session is not currently idle.

    • state

      public final SessionState state()

      The state of the session. A description of each state follows.

      CREATING - The session is being started, including acquiring resources.

      CREATED - The session has been started.

      IDLE - The session is able to accept a calculation.

      BUSY - The session is processing another task and is unable to accept a calculation.

      TERMINATING - The session is in the process of shutting down.

      TERMINATED - The session and its resources are no longer running.

      DEGRADED - The session has no healthy coordinators.

      FAILED - Due to a failure, the session and its resources are no longer running.

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

      Returns:
      The state of the session. A description of each state follows.

      CREATING - The session is being started, including acquiring resources.

      CREATED - The session has been started.

      IDLE - The session is able to accept a calculation.

      BUSY - The session is processing another task and is unable to accept a calculation.

      TERMINATING - The session is in the process of shutting down.

      TERMINATED - The session and its resources are no longer running.

      DEGRADED - The session has no healthy coordinators.

      FAILED - Due to a failure, the session and its resources are no longer running.

      See Also:

    • stateAsString

      public final String stateAsString()

      The state of the session. A description of each state follows.

      CREATING - The session is being started, including acquiring resources.

      CREATED - The session has been started.

      IDLE - The session is able to accept a calculation.

      BUSY - The session is processing another task and is unable to accept a calculation.

      TERMINATING - The session is in the process of shutting down.

      TERMINATED - The session and its resources are no longer running.

      DEGRADED - The session has no healthy coordinators.

      FAILED - Due to a failure, the session and its resources are no longer running.

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

      Returns:
      The state of the session. A description of each state follows.

      CREATING - The session is being started, including acquiring resources.

      CREATED - The session has been started.

      IDLE - The session is able to accept a calculation.

      BUSY - The session is processing another task and is unable to accept a calculation.

      TERMINATING - The session is in the process of shutting down.

      TERMINATED - The session and its resources are no longer running.

      DEGRADED - The session has no healthy coordinators.

      FAILED - Due to a failure, the session and its resources are no longer running.

      See Also:

    • stateChangeReason

      public final String stateChangeReason()

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

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

    • toBuilder

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

    • builder

      public static SessionStatus.Builder builder()

    • serializableBuilderClass

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