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:

  • Method Details

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

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