Class WorkspacesPoolSession

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

Describes a pool session.

See Also:

  • Method Details

    • authenticationType

      public final AuthenticationType authenticationType()

      The authentication method. The user is authenticated using a WorkSpaces Pools 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 WorkSpaces Pools URL (API) or SAML 2.0 federation (SAML).
      See Also:

    • authenticationTypeAsString

      public final String authenticationTypeAsString()

      The authentication method. The user is authenticated using a WorkSpaces Pools 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 WorkSpaces Pools URL (API) or SAML 2.0 federation (SAML).
      See Also:

    • connectionState

      public final SessionConnectionState connectionState()

      Specifies whether a user is connected to the pool 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 pool session.
      See Also:

    • connectionStateAsString

      public final String connectionStateAsString()

      Specifies whether a user is connected to the pool 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 pool session.
      See Also:

    • sessionId

      public final String sessionId()

      The identifier of the session.

      Returns:
      The identifier of the session.

    • instanceId

      public final String instanceId()

      The identifier for the instance hosting the session.

      Returns:
      The identifier for the instance hosting the session.

    • poolId

      public final String poolId()

      The identifier of the pool.

      Returns:
      The identifier of the pool.

    • expirationTime

      public final Instant expirationTime()

      The time that the pool session ended.

      Returns:
      The time that the pool session ended.

    • networkAccessConfiguration

      public final NetworkAccessConfiguration networkAccessConfiguration()

      Describes the network details of the pool.

      Returns:
      Describes the network details of the pool.

    • startTime

      public final Instant startTime()

      The time that the pool sission started.

      Returns:
      The time that the pool sission started.

    • userId

      public final String userId()

      The identifier of the user.

      Returns:
      The identifier of the user.

    • toBuilder

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

    • builder

      public static WorkspacesPoolSession.Builder builder()

    • serializableBuilderClass

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