Class CapacityBlockStatus

java.lang.Object
software.amazon.awssdk.services.ec2.model.CapacityBlockStatus
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<CapacityBlockStatus.Builder,CapacityBlockStatus>
@Generated("software.amazon.awssdk:codegen") public final class CapacityBlockStatus extends Object implements SdkPojo, Serializable, ToCopyableBuilder<CapacityBlockStatus.Builder,CapacityBlockStatus>

Describes the availability of capacity for a Capacity Block.

See Also:

  • Method Details

    • capacityBlockId

      public final String capacityBlockId()

      The ID of the Capacity Block.

      Returns:
      The ID of the Capacity Block.

    • interconnectStatus

      public final CapacityBlockInterconnectStatus interconnectStatus()

      The status of the high-bandwidth accelerator interconnect. Possible states include:

      • ok the accelerator interconnect is healthy.

      • impaired - accelerator interconnect communication is impaired.

      • insufficient-data - insufficient data to determine accelerator interconnect status.

      If the service returns an enum value that is not available in the current SDK version, interconnectStatus will return CapacityBlockInterconnectStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from interconnectStatusAsString().

      Returns:
      The status of the high-bandwidth accelerator interconnect. Possible states include:

      • ok the accelerator interconnect is healthy.

      • impaired - accelerator interconnect communication is impaired.

      • insufficient-data - insufficient data to determine accelerator interconnect status.

      See Also:

    • interconnectStatusAsString

      public final String interconnectStatusAsString()

      The status of the high-bandwidth accelerator interconnect. Possible states include:

      • ok the accelerator interconnect is healthy.

      • impaired - accelerator interconnect communication is impaired.

      • insufficient-data - insufficient data to determine accelerator interconnect status.

      If the service returns an enum value that is not available in the current SDK version, interconnectStatus will return CapacityBlockInterconnectStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from interconnectStatusAsString().

      Returns:
      The status of the high-bandwidth accelerator interconnect. Possible states include:

      • ok the accelerator interconnect is healthy.

      • impaired - accelerator interconnect communication is impaired.

      • insufficient-data - insufficient data to determine accelerator interconnect status.

      See Also:

    • totalCapacity

      public final Integer totalCapacity()

      The combined amount of Available and Unavailable capacity in the Capacity Block.

      Returns:
      The combined amount of Available and Unavailable capacity in the Capacity Block.

    • totalAvailableCapacity

      public final Integer totalAvailableCapacity()

      The remaining capacity. Indicates the number of resources that can be launched into the Capacity Block.

      Returns:
      The remaining capacity. Indicates the number of resources that can be launched into the Capacity Block.

    • totalUnavailableCapacity

      public final Integer totalUnavailableCapacity()

      The unavailable capacity. Indicates the instance capacity that is unavailable for use due to a system status check failure.

      Returns:
      The unavailable capacity. Indicates the instance capacity that is unavailable for use due to a system status check failure.

    • hasCapacityReservationStatuses

      public final boolean hasCapacityReservationStatuses()
      For responses, this returns true if the service returned a value for the CapacityReservationStatuses 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.

    • capacityReservationStatuses

      public final List<CapacityReservationStatus> capacityReservationStatuses()

      The availability of capacity for the Capacity Block reservations.

      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 hasCapacityReservationStatuses() method.

      Returns:
      The availability of capacity for the Capacity Block reservations.

    • toBuilder

      public CapacityBlockStatus.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<CapacityBlockStatus.Builder,CapacityBlockStatus>
      Returns:
      a builder for type T

    • builder

      public static CapacityBlockStatus.Builder builder()

    • serializableBuilderClass

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