Package software.amazon.awssdk.services.keyspaces.model

Class CapacitySpecification

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

Amazon Keyspaces has two read/write capacity modes for processing reads and writes on your tables:

  • On-demand (default)

  • Provisioned

The read/write capacity mode that you choose controls how you are charged for read and write throughput and how table throughput capacity is managed.

For more information, see Read/write capacity modes in the Amazon Keyspaces Developer Guide.

See Also:

  • Method Details

    • throughputMode

      public final ThroughputMode throughputMode()

      The read/write throughput capacity mode for a table. The options are:

      • throughputMode:PAY_PER_REQUEST and

      • throughputMode:PROVISIONED - Provisioned capacity mode requires readCapacityUnits and writeCapacityUnits as input.

      The default is throughput_mode:PAY_PER_REQUEST.

      For more information, see Read/write capacity modes in the Amazon Keyspaces Developer Guide.

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

      Returns:
      The read/write throughput capacity mode for a table. The options are:

      • throughputMode:PAY_PER_REQUEST and

      • throughputMode:PROVISIONED - Provisioned capacity mode requires readCapacityUnits and writeCapacityUnits as input.

      The default is throughput_mode:PAY_PER_REQUEST.

      For more information, see Read/write capacity modes in the Amazon Keyspaces Developer Guide.

      See Also:

    • throughputModeAsString

      public final String throughputModeAsString()

      The read/write throughput capacity mode for a table. The options are:

      • throughputMode:PAY_PER_REQUEST and

      • throughputMode:PROVISIONED - Provisioned capacity mode requires readCapacityUnits and writeCapacityUnits as input.

      The default is throughput_mode:PAY_PER_REQUEST.

      For more information, see Read/write capacity modes in the Amazon Keyspaces Developer Guide.

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

      Returns:
      The read/write throughput capacity mode for a table. The options are:

      • throughputMode:PAY_PER_REQUEST and

      • throughputMode:PROVISIONED - Provisioned capacity mode requires readCapacityUnits and writeCapacityUnits as input.

      The default is throughput_mode:PAY_PER_REQUEST.

      For more information, see Read/write capacity modes in the Amazon Keyspaces Developer Guide.

      See Also:

    • readCapacityUnits

      public final Long readCapacityUnits()

      The throughput capacity specified for read operations defined in read capacity units (RCUs).

      Returns:
      The throughput capacity specified for read operations defined in read capacity units (RCUs).

    • writeCapacityUnits

      public final Long writeCapacityUnits()

      The throughput capacity specified for write operations defined in write capacity units (WCUs).

      Returns:
      The throughput capacity specified for write operations defined in write capacity units (WCUs).

    • toBuilder

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

    • builder

      public static CapacitySpecification.Builder builder()

    • serializableBuilderClass

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