com.databricks.sdk.service.catalog

Class ModelVersionsAPI

java.lang.Object

com.databricks.sdk.service.catalog.ModelVersionsAPI

@Generated
public class ModelVersionsAPI
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.

This API reference documents the REST endpoints for managing model versions in Unity Catalog. For more details, see the [registered models API docs](/api/workspace/registeredmodels).

Constructor Summary

Constructors

Constructor and Description
ModelVersionsAPI(ApiClient apiClient) Regular-use constructor
ModelVersionsAPI(ModelVersionsService mock) Constructor for mocks

Method Summary

Modifier and Type	Method and Description
void	delete(DeleteModelVersionRequest request) Deletes a model version from the specified registered model.
void	delete(String fullName, long version)
ModelVersionInfo	get(GetModelVersionRequest request) Get a model version.
ModelVersionInfo	get(String fullName, long version)
ModelVersionInfo	getByAlias(GetByAliasRequest request) Get a model version by alias.
ModelVersionInfo	getByAlias(String fullName, String alias)
ModelVersionsService	impl()
Iterable<ModelVersionInfo>	list(ListModelVersionsRequest request) List model versions.
Iterable<ModelVersionInfo>	list(String fullName)
ModelVersionInfo	update(UpdateModelVersionRequest request) Updates the specified model version.

Methods inherited from class java.lang.Object

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

Constructor Detail

ModelVersionsAPI

public ModelVersionsAPI(ApiClient apiClient)

Regular-use constructor

ModelVersionsAPI

public ModelVersionsAPI(ModelVersionsService mock)

Constructor for mocks

Method Detail

delete

public void delete(String fullName,
                   long version)

delete

public void delete(DeleteModelVersionRequest request)

Deletes a model version from the specified registered model. Any aliases assigned to the model version will also be deleted.

The caller must be a metastore admin or an owner of the parent 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 ModelVersionInfo get(String fullName,
                            long version)

get

public ModelVersionInfo get(GetModelVersionRequest request)

Get a model version.

The caller must be a metastore admin or an owner of (or have the **EXECUTE** privilege on) the parent 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.

getByAlias

public ModelVersionInfo getByAlias(String fullName,
                                   String alias)

getByAlias

public ModelVersionInfo getByAlias(GetByAliasRequest request)

Get a model version by alias.

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<ModelVersionInfo> list(String fullName)

list

public Iterable<ModelVersionInfo> list(ListModelVersionsRequest request)

List model versions. You can list model versions under a particular schema, or list all model versions 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 model versions. A regular user needs to be the owner or have the **EXECUTE** privilege on the parent registered model to recieve the model versions 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. The elements in the response will not contain any aliases or tags.

PAGINATION BEHAVIOR: The API is by default paginated, 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 ModelVersionInfo update(UpdateModelVersionRequest request)

Updates the specified model version.

The caller must be a metastore admin or an owner of the parent 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 comment of the model version can be updated.

impl

public ModelVersionsService impl()