Class IcebergTableMetadata

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

The Apache Iceberg table metadata, including format version, table identifier, schemas, partition specifications, sort orders, and table properties. This structure captures the current state of an Iceberg table's metadata as managed by the Glue Data Catalog.

See Also:

  • Method Details

    • formatVersion

      public final String formatVersion()

      The Apache Iceberg table format version, such as 1 or 2. Determines the set of features and on-disk layout supported by the table.

      Returns:
      The Apache Iceberg table format version, such as 1 or 2. Determines the set of features and on-disk layout supported by the table.

    • tableUuid

      public final String tableUuid()

      The unique identifier (UUID) for the Iceberg table, assigned when the table is created and used to track the table across metadata updates.

      Returns:
      The unique identifier (UUID) for the Iceberg table, assigned when the table is created and used to track the table across metadata updates.

    • location

      public final String location()

      The base S3 location where the Iceberg table's data and metadata files are stored.

      Returns:
      The base S3 location where the Iceberg table's data and metadata files are stored.

    • hasProperties

      public final boolean hasProperties()
      For responses, this returns true if the service returned a value for the Properties property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • properties

      public final Map<String,String> properties()

      A map of key-value pairs that define table-level properties and configuration settings for the Iceberg table.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasProperties() method.

      Returns:
      A map of key-value pairs that define table-level properties and configuration settings for the Iceberg table.

    • hasSchemas

      public final boolean hasSchemas()
      For responses, this returns true if the service returned a value for the Schemas property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • schemas

      public final List<IcebergSchema> schemas()

      The list of schemas that have been associated with the Iceberg table over its history, supporting schema evolution.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSchemas() method.

      Returns:
      The list of schemas that have been associated with the Iceberg table over its history, supporting schema evolution.

    • currentSchemaId

      public final Integer currentSchemaId()

      The identifier of the schema that is currently active for the Iceberg table. Matches an entry in Schemas.

      Returns:
      The identifier of the schema that is currently active for the Iceberg table. Matches an entry in Schemas.

    • lastColumnId

      public final Integer lastColumnId()

      The highest column identifier that has been assigned in the Iceberg table's schema, used to ensure unique IDs as new columns are added.

      Returns:
      The highest column identifier that has been assigned in the Iceberg table's schema, used to ensure unique IDs as new columns are added.

    • hasPartitionSpecs

      public final boolean hasPartitionSpecs()
      For responses, this returns true if the service returned a value for the PartitionSpecs property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • partitionSpecs

      public final List<IcebergPartitionSpec> partitionSpecs()

      The list of partition specifications that have been associated with the Iceberg table over its history, supporting partition evolution.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasPartitionSpecs() method.

      Returns:
      The list of partition specifications that have been associated with the Iceberg table over its history, supporting partition evolution.

    • defaultSpecId

      public final Integer defaultSpecId()

      The identifier of the partition specification that is currently used by default when writing new data to the Iceberg table.

      Returns:
      The identifier of the partition specification that is currently used by default when writing new data to the Iceberg table.

    • lastPartitionId

      public final Integer lastPartitionId()

      The highest partition field identifier that has been assigned across the table's partition specifications.

      Returns:
      The highest partition field identifier that has been assigned across the table's partition specifications.

    • hasSortOrders

      public final boolean hasSortOrders()
      For responses, this returns true if the service returned a value for the SortOrders property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • sortOrders

      public final List<IcebergSortOrder> sortOrders()

      The list of sort order specifications that have been associated with the Iceberg table over its history.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSortOrders() method.

      Returns:
      The list of sort order specifications that have been associated with the Iceberg table over its history.

    • defaultSortOrderId

      public final Integer defaultSortOrderId()

      The identifier of the sort order that is currently used by default when writing new data to the Iceberg table.

      Returns:
      The identifier of the sort order that is currently used by default when writing new data to the Iceberg table.

    • toBuilder

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

    • builder

      public static IcebergTableMetadata.Builder builder()

    • serializableBuilderClass

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