Class Sort

java.lang.Object
software.amazon.awssdk.services.connect.model.Sort
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Sort.Builder,Sort>
@Generated("software.amazon.awssdk:codegen") public final class Sort extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Sort.Builder,Sort>

A structure that defines the field name to sort by and a sort order.

See Also:

  • Method Details

    • fieldName

      public final SortableFieldName fieldName()

      The name of the field on which to sort.

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

      Returns:
      The name of the field on which to sort.
      See Also:

    • fieldNameAsString

      public final String fieldNameAsString()

      The name of the field on which to sort.

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

      Returns:
      The name of the field on which to sort.
      See Also:

    • order

      public final SortOrder order()

      An ascending or descending sort.

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

      Returns:
      An ascending or descending sort.
      See Also:

    • orderAsString

      public final String orderAsString()

      An ascending or descending sort.

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

      Returns:
      An ascending or descending sort.
      See Also:

    • toBuilder

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

    • builder

      public static Sort.Builder builder()

    • serializableBuilderClass

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