@Generated(value="software.amazon.awssdk:codegen") public final class ComparativeOrder extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ComparativeOrder.Builder,ComparativeOrder>
A structure that represents a comparative order.
| Modifier and Type | Class and Description |
|---|---|
static interface |
ComparativeOrder.Builder |
| Modifier and Type | Method and 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.
|
clone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic 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().
GREATER_IS_BETTER,
LESSER_IS_BETTER and SPECIFIED.ColumnOrderingTypepublic 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().
GREATER_IS_BETTER,
LESSER_IS_BETTER and SPECIFIED.ColumnOrderingTypepublic final boolean hasSpecifedOrder()
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.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.
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().
LEAST and
MOST.UndefinedSpecifiedValueTypepublic 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().
LEAST and
MOST.UndefinedSpecifiedValueTypepublic ComparativeOrder.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<ComparativeOrder.Builder,ComparativeOrder>public static ComparativeOrder.Builder builder()
public static Class<? extends ComparativeOrder.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
Copyright © 2023. All rights reserved.