Package software.amazon.awssdk.services.appstream.model

Class ComputeCapacityStatus

java.lang.Object

software.amazon.awssdk.services.appstream.model.ComputeCapacityStatus

All Implemented Interfaces:

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

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

Describes the capacity status for a fleet.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ComputeCapacityStatus.Builder

Method Summary

Modifier and Type	Method	Description
Integer	activeUserSessions()	The number of user sessions currently being used for streaming sessions.
Integer	actualUserSessions()	The total number of session slots that are available for streaming or are currently streaming.
Integer	available()	The number of currently available instances that can be used to stream sessions.
Integer	availableUserSessions()	The number of idle session slots currently available for user sessions.
static ComputeCapacityStatus.Builder	builder()
Integer	desired()	The desired number of streaming instances.
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()
Integer	inUse()	The number of instances in use for streaming.
Integer	running()	The total number of simultaneous streaming instances that are running.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ComputeCapacityStatus.Builder>	serializableBuilderClass()
ComputeCapacityStatus.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

desired

public final Integer desired()

The desired number of streaming instances.

Returns:

The desired number of streaming instances.

running

public final Integer running()

The total number of simultaneous streaming instances that are running.

Returns:

The total number of simultaneous streaming instances that are running.

inUse

public final Integer inUse()

The number of instances in use for streaming.

Returns:

The number of instances in use for streaming.

available

public final Integer available()

The number of currently available instances that can be used to stream sessions.

Returns:

The number of currently available instances that can be used to stream sessions.

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 fleet can support in a steady state.

DesiredUserSessionCapacity = ActualUserSessionCapacity + PendingUserSessionCapacity

This only applies to multi-session fleets.

Returns:

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

DesiredUserSessionCapacity = ActualUserSessionCapacity + PendingUserSessionCapacity

This only applies to multi-session fleets.

availableUserSessions

public final Integer availableUserSessions()

The number of idle session slots currently available for user sessions.

AvailableUserSessionCapacity = ActualUserSessionCapacity - ActiveUserSessions

This only applies to multi-session fleets.

Returns:

The number of idle session slots currently available for user sessions.

AvailableUserSessionCapacity = ActualUserSessionCapacity - ActiveUserSessions

This only applies to multi-session fleets.

activeUserSessions

public final Integer activeUserSessions()

The number of user sessions currently being used for streaming sessions. This only applies to multi-session fleets.

Returns:

The number of user sessions currently being used for streaming sessions. This only applies to multi-session fleets.

actualUserSessions

public final Integer actualUserSessions()

The total number of session slots that are available for streaming or are currently streaming.

ActualUserSessionCapacity = AvailableUserSessionCapacity + ActiveUserSessions

This only applies to multi-session fleets.

Returns:

The total number of session slots that are available for streaming or are currently streaming.

ActualUserSessionCapacity = AvailableUserSessionCapacity + ActiveUserSessions

This only applies to multi-session fleets.

toBuilder

public ComputeCapacityStatus.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ComputeCapacityStatus.Builder,ComputeCapacityStatus>

builder

public static ComputeCapacityStatus.Builder builder()

serializableBuilderClass

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