com.databricks.sdk.core

Interface CredentialsProvider

All Known Implementing Classes:

AzureCliCredentialsProvider, AzureGithubOidcCredentialsProvider, AzureServicePrincipalCredentialsProvider, BasicCredentialsProvider, DatabricksCliCredentialsProvider, DefaultCredentialsProvider, ExternalBrowserCredentialsProvider, GoogleCredentialsCredentialsProvider, GoogleIdCredentialsProvider, NotebookNativeCredentialsProvider, OAuthM2MServicePrincipalCredentialsProvider, PatCredentialsProvider, SessionCredentials, TokenSourceCredentialsProvider

public interface CredentialsProvider

CredentialsProvider is an interface that provides a HeaderFactory to authenticate requests to the Databricks API.

Users can implement this interface to provide custom authentication mechanisms. Once implemented, the custom provider can be set on DatabricksConfig using DatabricksConfig.setCredentialsProvider(CredentialsProvider).

Note: The methods in this interface are called internally by the SDK clients (WorkspaceClient and AccountClient) during request authentication. Users implementing this interface should not call these methods directly.

Method Summary

Modifier and Type	Method and Description
String	authType() Returns the authentication type identifier for this credentials provider.
HeaderFactory	configure(DatabricksConfig config) Creates and returns a new HeaderFactory to authenticate requests to the Databricks API.

Method Detail

authType

String authType()

Returns the authentication type identifier for this credentials provider.

This method is called internally by the SDK and should not be invoked directly by users. It is used for logging and user-agent identification purposes.

Returns:

the authentication type as a string

configure

HeaderFactory configure(DatabricksConfig config)

Creates and returns a new HeaderFactory to authenticate requests to the Databricks API.

Note: A new HeaderFactory instance is returned on each invocation.

This method is called internally by the SDK during client initialization and should not be invoked directly by users. The SDK will call this method to obtain a HeaderFactory that will be used to add authentication headers to each API request.

Parameters:

config - the Databricks configuration to use for authentication

Returns:

a new HeaderFactory configured for authenticating API requests