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

Class ClusteringKey

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

The optional clustering column portion of your primary key determines how the data is clustered and sorted within each partition.

See Also:

  • Method Details

    • name

      public final String name()

      The name(s) of the clustering column(s).

      Returns:
      The name(s) of the clustering column(s).

    • orderBy

      public final SortOrder orderBy()

      Sets the ascendant (ASC) or descendant (DESC) order modifier.

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

      Returns:
      Sets the ascendant (ASC) or descendant (DESC) order modifier.
      See Also:

    • orderByAsString

      public final String orderByAsString()

      Sets the ascendant (ASC) or descendant (DESC) order modifier.

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

      Returns:
      Sets the ascendant (ASC) or descendant (DESC) order modifier.
      See Also:

    • toBuilder

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

    • builder

      public static ClusteringKey.Builder builder()

    • serializableBuilderClass

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