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:

  • Method Details

    • 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 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.

    • 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 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.

    • 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 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.

    • 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()
      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<S3IcebergCatalogTarget.Builder,S3IcebergCatalogTarget>
      Returns:
      a builder for type T

    • builder

      public static S3IcebergCatalogTarget.Builder builder()

    • serializableBuilderClass

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