Class IcebergSchema
- java.lang.Object
-
- software.amazon.awssdk.services.glue.model.IcebergSchema
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<IcebergSchema.Builder,IcebergSchema>
@Generated("software.amazon.awssdk:codegen") public final class IcebergSchema extends Object implements SdkPojo, Serializable, ToCopyableBuilder<IcebergSchema.Builder,IcebergSchema>
Defines the schema structure for an Iceberg table, including field definitions, data types, and schema metadata.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceIcebergSchema.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static IcebergSchema.Builderbuilder()booleanequals(Object obj)booleanequalsBySdkFields(Object obj)List<IcebergStructField>fields()The list of field definitions that make up the table schema, including field names, types, and metadata.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasFields()For responses, this returns true if the service returned a value for the Fields property.inthashCode()booleanhasIdentifierFieldIds()For responses, this returns true if the service returned a value for the IdentifierFieldIds property.List<Integer>identifierFieldIds()The list of field identifiers that uniquely identify records in the table, used for row-level operations and deduplication.IntegerschemaId()The unique identifier for this schema version within the Iceberg table's schema evolution history.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends IcebergSchema.Builder>serializableBuilderClass()IcebergSchema.BuildertoBuilder()StringtoString()Returns a string representation of this object.IcebergStructTypeEnumtype()The root type of the schema structure, typically "struct" for Iceberg table schemas.StringtypeAsString()The 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, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
schemaId
public final Integer 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
public final List<Integer> 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
public final IcebergStructTypeEnum 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:
IcebergStructTypeEnum
-
typeAsString
public final String 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:
IcebergStructTypeEnum
-
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
public final List<IcebergStructField> 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
public IcebergSchema.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<IcebergSchema.Builder,IcebergSchema>
-
builder
public static IcebergSchema.Builder builder()
-
serializableBuilderClass
public static Class<? extends IcebergSchema.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-