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:

  • Method Details

    • 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()
      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<ComputeCapacityStatus.Builder,ComputeCapacityStatus>
      Returns:
      a builder for type T

    • 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)
      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.