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:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface WorkspacesPool.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`ApplicationSettingsResponse`	`applicationSettings()`	The persistent application settings for users of the pool.
`static WorkspacesPool.Builder`	`builder()`
`String`	`bundleId()`	The identifier of the bundle used by the pool.
`CapacityStatus`	`capacityStatus()`	The capacity status for the pool
`Instant`	`createdAt()`	The time the pool was created.
`String`	`description()`	The description of the pool.
`String`	`directoryId()`	The identifier of the directory used by the pool.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`List<WorkspacesPoolError>`	`errors()`	The pool errors.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasErrors()`	For responses, this returns true if the service returned a value for the Errors property.
`int`	`hashCode()`
`String`	`poolArn()`	The Amazon Resource Name (ARN) for the pool.
`String`	`poolId()`	The identifier of a pool.
`String`	`poolName()`	The name of the pool,
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends WorkspacesPool.Builder>`	`serializableBuilderClass()`
`WorkspacesPoolState`	`state()`	The current state of the pool.
`String`	`stateAsString()`	The current state of the pool.
`TimeoutSettings`	`timeoutSettings()`	The amount of time that a pool session remains active after users disconnect.
`WorkspacesPool.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - 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:
    
    WorkspacesPoolState
  - 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:
    
    WorkspacesPoolState
  - 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.
  - toBuilder
```
public WorkspacesPool.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<WorkspacesPool.Builder,WorkspacesPool>
  - 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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class WorkspacesPool

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

poolId

poolArn

capacityStatus

poolName

description

state

stateAsString

createdAt

bundleId

directoryId

hasErrors

errors

applicationSettings

timeoutSettings

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField