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

Class ComparativeOrder

java.lang.Object

software.amazon.awssdk.services.quicksight.model.ComparativeOrder

All Implemented Interfaces:

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

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

A structure that represents a comparative order.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ComparativeOrder.Builder

Method Summary

Modifier and Type	Method	Description
static ComparativeOrder.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasSpecifedOrder()	For responses, this returns true if the service returned a value for the SpecifedOrder property.
List<SdkField<?>>	sdkFields()
static Class<? extends ComparativeOrder.Builder>	serializableBuilderClass()
List<String>	specifedOrder()	The list of columns to be used in the ordering.
ComparativeOrder.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
UndefinedSpecifiedValueType	treatUndefinedSpecifiedValues()	The treat of undefined specified values.
String	treatUndefinedSpecifiedValuesAsString()	The treat of undefined specified values.
ColumnOrderingType	useOrdering()	The ordering type for a column.
String	useOrderingAsString()	The ordering type for a column.

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

useOrdering

public final ColumnOrderingType useOrdering()

The ordering type for a column. Valid values for this structure are GREATER_IS_BETTER, LESSER_IS_BETTER and SPECIFIED.

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

Returns:

The ordering type for a column. Valid values for this structure are GREATER_IS_BETTER, LESSER_IS_BETTER and SPECIFIED.

See Also:

ColumnOrderingType

useOrderingAsString

public final String useOrderingAsString()

The ordering type for a column. Valid values for this structure are GREATER_IS_BETTER, LESSER_IS_BETTER and SPECIFIED.

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

Returns:

The ordering type for a column. Valid values for this structure are GREATER_IS_BETTER, LESSER_IS_BETTER and SPECIFIED.

See Also:

ColumnOrderingType

hasSpecifedOrder

public final boolean hasSpecifedOrder()

For responses, this returns true if the service returned a value for the SpecifedOrder 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.

specifedOrder

public final List<String> specifedOrder()

The list of columns to be used in the ordering.

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 hasSpecifedOrder() method.

Returns:

The list of columns to be used in the ordering.

treatUndefinedSpecifiedValues

public final UndefinedSpecifiedValueType treatUndefinedSpecifiedValues()

The treat of undefined specified values. Valid values for this structure are LEAST and MOST.

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

Returns:

The treat of undefined specified values. Valid values for this structure are LEAST and MOST.

See Also:

UndefinedSpecifiedValueType

treatUndefinedSpecifiedValuesAsString

public final String treatUndefinedSpecifiedValuesAsString()

The treat of undefined specified values. Valid values for this structure are LEAST and MOST.

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

Returns:

The treat of undefined specified values. Valid values for this structure are LEAST and MOST.

See Also:

UndefinedSpecifiedValueType

toBuilder

public ComparativeOrder.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ComparativeOrder.Builder,ComparativeOrder>

builder

public static ComparativeOrder.Builder builder()

serializableBuilderClass

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