Class IcebergPartitionField

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

Defines a single partition field in an Iceberg partition specification.

See Also:

  • Method Details

    • sourceId

      public final Integer sourceId()

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

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

    • transform

      public final String transform()

      The partition transform to apply to the source field. Supported transforms include identity, year, month, day, hour, bucket, and truncate. For more information, see the Apache Iceberg partition transforms documentation.

      Returns:
      The partition transform to apply to the source field. Supported transforms include identity, year, month, day, hour, bucket, and truncate. For more information, see the Apache Iceberg partition transforms documentation.

    • name

      public final String name()

      The name for this partition field. This name is used in the partitioned file paths.

      Returns:
      The name for this partition field. This name is used in the partitioned file paths.

    • fieldId

      public final Integer fieldId()

      An optional unique identifier for this partition field. If not specified, S3 Tables automatically assigns a field ID.

      Returns:
      An optional unique identifier for this partition field. If not specified, S3 Tables automatically assigns a field ID.

    • toBuilder

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

    • builder

      public static IcebergPartitionField.Builder builder()

    • serializableBuilderClass

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