Class SessionData

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

Contains the metadata for a session returned by ListSessions, including its status, compute target, database connection, and lifecycle timestamps.

See Also:

  • Method Details

    • sessionId

      public final String sessionId()

      The session identifier. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.

      Returns:
      The session identifier. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.

    • status

      public final SessionStatusString status()

      The status of the session. Status values are defined as follows:

      • AVAILABLE – The session is open and ready to run a SQL statement.

      • BUSY – The session is currently running a SQL statement.

      • CLOSED – The session is closed and can no longer run SQL statements.

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

      Returns:
      The status of the session. Status values are defined as follows:

      • AVAILABLE – The session is open and ready to run a SQL statement.

      • BUSY – The session is currently running a SQL statement.

      • CLOSED – The session is closed and can no longer run SQL statements.

      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the session. Status values are defined as follows:

      • AVAILABLE – The session is open and ready to run a SQL statement.

      • BUSY – The session is currently running a SQL statement.

      • CLOSED – The session is closed and can no longer run SQL statements.

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

      Returns:
      The status of the session. Status values are defined as follows:

      • AVAILABLE – The session is open and ready to run a SQL statement.

      • BUSY – The session is currently running a SQL statement.

      • CLOSED – The session is closed and can no longer run SQL statements.

      See Also:

    • createdAt

      public final Instant createdAt()

      The date and time (UTC) when the session was created.

      Returns:
      The date and time (UTC) when the session was created.

    • updatedAt

      public final Instant updatedAt()

      The date and time (UTC) that the session metadata was last updated. An example is the time the status last changed.

      Returns:
      The date and time (UTC) that the session metadata was last updated. An example is the time the status last changed.

    • database

      public final String database()

      The name of the database that the session is connected to.

      Returns:
      The name of the database that the session is connected to.

    • dbUser

      public final String dbUser()

      The database user name.

      Returns:
      The database user name.

    • clusterIdentifier

      public final String clusterIdentifier()

      The cluster identifier. This element is not returned when connecting to a serverless workgroup.

      Returns:
      The cluster identifier. This element is not returned when connecting to a serverless workgroup.

    • workgroupName

      public final String workgroupName()

      The serverless workgroup name or Amazon Resource Name (ARN). This element is not returned when connecting to a provisioned cluster.

      Returns:
      The serverless workgroup name or Amazon Resource Name (ARN). This element is not returned when connecting to a provisioned cluster.

    • sessionAliveSeconds

      public final Integer sessionAliveSeconds()

      The number of seconds that the session is kept alive after a query finishes.

      Returns:
      The number of seconds that the session is kept alive after a query finishes.

    • sessionTtl

      public final Instant sessionTtl()

      The date and time (UTC) when the session is set to expire and be closed.

      Returns:
      The date and time (UTC) when the session is set to expire and be closed.

    • currentStatementId

      public final String currentStatementId()

      The identifier of the SQL statement currently running in the session. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. This element is returned only when the session status is BUSY.

      Returns:
      The identifier of the SQL statement currently running in the session. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. This element is returned only when the session status is BUSY.

    • toBuilder

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

    • builder

      public static SessionData.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

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