DatabricksConfig (Databricks SDK for Java 0.94.0 API)

java.lang.Object
- com.databricks.sdk.core.DatabricksConfig

public class DatabricksConfig
extends Object

Constructor Summary

Constructors
Constructor and Description

DatabricksConfig()

Constructors
Constructor and Description
`DatabricksConfig()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`Map<String,String>`	`authenticate()`
`void`	`authenticate(org.apache.http.HttpMessage request)`
`DatabricksConfig`	`clone()`
`String`	`getAccountId()`
`String`	`getActionsIdTokenRequestToken()`
`String`	`getActionsIdTokenRequestUrl()`
`String`	`getAuthType()`
`String`	`getAzureClientId()`
`String`	`getAzureClientSecret()`
`OpenIDConnectEndpoints`	`getAzureEntraIdWorkspaceEndpoints()`
`AzureEnvironment`	`getAzureEnvironment()`
`String`	`getAzureTenantId()`
`boolean`	`getAzureUseMsi()`
`boolean`	`getAzureUseMSI()` Deprecated. Use `getAzureUseMsi()` instead.
`String`	`getAzureWorkspaceResourceId()`
`String`	`getClientId()`
`String`	`getClientSecret()`
`ClientType`	`getClientType()` Returns the client type based on host type and workspace ID configuration.
`String`	`getClusterId()`
`String`	`getConfigFile()`
`CredentialsProvider`	`getCredentialsProvider()`
`String`	`getDatabricksCliPath()`
`DatabricksEnvironment`	`getDatabricksEnvironment()`
`OpenIDConnectEndpoints`	`getDatabricksOidcEndpoints()`
`Integer`	`getDebugTruncateBytes()`
`boolean`	`getDisableAsyncTokenRefresh()`
`boolean`	`getDisableOauthRefreshToken()`
`boolean`	`getDisableRetries()`
`String`	`getDiscoveryUrl()`
`String`	`getEffectiveAzureLoginAppId()`
`String`	`getEffectiveOAuthRedirectUrl()` Gets the default OAuth redirect URL.
`Environment`	`getEnv()`
`Boolean`	`getExperimentalIsUnifiedHost()`
`String`	`getGoogleCredentials()`
`String`	`getGoogleServiceAccount()`
`String`	`getHost()`
`HostType`	`getHostType()` Returns the host type based on configuration settings and host URL.
`HttpClient`	`getHttpClient()`
`Integer`	`getHttpTimeoutSeconds()`
`Duration`	`getOAuthBrowserAuthTimeout()`
`String`	`getOAuthRedirectUrl()`
`OpenIDConnectEndpoints`	`getOidcEndpoints()` Deprecated. Use `getDatabricksOidcEndpoints()` instead. This method incorrectly returns Azure OIDC endpoints when azure_client_id is set, even for Databricks OAuth flows that don't use Azure authentication. This caused bugs where Databricks M2M OAuth would fail when ARM_CLIENT_ID was set for other purposes. Use instead: - getDatabricksOidcEndpoints(): For Databricks OAuth (oauth-m2m, external-browser, etc.). - getAzureEntraIdWorkspaceEndpoints(): For Azure Entra ID OIDC endpoints.
`String`	`getOidcTokenEnv()`
`String`	`getOidcTokenFilepath()`
`String`	`getPassword()`
`String`	`getProfile()`
`Integer`	`getRateLimit()`
`List<String>`	`getScopes()` Returns the scopes to use for the current configuration.
`String`	`getServerlessComputeId()`
`String`	`getToken()`
`String`	`getTokenAudience()`
`TokenSource`	`getTokenSource()`
`String`	`getUsername()`
`String`	`getWorkspaceId()`
`boolean`	`isAccountClient()`
`boolean`	`isAws()`
`boolean`	`isAzure()`
`boolean`	`isDebugHeaders()`
`boolean`	`isGcp()`
`boolean`	`isSkipVerify()`
`DatabricksConfig`	`newWithWorkspaceHost(String host)`
`DatabricksConfig`	`resolve()`
`DatabricksConfig`	`setAccountId(String accountId)`
`DatabricksConfig`	`setActionsIdTokenRequestToken(String token)`
`DatabricksConfig`	`setActionsIdTokenRequestUrl(String url)`
`DatabricksConfig`	`setAuthType(String authType)`
`DatabricksConfig`	`setAzureClientId(String azureClientId)`
`DatabricksConfig`	`setAzureClientSecret(String azureClientSecret)`
`DatabricksConfig`	`setAzureEnvironment(String azureEnvironment)`
`DatabricksConfig`	`setAzureTenantId(String azureTenantId)`
`DatabricksConfig`	`setAzureUseMsi(boolean azureUseMsi)`
`DatabricksConfig`	`setAzureUseMSI(boolean azureUseMsi)` Deprecated. Use `getAzureUseMsi()` instead.
`DatabricksConfig`	`setAzureWorkspaceResourceId(String azureWorkspaceResourceId)`
`DatabricksConfig`	`setClientId(String clientId)`
`DatabricksConfig`	`setClientSecret(String clientSecret)`
`DatabricksConfig`	`setClusterId(String clusterId)`
`DatabricksConfig`	`setConfigFile(String configFile)`
`DatabricksConfig`	`setCredentialsProvider(CredentialsProvider credentialsProvider)`
`DatabricksConfig`	`setDatabricksCliPath(String databricksCliPath)`
`DatabricksConfig`	`setDatabricksEnvironment(DatabricksEnvironment databricksEnvironment)`
`DatabricksConfig`	`setDebugHeaders(boolean debugHeaders)`
`DatabricksConfig`	`setDebugTruncateBytes(int debugTruncateBytes)`
`DatabricksConfig`	`setDisableAsyncTokenRefresh(boolean disableAsyncTokenRefresh)`
`DatabricksConfig`	`setDisableOauthRefreshToken(boolean disable)`
`DatabricksConfig`	`setDisableRetries(boolean disableRetries)`
`DatabricksConfig`	`setDiscoveryUrl(String discoveryUrl)`
`DatabricksConfig`	`setExperimentalIsUnifiedHost(Boolean experimentalIsUnifiedHost)`
`DatabricksConfig`	`setGoogleCredentials(String googleCredentials)`
`DatabricksConfig`	`setGoogleServiceAccount(String googleServiceAccount)`
`DatabricksConfig`	`setHost(String host)`
`DatabricksConfig`	`setHttpClient(HttpClient httpClient)`
`DatabricksConfig`	`setHttpTimeoutSeconds(int httpTimeoutSeconds)`
`DatabricksConfig`	`setOAuthBrowserAuthTimeout(Duration oauthBrowserAuthTimeout)`
`DatabricksConfig`	`setOAuthRedirectUrl(String redirectUrl)`
`DatabricksConfig`	`setOidcTokenEnv(String oidcTokenEnv)`
`DatabricksConfig`	`setOidcTokenFilepath(String oidcTokenFilepath)`
`DatabricksConfig`	`setPassword(String password)`
`DatabricksConfig`	`setProfile(String profile)`
`DatabricksConfig`	`setRateLimit(int rateLimit)`
`DatabricksConfig`	`setScopes(List<String> scopes)`
`DatabricksConfig`	`setServerlessComputeId(String serverlessComputeId)`
`DatabricksConfig`	`setSkipVerify(boolean skipVerify)`
`DatabricksConfig`	`setToken(String token)`
`DatabricksConfig`	`setTokenAudience(String tokenAudience)`
`DatabricksConfig`	`setUsername(String username)`
`DatabricksConfig`	`setWorkspaceId(String workspaceId)`
`String`	`toString()`

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail
- DatabricksConfig
```
public DatabricksConfig()
```

Method Detail

getEnv
```
public Environment getEnv()
```

resolve
```
public DatabricksConfig resolve()
```

authenticate

public Map<String,String> authenticate()
                                throws DatabricksException

Throws:: DatabricksException

getTokenSource
```
public TokenSource getTokenSource()
```

getCredentialsProvider

public CredentialsProvider getCredentialsProvider()

setCredentialsProvider

public DatabricksConfig setCredentialsProvider(CredentialsProvider credentialsProvider)

getHost
```
public String getHost()
```

setHost

public DatabricksConfig setHost(String host)

getDiscoveryUrl
```
public String getDiscoveryUrl()
```

setDiscoveryUrl

public DatabricksConfig setDiscoveryUrl(String discoveryUrl)

getAccountId
```
public String getAccountId()
```

setAccountId

public DatabricksConfig setAccountId(String accountId)

getWorkspaceId
```
public String getWorkspaceId()
```

setWorkspaceId

public DatabricksConfig setWorkspaceId(String workspaceId)

getExperimentalIsUnifiedHost

public Boolean getExperimentalIsUnifiedHost()

setExperimentalIsUnifiedHost

public DatabricksConfig setExperimentalIsUnifiedHost(Boolean experimentalIsUnifiedHost)

getDatabricksCliPath
```
public String getDatabricksCliPath()
```

setDatabricksCliPath

public DatabricksConfig setDatabricksCliPath(String databricksCliPath)

getToken
```
public String getToken()
```

setToken

public DatabricksConfig setToken(String token)

getUsername
```
public String getUsername()
```

setUsername

public DatabricksConfig setUsername(String username)

getClusterId
```
public String getClusterId()
```

setClusterId

public DatabricksConfig setClusterId(String clusterId)

getServerlessComputeId

public String getServerlessComputeId()

setServerlessComputeId

public DatabricksConfig setServerlessComputeId(String serverlessComputeId)

getPassword
```
public String getPassword()
```

setPassword

public DatabricksConfig setPassword(String password)

getClientId
```
public String getClientId()
```

setClientId

public DatabricksConfig setClientId(String clientId)

getClientSecret
```
public String getClientSecret()
```

setClientSecret

public DatabricksConfig setClientSecret(String clientSecret)

getOAuthRedirectUrl
```
public String getOAuthRedirectUrl()
```

setOAuthRedirectUrl

public DatabricksConfig setOAuthRedirectUrl(String redirectUrl)

getScopes
```
public List<String> getScopes()
```
Returns the scopes to use for the current configuration. If no scopes were provided, returns the default "all-apis" scope.

Returns:

The scopes to use for the current configuration

setScopes

public DatabricksConfig setScopes(List<String> scopes)

getProfile
```
public String getProfile()
```

setProfile

public DatabricksConfig setProfile(String profile)

getConfigFile
```
public String getConfigFile()
```

setConfigFile

public DatabricksConfig setConfigFile(String configFile)

getGoogleServiceAccount

public String getGoogleServiceAccount()

setGoogleServiceAccount

public DatabricksConfig setGoogleServiceAccount(String googleServiceAccount)

getGoogleCredentials
```
public String getGoogleCredentials()
```

setGoogleCredentials

public DatabricksConfig setGoogleCredentials(String googleCredentials)

getAzureWorkspaceResourceId

public String getAzureWorkspaceResourceId()

setAzureWorkspaceResourceId

public DatabricksConfig setAzureWorkspaceResourceId(String azureWorkspaceResourceId)

getAzureUseMsi
```
public boolean getAzureUseMsi()
```

setAzureUseMsi

public DatabricksConfig setAzureUseMsi(boolean azureUseMsi)

getAzureUseMSI
```
@Deprecated
public boolean getAzureUseMSI()
```
Deprecated. Use getAzureUseMsi() instead.

setAzureUseMSI

@Deprecated
public DatabricksConfig setAzureUseMSI(boolean azureUseMsi)

Deprecated. Use getAzureUseMsi() instead.

getAzureClientSecret
```
public String getAzureClientSecret()
```

setAzureClientSecret

public DatabricksConfig setAzureClientSecret(String azureClientSecret)

getAzureClientId
```
public String getAzureClientId()
```

setAzureClientId

public DatabricksConfig setAzureClientId(String azureClientId)

getAzureTenantId
```
public String getAzureTenantId()
```

setAzureTenantId

public DatabricksConfig setAzureTenantId(String azureTenantId)

getAzureEnvironment

public AzureEnvironment getAzureEnvironment()

setAzureEnvironment

public DatabricksConfig setAzureEnvironment(String azureEnvironment)

getActionsIdTokenRequestUrl

public String getActionsIdTokenRequestUrl()

setActionsIdTokenRequestUrl

public DatabricksConfig setActionsIdTokenRequestUrl(String url)

getActionsIdTokenRequestToken

public String getActionsIdTokenRequestToken()

setActionsIdTokenRequestToken

public DatabricksConfig setActionsIdTokenRequestToken(String token)

getEffectiveAzureLoginAppId

public String getEffectiveAzureLoginAppId()

getAuthType
```
public String getAuthType()
```

setAuthType

public DatabricksConfig setAuthType(String authType)

isSkipVerify
```
public boolean isSkipVerify()
```

setSkipVerify

public DatabricksConfig setSkipVerify(boolean skipVerify)

getHttpTimeoutSeconds

public Integer getHttpTimeoutSeconds()

setHttpTimeoutSeconds

public DatabricksConfig setHttpTimeoutSeconds(int httpTimeoutSeconds)

getDebugTruncateBytes

public Integer getDebugTruncateBytes()

setDebugTruncateBytes

public DatabricksConfig setDebugTruncateBytes(int debugTruncateBytes)

isDebugHeaders
```
public boolean isDebugHeaders()
```

setDebugHeaders

public DatabricksConfig setDebugHeaders(boolean debugHeaders)

getRateLimit
```
public Integer getRateLimit()
```

setRateLimit

public DatabricksConfig setRateLimit(int rateLimit)

getHttpClient
```
public HttpClient getHttpClient()
```

setHttpClient

public DatabricksConfig setHttpClient(HttpClient httpClient)

getTokenAudience
```
public String getTokenAudience()
```

setTokenAudience

public DatabricksConfig setTokenAudience(String tokenAudience)

getOidcTokenFilepath
```
public String getOidcTokenFilepath()
```

setOidcTokenFilepath

public DatabricksConfig setOidcTokenFilepath(String oidcTokenFilepath)

getOidcTokenEnv
```
public String getOidcTokenEnv()
```

setOidcTokenEnv

public DatabricksConfig setOidcTokenEnv(String oidcTokenEnv)

getDisableAsyncTokenRefresh

public boolean getDisableAsyncTokenRefresh()

setDisableAsyncTokenRefresh

public DatabricksConfig setDisableAsyncTokenRefresh(boolean disableAsyncTokenRefresh)

getDisableRetries
```
public boolean getDisableRetries()
```

setDisableRetries

public DatabricksConfig setDisableRetries(boolean disableRetries)

getOAuthBrowserAuthTimeout

public Duration getOAuthBrowserAuthTimeout()

setOAuthBrowserAuthTimeout

public DatabricksConfig setOAuthBrowserAuthTimeout(Duration oauthBrowserAuthTimeout)

getDisableOauthRefreshToken

public boolean getDisableOauthRefreshToken()

setDisableOauthRefreshToken

public DatabricksConfig setDisableOauthRefreshToken(boolean disable)

isAzure
```
public boolean isAzure()
```

authenticate

public void authenticate(org.apache.http.HttpMessage request)

isGcp
```
public boolean isGcp()
```

isAws
```
public boolean isAws()
```

isAccountClient
```
public boolean isAccountClient()
```

getHostType
```
public HostType getHostType()
```
Returns the host type based on configuration settings and host URL.

getClientType
```
public ClientType getClientType()
```
Returns the client type based on host type and workspace ID configuration.

getOidcEndpoints
```
@Deprecated
public OpenIDConnectEndpoints getOidcEndpoints()
                                                    throws IOException
```
Deprecated. Use getDatabricksOidcEndpoints() instead. This method incorrectly returns Azure OIDC endpoints when azure_client_id is set, even for Databricks OAuth flows that don't use Azure authentication. This caused bugs where Databricks M2M OAuth would fail when ARM_CLIENT_ID was set for other purposes. Use instead: - getDatabricksOidcEndpoints(): For Databricks OAuth (oauth-m2m, external-browser, etc.). - getAzureEntraIdWorkspaceEndpoints(): For Azure Entra ID OIDC endpoints.

Returns:

The OIDC endpoints. This method dinamically returns the OIDC endpoints based on the config.

Throws:

IOException

getAzureEntraIdWorkspaceEndpoints

public OpenIDConnectEndpoints getAzureEntraIdWorkspaceEndpoints()
                                                         throws IOException

Returns:: The Azure Entra ID OIDC endpoints.
Throws:: IOException

getDatabricksOidcEndpoints

public OpenIDConnectEndpoints getDatabricksOidcEndpoints()
                                                  throws IOException

Returns:: The Databricks OIDC endpoints.
Throws:: IOException

toString
```
public String toString()
```
Overrides:

toString in class Object

setDatabricksEnvironment

public DatabricksConfig setDatabricksEnvironment(DatabricksEnvironment databricksEnvironment)

getDatabricksEnvironment

public DatabricksEnvironment getDatabricksEnvironment()

clone
```
public DatabricksConfig clone()
```
Overrides:

clone in class Object

newWithWorkspaceHost

public DatabricksConfig newWithWorkspaceHost(String host)

getEffectiveOAuthRedirectUrl
```
public String getEffectiveOAuthRedirectUrl()
```
Gets the default OAuth redirect URL. If one is not provided explicitly, uses http://localhost:8080/callback

Returns:

The OAuth redirect URL to use

Class DatabricksConfig

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DatabricksConfig

Method Detail

getEnv

resolve

authenticate

getTokenSource

getCredentialsProvider

setCredentialsProvider

getHost

setHost

getDiscoveryUrl

setDiscoveryUrl

getAccountId

setAccountId

getWorkspaceId

setWorkspaceId

getExperimentalIsUnifiedHost

setExperimentalIsUnifiedHost

getDatabricksCliPath

setDatabricksCliPath

getToken

setToken

getUsername

setUsername

getClusterId

setClusterId

getServerlessComputeId

setServerlessComputeId

getPassword

setPassword

getClientId

setClientId

getClientSecret

setClientSecret

getOAuthRedirectUrl

setOAuthRedirectUrl

getScopes

setScopes

getProfile

setProfile

getConfigFile

setConfigFile

getGoogleServiceAccount

setGoogleServiceAccount

getGoogleCredentials

setGoogleCredentials

getAzureWorkspaceResourceId

setAzureWorkspaceResourceId

getAzureUseMsi

setAzureUseMsi

getAzureUseMSI

setAzureUseMSI

getAzureClientSecret

setAzureClientSecret

getAzureClientId

setAzureClientId

getAzureTenantId

setAzureTenantId

getAzureEnvironment

setAzureEnvironment

getActionsIdTokenRequestUrl

setActionsIdTokenRequestUrl

getActionsIdTokenRequestToken

setActionsIdTokenRequestToken

getEffectiveAzureLoginAppId

getAuthType

setAuthType

isSkipVerify

setSkipVerify

getHttpTimeoutSeconds

setHttpTimeoutSeconds

getDebugTruncateBytes

setDebugTruncateBytes

isDebugHeaders

setDebugHeaders