Class DatabricksConnection


  • @Generated(value="OracleSDKGenerator",
               comments="API Version: 20200407")
    public final class DatabricksConnection
    extends Connection
    Represents the metadata of a Databricks Connection.
    Note: Objects should always be created or deserialized using the DatabricksConnection.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the DatabricksConnection.Builder, which maintain a set of all explicitly set fields called DatabricksConnection.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).
    • Method Detail

      • getAuthenticationType

        public DatabricksConnection.AuthenticationType getAuthenticationType()
        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
        Returns:
        the value
      • getConnectionUrl

        public String getConnectionUrl()
        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 value
      • getPasswordSecretId

        public String getPasswordSecretId()
        The OCID of the Secret where the password is stored.

        Note: When provided, ‘password’ field must not be provided.

        Returns:
        the value
      • getClientId

        public String getClientId()
        OAuth client id, only applicable for authenticationType == OAUTH_M2M
        Returns:
        the value
      • getClientSecretSecretId

        public String getClientSecretSecretId()
        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 value
      • getStorageCredentialName

        public String getStorageCredentialName()
        Optional.

        External storage credential name to access files on object storage such as ADLS Gen2, S3 or GCS.

        Returns:
        the value
      • toString

        public String toString​(boolean includeByteArrayContents)
        Return a string representation of the object.
        Overrides:
        toString in class Connection
        Parameters:
        includeByteArrayContents - true to include the full contents of byte arrays
        Returns:
        string representation