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:

  • Method Details

    • 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:

    • 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:

    • 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:

    • 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:

    • toBuilder

      public ComparativeOrder.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<ComparativeOrder.Builder,ComparativeOrder>
      Returns:
      a builder for type T

    • 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)
      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.