Package software.amazon.awssdk.services.workdocs.model

Class SearchSortResult

java.lang.Object

software.amazon.awssdk.services.workdocs.model.SearchSortResult

All Implemented Interfaces:

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

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

The result of the sort operation.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SearchSortResult.Builder

Method Summary

Modifier and Type	Method	Description
static SearchSortResult.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
OrderByFieldType	field()	Sort search results based on this field name.
String	fieldAsString()	Sort search results based on this field name.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
SortOrder	order()	Sort direction.
String	orderAsString()	Sort direction.
List<SdkField<?>>	sdkFields()
static Class<? extends SearchSortResult.Builder>	serializableBuilderClass()
SearchSortResult.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

field

public final OrderByFieldType field()

Sort search results based on this field name.

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

Returns:

Sort search results based on this field name.

See Also:

OrderByFieldType

fieldAsString

public final String fieldAsString()

Sort search results based on this field name.

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

Returns:

Sort search results based on this field name.

See Also:

OrderByFieldType

order

public final SortOrder order()

Sort direction.

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:

Sort direction.

See Also:

SortOrder

orderAsString

public final String orderAsString()

Sort direction.

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:

Sort direction.

See Also:

SortOrder

toBuilder

public SearchSortResult.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SearchSortResult.Builder,SearchSortResult>

builder

public static SearchSortResult.Builder builder()

serializableBuilderClass

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