Class KnowledgeBaseSortBy

java.lang.Object

software.amazon.awssdk.services.quicksight.model.KnowledgeBaseSortBy

All Implemented Interfaces:

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

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

The sort configuration for searching knowledge bases.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	KnowledgeBaseSortBy.Builder

Method Summary

Modifier and Type	Method	Description
static KnowledgeBaseSortBy.Builder	builder()
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)	Indicates whether some other object is "equal to" this one by SDK fields.
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
final int	hashCode()
final Map<String,SdkField<?>>	sdkFieldNameToField()
final List<SdkField<?>>	sdkFields()
static Class<? extends KnowledgeBaseSortBy.Builder>	serializableBuilderClass()
final KnowledgeBaseSortByField	sortByField()	The field to sort by.
final String	sortByFieldAsString()	The field to sort by.
final SortOrder	sortOrder()	The sort order (ascending or descending).
final String	sortOrderAsString()	The sort order (ascending or descending).
KnowledgeBaseSortBy.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
final String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Details

sortByField

public final KnowledgeBaseSortByField sortByField()

The field to sort by.

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

Returns:

The field to sort by.

See Also:

• KnowledgeBaseSortByField

sortByFieldAsString

public final String sortByFieldAsString()

The field to sort by.

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

Returns:

The field to sort by.

See Also:

• KnowledgeBaseSortByField

sortOrder

public final SortOrder sortOrder()

The sort order (ascending or descending).

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

Returns:

The sort order (ascending or descending).

See Also:

• SortOrder

sortOrderAsString

public final String sortOrderAsString()

The sort order (ascending or descending).

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

Returns:

The sort order (ascending or descending).

See Also:

• SortOrder

toBuilder

public KnowledgeBaseSortBy.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<KnowledgeBaseSortBy.Builder,KnowledgeBaseSortBy>

Returns:

a builder for type T

builder

public static KnowledgeBaseSortBy.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo

Returns:

The mapping between the field name and its corresponding field.