com.databricks.sdk.service.catalog

Class StorageCredentialsAPI

java.lang.Object

com.databricks.sdk.service.catalog.StorageCredentialsAPI

@Generated
public class StorageCredentialsAPI
extends Object

A storage credential represents an authentication and authorization mechanism for accessing data stored on your cloud tenant. Each storage credential is subject to Unity Catalog access-control policies that control which users and groups can access the credential. If a user does not have access to a storage credential in Unity Catalog, the request fails and Unity Catalog does not attempt to authenticate to your cloud tenant on the user’s behalf.

Databricks recommends using external locations rather than using storage credentials directly.

To create storage credentials, you must be a Databricks account admin. The account admin who creates the storage credential can delegate ownership to another user or group to manage permissions on it.

Constructor Summary

Constructors

Constructor and Description
StorageCredentialsAPI(ApiClient apiClient) Regular-use constructor
StorageCredentialsAPI(StorageCredentialsService mock) Constructor for mocks

Method Summary

Modifier and Type	Method and Description
StorageCredentialInfo	create(CreateStorageCredential request) Creates a new storage credential.
void	delete(DeleteStorageCredentialRequest request) Deletes a storage credential from the metastore.
void	delete(String name)
StorageCredentialInfo	get(GetStorageCredentialRequest request) Gets a storage credential from the metastore.
StorageCredentialInfo	get(String name)
StorageCredentialsService	impl()
Iterable<StorageCredentialInfo>	list(ListStorageCredentialsRequest request) Gets an array of storage credentials (as __StorageCredentialInfo__ objects).
StorageCredentialInfo	update(UpdateStorageCredential request) Updates a storage credential on the metastore.
ValidateStorageCredentialResponse	validate(ValidateStorageCredential request) Validates a storage credential.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StorageCredentialsAPI

public StorageCredentialsAPI(ApiClient apiClient)

Regular-use constructor

StorageCredentialsAPI

public StorageCredentialsAPI(StorageCredentialsService mock)

Constructor for mocks

Method Detail

create

public StorageCredentialInfo create(CreateStorageCredential request)

Creates a new storage credential.

The caller must be a metastore admin or have the **CREATE_STORAGE_CREDENTIAL** privilege on the metastore.

delete

public void delete(String name)

delete

public void delete(DeleteStorageCredentialRequest request)

Deletes a storage credential from the metastore. The caller must be an owner of the storage credential.

get

public StorageCredentialInfo get(String name)

get

public StorageCredentialInfo get(GetStorageCredentialRequest request)

Gets a storage credential from the metastore. The caller must be a metastore admin, the owner of the storage credential, or have some permission on the storage credential.

list

public Iterable<StorageCredentialInfo> list(ListStorageCredentialsRequest request)

Gets an array of storage credentials (as __StorageCredentialInfo__ objects). The array is limited to only those storage credentials the caller has permission to access. If the caller is a metastore admin, retrieval of credentials is unrestricted. There is no guarantee of a specific ordering of the elements in the array.

NOTE: we recommend using max_results=0 to use the paginated version of this API. Unpaginated calls will be deprecated soon.

PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero results while still providing a next_page_token. Clients must continue reading pages until next_page_token is absent, which is the only indication that the end of results has been reached.

update

public StorageCredentialInfo update(UpdateStorageCredential request)

Updates a storage credential on the metastore.

The caller must be the owner of the storage credential or a metastore admin. If the caller is a metastore admin, only the **owner** field can be changed.

validate

public ValidateStorageCredentialResponse validate(ValidateStorageCredential request)

Validates a storage credential. At least one of __external_location_name__ and __url__ need to be provided. If only one of them is provided, it will be used for validation. And if both are provided, the __url__ will be used for validation, and __external_location_name__ will be ignored when checking overlapping urls.

Either the __storage_credential_name__ or the cloud-specific credential must be provided.

The caller must be a metastore admin or the storage credential owner or have the **CREATE_EXTERNAL_LOCATION** privilege on the metastore and the storage credential.

impl

public StorageCredentialsService impl()