Class Session

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

Describes a streaming session.

See Also:

  • Method Details

    • id

      public final String id()

      The identifier of the streaming session.

      Returns:
      The identifier of the streaming session.

    • userId

      public final String userId()

      The identifier of the user for whom the session was created.

      Returns:
      The identifier of the user for whom the session was created.

    • stackName

      public final String stackName()

      The name of the stack for the streaming session.

      Returns:
      The name of the stack for the streaming session.

    • fleetName

      public final String fleetName()

      The name of the fleet for the streaming session.

      Returns:
      The name of the fleet for the streaming session.

    • state

      public final SessionState state()

      The current state of the streaming session.

      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 current state of the streaming session.
      See Also:

    • stateAsString

      public final String stateAsString()

      The current state of the streaming session.

      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 current state of the streaming session.
      See Also:

    • connectionState

      public final SessionConnectionState connectionState()

      Specifies whether a user is connected to the streaming session.

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

      Returns:
      Specifies whether a user is connected to the streaming session.
      See Also:

    • connectionStateAsString

      public final String connectionStateAsString()

      Specifies whether a user is connected to the streaming session.

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

      Returns:
      Specifies whether a user is connected to the streaming session.
      See Also:

    • startTime

      public final Instant startTime()

      The time when a streaming instance is dedicated for the user.

      Returns:
      The time when a streaming instance is dedicated for the user.

    • maxExpirationTime

      public final Instant maxExpirationTime()

      The time when the streaming session is set to expire. This time is based on the MaxUserDurationinSeconds value, which determines the maximum length of time that a streaming session can run. A streaming session might end earlier than the time specified in SessionMaxExpirationTime, when the DisconnectTimeOutInSeconds elapses or the user chooses to end his or her session. If the DisconnectTimeOutInSeconds elapses, or the user chooses to end his or her session, the streaming instance is terminated and the streaming session ends.

      Returns:
      The time when the streaming session is set to expire. This time is based on the MaxUserDurationinSeconds value, which determines the maximum length of time that a streaming session can run. A streaming session might end earlier than the time specified in SessionMaxExpirationTime, when the DisconnectTimeOutInSeconds elapses or the user chooses to end his or her session. If the DisconnectTimeOutInSeconds elapses, or the user chooses to end his or her session, the streaming instance is terminated and the streaming session ends.

    • authenticationType

      public final AuthenticationType authenticationType()

      The authentication method. The user is authenticated using a streaming URL (API) or SAML 2.0 federation (SAML).

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

      Returns:
      The authentication method. The user is authenticated using a streaming URL (API) or SAML 2.0 federation (SAML).
      See Also:

    • authenticationTypeAsString

      public final String authenticationTypeAsString()

      The authentication method. The user is authenticated using a streaming URL (API) or SAML 2.0 federation (SAML).

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

      Returns:
      The authentication method. The user is authenticated using a streaming URL (API) or SAML 2.0 federation (SAML).
      See Also:

    • networkAccessConfiguration

      public final NetworkAccessConfiguration networkAccessConfiguration()

      The network details for the streaming session.

      Returns:
      The network details for the streaming session.

    • instanceId

      public final String instanceId()

      The identifier for the instance hosting the session.

      Returns:
      The identifier for the instance hosting the session.

    • toBuilder

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

    • builder

      public static Session.Builder builder()

    • serializableBuilderClass

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