com.databricks.sdk.service.catalog

Interface ExternalLocationsService

@Generated
public interface ExternalLocationsService

An external location is an object that combines a cloud storage path with a storage credential that authorizes access to the cloud storage path. Each external location 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 an external location 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 external locations, you must be a metastore admin or a user with the **CREATE_EXTERNAL_LOCATION** privilege.

This is the high-level interface, that contains generated methods.

Evolving: this interface is under development. Method signatures may change.

Method Summary

Modifier and Type	Method and Description
ExternalLocationInfo	create(CreateExternalLocation createExternalLocation) Creates a new external location entry in the metastore.
void	delete(DeleteExternalLocationRequest deleteExternalLocationRequest) Deletes the specified external location from the metastore.
ExternalLocationInfo	get(GetExternalLocationRequest getExternalLocationRequest) Gets an external location from the metastore.
ListExternalLocationsResponse	list(ListExternalLocationsRequest listExternalLocationsRequest) Gets an array of external locations (__ExternalLocationInfo__ objects) from the metastore.
ExternalLocationInfo	update(UpdateExternalLocation updateExternalLocation) Updates an external location in the metastore.

Method Detail

create

ExternalLocationInfo create(CreateExternalLocation createExternalLocation)

Creates a new external location entry in the metastore. The caller must be a metastore admin or have the **CREATE_EXTERNAL_LOCATION** privilege on both the metastore and the associated storage credential.

delete

void delete(DeleteExternalLocationRequest deleteExternalLocationRequest)

Deletes the specified external location from the metastore. The caller must be the owner of the external location.

get

ExternalLocationInfo get(GetExternalLocationRequest getExternalLocationRequest)

Gets an external location from the metastore. The caller must be either a metastore admin, the owner of the external location, or a user that has some privilege on the external location.

list

ListExternalLocationsResponse list(ListExternalLocationsRequest listExternalLocationsRequest)

Gets an array of external locations (__ExternalLocationInfo__ objects) from the metastore. The caller must be a metastore admin, the owner of the external location, or a user that has some privilege on the external location. 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

ExternalLocationInfo update(UpdateExternalLocation updateExternalLocation)

Updates an external location in the metastore. The caller must be the owner of the external location, or be a metastore admin. In the second case, the admin can only update the name of the external location.