Interface ModelRegistryService


  • @Generated
    public interface ModelRegistryService
    This is the high-level interface, that contains generated methods.

    Evolving: this interface is under development. Method signatures may change.

    • Method Detail

      • 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.

      • 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 ransition 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.

      • 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

      • listModels

        ListModelsResponse listModels​(ListModelsRequest listModelsRequest)
        List models.

        Lists all available registered models, up to the limit specified in __max_results__.

      • 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.

      • 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

      • updateModel

        void updateModel​(UpdateModelRequest updateModelRequest)
        Update model.

        Updates a registered model.

      • updateModelVersion

        void updateModelVersion​(UpdateModelVersionRequest updateModelVersionRequest)
        Update model version.

        Updates the model version.

      • updateWebhook

        void updateWebhook​(UpdateRegistryWebhook updateRegistryWebhook)
        Update a webhook.

        **NOTE:** This endpoint is in Public Preview.

        Updates a registry webhook.