ModelRegistryService (databricks-sdk-java 0.24.0 API)

```
@Generated
public interface ModelRegistryService
```
Note: This API reference documents APIs for the Workspace Model Registry. Databricks recommends using [Models in Unity Catalog](/api/workspace/registeredmodels) instead. Models in Unity Catalog provides centralized model governance, cross-workspace access, lineage, and deployment. Workspace Model Registry will be deprecated in the future.
The Workspace Model Registry is a centralized model repository and a UI and set of APIs that enable you to manage the full lifecycle of MLflow Models.
This is the high-level interface, that contains generated methods.
Evolving: this interface is under development. Method signatures may change.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`ApproveTransitionRequestResponse`	`approveTransitionRequest(ApproveTransitionRequest approveTransitionRequest)` Approve transition request.
`CreateCommentResponse`	`createComment(CreateComment createComment)` Post a comment.
`CreateModelResponse`	`createModel(CreateModelRequest createModelRequest)` Create a model.
`CreateModelVersionResponse`	`createModelVersion(CreateModelVersionRequest createModelVersionRequest)` Create a model version.
`CreateTransitionRequestResponse`	`createTransitionRequest(CreateTransitionRequest createTransitionRequest)` Make a transition request.
`CreateWebhookResponse`	`createWebhook(CreateRegistryWebhook createRegistryWebhook)` Create a webhook.
`void`	`deleteComment(DeleteCommentRequest deleteCommentRequest)` Delete a comment.
`void`	`deleteModel(DeleteModelRequest deleteModelRequest)` Delete a model.
`void`	`deleteModelTag(DeleteModelTagRequest deleteModelTagRequest)` Delete a model tag.
`void`	`deleteModelVersion(DeleteModelVersionRequest deleteModelVersionRequest)` Delete a model version.
`void`	`deleteModelVersionTag(DeleteModelVersionTagRequest deleteModelVersionTagRequest)` Delete a model version tag.
`void`	`deleteTransitionRequest(DeleteTransitionRequestRequest deleteTransitionRequestRequest)` Delete a transition request.
`void`	`deleteWebhook(DeleteWebhookRequest deleteWebhookRequest)` Delete a webhook.
`GetLatestVersionsResponse`	`getLatestVersions(GetLatestVersionsRequest getLatestVersionsRequest)` Get the latest version.
`GetModelResponse`	`getModel(GetModelRequest getModelRequest)` Get model.
`GetModelVersionResponse`	`getModelVersion(GetModelVersionRequest getModelVersionRequest)` Get a model version.
`GetModelVersionDownloadUriResponse`	`getModelVersionDownloadUri(GetModelVersionDownloadUriRequest getModelVersionDownloadUriRequest)` Get a model version URI.
`GetRegisteredModelPermissionLevelsResponse`	`getPermissionLevels(GetRegisteredModelPermissionLevelsRequest getRegisteredModelPermissionLevelsRequest)` Get registered model permission levels.
`RegisteredModelPermissions`	`getPermissions(GetRegisteredModelPermissionsRequest getRegisteredModelPermissionsRequest)` Get registered model permissions.
`ListModelsResponse`	`listModels(ListModelsRequest listModelsRequest)` List models.
`ListTransitionRequestsResponse`	`listTransitionRequests(ListTransitionRequestsRequest listTransitionRequestsRequest)` List transition requests.
`ListRegistryWebhooks`	`listWebhooks(ListWebhooksRequest listWebhooksRequest)` List registry webhooks.
`RejectTransitionRequestResponse`	`rejectTransitionRequest(RejectTransitionRequest rejectTransitionRequest)` Reject a transition request.
`RenameModelResponse`	`renameModel(RenameModelRequest renameModelRequest)` Rename a model.
`SearchModelsResponse`	`searchModels(SearchModelsRequest searchModelsRequest)` Search models.
`SearchModelVersionsResponse`	`searchModelVersions(SearchModelVersionsRequest searchModelVersionsRequest)` Searches model versions.
`void`	`setModelTag(SetModelTagRequest setModelTagRequest)` Set a tag.
`void`	`setModelVersionTag(SetModelVersionTagRequest setModelVersionTagRequest)` Set a version tag.
`RegisteredModelPermissions`	`setPermissions(RegisteredModelPermissionsRequest registeredModelPermissionsRequest)` Set registered model permissions.
`TestRegistryWebhookResponse`	`testRegistryWebhook(TestRegistryWebhookRequest testRegistryWebhookRequest)` Test a webhook.
`TransitionStageResponse`	`transitionStage(TransitionModelVersionStageDatabricks transitionModelVersionStageDatabricks)` Transition a stage.
`UpdateCommentResponse`	`updateComment(UpdateComment updateComment)` Update a comment.
`void`	`updateModel(UpdateModelRequest updateModelRequest)` Update model.
`void`	`updateModelVersion(UpdateModelVersionRequest updateModelVersionRequest)` Update model version.
`RegisteredModelPermissions`	`updatePermissions(RegisteredModelPermissionsRequest registeredModelPermissionsRequest)` Update registered model permissions.
`void`	`updateWebhook(UpdateRegistryWebhook updateRegistryWebhook)` Update a webhook.

- Method Detail
  - approveTransitionRequest
```
ApproveTransitionRequestResponse approveTransitionRequest(ApproveTransitionRequest approveTransitionRequest)
```
    Approve transition request.
    Approves a model version stage transition request.
  - createComment
```
CreateCommentResponse createComment(CreateComment createComment)
```
    Post a comment.
    Posts a comment on a model version. A comment can be submitted either by a user or programmatically to display relevant information about the model. For example, test results or deployment errors.
  - createModel
```
CreateModelResponse createModel(CreateModelRequest createModelRequest)
```
    Create a model.
    Creates a new registered model with the name specified in the request body.
    Throws `RESOURCE_ALREADY_EXISTS` if a registered model with the given name exists.
  - createModelVersion
```
CreateModelVersionResponse createModelVersion(CreateModelVersionRequest createModelVersionRequest)
```
    Create a model version.
    Creates a model version.
  - createTransitionRequest
```
CreateTransitionRequestResponse createTransitionRequest(CreateTransitionRequest createTransitionRequest)
```
    Make a transition request.
    Creates a model version stage transition request.
  - createWebhook
```
CreateWebhookResponse createWebhook(CreateRegistryWebhook createRegistryWebhook)
```
    Create a webhook.
    **NOTE**: This endpoint is in Public Preview.
    Creates a registry webhook.
  - deleteComment
```
void deleteComment(DeleteCommentRequest deleteCommentRequest)
```
    Delete a comment.
    Deletes a comment on a model version.
  - deleteModel
```
void deleteModel(DeleteModelRequest deleteModelRequest)
```
    Delete a model.
    Deletes a registered model.
  - deleteModelTag
```
void deleteModelTag(DeleteModelTagRequest deleteModelTagRequest)
```
    Delete a model tag.
    Deletes the tag for a registered model.
  - deleteModelVersion
```
void deleteModelVersion(DeleteModelVersionRequest deleteModelVersionRequest)
```
    Delete a model version.
    Deletes a model version.
  - deleteModelVersionTag
```
void deleteModelVersionTag(DeleteModelVersionTagRequest deleteModelVersionTagRequest)
```
    Delete a model version tag.
    Deletes a model version tag.
  - deleteTransitionRequest
```
void deleteTransitionRequest(DeleteTransitionRequestRequest deleteTransitionRequestRequest)
```
    Delete a transition request.
    Cancels a model version stage transition request.
  - deleteWebhook
```
void deleteWebhook(DeleteWebhookRequest deleteWebhookRequest)
```
    Delete a webhook.
    **NOTE:** This endpoint is in Public Preview.
    Deletes a registry webhook.
  - getLatestVersions
```
GetLatestVersionsResponse getLatestVersions(GetLatestVersionsRequest getLatestVersionsRequest)
```
    Get the latest version.
    Gets the latest version of a registered model.
  - getModel
```
GetModelResponse getModel(GetModelRequest getModelRequest)
```
    Get model.
    Get the details of a model. This is a Databricks workspace version of the [MLflow endpoint] that also returns the model's Databricks workspace ID and the permission level of the requesting user on the model.
    [MLflow endpoint]: https://www.mlflow.org/docs/latest/rest-api.html#get-registeredmodel
  - getModelVersion
```
GetModelVersionResponse getModelVersion(GetModelVersionRequest getModelVersionRequest)
```
    Get a model version.
    Get a model version.
  - getModelVersionDownloadUri
```
GetModelVersionDownloadUriResponse getModelVersionDownloadUri(GetModelVersionDownloadUriRequest getModelVersionDownloadUriRequest)
```
    Get a model version URI.
    Gets a URI to download the model version.
  - getPermissionLevels
```
GetRegisteredModelPermissionLevelsResponse getPermissionLevels(GetRegisteredModelPermissionLevelsRequest getRegisteredModelPermissionLevelsRequest)
```
    Get registered model permission levels.
    Gets the permission levels that a user can have on an object.
  - getPermissions
```
RegisteredModelPermissions getPermissions(GetRegisteredModelPermissionsRequest getRegisteredModelPermissionsRequest)
```
    Get registered model permissions.
    Gets the permissions of a registered model. Registered models can inherit permissions from their root object.
  - listModels
```
ListModelsResponse listModels(ListModelsRequest listModelsRequest)
```
    List models.
    Lists all available registered models, up to the limit specified in __max_results__.
  - listTransitionRequests
```
ListTransitionRequestsResponse listTransitionRequests(ListTransitionRequestsRequest listTransitionRequestsRequest)
```
    List transition requests.
    Gets a list of all open stage transition requests for the model version.
  - listWebhooks
```
ListRegistryWebhooks listWebhooks(ListWebhooksRequest listWebhooksRequest)
```
    List registry webhooks.
    **NOTE:** This endpoint is in Public Preview.
    Lists all registry webhooks.
  - rejectTransitionRequest
```
RejectTransitionRequestResponse rejectTransitionRequest(RejectTransitionRequest rejectTransitionRequest)
```
    Reject a transition request.
    Rejects a model version stage transition request.
  - renameModel
```
RenameModelResponse renameModel(RenameModelRequest renameModelRequest)
```
    Rename a model.
    Renames a registered model.
  - searchModelVersions
```
SearchModelVersionsResponse searchModelVersions(SearchModelVersionsRequest searchModelVersionsRequest)
```
    Searches model versions.
    Searches for specific model versions based on the supplied __filter__.
  - searchModels
```
SearchModelsResponse searchModels(SearchModelsRequest searchModelsRequest)
```
    Search models.
    Search for registered models based on the specified __filter__.
  - setModelTag
```
void setModelTag(SetModelTagRequest setModelTagRequest)
```
    Set a tag.
    Sets a tag on a registered model.
  - setModelVersionTag
```
void setModelVersionTag(SetModelVersionTagRequest setModelVersionTagRequest)
```
    Set a version tag.
    Sets a model version tag.
  - setPermissions
```
RegisteredModelPermissions setPermissions(RegisteredModelPermissionsRequest registeredModelPermissionsRequest)
```
    Set registered model permissions.
    Sets permissions on a registered model. Registered models can inherit permissions from their root object.
  - testRegistryWebhook
```
TestRegistryWebhookResponse testRegistryWebhook(TestRegistryWebhookRequest testRegistryWebhookRequest)
```
    Test a webhook.
    **NOTE:** This endpoint is in Public Preview.
    Tests a registry webhook.
  - transitionStage
```
TransitionStageResponse transitionStage(TransitionModelVersionStageDatabricks transitionModelVersionStageDatabricks)
```
    Transition a stage.
    Transition a model version's stage. This is a Databricks workspace version of the [MLflow endpoint] that also accepts a comment associated with the transition to be recorded.",
    [MLflow endpoint]: https://www.mlflow.org/docs/latest/rest-api.html#transition-modelversion-stage
  - updateComment
```
UpdateCommentResponse updateComment(UpdateComment updateComment)
```
    Update a comment.
    Post an edit to a comment on a model version.
  - updateModel
```
void updateModel(UpdateModelRequest updateModelRequest)
```
    Update model.
    Updates a registered model.
  - updateModelVersion
```
void updateModelVersion(UpdateModelVersionRequest updateModelVersionRequest)
```
    Update model version.
    Updates the model version.
  - updatePermissions
```
RegisteredModelPermissions updatePermissions(RegisteredModelPermissionsRequest registeredModelPermissionsRequest)
```
    Update registered model permissions.
    Updates the permissions on a registered model. Registered models can inherit permissions from their root object.
  - updateWebhook
```
void updateWebhook(UpdateRegistryWebhook updateRegistryWebhook)
```
    Update a webhook.
    **NOTE:** This endpoint is in Public Preview.
    Updates a registry webhook.

Interface ModelRegistryService

Method Summary

Method Detail

approveTransitionRequest

createComment

createModel

createModelVersion

createTransitionRequest

createWebhook

deleteComment

deleteModel

deleteModelTag

deleteModelVersion

deleteModelVersionTag

deleteTransitionRequest

deleteWebhook

getLatestVersions

getModel

getModelVersion

getModelVersionDownloadUri

getPermissionLevels

getPermissions

listModels

listTransitionRequests

listWebhooks

rejectTransitionRequest

renameModel

searchModelVersions

searchModels

setModelTag

setModelVersionTag

setPermissions

testRegistryWebhook

transitionStage

updateComment

updateModel

updateModelVersion

updatePermissions

updateWebhook