Class WorkspacesPool

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

Describes a pool of WorkSpaces.

See Also:

  • Method Details

    • poolId

      public final String poolId()

      The identifier of a pool.

      Returns:
      The identifier of a pool.

    • poolArn

      public final String poolArn()

      The Amazon Resource Name (ARN) for the pool.

      Returns:
      The Amazon Resource Name (ARN) for the pool.

    • capacityStatus

      public final CapacityStatus capacityStatus()

      The capacity status for the pool

      Returns:
      The capacity status for the pool

    • poolName

      public final String poolName()

      The name of the pool.

      Returns:
      The name of the pool.

    • description

      public final String description()

      The description of the pool.

      Returns:
      The description of the pool.

    • state

      public final WorkspacesPoolState state()

      The current state of the pool.

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

      Returns:
      The current state of the pool.
      See Also:

    • stateAsString

      public final String stateAsString()

      The current state of the pool.

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

      Returns:
      The current state of the pool.
      See Also:

    • createdAt

      public final Instant createdAt()

      The time the pool was created.

      Returns:
      The time the pool was created.

    • bundleId

      public final String bundleId()

      The identifier of the bundle used by the pool.

      Returns:
      The identifier of the bundle used by the pool.

    • directoryId

      public final String directoryId()

      The identifier of the directory used by the pool.

      Returns:
      The identifier of the directory used by the pool.

    • hasErrors

      public final boolean hasErrors()
      For responses, this returns true if the service returned a value for the Errors property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • errors

      public final List<WorkspacesPoolError> errors()

      The pool errors.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasErrors() method.

      Returns:
      The pool errors.

    • applicationSettings

      public final ApplicationSettingsResponse applicationSettings()

      The persistent application settings for users of the pool.

      Returns:
      The persistent application settings for users of the pool.

    • timeoutSettings

      public final TimeoutSettings timeoutSettings()

      The amount of time that a pool session remains active after users disconnect. If they try to reconnect to the pool session after a disconnection or network interruption within this time interval, they are connected to their previous session. Otherwise, they are connected to a new session with a new pool instance.

      Returns:
      The amount of time that a pool session remains active after users disconnect. If they try to reconnect to the pool session after a disconnection or network interruption within this time interval, they are connected to their previous session. Otherwise, they are connected to a new session with a new pool instance.

    • runningMode

      public final PoolsRunningMode runningMode()

      The running mode of the pool.

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

      Returns:
      The running mode of the pool.
      See Also:

    • runningModeAsString

      public final String runningModeAsString()

      The running mode of the pool.

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

      Returns:
      The running mode of the pool.
      See Also:

    • toBuilder

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

    • builder

      public static WorkspacesPool.Builder builder()

    • serializableBuilderClass

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