AmazonS3IcebergStorage¶
- class oci.golden_gate.models.AmazonS3IcebergStorage(**kwargs)¶
Bases:
IcebergStorageRepresents an Amazon S3 storage used in the Iceberg connection.
Attributes:
A constant which can be used with the scheme_type property of a AmazonS3IcebergStorage.
A constant which can be used with the scheme_type property of a AmazonS3IcebergStorage.
A constant which can be used with the storage_type property of a IcebergStorage.
A constant which can be used with the storage_type property of a IcebergStorage.
A constant which can be used with the storage_type property of a IcebergStorage.
A constant which can be used with the storage_type property of a IcebergStorage.
A constant which can be used with the storage_type property of a IcebergStorage.
[Required] Gets the access_key_id of this AmazonS3IcebergStorage.
[Required] Gets the bucket of this AmazonS3IcebergStorage.
Gets the endpoint of this AmazonS3IcebergStorage.
[Required] Gets the region of this AmazonS3IcebergStorage.
[Required] Gets the scheme_type of this AmazonS3IcebergStorage.
Gets the secret_access_key_secret_id of this AmazonS3IcebergStorage.
[Required] Gets the storage_type of this IcebergStorage. 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 AmazonS3IcebergStorage 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.
- SCHEME_TYPE_S3 = 'S3'¶
A constant which can be used with the scheme_type property of a AmazonS3IcebergStorage. This constant has a value of “S3”
- SCHEME_TYPE_S3_A = 'S3A'¶
A constant which can be used with the scheme_type property of a AmazonS3IcebergStorage. This constant has a value of “S3A”
- STORAGE_TYPE_AMAZON_S3 = 'AMAZON_S3'¶
A constant which can be used with the storage_type property of a IcebergStorage. 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 IcebergStorage. 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 IcebergStorage. 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 IcebergStorage. 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 IcebergStorage. This constant has a value of “OCI_OBJECT_STORAGE_S3_API”
- __init__(**kwargs)¶
Initializes a new AmazonS3IcebergStorage object with values from keyword arguments. The default value of the
storage_typeattribute of this class isAMAZON_S3and 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 AmazonS3IcebergStorage. 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’.
scheme_type (str) – The value to assign to the scheme_type property of this AmazonS3IcebergStorage. Allowed values for this property are: “S3”, “S3A”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
endpoint (str) – The value to assign to the endpoint property of this AmazonS3IcebergStorage.
access_key_id (str) – The value to assign to the access_key_id property of this AmazonS3IcebergStorage.
secret_access_key_secret_id (str) – The value to assign to the secret_access_key_secret_id property of this AmazonS3IcebergStorage.
region (str) – The value to assign to the region property of this AmazonS3IcebergStorage.
bucket (str) – The value to assign to the bucket property of this AmazonS3IcebergStorage.
- property access_key_id¶
[Required] Gets the access_key_id of this AmazonS3IcebergStorage. Access key ID to access the Amazon S3 bucket. Note: Despite the “Id” suffix, this value is not an OCI OCID.
- Returns
The access_key_id of this AmazonS3IcebergStorage.
- Return type
str
- property bucket¶
[Required] Gets the bucket of this AmazonS3IcebergStorage. S3 bucket where Iceberg stores metadata and data files.
- Returns
The bucket of this AmazonS3IcebergStorage.
- Return type
str
- property endpoint¶
Gets the endpoint of this AmazonS3IcebergStorage. The endpoint URL of the Amazon S3 storage service. e.g.: ‘https://s3.amazonaws.com’
- Returns
The endpoint of this AmazonS3IcebergStorage.
- 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 region¶
[Required] Gets the region of this AmazonS3IcebergStorage. The AMAZON region where the S3 bucket is hosted. e.g.: ‘us-east-2’
- Returns
The region of this AmazonS3IcebergStorage.
- Return type
str
- property scheme_type¶
[Required] Gets the scheme_type of this AmazonS3IcebergStorage. The scheme of the storage.
Allowed values for this property are: “S3”, “S3A”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The scheme_type of this AmazonS3IcebergStorage.
- Return type
str
- property secret_access_key_secret_id¶
Gets the secret_access_key_secret_id of this AmazonS3IcebergStorage. The OCID of the Secret where the Secret Access Key is stored.
- Returns
The secret_access_key_secret_id of this AmazonS3IcebergStorage.
- Return type
str
- property storage_type¶
[Required] Gets the storage_type of this IcebergStorage. 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”, ‘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