oci 2.144.0__py3-none-any.whl → 2.145.0__py3-none-any.whl

oci/golden_gate/models/databricks_connection.py

@@ -0,0 +1,456 @@
+# coding: utf-8
+# Copyright (c) 2016, 2025, Oracle and/or its affiliates.  All rights reserved.
+# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
+
+# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20200407
+
+from .connection import Connection
+from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel  # noqa: F401
+from oci.decorators import init_model_state_from_kwargs
+
+
+@init_model_state_from_kwargs
+class DatabricksConnection(Connection):
+    """
+    Represents the metadata of a Databricks Connection.
+    """
+
+    #: A constant which can be used with the technology_type property of a DatabricksConnection.
+    #: This constant has a value of "DATABRICKS"
+    TECHNOLOGY_TYPE_DATABRICKS = "DATABRICKS"
+
+    #: A constant which can be used with the authentication_type property of a DatabricksConnection.
+    #: This constant has a value of "PERSONAL_ACCESS_TOKEN"
+    AUTHENTICATION_TYPE_PERSONAL_ACCESS_TOKEN = "PERSONAL_ACCESS_TOKEN"
+
+    #: A constant which can be used with the authentication_type property of a DatabricksConnection.
+    #: This constant has a value of "OAUTH_M2M"
+    AUTHENTICATION_TYPE_OAUTH_M2_M = "OAUTH_M2M"
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new DatabricksConnection object with values from keyword arguments. The default value of the :py:attr:`~oci.golden_gate.models.DatabricksConnection.connection_type` attribute
+        of this class is ``DATABRICKS`` and it should not be changed.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param connection_type:
+            The value to assign to the connection_type property of this DatabricksConnection.
+            Allowed values for this property are: "GOLDENGATE", "KAFKA", "KAFKA_SCHEMA_REGISTRY", "MYSQL", "JAVA_MESSAGE_SERVICE", "MICROSOFT_SQLSERVER", "OCI_OBJECT_STORAGE", "ORACLE", "AZURE_DATA_LAKE_STORAGE", "POSTGRESQL", "AZURE_SYNAPSE_ANALYTICS", "SNOWFLAKE", "AMAZON_S3", "HDFS", "ORACLE_NOSQL", "MONGODB", "AMAZON_KINESIS", "AMAZON_REDSHIFT", "DB2", "REDIS", "ELASTICSEARCH", "GENERIC", "GOOGLE_CLOUD_STORAGE", "GOOGLE_BIGQUERY", "DATABRICKS", "GOOGLE_PUBSUB", "MICROSOFT_FABRIC", 'UNKNOWN_ENUM_VALUE'.
+            Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
+        :type connection_type: str
+
+        :param id:
+            The value to assign to the id property of this DatabricksConnection.
+        :type id: str
+
+        :param display_name:
+            The value to assign to the display_name property of this DatabricksConnection.
+        :type display_name: str
+
+        :param description:
+            The value to assign to the description property of this DatabricksConnection.
+        :type description: str
+
+        :param compartment_id:
+            The value to assign to the compartment_id property of this DatabricksConnection.
+        :type compartment_id: str
+
+        :param freeform_tags:
+            The value to assign to the freeform_tags property of this DatabricksConnection.
+        :type freeform_tags: dict(str, str)
+
+        :param defined_tags:
+            The value to assign to the defined_tags property of this DatabricksConnection.
+        :type defined_tags: dict(str, dict(str, object))
+
+        :param system_tags:
+            The value to assign to the system_tags property of this DatabricksConnection.
+        :type system_tags: dict(str, dict(str, object))
+
+        :param lifecycle_state:
+            The value to assign to the lifecycle_state property of this DatabricksConnection.
+            Allowed values for this property are: "CREATING", "UPDATING", "ACTIVE", "DELETING", "DELETED", "FAILED", 'UNKNOWN_ENUM_VALUE'.
+            Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
+        :type lifecycle_state: str
+
+        :param lifecycle_details:
+            The value to assign to the lifecycle_details property of this DatabricksConnection.
+        :type lifecycle_details: str
+
+        :param time_created:
+            The value to assign to the time_created property of this DatabricksConnection.
+        :type time_created: datetime
+
+        :param time_updated:
+            The value to assign to the time_updated property of this DatabricksConnection.
+        :type time_updated: datetime
+
+        :param locks:
+            The value to assign to the locks property of this DatabricksConnection.
+        :type locks: list[oci.golden_gate.models.ResourceLock]
+
+        :param vault_id:
+            The value to assign to the vault_id property of this DatabricksConnection.
+        :type vault_id: str
+
+        :param key_id:
+            The value to assign to the key_id property of this DatabricksConnection.
+        :type key_id: str
+
+        :param ingress_ips:
+            The value to assign to the ingress_ips property of this DatabricksConnection.
+        :type ingress_ips: list[oci.golden_gate.models.IngressIpDetails]
+
+        :param nsg_ids:
+            The value to assign to the nsg_ids property of this DatabricksConnection.
+        :type nsg_ids: list[str]
+
+        :param subnet_id:
+            The value to assign to the subnet_id property of this DatabricksConnection.
+        :type subnet_id: str
+
+        :param routing_method:
+            The value to assign to the routing_method property of this DatabricksConnection.
+            Allowed values for this property are: "SHARED_SERVICE_ENDPOINT", "SHARED_DEPLOYMENT_ENDPOINT", "DEDICATED_ENDPOINT", 'UNKNOWN_ENUM_VALUE'.
+            Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
+        :type routing_method: str
+
+        :param does_use_secret_ids:
+            The value to assign to the does_use_secret_ids property of this DatabricksConnection.
+        :type does_use_secret_ids: bool
+
+        :param technology_type:
+            The value to assign to the technology_type property of this DatabricksConnection.
+            Allowed values for this property are: "DATABRICKS", 'UNKNOWN_ENUM_VALUE'.
+            Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
+        :type technology_type: str
+
+        :param authentication_type:
+            The value to assign to the authentication_type property of this DatabricksConnection.
+            Allowed values for this property are: "PERSONAL_ACCESS_TOKEN", "OAUTH_M2M", 'UNKNOWN_ENUM_VALUE'.
+            Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
+        :type authentication_type: str
+
+        :param connection_url:
+            The value to assign to the connection_url property of this DatabricksConnection.
+        :type connection_url: str
+
+        :param password_secret_id:
+            The value to assign to the password_secret_id property of this DatabricksConnection.
+        :type password_secret_id: str
+
+        :param client_id:
+            The value to assign to the client_id property of this DatabricksConnection.
+        :type client_id: str
+
+        :param client_secret_secret_id:
+            The value to assign to the client_secret_secret_id property of this DatabricksConnection.
+        :type client_secret_secret_id: str
+
+        :param storage_credential_name:
+            The value to assign to the storage_credential_name property of this DatabricksConnection.
+        :type storage_credential_name: str
+
+        """
+        self.swagger_types = {
+            'connection_type': 'str',
+            'id': 'str',
+            'display_name': 'str',
+            'description': 'str',
+            'compartment_id': 'str',
+            'freeform_tags': 'dict(str, str)',
+            'defined_tags': 'dict(str, dict(str, object))',
+            'system_tags': 'dict(str, dict(str, object))',
+            'lifecycle_state': 'str',
+            'lifecycle_details': 'str',
+            'time_created': 'datetime',
+            'time_updated': 'datetime',
+            'locks': 'list[ResourceLock]',
+            'vault_id': 'str',
+            'key_id': 'str',
+            'ingress_ips': 'list[IngressIpDetails]',
+            'nsg_ids': 'list[str]',
+            'subnet_id': 'str',
+            'routing_method': 'str',
+            'does_use_secret_ids': 'bool',
+            'technology_type': 'str',
+            'authentication_type': 'str',
+            'connection_url': 'str',
+            'password_secret_id': 'str',
+            'client_id': 'str',
+            'client_secret_secret_id': 'str',
+            'storage_credential_name': 'str'
+        }
+
+        self.attribute_map = {
+            'connection_type': 'connectionType',
+            'id': 'id',
+            'display_name': 'displayName',
+            'description': 'description',
+            'compartment_id': 'compartmentId',
+            'freeform_tags': 'freeformTags',
+            'defined_tags': 'definedTags',
+            'system_tags': 'systemTags',
+            'lifecycle_state': 'lifecycleState',
+            'lifecycle_details': 'lifecycleDetails',
+            'time_created': 'timeCreated',
+            'time_updated': 'timeUpdated',
+            'locks': 'locks',
+            'vault_id': 'vaultId',
+            'key_id': 'keyId',
+            'ingress_ips': 'ingressIps',
+            'nsg_ids': 'nsgIds',
+            'subnet_id': 'subnetId',
+            'routing_method': 'routingMethod',
+            'does_use_secret_ids': 'doesUseSecretIds',
+            'technology_type': 'technologyType',
+            'authentication_type': 'authenticationType',
+            'connection_url': 'connectionUrl',
+            'password_secret_id': 'passwordSecretId',
+            'client_id': 'clientId',
+            'client_secret_secret_id': 'clientSecretSecretId',
+            'storage_credential_name': 'storageCredentialName'
+        }
+
+        self._connection_type = None
+        self._id = None
+        self._display_name = None
+        self._description = None
+        self._compartment_id = None
+        self._freeform_tags = None
+        self._defined_tags = None
+        self._system_tags = None
+        self._lifecycle_state = None
+        self._lifecycle_details = None
+        self._time_created = None
+        self._time_updated = None
+        self._locks = None
+        self._vault_id = None
+        self._key_id = None
+        self._ingress_ips = None
+        self._nsg_ids = None
+        self._subnet_id = None
+        self._routing_method = None
+        self._does_use_secret_ids = None
+        self._technology_type = None
+        self._authentication_type = None
+        self._connection_url = None
+        self._password_secret_id = None
+        self._client_id = None
+        self._client_secret_secret_id = None
+        self._storage_credential_name = None
+        self._connection_type = 'DATABRICKS'
+
+    @property
+    def technology_type(self):
+        """
+        **[Required]** Gets the technology_type of this DatabricksConnection.
+        The Databricks technology type.
+
+        Allowed values for this property are: "DATABRICKS", 'UNKNOWN_ENUM_VALUE'.
+        Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
+
+
+        :return: The technology_type of this DatabricksConnection.
+        :rtype: str
+        """
+        return self._technology_type
+
+    @technology_type.setter
+    def technology_type(self, technology_type):
+        """
+        Sets the technology_type of this DatabricksConnection.
+        The Databricks technology type.
+
+
+        :param technology_type: The technology_type of this DatabricksConnection.
+        :type: str
+        """
+        allowed_values = ["DATABRICKS"]
+        if not value_allowed_none_or_none_sentinel(technology_type, allowed_values):
+            technology_type = 'UNKNOWN_ENUM_VALUE'
+        self._technology_type = technology_type
+
+    @property
+    def authentication_type(self):
+        """
+        **[Required]** Gets the authentication_type of this DatabricksConnection.
+        Used authentication mechanism to access Databricks.
+        Required fields by authentication types:
+        - PERSONAL_ACCESS_TOKEN: username is always 'token', user must enter password
+        - OAUTH_M2M: user must enter clientId and clientSecret
+
+        Allowed values for this property are: "PERSONAL_ACCESS_TOKEN", "OAUTH_M2M", 'UNKNOWN_ENUM_VALUE'.
+        Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
+
+
+        :return: The authentication_type of this DatabricksConnection.
+        :rtype: str
+        """
+        return self._authentication_type
+
+    @authentication_type.setter
+    def authentication_type(self, authentication_type):
+        """
+        Sets the authentication_type of this DatabricksConnection.
+        Used authentication mechanism to access Databricks.
+        Required fields by authentication types:
+        - PERSONAL_ACCESS_TOKEN: username is always 'token', user must enter password
+        - OAUTH_M2M: user must enter clientId and clientSecret
+
+
+        :param authentication_type: The authentication_type of this DatabricksConnection.
+        :type: str
+        """
+        allowed_values = ["PERSONAL_ACCESS_TOKEN", "OAUTH_M2M"]
+        if not value_allowed_none_or_none_sentinel(authentication_type, allowed_values):
+            authentication_type = 'UNKNOWN_ENUM_VALUE'
+        self._authentication_type = authentication_type
+
+    @property
+    def connection_url(self):
+        """
+        **[Required]** Gets the connection_url of this DatabricksConnection.
+        Connection URL.
+        e.g.: 'jdbc:databricks://adb-33934.4.azuredatabricks.net:443/default;transportMode=http;ssl=1;httpPath=sql/protocolv1/o/3393########44/0##3-7-hlrb'
+
+
+        :return: The connection_url of this DatabricksConnection.
+        :rtype: str
+        """
+        return self._connection_url
+
+    @connection_url.setter
+    def connection_url(self, connection_url):
+        """
+        Sets the connection_url of this DatabricksConnection.
+        Connection URL.
+        e.g.: 'jdbc:databricks://adb-33934.4.azuredatabricks.net:443/default;transportMode=http;ssl=1;httpPath=sql/protocolv1/o/3393########44/0##3-7-hlrb'
+
+
+        :param connection_url: The connection_url of this DatabricksConnection.
+        :type: str
+        """
+        self._connection_url = connection_url
+
+    @property
+    def password_secret_id(self):
+        """
+        Gets the password_secret_id of this DatabricksConnection.
+        The `OCID`__ of the Secret where the password is stored.
+        Note: When provided, 'password' field must not be provided.
+
+        __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
+
+
+        :return: The password_secret_id of this DatabricksConnection.
+        :rtype: str
+        """
+        return self._password_secret_id
+
+    @password_secret_id.setter
+    def password_secret_id(self, password_secret_id):
+        """
+        Sets the password_secret_id of this DatabricksConnection.
+        The `OCID`__ of the Secret where the password is stored.
+        Note: When provided, 'password' field must not be provided.
+
+        __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
+
+
+        :param password_secret_id: The password_secret_id of this DatabricksConnection.
+        :type: str
+        """
+        self._password_secret_id = password_secret_id
+
+    @property
+    def client_id(self):
+        """
+        Gets the client_id of this DatabricksConnection.
+        OAuth client id, only applicable for authenticationType == OAUTH_M2M
+
+
+        :return: The client_id of this DatabricksConnection.
+        :rtype: str
+        """
+        return self._client_id
+
+    @client_id.setter
+    def client_id(self, client_id):
+        """
+        Sets the client_id of this DatabricksConnection.
+        OAuth client id, only applicable for authenticationType == OAUTH_M2M
+
+
+        :param client_id: The client_id of this DatabricksConnection.
+        :type: str
+        """
+        self._client_id = client_id
+
+    @property
+    def client_secret_secret_id(self):
+        """
+        Gets the client_secret_secret_id of this DatabricksConnection.
+        The `OCID`__ of the Secret where the client secret is stored.
+        Only applicable for authenticationType == OAUTH_M2M.
+        Note: When provided, 'clientSecret' field must not be provided.
+
+        __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
+
+
+        :return: The client_secret_secret_id of this DatabricksConnection.
+        :rtype: str
+        """
+        return self._client_secret_secret_id
+
+    @client_secret_secret_id.setter
+    def client_secret_secret_id(self, client_secret_secret_id):
+        """
+        Sets the client_secret_secret_id of this DatabricksConnection.
+        The `OCID`__ of the Secret where the client secret is stored.
+        Only applicable for authenticationType == OAUTH_M2M.
+        Note: When provided, 'clientSecret' field must not be provided.
+
+        __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
+
+
+        :param client_secret_secret_id: The client_secret_secret_id of this DatabricksConnection.
+        :type: str
+        """
+        self._client_secret_secret_id = client_secret_secret_id
+
+    @property
+    def storage_credential_name(self):
+        """
+        Gets the storage_credential_name of this DatabricksConnection.
+        Optional. External storage credential name to access files on object storage such as ADLS Gen2, S3 or GCS.
+
+
+        :return: The storage_credential_name of this DatabricksConnection.
+        :rtype: str
+        """
+        return self._storage_credential_name
+
+    @storage_credential_name.setter
+    def storage_credential_name(self, storage_credential_name):
+        """
+        Sets the storage_credential_name of this DatabricksConnection.
+        Optional. External storage credential name to access files on object storage such as ADLS Gen2, S3 or GCS.
+
+
+        :param storage_credential_name: The storage_credential_name of this DatabricksConnection.
+        :type: str
+        """
+        self._storage_credential_name = storage_credential_name
+
+    def __repr__(self):
+        return formatted_flat_dict(self)
+
+    def __eq__(self, other):
+        if other is None:
+            return False
+
+        return self.__dict__ == other.__dict__
+
+    def __ne__(self, other):
+        return not self == other