Class S3IcebergCatalogTarget
- java.lang.Object
-
- software.amazon.awssdk.services.glue.model.S3IcebergCatalogTarget
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<S3IcebergCatalogTarget.Builder,S3IcebergCatalogTarget>
@Generated("software.amazon.awssdk:codegen") public final class S3IcebergCatalogTarget extends Object implements SdkPojo, Serializable, ToCopyableBuilder<S3IcebergCatalogTarget.Builder,S3IcebergCatalogTarget>
Specifies an Apache Iceberg catalog target that writes data to Amazon S3 and registers the table in the Glue Data Catalog.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceS3IcebergCatalogTarget.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Map<String,String>additionalOptions()Specifies additional connection options for the Iceberg catalog target.AutoDataQualityautoDataQuality()Specifies whether to automatically enable data quality evaluation for the S3 Iceberg catalog target.static S3IcebergCatalogTarget.Builderbuilder()Stringdatabase()The name of the database to write to.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasAdditionalOptions()For responses, this returns true if the service returned a value for the AdditionalOptions property.inthashCode()booleanhasInputs()For responses, this returns true if the service returned a value for the Inputs property.booleanhasPartitionKeys()For responses, this returns true if the service returned a value for the PartitionKeys property.List<String>inputs()The input connection for the Iceberg catalog target.Stringname()The name of the Iceberg catalog target.List<List<String>>partitionKeys()A list of partition keys for the Iceberg table.CatalogSchemaChangePolicyschemaChangePolicy()The policy for handling schema changes in the catalog target.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends S3IcebergCatalogTarget.Builder>serializableBuilderClass()Stringtable()The name of the table to write to in the catalog.S3IcebergCatalogTarget.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
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
-
name
public final String name()
The name of the Iceberg catalog target.
- Returns:
- The name of the Iceberg catalog target.
-
hasInputs
public final boolean hasInputs()
For responses, this returns true if the service returned a value for the Inputs 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.
-
inputs
public final List<String> inputs()
The input connection for the Iceberg catalog target.
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
hasInputs()method.- Returns:
- The input connection for the Iceberg catalog target.
-
hasPartitionKeys
public final boolean hasPartitionKeys()
For responses, this returns true if the service returned a value for the PartitionKeys 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.
-
partitionKeys
public final List<List<String>> partitionKeys()
A list of partition keys 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
hasPartitionKeys()method.- Returns:
- A list of partition keys for the Iceberg table.
-
table
public final String table()
The name of the table to write to in the catalog.
- Returns:
- The name of the table to write to in the catalog.
-
database
public final String database()
The name of the database to write to.
- Returns:
- The name of the database to write to.
-
hasAdditionalOptions
public final boolean hasAdditionalOptions()
For responses, this returns true if the service returned a value for the AdditionalOptions 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.
-
additionalOptions
public final Map<String,String> additionalOptions()
Specifies additional connection options for the Iceberg catalog target.
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
hasAdditionalOptions()method.- Returns:
- Specifies additional connection options for the Iceberg catalog target.
-
schemaChangePolicy
public final CatalogSchemaChangePolicy schemaChangePolicy()
The policy for handling schema changes in the catalog target.
- Returns:
- The policy for handling schema changes in the catalog target.
-
autoDataQuality
public final AutoDataQuality autoDataQuality()
Specifies whether to automatically enable data quality evaluation for the S3 Iceberg catalog target. When set to
true, data quality checks are performed automatically during the write operation.- Returns:
- Specifies whether to automatically enable data quality evaluation for the S3 Iceberg catalog target. When
set to
true, data quality checks are performed automatically during the write operation.
-
toBuilder
public S3IcebergCatalogTarget.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<S3IcebergCatalogTarget.Builder,S3IcebergCatalogTarget>
-
builder
public static S3IcebergCatalogTarget.Builder builder()
-
serializableBuilderClass
public static Class<? extends S3IcebergCatalogTarget.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
-
-