Package software.amazon.awssdk.services.workspaces.model

Class CapacityStatus

java.lang.Object

software.amazon.awssdk.services.workspaces.model.CapacityStatus

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<CapacityStatus.Builder,CapacityStatus>

@Generated("software.amazon.awssdk:codegen")
public final class CapacityStatus
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<CapacityStatus.Builder,CapacityStatus>

Describes the capacity status for a pool of WorkSpaces.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CapacityStatus.Builder

Method Summary

Modifier and Type	Method	Description
Integer	activeUserSessions()	The number of user sessions currently being used for your pool.
Integer	actualUserSessions()	The total number of user sessions that are available for streaming or are currently streaming in your pool.
Integer	availableUserSessions()	The number of user sessions currently available for streaming from your pool.
static CapacityStatus.Builder	builder()
Integer	desiredUserSessions()	The total number of sessions slots that are either running or pending.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends CapacityStatus.Builder>	serializableBuilderClass()
CapacityStatus.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

availableUserSessions

public final Integer availableUserSessions()

The number of user sessions currently available for streaming from your pool.

AvailableUserSessions = ActualUserSessions - ActiveUserSessions

Returns:

The number of user sessions currently available for streaming from your pool.

AvailableUserSessions = ActualUserSessions - ActiveUserSessions

desiredUserSessions

public final Integer desiredUserSessions()

The total number of sessions slots that are either running or pending. This represents the total number of concurrent streaming sessions your pool can support in a steady state.

Returns:

The total number of sessions slots that are either running or pending. This represents the total number of concurrent streaming sessions your pool can support in a steady state.

actualUserSessions

public final Integer actualUserSessions()

The total number of user sessions that are available for streaming or are currently streaming in your pool.

ActualUserSessions = AvailableUserSessions + ActiveUserSessions

Returns:

The total number of user sessions that are available for streaming or are currently streaming in your pool.

ActualUserSessions = AvailableUserSessions + ActiveUserSessions

activeUserSessions

public final Integer activeUserSessions()

The number of user sessions currently being used for your pool.

Returns:

The number of user sessions currently being used for your pool.

toBuilder

public CapacityStatus.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CapacityStatus.Builder,CapacityStatus>

builder

public static CapacityStatus.Builder builder()

serializableBuilderClass

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