Package software.amazon.awssdk.services.connect.model

Class Sort

java.lang.Object

software.amazon.awssdk.services.connect.model.Sort

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Sort.Builder,Sort>

@Generated("software.amazon.awssdk:codegen")
public final class Sort
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Sort.Builder,Sort>

A structure that defineds the field name to sort by and a sort order.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Sort.Builder

Method Summary

Modifier and Type	Method	Description
static Sort.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
SortableFieldName	fieldName()	The name of the field on which to sort.
String	fieldNameAsString()	The name of the field on which to sort.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
SortOrder	order()	An ascending or descending sort.
String	orderAsString()	An ascending or descending sort.
List<SdkField<?>>	sdkFields()
static Class<? extends Sort.Builder>	serializableBuilderClass()
Sort.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

fieldName

public final SortableFieldName fieldName()

The name of the field on which to sort.

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

Returns:

The name of the field on which to sort.

See Also:

SortableFieldName

fieldNameAsString

public final String fieldNameAsString()

The name of the field on which to sort.

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

Returns:

The name of the field on which to sort.

See Also:

SortableFieldName

order

public final SortOrder order()

An ascending or descending sort.

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

Returns:

An ascending or descending sort.

See Also:

SortOrder

orderAsString

public final String orderAsString()

An ascending or descending sort.

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

Returns:

An ascending or descending sort.

See Also:

SortOrder

toBuilder

public Sort.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Sort.Builder,Sort>

builder

public static Sort.Builder builder()

serializableBuilderClass

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