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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ClusteringKey.Builder

Method Summary

Modifier and Type	Method	Description
static ClusteringKey.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	name()	The name(s) of the clustering column(s).
SortOrder	orderBy()	Sets the ascendant (ASC) or descendant (DESC) order modifier.
String	orderByAsString()	Sets the ascendant (ASC) or descendant (DESC) order modifier.
List<SdkField<?>>	sdkFields()
static Class<? extends ClusteringKey.Builder>	serializableBuilderClass()
ClusteringKey.Builder	toBuilder()
String	toString()	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, 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:

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, 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:

SortOrder

toBuilder

public ClusteringKey.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ClusteringKey.Builder,ClusteringKey>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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