Class IcebergSchemaV2

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

Contains details about the schema for an Iceberg table using the V2 format. This schema format supports nested and complex data types such as struct, list, and map, in addition to primitive types.

See Also:

  • Method Details

    • type

      public final SchemaV2FieldType type()

      The type of the top-level schema, which is always a struct type as defined in the Apache Iceberg specification. This value must be struct.

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

      Returns:
      The type of the top-level schema, which is always a struct type as defined in the Apache Iceberg specification. This value must be struct.
      See Also:

    • typeAsString

      public final String typeAsString()

      The type of the top-level schema, which is always a struct type as defined in the Apache Iceberg specification. This value must be struct.

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

      Returns:
      The type of the top-level schema, which is always a struct type as defined in the Apache Iceberg specification. This value must be struct.
      See Also:

    • hasFields

      public final boolean hasFields()
      For responses, this returns true if the service returned a value for the Fields 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.

    • fields

      public final List<SchemaV2Field> fields()

      The schema fields for the table. Each field defines a column in the table, including its name, type, and whether it is required.

      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 hasFields() method.

      Returns:
      The schema fields for the table. Each field defines a column in the table, including its name, type, and whether it is required.

    • schemaId

      public final Integer schemaId()

      An optional unique identifier for the schema. Schema IDs are used by Apache Iceberg to track schema evolution.

      Returns:
      An optional unique identifier for the schema. Schema IDs are used by Apache Iceberg to track schema evolution.

    • hasIdentifierFieldIds

      public final boolean hasIdentifierFieldIds()
      For responses, this returns true if the service returned a value for the IdentifierFieldIds 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.

    • identifierFieldIds

      public final List<Integer> identifierFieldIds()

      A list of field IDs that are used as the identifier fields for the table. Identifier fields uniquely identify a row in the 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 hasIdentifierFieldIds() method.

      Returns:
      A list of field IDs that are used as the identifier fields for the table. Identifier fields uniquely identify a row in the table.

    • toBuilder

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

    • builder

      public static IcebergSchemaV2.Builder builder()

    • serializableBuilderClass

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