Class CreateAmazonS3IcebergStorageDetails


  • @Generated(value="OracleSDKGenerator",
               comments="API Version: 20200407")
    public final class CreateAmazonS3IcebergStorageDetails
    extends CreateIcebergStorageDetails
    The information about a new Amazon S3 storage used in the Iceberg connection.
    Note: Objects should always be created or deserialized using the CreateAmazonS3IcebergStorageDetails.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 CreateAmazonS3IcebergStorageDetails.Builder, which maintain a set of all explicitly set fields called CreateAmazonS3IcebergStorageDetails.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).
    • Method Detail

      • getEndpoint

        public String getEndpoint()
        The endpoint URL of the Amazon S3 storage service.

        e.g.: ‘https://s3.amazonaws.com’

        Returns:
        the value
      • getAccessKeyId

        public String getAccessKeyId()
        Access key ID to access the Amazon S3 bucket.
        Returns:
        the value
      • getSecretAccessKeySecretId

        public String getSecretAccessKeySecretId()
        The OCID of the Secret where the Secret Access Key is stored.
        Returns:
        the value
      • getSecretAccessKey

        @Deprecated
        public String getSecretAccessKey()
        Deprecated.
        Use getSecretAccessKey__AsCharArray() instead.
        Secret access key to access the Amazon S3 bucket.

        e.g.: "this-is-not-the-secret" Deprecated: This field is deprecated and replaced by "secretAccessKeySecretId". This field will be removed after February 15 2026.

        Returns:
        the value
      • getSecretAccessKey__AsCharArray

        public char[] getSecretAccessKey__AsCharArray()
        Secret access key to access the Amazon S3 bucket.

        e.g.: “this-is-not-the-secret” Deprecated: This field is deprecated and replaced by “secretAccessKeySecretId”. This field will be removed after February 15 2026.

        Returns:
        the value
      • getRegion

        public String getRegion()
        The AMAZON region where the S3 bucket is hosted.

        e.g.: ‘us-east-2’

        Returns:
        the value
      • getBucket

        public String getBucket()
        S3 bucket where Iceberg stores metadata and data files.
        Returns:
        the value
      • toString

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