com.databricks.sdk.service.catalog

Class ExternalMetadataAPI

java.lang.Object

com.databricks.sdk.service.catalog.ExternalMetadataAPI

@Generated
public class ExternalMetadataAPI
extends Object

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.

Constructor Summary

Constructors

Constructor and Description
ExternalMetadataAPI(ApiClient apiClient) Regular-use constructor
ExternalMetadataAPI(ExternalMetadataService mock) Constructor for mocks

Method Summary

Modifier and Type	Method and Description
ExternalMetadata	createExternalMetadata(CreateExternalMetadataRequest request) 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 request) Deletes the external metadata object that matches the supplied name.
void	deleteExternalMetadata(String name)
ExternalMetadata	getExternalMetadata(GetExternalMetadataRequest request) Gets the specified external metadata object in a metastore.
ExternalMetadata	getExternalMetadata(String name)
ExternalMetadataService	impl()
Iterable<ExternalMetadata>	listExternalMetadata(ListExternalMetadataRequest request) Gets an array of external metadata objects in the metastore.
ExternalMetadata	updateExternalMetadata(UpdateExternalMetadataRequest request) Updates the external metadata object that matches the supplied name.

Methods inherited from class java.lang.Object

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

Constructor Detail

ExternalMetadataAPI

public ExternalMetadataAPI(ApiClient apiClient)

Regular-use constructor

ExternalMetadataAPI

public ExternalMetadataAPI(ExternalMetadataService mock)

Constructor for mocks

Method Detail

createExternalMetadata

public ExternalMetadata createExternalMetadata(CreateExternalMetadataRequest request)

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

public void deleteExternalMetadata(String name)

deleteExternalMetadata

public void deleteExternalMetadata(DeleteExternalMetadataRequest request)

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

public ExternalMetadata getExternalMetadata(String name)

getExternalMetadata

public ExternalMetadata getExternalMetadata(GetExternalMetadataRequest request)

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

public Iterable<ExternalMetadata> listExternalMetadata(ListExternalMetadataRequest request)

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

public ExternalMetadata updateExternalMetadata(UpdateExternalMetadataRequest request)

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.

impl

public ExternalMetadataService impl()