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:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceClusteringKey.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ClusteringKey.Builderbuilder()booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()Stringname()The name(s) of the clustering column(s).SortOrderorderBy()Sets the ascendant (ASC) or descendant (DESC) order modifier.StringorderByAsString()Sets the ascendant (ASC) or descendant (DESC) order modifier.List<SdkField<?>>sdkFields()static Class<? extends ClusteringKey.Builder>serializableBuilderClass()ClusteringKey.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
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,
orderBywill returnSortOrder.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromorderByAsString().- Returns:
- Sets the ascendant (
ASC) or descendant (DESC) order modifier. - See Also:
SortOrder
-
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,
orderBywill returnSortOrder.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromorderByAsString().- Returns:
- Sets the ascendant (
ASC) or descendant (DESC) order modifier. - See Also:
SortOrder
-
toBuilder
public ClusteringKey.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<ClusteringKey.Builder,ClusteringKey>
-
builder
public static ClusteringKey.Builder builder()
-
serializableBuilderClass
public static Class<? extends ClusteringKey.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
-