Package software.amazon.awssdk.services.quicksight.model

Class DataPathSort

java.lang.Object

software.amazon.awssdk.services.quicksight.model.DataPathSort

All Implemented Interfaces:

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

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

Allows data paths to be sorted by a specific data value.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DataPathSort.Builder

Method Summary

Modifier and Type	Method	Description
static DataPathSort.Builder	builder()
SortDirection	direction()	Determines the sort direction.
String	directionAsString()	Determines the sort direction.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasSortPaths()	For responses, this returns true if the service returned a value for the SortPaths property.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends DataPathSort.Builder>	serializableBuilderClass()
List<DataPathValue>	sortPaths()	The list of data paths that need to be sorted.
DataPathSort.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

direction

public final SortDirection direction()

Determines the sort direction.

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

Returns:

Determines the sort direction.

See Also:

SortDirection

directionAsString

public final String directionAsString()

Determines the sort direction.

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

Returns:

Determines the sort direction.

See Also:

SortDirection

hasSortPaths

public final boolean hasSortPaths()

For responses, this returns true if the service returned a value for the SortPaths property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

sortPaths

public final List<DataPathValue> sortPaths()

The list of data paths that need to be sorted.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSortPaths() method.

Returns:

The list of data paths that need to be sorted.

toBuilder

public DataPathSort.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DataPathSort.Builder,DataPathSort>

builder

public static DataPathSort.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

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

Specified by:

sdkFieldNameToField in interface SdkPojo