com.databricks.sdk.service.catalog

Interface ExternalMetadataService

@Generated
public interface ExternalMetadataService

External Metadata objects enable customers to register and manage metadata about external systems within Unity Catalog.

These APIs provide a standardized way to create, update, retrieve, list, and delete external metadata objects. Fine-grained authorization ensures that only users with appropriate permissions can view and manage external metadata objects.

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
ExternalMetadata	createExternalMetadata(CreateExternalMetadataRequest createExternalMetadataRequest) Creates a new external metadata object in the parent metastore if the caller is a metastore admin or has the **CREATE_EXTERNAL_METADATA** privilege.
void	deleteExternalMetadata(DeleteExternalMetadataRequest deleteExternalMetadataRequest) Deletes the external metadata object that matches the supplied name.
ExternalMetadata	getExternalMetadata(GetExternalMetadataRequest getExternalMetadataRequest) Gets the specified external metadata object in a metastore.
ListExternalMetadataResponse	listExternalMetadata(ListExternalMetadataRequest listExternalMetadataRequest) Gets an array of external metadata objects in the metastore.
ExternalMetadata	updateExternalMetadata(UpdateExternalMetadataRequest updateExternalMetadataRequest) Updates the external metadata object that matches the supplied name.

Method Detail

createExternalMetadata

ExternalMetadata createExternalMetadata(CreateExternalMetadataRequest createExternalMetadataRequest)

Creates a new external metadata object in the parent metastore if the caller is a metastore admin or has the **CREATE_EXTERNAL_METADATA** privilege. Grants **BROWSE** to all account users upon creation by default.

deleteExternalMetadata

void deleteExternalMetadata(DeleteExternalMetadataRequest deleteExternalMetadataRequest)

Deletes the external metadata object that matches the supplied name. The caller must be a metastore admin, the owner of the external metadata object, or a user that has the **MANAGE** privilege.

getExternalMetadata

ExternalMetadata getExternalMetadata(GetExternalMetadataRequest getExternalMetadataRequest)

Gets the specified external metadata object in a metastore. The caller must be a metastore admin, the owner of the external metadata object, or a user that has the **BROWSE** privilege.

listExternalMetadata

ListExternalMetadataResponse listExternalMetadata(ListExternalMetadataRequest listExternalMetadataRequest)

Gets an array of external metadata objects in the metastore. If the caller is the metastore admin, all external metadata objects will be retrieved. Otherwise, only external metadata objects that the caller has **BROWSE** on will be retrieved. There is no guarantee of a specific ordering of the elements in the array.

updateExternalMetadata

ExternalMetadata updateExternalMetadata(UpdateExternalMetadataRequest updateExternalMetadataRequest)

Updates the external metadata object that matches the supplied name. The caller can only update either the owner or other metadata fields in one request. The caller must be a metastore admin, the owner of the external metadata object, or a user that has the **MODIFY** privilege. If the caller is updating the owner, they must also have the **MANAGE** privilege.