DatabricksConnectionSummary

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

Bases: oci.golden_gate.models.connection_summary.ConnectionSummary

Summary of the Databricks Connection.

Attributes

CONNECTION_TYPE_AI_MODEL str(object=’’) -> str
CONNECTION_TYPE_AMAZON_KINESIS str(object=’’) -> str
CONNECTION_TYPE_AMAZON_REDSHIFT str(object=’’) -> str
CONNECTION_TYPE_AMAZON_S3 str(object=’’) -> str
CONNECTION_TYPE_AZURE_DATA_LAKE_STORAGE str(object=’’) -> str
CONNECTION_TYPE_AZURE_SYNAPSE_ANALYTICS str(object=’’) -> str
CONNECTION_TYPE_DATABRICKS str(object=’’) -> str
CONNECTION_TYPE_DB2 str(object=’’) -> str
CONNECTION_TYPE_ELASTICSEARCH str(object=’’) -> str
CONNECTION_TYPE_GENERIC str(object=’’) -> str
CONNECTION_TYPE_GOLDENGATE str(object=’’) -> str
CONNECTION_TYPE_GOOGLE_BIGQUERY str(object=’’) -> str
CONNECTION_TYPE_GOOGLE_CLOUD_STORAGE str(object=’’) -> str
CONNECTION_TYPE_GOOGLE_PUBSUB str(object=’’) -> str
CONNECTION_TYPE_HDFS str(object=’’) -> str
CONNECTION_TYPE_ICEBERG str(object=’’) -> str
CONNECTION_TYPE_JAVA_MESSAGE_SERVICE str(object=’’) -> str
CONNECTION_TYPE_KAFKA str(object=’’) -> str
CONNECTION_TYPE_KAFKA_SCHEMA_REGISTRY str(object=’’) -> str
CONNECTION_TYPE_MICROSOFT_FABRIC str(object=’’) -> str
CONNECTION_TYPE_MICROSOFT_SQLSERVER str(object=’’) -> str
CONNECTION_TYPE_MONGODB str(object=’’) -> str
CONNECTION_TYPE_MYSQL str(object=’’) -> str
CONNECTION_TYPE_OCI_OBJECT_STORAGE str(object=’’) -> str
CONNECTION_TYPE_ORACLE str(object=’’) -> str
CONNECTION_TYPE_ORACLE_AI_DATA_PLATFORM str(object=’’) -> str
CONNECTION_TYPE_ORACLE_NOSQL str(object=’’) -> str
CONNECTION_TYPE_POSTGRESQL str(object=’’) -> str
CONNECTION_TYPE_REDIS str(object=’’) -> str
CONNECTION_TYPE_SNOWFLAKE str(object=’’) -> str
ROUTING_METHOD_DEDICATED_ENDPOINT str(object=’’) -> str
ROUTING_METHOD_SHARED_DEPLOYMENT_ENDPOINT str(object=’’) -> str
ROUTING_METHOD_SHARED_SERVICE_ENDPOINT str(object=’’) -> str
authentication_type [Required] Gets the authentication_type of this DatabricksConnectionSummary.
client_id Gets the client_id of this DatabricksConnectionSummary.
client_secret_secret_id Gets the client_secret_secret_id of this DatabricksConnectionSummary.
cluster_placement_group_id Gets the cluster_placement_group_id of this ConnectionSummary.
compartment_id [Required] Gets the compartment_id of this ConnectionSummary.
connection_type [Required] Gets the connection_type of this ConnectionSummary.
connection_url [Required] Gets the connection_url of this DatabricksConnectionSummary.
defined_tags Gets the defined_tags of this ConnectionSummary.
description Gets the description of this ConnectionSummary.
display_name [Required] Gets the display_name of this ConnectionSummary.
does_use_secret_ids Gets the does_use_secret_ids of this ConnectionSummary.
freeform_tags Gets the freeform_tags of this ConnectionSummary.
id [Required] Gets the id of this ConnectionSummary.
ingress_ips Gets the ingress_ips of this ConnectionSummary.
key_id Gets the key_id of this ConnectionSummary.
lifecycle_details Gets the lifecycle_details of this ConnectionSummary.
lifecycle_state [Required] Gets the lifecycle_state of this ConnectionSummary.
locks Gets the locks of this ConnectionSummary.
nsg_ids Gets the nsg_ids of this ConnectionSummary.
password_secret_id Gets the password_secret_id of this DatabricksConnectionSummary.
routing_method Gets the routing_method of this ConnectionSummary.
security_attributes Gets the security_attributes of this ConnectionSummary.
storage_credential_name Gets the storage_credential_name of this DatabricksConnectionSummary.
subnet_id Gets the subnet_id of this ConnectionSummary.
subscription_id Gets the subscription_id of this ConnectionSummary.
system_tags Gets the system_tags of this ConnectionSummary.
technology_type [Required] Gets the technology_type of this DatabricksConnectionSummary.
time_created [Required] Gets the time_created of this ConnectionSummary.
time_updated [Required] Gets the time_updated of this ConnectionSummary.
vault_id Gets the vault_id of this ConnectionSummary.

Methods

__init__(**kwargs) Initializes a new DatabricksConnectionSummary 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.
CONNECTION_TYPE_AI_MODEL = 'AI_MODEL'
CONNECTION_TYPE_AMAZON_KINESIS = 'AMAZON_KINESIS'
CONNECTION_TYPE_AMAZON_REDSHIFT = 'AMAZON_REDSHIFT'
CONNECTION_TYPE_AMAZON_S3 = 'AMAZON_S3'
CONNECTION_TYPE_AZURE_DATA_LAKE_STORAGE = 'AZURE_DATA_LAKE_STORAGE'
CONNECTION_TYPE_AZURE_SYNAPSE_ANALYTICS = 'AZURE_SYNAPSE_ANALYTICS'
CONNECTION_TYPE_DATABRICKS = 'DATABRICKS'
CONNECTION_TYPE_DB2 = 'DB2'
CONNECTION_TYPE_ELASTICSEARCH = 'ELASTICSEARCH'
CONNECTION_TYPE_GENERIC = 'GENERIC'
CONNECTION_TYPE_GOLDENGATE = 'GOLDENGATE'
CONNECTION_TYPE_GOOGLE_BIGQUERY = 'GOOGLE_BIGQUERY'
CONNECTION_TYPE_GOOGLE_CLOUD_STORAGE = 'GOOGLE_CLOUD_STORAGE'
CONNECTION_TYPE_GOOGLE_PUBSUB = 'GOOGLE_PUBSUB'
CONNECTION_TYPE_HDFS = 'HDFS'
CONNECTION_TYPE_ICEBERG = 'ICEBERG'
CONNECTION_TYPE_JAVA_MESSAGE_SERVICE = 'JAVA_MESSAGE_SERVICE'
CONNECTION_TYPE_KAFKA = 'KAFKA'
CONNECTION_TYPE_KAFKA_SCHEMA_REGISTRY = 'KAFKA_SCHEMA_REGISTRY'
CONNECTION_TYPE_MICROSOFT_FABRIC = 'MICROSOFT_FABRIC'
CONNECTION_TYPE_MICROSOFT_SQLSERVER = 'MICROSOFT_SQLSERVER'
CONNECTION_TYPE_MONGODB = 'MONGODB'
CONNECTION_TYPE_MYSQL = 'MYSQL'
CONNECTION_TYPE_OCI_OBJECT_STORAGE = 'OCI_OBJECT_STORAGE'
CONNECTION_TYPE_ORACLE = 'ORACLE'
CONNECTION_TYPE_ORACLE_AI_DATA_PLATFORM = 'ORACLE_AI_DATA_PLATFORM'
CONNECTION_TYPE_ORACLE_NOSQL = 'ORACLE_NOSQL'
CONNECTION_TYPE_POSTGRESQL = 'POSTGRESQL'
CONNECTION_TYPE_REDIS = 'REDIS'
CONNECTION_TYPE_SNOWFLAKE = 'SNOWFLAKE'
ROUTING_METHOD_DEDICATED_ENDPOINT = 'DEDICATED_ENDPOINT'
ROUTING_METHOD_SHARED_DEPLOYMENT_ENDPOINT = 'SHARED_DEPLOYMENT_ENDPOINT'
ROUTING_METHOD_SHARED_SERVICE_ENDPOINT = 'SHARED_SERVICE_ENDPOINT'
__init__(**kwargs)

Initializes a new DatabricksConnectionSummary object with values from keyword arguments. The default value of the 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):

Parameters:
  • connection_type (str) – The value to assign to the connection_type property of this DatabricksConnectionSummary. 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_AI_DATA_PLATFORM”, “ORACLE_NOSQL”, “MONGODB”, “AMAZON_KINESIS”, “AMAZON_REDSHIFT”, “DB2”, “REDIS”, “ELASTICSEARCH”, “GENERIC”, “GOOGLE_CLOUD_STORAGE”, “GOOGLE_BIGQUERY”, “DATABRICKS”, “GOOGLE_PUBSUB”, “MICROSOFT_FABRIC”, “ICEBERG”, “AI_MODEL”
  • id (str) – The value to assign to the id property of this DatabricksConnectionSummary.
  • display_name (str) – The value to assign to the display_name property of this DatabricksConnectionSummary.
  • description (str) – The value to assign to the description property of this DatabricksConnectionSummary.
  • compartment_id (str) – The value to assign to the compartment_id property of this DatabricksConnectionSummary.
  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this DatabricksConnectionSummary.
  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this DatabricksConnectionSummary.
  • system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this DatabricksConnectionSummary.
  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this DatabricksConnectionSummary.
  • lifecycle_details (str) – The value to assign to the lifecycle_details property of this DatabricksConnectionSummary.
  • time_created (datetime) – The value to assign to the time_created property of this DatabricksConnectionSummary.
  • time_updated (datetime) – The value to assign to the time_updated property of this DatabricksConnectionSummary.
  • vault_id (str) – The value to assign to the vault_id property of this DatabricksConnectionSummary.
  • key_id (str) – The value to assign to the key_id property of this DatabricksConnectionSummary.
  • ingress_ips (list[oci.golden_gate.models.IngressIpDetails]) – The value to assign to the ingress_ips property of this DatabricksConnectionSummary.
  • nsg_ids (list[str]) – The value to assign to the nsg_ids property of this DatabricksConnectionSummary.
  • subnet_id (str) – The value to assign to the subnet_id property of this DatabricksConnectionSummary.
  • routing_method (str) – The value to assign to the routing_method property of this DatabricksConnectionSummary. Allowed values for this property are: “SHARED_SERVICE_ENDPOINT”, “SHARED_DEPLOYMENT_ENDPOINT”, “DEDICATED_ENDPOINT”
  • locks (list[oci.golden_gate.models.ResourceLock]) – The value to assign to the locks property of this DatabricksConnectionSummary.
  • does_use_secret_ids (bool) – The value to assign to the does_use_secret_ids property of this DatabricksConnectionSummary.
  • subscription_id (str) – The value to assign to the subscription_id property of this DatabricksConnectionSummary.
  • cluster_placement_group_id (str) – The value to assign to the cluster_placement_group_id property of this DatabricksConnectionSummary.
  • security_attributes (dict(str, dict(str, object))) – The value to assign to the security_attributes property of this DatabricksConnectionSummary.
  • technology_type (str) – The value to assign to the technology_type property of this DatabricksConnectionSummary.
  • authentication_type (str) – The value to assign to the authentication_type property of this DatabricksConnectionSummary.
  • connection_url (str) – The value to assign to the connection_url property of this DatabricksConnectionSummary.
  • password_secret_id (str) – The value to assign to the password_secret_id property of this DatabricksConnectionSummary.
  • client_id (str) – The value to assign to the client_id property of this DatabricksConnectionSummary.
  • client_secret_secret_id (str) – The value to assign to the client_secret_secret_id property of this DatabricksConnectionSummary.
  • storage_credential_name (str) – The value to assign to the storage_credential_name property of this DatabricksConnectionSummary.
authentication_type

[Required] Gets the authentication_type of this DatabricksConnectionSummary. Used authentication mechanism to access Databricks.

Returns:The authentication_type of this DatabricksConnectionSummary.
Return type:str
client_id

Gets the client_id of this DatabricksConnectionSummary. OAuth client id, only applicable for authenticationType == OAUTH_M2M

Returns:The client_id of this DatabricksConnectionSummary.
Return type:str
client_secret_secret_id

Gets the client_secret_secret_id of this DatabricksConnectionSummary. 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.

Returns:The client_secret_secret_id of this DatabricksConnectionSummary.
Return type:str
cluster_placement_group_id

Gets the cluster_placement_group_id of this ConnectionSummary. The OCID(/Content/General/Concepts/identifiers.htm) of the cluster placement group for the resource. Only applicable for multicloud subscriptions. The cluster placement group id must be provided when a multicloud subscription id is provided. Otherwise the cluster placement group must not be provided.

Returns:The cluster_placement_group_id of this ConnectionSummary.
Return type:str
compartment_id

[Required] Gets the compartment_id of this ConnectionSummary. The OCID of the compartment being referenced.

Returns:The compartment_id of this ConnectionSummary.
Return type:str
connection_type

[Required] Gets the connection_type of this ConnectionSummary. The connection type.

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_AI_DATA_PLATFORM”, “ORACLE_NOSQL”, “MONGODB”, “AMAZON_KINESIS”, “AMAZON_REDSHIFT”, “DB2”, “REDIS”, “ELASTICSEARCH”, “GENERIC”, “GOOGLE_CLOUD_STORAGE”, “GOOGLE_BIGQUERY”, “DATABRICKS”, “GOOGLE_PUBSUB”, “MICROSOFT_FABRIC”, “ICEBERG”, “AI_MODEL”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:The connection_type of this ConnectionSummary.
Return type:str
connection_url

[Required] Gets the connection_url of this DatabricksConnectionSummary. 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’

Returns:The connection_url of this DatabricksConnectionSummary.
Return type:str
defined_tags

Gets the defined_tags of this ConnectionSummary. Tags defined for this resource. Each key is predefined and scoped to a namespace.

Example: {“foo-namespace”: {“bar-key”: “value”}}

Returns:The defined_tags of this ConnectionSummary.
Return type:dict(str, dict(str, object))
description

Gets the description of this ConnectionSummary. Metadata about this specific object.

Returns:The description of this ConnectionSummary.
Return type:str
display_name

[Required] Gets the display_name of this ConnectionSummary. An object’s Display Name.

Returns:The display_name of this ConnectionSummary.
Return type:str
does_use_secret_ids

Gets the does_use_secret_ids of this ConnectionSummary. Indicates that sensitive attributes are provided via Secrets.

Deprecated: This field is deprecated. Sensitive attributes should be provided using the corresponding Secret OCID attributes of the connection (for example, passwordSecretId) instead of plain-text attributes. This change follows the GoldenGate “Plain Text Fields in Connections” deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate

When set to true, all sensitive information must be provided as OCI Vault secrets using the corresponding *SecretId attributes of the connection (for example, passwordSecretId). Plain-text sensitive attributes (for example, password) must not be used. This ensures that sensitive information remains stored and managed in the customer’s OCI Vault rather than by the GoldenGate service.

When set to false, sensitive information must be provided in the corresponding plain-text attributes (for example, password) rather than in secret OCID attributes. In this mode, the sensitive information is stored by the GoldenGate service. If vaultId and keyId are not specified, the GoldenGate service uses Oracle-managed encryption keys to encrypt the stored data.

If vaultId and keyId are provided, the specified customer-managed key is used.

Returns:The does_use_secret_ids of this ConnectionSummary.
Return type:bool
freeform_tags

Gets the freeform_tags of this ConnectionSummary. A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only.

Example: {“bar-key”: “value”}

Returns:The freeform_tags of this ConnectionSummary.
Return type:dict(str, 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.

id

[Required] Gets the id of this ConnectionSummary. The OCID of the connection being referenced.

Returns:The id of this ConnectionSummary.
Return type:str
ingress_ips

Gets the ingress_ips of this ConnectionSummary. List of ingress IP addresses from where the GoldenGate deployment connects to this connection’s privateIp. Customers may optionally set up ingress security rules to restrict traffic from these IP addresses.

Returns:The ingress_ips of this ConnectionSummary.
Return type:list[oci.golden_gate.models.IngressIpDetails]
key_id

Gets the key_id of this ConnectionSummary. References the OCI Vault key in the OCI Vault identified by vaultId.

Deprecated: This field is deprecated for GoldenGate connections. Sensitive attributes should be provided using the corresponding Secret OCID attributes of the connection (for example, passwordSecretId) instead of plain-text attributes encrypted with vaultId and keyId. This change follows the GoldenGate “Plain Text Fields in Connections” deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate

The GoldenGate service uses this key to encrypt sensitive information (for example, password) that is provided in plain-text connection attributes through the API. This field is applicable only when doesUseSecretIds is set to false. If both vaultId and keyId are provided, the GoldenGate service uses the specified customer-managed key to encrypt the sensitive data. If neither vaultId nor keyId is provided, the GoldenGate service uses Oracle-managed encryption keys.

Returns:The key_id of this ConnectionSummary.
Return type:str
lifecycle_details

Gets the lifecycle_details of this ConnectionSummary. Describes the object’s current state in detail. For example, it can be used to provide actionable information for a resource in a Failed state.

Returns:The lifecycle_details of this ConnectionSummary.
Return type:str
lifecycle_state

[Required] Gets the lifecycle_state of this ConnectionSummary. Possible lifecycle states for connection.

Returns:The lifecycle_state of this ConnectionSummary.
Return type:str
locks

Gets the locks of this ConnectionSummary. Locks associated with this resource.

Returns:The locks of this ConnectionSummary.
Return type:list[oci.golden_gate.models.ResourceLock]
nsg_ids

Gets the nsg_ids of this ConnectionSummary. An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.

Returns:The nsg_ids of this ConnectionSummary.
Return type:list[str]
password_secret_id

Gets the password_secret_id of this DatabricksConnectionSummary. The OCID of the Secret where the password is stored. Note: When provided, ‘password’ field must not be provided.

Returns:The password_secret_id of this DatabricksConnectionSummary.
Return type:str
routing_method

Gets the routing_method of this ConnectionSummary. Controls the network traffic direction to the target: SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment’s private endpoint through the deployment’s subnet. DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected. SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service’s network to public hosts. Cannot be used for private targets.

Deprecated: SHARED_SERVICE_ENDPOINT is deprecated. Use another supported routingMethod value, or update existing connections to use a supported routing method. This change follows the GoldenGate “Plain Text Fields in Connections” deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate

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’.

Returns:The routing_method of this ConnectionSummary.
Return type:str
security_attributes

Gets the security_attributes of this ConnectionSummary. Security attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {“Oracle-ZPR”: {“MaxEgressCount”: {“value”: “42”, “mode”: “enforce”}}}

Returns:The security_attributes of this ConnectionSummary.
Return type:dict(str, dict(str, object))
storage_credential_name

Gets the storage_credential_name of this DatabricksConnectionSummary. Optional. External storage credential name to access files on object storage such as ADLS Gen2, S3 or GCS.

Returns:The storage_credential_name of this DatabricksConnectionSummary.
Return type:str
subnet_id

Gets the subnet_id of this ConnectionSummary. The OCID of the target subnet of the dedicated connection.

Returns:The subnet_id of this ConnectionSummary.
Return type:str
subscription_id

Gets the subscription_id of this ConnectionSummary. The OCID of the subscription with which resource needs to be associated with.

Returns:The subscription_id of this ConnectionSummary.
Return type:str
system_tags

Gets the system_tags of this ConnectionSummary. The system tags associated with this resource, if any. The system tags are set by Oracle Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags.

Example: {orcl-cloud: {free-tier-retain: true}}

Returns:The system_tags of this ConnectionSummary.
Return type:dict(str, dict(str, object))
technology_type

[Required] Gets the technology_type of this DatabricksConnectionSummary. The Databricks technology type.

Returns:The technology_type of this DatabricksConnectionSummary.
Return type:str
time_created

[Required] Gets the time_created of this ConnectionSummary. The time the resource was created. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.

Returns:The time_created of this ConnectionSummary.
Return type:datetime
time_updated

[Required] Gets the time_updated of this ConnectionSummary. The time the resource was last updated. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.

Returns:The time_updated of this ConnectionSummary.
Return type:datetime
vault_id

Gets the vault_id of this ConnectionSummary. References the OCI Vault that contains the customer-managed encryption key identified by keyId.

Deprecated: This field is deprecated for GoldenGate connections. Sensitive attributes should be provided using the corresponding Secret OCID attributes of the connection (for example, passwordSecretId) instead of plain-text attributes encrypted with vaultId and keyId. This change follows the GoldenGate “Plain Text Fields in Connections” deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate

This field is applicable only when doesUseSecretIds is set to false. If vaultId is provided, keyId must also be provided.

Returns:The vault_id of this ConnectionSummary.
Return type:str