PolarisIcebergCatalogSummary

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

Bases: IcebergCatalogSummary

Summary of the Polaris catalog used in the Iceberg connection.

Attributes:

CATALOG_TYPE_GLUE

A constant which can be used with the catalog_type property of a IcebergCatalogSummary.

CATALOG_TYPE_HADOOP

A constant which can be used with the catalog_type property of a IcebergCatalogSummary.

CATALOG_TYPE_NESSIE

A constant which can be used with the catalog_type property of a IcebergCatalogSummary.

CATALOG_TYPE_POLARIS

A constant which can be used with the catalog_type property of a IcebergCatalogSummary.

CATALOG_TYPE_REST

A constant which can be used with the catalog_type property of a IcebergCatalogSummary.

catalog_type

[Required] Gets the catalog_type of this IcebergCatalogSummary.

client_id

[Required] Gets the client_id of this PolarisIcebergCatalogSummary.

client_secret_secret_id

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'

A constant which can be used with the catalog_type property of a IcebergCatalogSummary. This constant has a value of “GLUE”

CATALOG_TYPE_HADOOP = 'HADOOP'

A constant which can be used with the catalog_type property of a IcebergCatalogSummary. This constant has a value of “HADOOP”

CATALOG_TYPE_NESSIE = 'NESSIE'

A constant which can be used with the catalog_type property of a IcebergCatalogSummary. This constant has a value of “NESSIE”

CATALOG_TYPE_POLARIS = 'POLARIS'

A constant which can be used with the catalog_type property of a IcebergCatalogSummary. This constant has a value of “POLARIS”

CATALOG_TYPE_REST = 'REST'

A constant which can be used with the catalog_type property of a IcebergCatalogSummary. This constant has a value of “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.

property 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

property 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

property client_secret_secret_id

Gets the client_secret_secret_id of this PolarisIcebergCatalogSummary. The OCID of the Secret that stores the password Oracle GoldenGate uses to connect to Polaris.

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.

property 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

property 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

property 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