Package software.amazon.awssdk.services.glue.model

Class IcebergSortField

java.lang.Object

software.amazon.awssdk.services.glue.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 field within an Iceberg sort order specification, including the source field, transformation, sort direction, and null value ordering.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	IcebergSortField.Builder

Method Summary

Modifier and Type	Method	Description
static IcebergSortField.Builder	builder()
IcebergSortDirection	direction()	The sort direction for this field, either ascending or descending.
String	directionAsString()	The sort direction for this field, either ascending or descending.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
IcebergNullOrder	nullOrder()	The ordering behavior for null values in this field, specifying whether nulls should appear first or last in the sort order.
String	nullOrderAsString()	The ordering behavior for null values in this field, specifying whether nulls should appear first or last in the sort order.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends IcebergSortField.Builder>	serializableBuilderClass()
Integer	sourceId()	The identifier of the source field from the table schema that this sort field is based on.
IcebergSortField.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	transform()	The transformation function applied to the source field before sorting, such as identity, bucket, or truncate.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

sourceId

public final Integer sourceId()

The identifier of the source field from the table schema that this sort field is based on.

Returns:

The identifier of the source field from the table schema that this sort field is based on.

transform

public final String transform()

The transformation function applied to the source field before sorting, such as identity, bucket, or truncate.

Returns:

The transformation function applied to the source field before sorting, such as identity, bucket, or truncate.

direction

public final IcebergSortDirection direction()

The sort direction for this field, either ascending or descending.

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 for this field, either ascending or descending.

See Also:

IcebergSortDirection

directionAsString

public final String directionAsString()

The sort direction for this field, either ascending or descending.

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 for this field, either ascending or descending.

See Also:

IcebergSortDirection

nullOrder

public final IcebergNullOrder nullOrder()

The ordering behavior for null values in this field, specifying whether nulls should appear first or last in the sort order.

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:

The ordering behavior for null values in this field, specifying whether nulls should appear first or last in the sort order.

See Also:

IcebergNullOrder

nullOrderAsString

public final String nullOrderAsString()

The ordering behavior for null values in this field, specifying whether nulls should appear first or last in the sort order.

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:

The ordering behavior for null values in this field, specifying whether nulls should appear first or last in the sort order.

See Also:

IcebergNullOrder

toBuilder

public IcebergSortField.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<IcebergSortField.Builder,IcebergSortField>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo