com.databricks.sdk.service.catalog

Class RegisteredModelsAPI

java.lang.Object

com.databricks.sdk.service.catalog.RegisteredModelsAPI

@Generated
public class RegisteredModelsAPI
extends Object

Databricks provides a hosted version of MLflow Model Registry in Unity Catalog. Models in Unity Catalog provide centralized access control, auditing, lineage, and discovery of ML models across Databricks workspaces.

An MLflow registered model resides in the third layer of Unity Catalog’s three-level namespace. Registered models contain model versions, which correspond to actual ML models (MLflow models). Creating new model versions currently requires use of the MLflow Python client. Once model versions are created, you can load them for batch inference using MLflow Python client APIs, or deploy them for real-time serving using Databricks Model Serving.

All operations on registered models and model versions require USE_CATALOG permissions on the enclosing catalog and USE_SCHEMA permissions on the enclosing schema. In addition, the following additional privileges are required for various operations:

* To create a registered model, users must additionally have the CREATE_MODEL permission on the target schema. * To view registered model or model version metadata, model version data files, or invoke a model version, users must additionally have the EXECUTE permission on the registered model * To update registered model or model version tags, users must additionally have APPLY TAG permissions on the registered model * To update other registered model or model version metadata (comments, aliases) create a new model version, or update permissions on the registered model, users must be owners of the registered model.

Note: The securable type for models is "FUNCTION". When using REST APIs (e.g. tagging, grants) that specify a securable type, use "FUNCTION" as the securable type.

Constructor Summary

Constructors

Constructor and Description
RegisteredModelsAPI(ApiClient apiClient) Regular-use constructor
RegisteredModelsAPI(RegisteredModelsService mock) Constructor for mocks

Method Summary

Modifier and Type	Method and Description
RegisteredModelInfo	create(CreateRegisteredModelRequest request) Create a Registered Model.
RegisteredModelInfo	create(String catalogName, String schemaName, String name)
void	delete(DeleteRegisteredModelRequest request) Delete a Registered Model.
void	delete(String fullName)
void	deleteAlias(DeleteAliasRequest request) Delete a Registered Model Alias.
void	deleteAlias(String fullName, String alias)
RegisteredModelInfo	get(GetRegisteredModelRequest request) Get a Registered Model.
RegisteredModelInfo	get(String fullName)
RegisteredModelsService	impl()
Iterable<RegisteredModelInfo>	list(ListRegisteredModelsRequest request) List Registered Models.
RegisteredModelAlias	setAlias(SetRegisteredModelAliasRequest request) Set a Registered Model Alias.
RegisteredModelAlias	setAlias(String fullName, String alias, long versionNum)
RegisteredModelInfo	update(String fullName)
RegisteredModelInfo	update(UpdateRegisteredModelRequest request) Update a Registered Model.

Methods inherited from class java.lang.Object

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

Constructor Detail

RegisteredModelsAPI

public RegisteredModelsAPI(ApiClient apiClient)

Regular-use constructor

RegisteredModelsAPI

public RegisteredModelsAPI(RegisteredModelsService mock)

Constructor for mocks

Method Detail

create

public RegisteredModelInfo create(String catalogName,
                                  String schemaName,
                                  String name)

create

public RegisteredModelInfo create(CreateRegisteredModelRequest request)

Create a Registered Model.

Creates a new registered model in Unity Catalog.

File storage for model versions in the registered model will be located in the default location which is specified by the parent schema, or the parent catalog, or the Metastore.

For registered model creation to succeed, the user must satisfy the following conditions: - The caller must be a metastore admin, or be the owner of the parent catalog and schema, or have the **USE_CATALOG** privilege on the parent catalog and the **USE_SCHEMA** privilege on the parent schema. - The caller must have the **CREATE MODEL** or **CREATE FUNCTION** privilege on the parent schema.

delete

public void delete(String fullName)

delete

public void delete(DeleteRegisteredModelRequest request)

Delete a Registered Model.

Deletes a registered model and all its model versions from the specified parent catalog and schema.

The caller must be a metastore admin or an owner of the registered model. For the latter case, the caller must also be the owner or have the **USE_CATALOG** privilege on the parent catalog and the **USE_SCHEMA** privilege on the parent schema.

deleteAlias

public void deleteAlias(String fullName,
                        String alias)

deleteAlias

public void deleteAlias(DeleteAliasRequest request)

Delete a Registered Model Alias.

Deletes a registered model alias.

The caller must be a metastore admin or an owner of the registered model. For the latter case, the caller must also be the owner or have the **USE_CATALOG** privilege on the parent catalog and the **USE_SCHEMA** privilege on the parent schema.

get

public RegisteredModelInfo get(String fullName)

get

public RegisteredModelInfo get(GetRegisteredModelRequest request)

Get a Registered Model.

Get a registered model.

The caller must be a metastore admin or an owner of (or have the **EXECUTE** privilege on) the registered model. For the latter case, the caller must also be the owner or have the **USE_CATALOG** privilege on the parent catalog and the **USE_SCHEMA** privilege on the parent schema.

list

public Iterable<RegisteredModelInfo> list(ListRegisteredModelsRequest request)

List Registered Models.

List registered models. You can list registered models under a particular schema, or list all registered models in the current metastore.

The returned models are filtered based on the privileges of the calling user. For example, the metastore admin is able to list all the registered models. A regular user needs to be the owner or have the **EXECUTE** privilege on the registered model to recieve the registered models in the response. For the latter case, the caller must also be the owner or have the **USE_CATALOG** privilege on the parent catalog and the **USE_SCHEMA** privilege on the parent schema.

There is no guarantee of a specific ordering of the elements in the response.

setAlias

public RegisteredModelAlias setAlias(String fullName,
                                     String alias,
                                     long versionNum)

setAlias

public RegisteredModelAlias setAlias(SetRegisteredModelAliasRequest request)

Set a Registered Model Alias.

Set an alias on the specified registered model.

The caller must be a metastore admin or an owner of the registered model. For the latter case, the caller must also be the owner or have the **USE_CATALOG** privilege on the parent catalog and the **USE_SCHEMA** privilege on the parent schema.

update

public RegisteredModelInfo update(String fullName)

update

public RegisteredModelInfo update(UpdateRegisteredModelRequest request)

Update a Registered Model.

Updates the specified registered model.

The caller must be a metastore admin or an owner of the registered model. For the latter case, the caller must also be the owner or have the **USE_CATALOG** privilege on the parent catalog and the **USE_SCHEMA** privilege on the parent schema.

Currently only the name, the owner or the comment of the registered model can be updated.

impl

public RegisteredModelsService impl()