OciObjectStorageS3ApiIcebergStorage¶

class oci.golden_gate.models.OciObjectStorageS3ApiIcebergStorage(**kwargs)¶

Bases: oci.golden_gate.models.iceberg_storage.IcebergStorage

Connection details of the OCI Object Storage (S3 Compatibility API) configuration used by the Iceberg connection.

Attributes

`STORAGE_TYPE_AMAZON_S3`	str(object=’’) -> str
`STORAGE_TYPE_AZURE_DATA_LAKE_STORAGE`	str(object=’’) -> str
`STORAGE_TYPE_GOOGLE_CLOUD_STORAGE`	str(object=’’) -> str
`STORAGE_TYPE_NONE`	str(object=’’) -> str
`STORAGE_TYPE_OCI_OBJECT_STORAGE_S3_API`	str(object=’’) -> str
`access_key_id`	[Required] Gets the access_key_id of this OciObjectStorageS3ApiIcebergStorage.
`bucket`	[Required] Gets the bucket of this OciObjectStorageS3ApiIcebergStorage.
`endpoint`	[Required] Gets the endpoint of this OciObjectStorageS3ApiIcebergStorage.
`secret_access_key_secret_id`	Gets the secret_access_key_secret_id of this OciObjectStorageS3ApiIcebergStorage.
`storage_type`	[Required] Gets the storage_type of this IcebergStorage.

Methods

`__init__`(**kwargs)	Initializes a new OciObjectStorageS3ApiIcebergStorage object with values from keyword arguments.
`get_subtype`(object_dictionary)	Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

STORAGE_TYPE_AMAZON_S3 = 'AMAZON_S3'¶

STORAGE_TYPE_AZURE_DATA_LAKE_STORAGE = 'AZURE_DATA_LAKE_STORAGE'¶

STORAGE_TYPE_GOOGLE_CLOUD_STORAGE = 'GOOGLE_CLOUD_STORAGE'¶

STORAGE_TYPE_NONE = 'NONE'¶

STORAGE_TYPE_OCI_OBJECT_STORAGE_S3_API = 'OCI_OBJECT_STORAGE_S3_API'¶

__init__(**kwargs)¶

Initializes a new OciObjectStorageS3ApiIcebergStorage object with values from keyword arguments. The default value of the storage_type attribute of this class is OCI_OBJECT_STORAGE_S3_API and it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

storage_type (str) – The value to assign to the storage_type property of this OciObjectStorageS3ApiIcebergStorage. Allowed values for this property are: “AMAZON_S3”, “GOOGLE_CLOUD_STORAGE”, “AZURE_DATA_LAKE_STORAGE”, “NONE”, “OCI_OBJECT_STORAGE_S3_API”
endpoint (str) – The value to assign to the endpoint property of this OciObjectStorageS3ApiIcebergStorage.
access_key_id (str) – The value to assign to the access_key_id property of this OciObjectStorageS3ApiIcebergStorage.
secret_access_key_secret_id (str) – The value to assign to the secret_access_key_secret_id property of this OciObjectStorageS3ApiIcebergStorage.
bucket (str) – The value to assign to the bucket property of this OciObjectStorageS3ApiIcebergStorage.

access_key_id¶

[Required] Gets the access_key_id of this OciObjectStorageS3ApiIcebergStorage. 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 access_key_id of this OciObjectStorageS3ApiIcebergStorage.
Return type:	str

bucket¶

[Required] Gets the bucket of this OciObjectStorageS3ApiIcebergStorage. Target OCI Object Storage bucket name where Iceberg stores table metadata and data files.

Returns:	The bucket of this OciObjectStorageS3ApiIcebergStorage.
Return type:	str

endpoint¶

[Required] Gets the endpoint of this OciObjectStorageS3ApiIcebergStorage. OCI Object Storage S3 Compatibility API endpoint URL. Format: “https://<namespace>.compat.objectstorage.<region>.<domain>” Example: “https://mynamespace.compat.objectstorage.us-ashburn-1.oraclecloud.com”

Returns:	The endpoint of this OciObjectStorageS3ApiIcebergStorage.
Return type:	str

static get_subtype(object_dictionary)¶: Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

secret_access_key_secret_id¶

Gets the secret_access_key_secret_id of this OciObjectStorageS3ApiIcebergStorage. The OCID of the Secret where the Secret Access Key used for OCI Object Storage S3 Compatibility authentication.

Returns:	The secret_access_key_secret_id of this OciObjectStorageS3ApiIcebergStorage.
Return type:	str

storage_type¶

[Required] Gets the storage_type of this IcebergStorage. The storage type used in the Iceberg connection.

Allowed values for this property are: “AMAZON_S3”, “GOOGLE_CLOUD_STORAGE”, “AZURE_DATA_LAKE_STORAGE”, “NONE”, “OCI_OBJECT_STORAGE_S3_API”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The storage_type of this IcebergStorage.
Return type:	str