PolarisIcebergCatalogSummary¶

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

Bases: oci.golden_gate.models.iceberg_catalog_summary.IcebergCatalogSummary

Summary of the Polaris catalog used in the Iceberg connection.

Attributes

`CATALOG_TYPE_GLUE`	str(object=’’) -> str
`CATALOG_TYPE_HADOOP`	str(object=’’) -> str
`CATALOG_TYPE_NESSIE`	str(object=’’) -> str
`CATALOG_TYPE_POLARIS`	str(object=’’) -> str
`CATALOG_TYPE_REST`	str(object=’’) -> str
`catalog_type`	[Required] Gets the catalog_type of this IcebergCatalogSummary.
`client_id`	[Required] Gets the client_id of this PolarisIcebergCatalogSummary.
`client_secret_secret_id`	[Required] Gets the client_secret_secret_id of this PolarisIcebergCatalogSummary.
`name`	[Required] Gets the name of this PolarisIcebergCatalogSummary.
`principal_role`	[Required] Gets the principal_role of this PolarisIcebergCatalogSummary.
`uri`	[Required] Gets the uri of this PolarisIcebergCatalogSummary.

Methods

`__init__`(**kwargs)	Initializes a new PolarisIcebergCatalogSummary 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.

CATALOG_TYPE_GLUE = 'GLUE'¶

CATALOG_TYPE_HADOOP = 'HADOOP'¶

CATALOG_TYPE_NESSIE = 'NESSIE'¶

CATALOG_TYPE_POLARIS = 'POLARIS'¶

CATALOG_TYPE_REST = 'REST'¶

__init__(**kwargs)¶

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

Parameters:

catalog_type (str) – The value to assign to the catalog_type property of this PolarisIcebergCatalogSummary. Allowed values for this property are: “GLUE”, “HADOOP”, “NESSIE”, “POLARIS”, “REST”
uri (str) – The value to assign to the uri property of this PolarisIcebergCatalogSummary.
name (str) – The value to assign to the name property of this PolarisIcebergCatalogSummary.
client_id (str) – The value to assign to the client_id property of this PolarisIcebergCatalogSummary.
client_secret_secret_id (str) – The value to assign to the client_secret_secret_id property of this PolarisIcebergCatalogSummary.
principal_role (str) – The value to assign to the principal_role property of this PolarisIcebergCatalogSummary.

catalog_type¶

[Required] Gets the catalog_type of this IcebergCatalogSummary. The catalog type.

Allowed values for this property are: “GLUE”, “HADOOP”, “NESSIE”, “POLARIS”, “REST”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The catalog_type of this IcebergCatalogSummary.
Return type:	str

client_id¶

[Required] Gets the client_id of this PolarisIcebergCatalogSummary. The OAuth client ID used for authentication.

Returns:	The client_id of this PolarisIcebergCatalogSummary.
Return type:	str

client_secret_secret_id¶

[Required] Gets the client_secret_secret_id of this PolarisIcebergCatalogSummary. The OCID of the Secret that stores the password Oracle GoldenGate uses to connect to Snowflake platform.

Returns:	The client_secret_secret_id of this PolarisIcebergCatalogSummary.
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.

name¶

[Required] Gets the name of this PolarisIcebergCatalogSummary. The catalog name within Polaris where Iceberg tables are registered.

Returns:	The name of this PolarisIcebergCatalogSummary.
Return type:	str

principal_role¶

[Required] Gets the principal_role of this PolarisIcebergCatalogSummary. The Snowflake role used to access Polaris.

Returns:	The principal_role of this PolarisIcebergCatalogSummary.
Return type:	str

uri¶

[Required] Gets the uri of this PolarisIcebergCatalogSummary. The URL endpoint for the Polaris API. e.g.: ‘https://<your-snowflake-account>.snowflakecomputing.com/polaris/api/catalog’

Returns:	The uri of this PolarisIcebergCatalogSummary.
Return type:	str