Class OciObjectStorageS3ApiIcebergStorage


  • @Generated(value="OracleSDKGenerator",
               comments="API Version: 20200407")
    public final class OciObjectStorageS3ApiIcebergStorage
    extends IcebergStorage
    Connection details of the OCI Object Storage (S3 Compatibility API) configuration used by the Iceberg connection.
    Note: Objects should always be created or deserialized using the OciObjectStorageS3ApiIcebergStorage.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the OciObjectStorageS3ApiIcebergStorage.Builder, which maintain a set of all explicitly set fields called OciObjectStorageS3ApiIcebergStorage.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).
    • Constructor Detail

      • OciObjectStorageS3ApiIcebergStorage

        @Deprecated
        public OciObjectStorageS3ApiIcebergStorage​(String endpoint,
                                                   String accessKeyId,
                                                   String secretAccessKeySecretId,
                                                   String bucket)
        Deprecated.
    • Method Detail

      • getEndpoint

        public String getEndpoint()
        OCI Object Storage S3 Compatibility API endpoint URL.

        Format: “https://.compat.objectstorage..” Example: “https://mynamespace.compat.objectstorage.us-ashburn-1.oraclecloud.com”

        Returns:
        the value
      • getAccessKeyId

        public String getAccessKeyId()
        Access Key ID from the OCI IAM user’s Customer Secret Key pair used to authenticate to OCI Object Storage via the S3 Compatibility API.

        Note: Despite the "Id" suffix, this value is not an OCI OCID.

        Returns:
        the value
      • getSecretAccessKeySecretId

        public String getSecretAccessKeySecretId()
        The OCID of the Secret where the Secret Access Key used for OCI Object Storage S3 Compatibility authentication.
        Returns:
        the value
      • getBucket

        public String getBucket()
        Target OCI Object Storage bucket name where Iceberg stores table metadata and data files.
        Returns:
        the value
      • toString

        public String toString​(boolean includeByteArrayContents)
        Return a string representation of the object.
        Overrides:
        toString in class IcebergStorage
        Parameters:
        includeByteArrayContents - true to include the full contents of byte arrays
        Returns:
        string representation