UpdatePolarisIcebergCatalogDetails

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

Bases: UpdateIcebergCatalogDetails

The information to update a Polaris catalog used in the Iceberg connection.

Attributes:

CATALOG_TYPE_GLUE

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

CATALOG_TYPE_HADOOP

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

CATALOG_TYPE_NESSIE

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

CATALOG_TYPE_POLARIS

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

CATALOG_TYPE_REST

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

catalog_type

[Required] Gets the catalog_type of this UpdateIcebergCatalogDetails.

client_id

Gets the client_id of this UpdatePolarisIcebergCatalogDetails.

client_secret

Gets the client_secret of this UpdatePolarisIcebergCatalogDetails.

client_secret_secret_id

Gets the client_secret_secret_id of this UpdatePolarisIcebergCatalogDetails.

name

Gets the name of this UpdatePolarisIcebergCatalogDetails.

principal_role

Gets the principal_role of this UpdatePolarisIcebergCatalogDetails.

uri

Gets the uri of this UpdatePolarisIcebergCatalogDetails.

Methods:

__init__(**kwargs)

Initializes a new UpdatePolarisIcebergCatalogDetails 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 UpdateIcebergCatalogDetails. This constant has a value of “GLUE”

CATALOG_TYPE_HADOOP = 'HADOOP'

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

CATALOG_TYPE_NESSIE = 'NESSIE'

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

CATALOG_TYPE_POLARIS = 'POLARIS'

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

CATALOG_TYPE_REST = 'REST'

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

__init__(**kwargs)

Initializes a new UpdatePolarisIcebergCatalogDetails 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 UpdatePolarisIcebergCatalogDetails. Allowed values for this property are: “GLUE”, “HADOOP”, “NESSIE”, “POLARIS”, “REST”

  • uri (str) – The value to assign to the uri property of this UpdatePolarisIcebergCatalogDetails.

  • name (str) – The value to assign to the name property of this UpdatePolarisIcebergCatalogDetails.

  • client_id (str) – The value to assign to the client_id property of this UpdatePolarisIcebergCatalogDetails.

  • client_secret_secret_id (str) – The value to assign to the client_secret_secret_id property of this UpdatePolarisIcebergCatalogDetails.

  • client_secret (str) – The value to assign to the client_secret property of this UpdatePolarisIcebergCatalogDetails.

  • principal_role (str) – The value to assign to the principal_role property of this UpdatePolarisIcebergCatalogDetails.

property catalog_type

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

Allowed values for this property are: “GLUE”, “HADOOP”, “NESSIE”, “POLARIS”, “REST”

Returns

The catalog_type of this UpdateIcebergCatalogDetails.

Return type

str

property client_id

Gets the client_id of this UpdatePolarisIcebergCatalogDetails. The OAuth client ID used for authentication.

Returns

The client_id of this UpdatePolarisIcebergCatalogDetails.

Return type

str

property client_secret

Gets the client_secret of this UpdatePolarisIcebergCatalogDetails. Client secret required to connect to Polaris.

Returns

The client_secret of this UpdatePolarisIcebergCatalogDetails.

Return type

str

property client_secret_secret_id

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

Returns

The client_secret_secret_id of this UpdatePolarisIcebergCatalogDetails.

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

Gets the name of this UpdatePolarisIcebergCatalogDetails. The catalog name within Polaris where Iceberg tables are registered.

Returns

The name of this UpdatePolarisIcebergCatalogDetails.

Return type

str

property principal_role

Gets the principal_role of this UpdatePolarisIcebergCatalogDetails. The Snowflake role used to access Polaris.

Returns

The principal_role of this UpdatePolarisIcebergCatalogDetails.

Return type

str

property uri

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

Returns

The uri of this UpdatePolarisIcebergCatalogDetails.

Return type

str