Class WarmThroughputSpecificationSummary

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

Contains the current warm throughput settings for a table, including the configured capacity units and the current status of the warm throughput configuration.

See Also:

  • Method Details

    • readUnitsPerSecond

      public final Long readUnitsPerSecond()

      The number of read capacity units per second currently configured for warm throughput.

      Returns:
      The number of read capacity units per second currently configured for warm throughput.

    • writeUnitsPerSecond

      public final Long writeUnitsPerSecond()

      The number of write capacity units per second currently configured for warm throughput.

      Returns:
      The number of write capacity units per second currently configured for warm throughput.

    • status

      public final WarmThroughputStatus status()

      The current status of the warm throughput configuration. Valid values are AVAILABLE when the configuration is active, and UPDATING when changes are being applied.

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

      Returns:
      The current status of the warm throughput configuration. Valid values are AVAILABLE when the configuration is active, and UPDATING when changes are being applied.
      See Also:

    • statusAsString

      public final String statusAsString()

      The current status of the warm throughput configuration. Valid values are AVAILABLE when the configuration is active, and UPDATING when changes are being applied.

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

      Returns:
      The current status of the warm throughput configuration. Valid values are AVAILABLE when the configuration is active, and UPDATING when changes are being applied.
      See Also:

    • toBuilder

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

    • builder

      public static WarmThroughputSpecificationSummary.Builder builder()

    • serializableBuilderClass

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