software.amazon.s3tables.iceberg.S3TablesProperties Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of s3-tables-catalog-for-iceberg Show documentation

Amazon S3 Tables Catalog for Apache Iceberg.

There is a newer version: 0.1.4

Show newest version

package software.amazon.s3tables.iceberg;

import software.amazon.awssdk.core.client.config.SdkAdvancedClientOption;
import software.amazon.awssdk.core.client.config.SdkAdvancedClientOption;
import software.amazon.s3tables.iceberg.S3TablesAwsClientFactories.DefaultS3TablesAwsClientFactory;
import software.amazon.awssdk.services.s3tables.S3TablesClientBuilder;

import java.io.Serializable;
import java.net.URI;
import java.util.Map;

public class S3TablesProperties implements Serializable {
    /**
     * This property is used to pass in the aws client factory implementation class for S3 Tables. The
     * class should implement {@link S3TablesAwsClientFactory}. For example, {@link
     * DefaultS3TablesAwsClientFactory} implements {@link S3TablesAwsClientFactory}. If this property
     * wasn't set, will load one of {@link S3TablesAwsClientFactory} factory classes to
     * provide backward compatibility.
     */
    public static final String CLIENT_FACTORY = "s3tables.client-factory-impl";

    /**
     * Configure an alternative endpoint of the S3 Tables service to access.
     */
    public static final String S3TABLES_ENDPOINT = "s3tables.endpoint";
    public static final String S3_TABLES_ICEBERG_CATALOG = "s3tables-iceberg-catalog/1.0.0";

    private String s3tablesEndpoint;

    public S3TablesProperties() {
        super();
    }

    public S3TablesProperties(Map properties) {
        this.s3tablesEndpoint = properties.get(S3TABLES_ENDPOINT);
    }

    /**
     * Override the endpoint for a s3tables client.
     *
     * Sample usage:
     *
     * 
     *     S3TablesClient.builder().applyMutation(s3TablesProperties::applyS3TableEndpointConfigurations)
     * 
     */
    public  void applyS3TableEndpointConfigurations(T builder) {
        if (s3tablesEndpoint != null) {
            builder.endpointOverride(URI.create(s3tablesEndpoint));
        }
    }

    /**
     * Override the user agent for a s3 tables sdk client
     *
     * Sample usage:
     *
     * 
     *     S3TablesClient.builder().applyMutation(s3TablesProperties::applyUserAgentConfigurations)
     * 
     */
    public  void applyUserAgentConfigurations(T builder) {
        builder.overrideConfiguration(
            c -> c.putAdvancedOption(SdkAdvancedClientOption.USER_AGENT_PREFIX, S3_TABLES_ICEBERG_CATALOG));
    }
}