Class SortAttribute

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

Defines the characteristics and rules for sorting by a specific attribute.

See Also:

  • Method Details

    • name

      public final String name()

      The name of the attribute to sort by.

      Returns:
      The name of the attribute to sort by.

    • dataType

      public final SegmentSortDataType dataType()

      The data type of the sort attribute (e.g., string, number, date).

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

      Returns:
      The data type of the sort attribute (e.g., string, number, date).
      See Also:

    • dataTypeAsString

      public final String dataTypeAsString()

      The data type of the sort attribute (e.g., string, number, date).

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

      Returns:
      The data type of the sort attribute (e.g., string, number, date).
      See Also:

    • order

      public final SegmentSortOrder order()

      The sort order for the attribute (ascending or descending).

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

      Returns:
      The sort order for the attribute (ascending or descending).
      See Also:

    • orderAsString

      public final String orderAsString()

      The sort order for the attribute (ascending or descending).

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

      Returns:
      The sort order for the attribute (ascending or descending).
      See Also:

    • type

      public final SortAttributeType type()

      The type of attribute (e.g., profile, calculated).

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

      Returns:
      The type of attribute (e.g., profile, calculated).
      See Also:

    • typeAsString

      public final String typeAsString()

      The type of attribute (e.g., profile, calculated).

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

      Returns:
      The type of attribute (e.g., profile, calculated).
      See Also:

    • toBuilder

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

    • builder

      public static SortAttribute.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.