CreateOciObjectStorageS3ApiIcebergStorageDetails¶
- class oci.golden_gate.models.CreateOciObjectStorageS3ApiIcebergStorageDetails(**kwargs)¶
Bases:
CreateIcebergStorageDetailsThe information to create the OCI Object Storage (S3 Compatibility API) configuration used by the Iceberg connection.
Attributes:
A constant which can be used with the storage_type property of a CreateIcebergStorageDetails.
A constant which can be used with the storage_type property of a CreateIcebergStorageDetails.
A constant which can be used with the storage_type property of a CreateIcebergStorageDetails.
A constant which can be used with the storage_type property of a CreateIcebergStorageDetails.
A constant which can be used with the storage_type property of a CreateIcebergStorageDetails.
[Required] Gets the access_key_id of this CreateOciObjectStorageS3ApiIcebergStorageDetails.
[Required] Gets the bucket of this CreateOciObjectStorageS3ApiIcebergStorageDetails.
[Required] Gets the endpoint of this CreateOciObjectStorageS3ApiIcebergStorageDetails.
Gets the secret_access_key of this CreateOciObjectStorageS3ApiIcebergStorageDetails.
Gets the secret_access_key_secret_id of this CreateOciObjectStorageS3ApiIcebergStorageDetails.
[Required] Gets the storage_type of this CreateIcebergStorageDetails. The storage type used in the Iceberg connection. Supported storage types by catalog type: * GLUE: AMAZON_S3. * HADOOP: AMAZON_S3, GOOGLE_CLOUD_STORAGE, AZURE_DATA_LAKE_STORAGE, or OCI_OBJECT_STORAGE_S3_API. * NESSIE: AMAZON_S3, GOOGLE_CLOUD_STORAGE, or AZURE_DATA_LAKE_STORAGE. * POLARIS: AMAZON_S3, GOOGLE_CLOUD_STORAGE, or AZURE_DATA_LAKE_STORAGE. * REST: AMAZON_S3, GOOGLE_CLOUD_STORAGE, AZURE_DATA_LAKE_STORAGE, or NONE.
Methods:
__init__(**kwargs)Initializes a new CreateOciObjectStorageS3ApiIcebergStorageDetails 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'¶
A constant which can be used with the storage_type property of a CreateIcebergStorageDetails. This constant has a value of “AMAZON_S3”
- STORAGE_TYPE_AZURE_DATA_LAKE_STORAGE = 'AZURE_DATA_LAKE_STORAGE'¶
A constant which can be used with the storage_type property of a CreateIcebergStorageDetails. This constant has a value of “AZURE_DATA_LAKE_STORAGE”
- STORAGE_TYPE_GOOGLE_CLOUD_STORAGE = 'GOOGLE_CLOUD_STORAGE'¶
A constant which can be used with the storage_type property of a CreateIcebergStorageDetails. This constant has a value of “GOOGLE_CLOUD_STORAGE”
- STORAGE_TYPE_NONE = 'NONE'¶
A constant which can be used with the storage_type property of a CreateIcebergStorageDetails. This constant has a value of “NONE”
- STORAGE_TYPE_OCI_OBJECT_STORAGE_S3_API = 'OCI_OBJECT_STORAGE_S3_API'¶
A constant which can be used with the storage_type property of a CreateIcebergStorageDetails. This constant has a value of “OCI_OBJECT_STORAGE_S3_API”
- __init__(**kwargs)¶
Initializes a new CreateOciObjectStorageS3ApiIcebergStorageDetails object with values from keyword arguments. The default value of the
storage_typeattribute of this class isOCI_OBJECT_STORAGE_S3_APIand 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 CreateOciObjectStorageS3ApiIcebergStorageDetails. 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 CreateOciObjectStorageS3ApiIcebergStorageDetails.
access_key_id (str) – The value to assign to the access_key_id property of this CreateOciObjectStorageS3ApiIcebergStorageDetails.
secret_access_key_secret_id (str) – The value to assign to the secret_access_key_secret_id property of this CreateOciObjectStorageS3ApiIcebergStorageDetails.
secret_access_key (str) – The value to assign to the secret_access_key property of this CreateOciObjectStorageS3ApiIcebergStorageDetails.
bucket (str) – The value to assign to the bucket property of this CreateOciObjectStorageS3ApiIcebergStorageDetails.
- property access_key_id¶
[Required] Gets the access_key_id of this CreateOciObjectStorageS3ApiIcebergStorageDetails. 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 CreateOciObjectStorageS3ApiIcebergStorageDetails.
- Return type
str
- property bucket¶
[Required] Gets the bucket of this CreateOciObjectStorageS3ApiIcebergStorageDetails. Target OCI Object Storage bucket name where Iceberg stores table metadata and data files.
- Returns
The bucket of this CreateOciObjectStorageS3ApiIcebergStorageDetails.
- Return type
str
- property endpoint¶
[Required] Gets the endpoint of this CreateOciObjectStorageS3ApiIcebergStorageDetails. 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 CreateOciObjectStorageS3ApiIcebergStorageDetails.
- 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.
- property secret_access_key¶
Gets the secret_access_key of this CreateOciObjectStorageS3ApiIcebergStorageDetails. Secret Access Key from the OCI IAM user’s Customer Secret Key pair used to authenticate to OCI Object Storage via the S3 Compatibility API. Deprecated: This field is deprecated and replaced by “secretAccessKeySecretId”. This change follows the GoldenGate “Plain Text Fields in Connections” deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
- Returns
The secret_access_key of this CreateOciObjectStorageS3ApiIcebergStorageDetails.
- Return type
str
- property secret_access_key_secret_id¶
Gets the secret_access_key_secret_id of this CreateOciObjectStorageS3ApiIcebergStorageDetails. 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 CreateOciObjectStorageS3ApiIcebergStorageDetails.
- Return type
str
- property storage_type¶
[Required] Gets the storage_type of this CreateIcebergStorageDetails. The storage type used in the Iceberg connection. Supported storage types by catalog type: * GLUE: AMAZON_S3. * HADOOP: AMAZON_S3, GOOGLE_CLOUD_STORAGE, AZURE_DATA_LAKE_STORAGE,
or OCI_OBJECT_STORAGE_S3_API.
NESSIE: AMAZON_S3, GOOGLE_CLOUD_STORAGE, or AZURE_DATA_LAKE_STORAGE.
POLARIS: AMAZON_S3, GOOGLE_CLOUD_STORAGE, or AZURE_DATA_LAKE_STORAGE.
REST: AMAZON_S3, GOOGLE_CLOUD_STORAGE, AZURE_DATA_LAKE_STORAGE, or NONE.
Allowed values for this property are: “AMAZON_S3”, “GOOGLE_CLOUD_STORAGE”, “AZURE_DATA_LAKE_STORAGE”, “NONE”, “OCI_OBJECT_STORAGE_S3_API”
- Returns
The storage_type of this CreateIcebergStorageDetails.
- Return type
str