Class CapacityReservation

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

A reservation for a specified number of data processing units (DPUs). When a reservation is initially created, it has no DPUs. Athena allocates DPUs until the allocated amount equals the requested amount.

See Also:

  • Method Details

    • name

      public final String name()

      The name of the capacity reservation.

      Returns:
      The name of the capacity reservation.

    • status

      public final CapacityReservationStatus status()

      The status of the capacity reservation.

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

      Returns:
      The status of the capacity reservation.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the capacity reservation.

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

      Returns:
      The status of the capacity reservation.
      See Also:

    • targetDpus

      public final Integer targetDpus()

      The number of data processing units requested.

      Returns:
      The number of data processing units requested.

    • allocatedDpus

      public final Integer allocatedDpus()

      The number of data processing units currently allocated.

      Returns:
      The number of data processing units currently allocated.

    • lastAllocation

      public final CapacityAllocation lastAllocation()
      Returns the value of the LastAllocation property for this object.
      Returns:
      The value of the LastAllocation property for this object.

    • lastSuccessfulAllocationTime

      public final Instant lastSuccessfulAllocationTime()

      The time of the most recent capacity allocation that succeeded.

      Returns:
      The time of the most recent capacity allocation that succeeded.

    • creationTime

      public final Instant creationTime()

      The time in UTC epoch millis when the capacity reservation was created.

      Returns:
      The time in UTC epoch millis when the capacity reservation was created.

    • toBuilder

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

    • builder

      public static CapacityReservation.Builder builder()

    • serializableBuilderClass

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