Class IcebergSortField

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

Defines a single sort field in an Iceberg sort order specification.

See Also:

  • Method Details

    • sourceId

      public final Integer sourceId()

      The ID of the source schema field to sort by. This must reference a valid field ID from the table schema.

      Returns:
      The ID of the source schema field to sort by. This must reference a valid field ID from the table schema.

    • transform

      public final String transform()

      The transform to apply to the source field before sorting. Use identity to sort by the field value directly, or specify other transforms as needed.

      Returns:
      The transform to apply to the source field before sorting. Use identity to sort by the field value directly, or specify other transforms as needed.

    • direction

      public final IcebergSortDirection direction()

      The sort direction. Valid values are asc for ascending order or desc for descending order.

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

      Returns:
      The sort direction. Valid values are asc for ascending order or desc for descending order.
      See Also:

    • directionAsString

      public final String directionAsString()

      The sort direction. Valid values are asc for ascending order or desc for descending order.

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

      Returns:
      The sort direction. Valid values are asc for ascending order or desc for descending order.
      See Also:

    • nullOrder

      public final IcebergNullOrder nullOrder()

      Specifies how null values are ordered. Valid values are nulls-first to place nulls before non-null values, or nulls-last to place nulls after non-null values.

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

      Returns:
      Specifies how null values are ordered. Valid values are nulls-first to place nulls before non-null values, or nulls-last to place nulls after non-null values.
      See Also:

    • nullOrderAsString

      public final String nullOrderAsString()

      Specifies how null values are ordered. Valid values are nulls-first to place nulls before non-null values, or nulls-last to place nulls after non-null values.

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

      Returns:
      Specifies how null values are ordered. Valid values are nulls-first to place nulls before non-null values, or nulls-last to place nulls after non-null values.
      See Also:

    • toBuilder

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

    • builder

      public static IcebergSortField.Builder builder()

    • serializableBuilderClass

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