Class IcebergSchema
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<IcebergSchema.Builder,IcebergSchema>
Defines the schema structure for an Iceberg table, including field definitions, data types, and schema metadata.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionstatic IcebergSchema.Builderbuilder()final booleanfinal booleanequalsBySdkFields(Object obj) final List<IcebergStructField>fields()The list of field definitions that make up the table schema, including field names, types, and metadata.final <T> Optional<T>getValueForField(String fieldName, Class<T> clazz) final booleanFor responses, this returns true if the service returned a value for the Fields property.final inthashCode()final booleanFor responses, this returns true if the service returned a value for the IdentifierFieldIds property.The list of field identifiers that uniquely identify records in the table, used for row-level operations and deduplication.final IntegerschemaId()The unique identifier for this schema version within the Iceberg table's schema evolution history.static Class<? extends IcebergSchema.Builder>final StringtoString()Returns a string representation of this object.final IcebergStructTypeEnumtype()The root type of the schema structure, typically "struct" for Iceberg table schemas.final StringThe root type of the schema structure, typically "struct" for Iceberg table schemas.Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
schemaId
The unique identifier for this schema version within the Iceberg table's schema evolution history.
- Returns:
- The unique identifier for this schema version within the Iceberg table's schema evolution history.
-
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 theisEmpty()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
The list of field identifiers that uniquely identify records in the table, used for row-level operations and deduplication.
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:
- The list of field identifiers that uniquely identify records in the table, used for row-level operations and deduplication.
-
type
The root type of the schema structure, typically "struct" for Iceberg table schemas.
If the service returns an enum value that is not available in the current SDK version,
typewill returnIcebergStructTypeEnum.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromtypeAsString().- Returns:
- The root type of the schema structure, typically "struct" for Iceberg table schemas.
- See Also:
-
typeAsString
The root type of the schema structure, typically "struct" for Iceberg table schemas.
If the service returns an enum value that is not available in the current SDK version,
typewill returnIcebergStructTypeEnum.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromtypeAsString().- Returns:
- The root type of the schema structure, typically "struct" for Iceberg table schemas.
- 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 theisEmpty()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
The list of field definitions that make up the table schema, including field names, types, and metadata.
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 list of field definitions that make up the table schema, including field names, types, and metadata.
-
toBuilder
- Specified by:
toBuilderin interfaceToCopyableBuilder<IcebergSchema.Builder,IcebergSchema>
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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. -
getValueForField
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-