Package io.unitycatalog.client.api

Class RegisteredModelsApi

java.lang.Object
io.unitycatalog.client.api.RegisteredModelsApi
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.5.0") public class RegisteredModelsApi extends Object

  • Constructor Details

    • RegisteredModelsApi

      public RegisteredModelsApi()

    • RegisteredModelsApi

      public RegisteredModelsApi(ApiClient apiClient)

  • Method Details

    • getApiException

      protected ApiException getApiException(String operationId, HttpResponse<InputStream> response) throws IOException
      Throws:
      IOException

    • createRegisteredModel

      public RegisteredModelInfo createRegisteredModel(CreateRegisteredModel createRegisteredModel) throws ApiException
      Create a model. WARNING: This API is experimental and will change in future versions. Creates a new model instance. WARNING: This API is experimental and will change in future versions.
      Parameters:
      createRegisteredModel - (optional)
      Returns:
      RegisteredModelInfo
      Throws:
      ApiException - if fails to make API call

    • createRegisteredModelWithHttpInfo

      public ApiResponse<RegisteredModelInfo> createRegisteredModelWithHttpInfo(CreateRegisteredModel createRegisteredModel) throws ApiException
      Create a model. WARNING: This API is experimental and will change in future versions. Creates a new model instance. WARNING: This API is experimental and will change in future versions.
      Parameters:
      createRegisteredModel - (optional)
      Returns:
      ApiResponse<RegisteredModelInfo>
      Throws:
      ApiException - if fails to make API call

    • deleteRegisteredModel

      public Object deleteRegisteredModel(String fullName, Boolean force) throws ApiException
      Delete a specified registered model. Deletes a fully specified registered model. All versions of the model must have already been deleted.
      Parameters:
      fullName - Full name of the model. (required)
      force - Force deletion even if the registered model still has model versions. (optional)
      Returns:
      Object
      Throws:
      ApiException - if fails to make API call

    • deleteRegisteredModelWithHttpInfo

      public ApiResponse<Object> deleteRegisteredModelWithHttpInfo(String fullName, Boolean force) throws ApiException
      Delete a specified registered model. Deletes a fully specified registered model. All versions of the model must have already been deleted.
      Parameters:
      fullName - Full name of the model. (required)
      force - Force deletion even if the registered model still has model versions. (optional)
      Returns:
      ApiResponse<Object>
      Throws:
      ApiException - if fails to make API call

    • getRegisteredModel

      public RegisteredModelInfo getRegisteredModel(String fullName) throws ApiException
      Get a specified registered model Gets a fully specified registered model.
      Parameters:
      fullName - Full name of the model. (required)
      Returns:
      RegisteredModelInfo
      Throws:
      ApiException - if fails to make API call

    • getRegisteredModelWithHttpInfo

      public ApiResponse<RegisteredModelInfo> getRegisteredModelWithHttpInfo(String fullName) throws ApiException
      Get a specified registered model Gets a fully specified registered model.
      Parameters:
      fullName - Full name of the model. (required)
      Returns:
      ApiResponse<RegisteredModelInfo>
      Throws:
      ApiException - if fails to make API call

    • listRegisteredModels

      public ListRegisteredModelsResponse listRegisteredModels(String catalogName, String schemaName, Integer maxResults, String pageToken) throws ApiException
      List models Gets a paginated list of all available models either under the specified parent catalog and schema, or all models stored in UC. There is no guarantee of a specific ordering of the elements in the array.
      Parameters:
      catalogName - Name of parent catalog for models of interest. (optional)
      schemaName - Name of parent schema for models of interest. (optional)
      maxResults - Maximum number of models to return. - when set to a value greater than 0, the page length is the minimum of this value and a server configured value; - when set to 0, the page length is set to a server configured value; - when set to a value less than 0, an invalid parameter error is returned; (optional)
      pageToken - Opaque token to send for the next page of results (pagination). (optional)
      Returns:
      ListRegisteredModelsResponse
      Throws:
      ApiException - if fails to make API call

    • listRegisteredModelsWithHttpInfo

      public ApiResponse<ListRegisteredModelsResponse> listRegisteredModelsWithHttpInfo(String catalogName, String schemaName, Integer maxResults, String pageToken) throws ApiException
      List models Gets a paginated list of all available models either under the specified parent catalog and schema, or all models stored in UC. There is no guarantee of a specific ordering of the elements in the array.
      Parameters:
      catalogName - Name of parent catalog for models of interest. (optional)
      schemaName - Name of parent schema for models of interest. (optional)
      maxResults - Maximum number of models to return. - when set to a value greater than 0, the page length is the minimum of this value and a server configured value; - when set to 0, the page length is set to a server configured value; - when set to a value less than 0, an invalid parameter error is returned; (optional)
      pageToken - Opaque token to send for the next page of results (pagination). (optional)
      Returns:
      ApiResponse<ListRegisteredModelsResponse>
      Throws:
      ApiException - if fails to make API call

    • updateRegisteredModel

      public RegisteredModelInfo updateRegisteredModel(String fullName, UpdateRegisteredModel updateRegisteredModel) throws ApiException
      Update a registered model Updates the specified registered model.
      Parameters:
      fullName - Full name of the model. (required)
      updateRegisteredModel - (optional)
      Returns:
      RegisteredModelInfo
      Throws:
      ApiException - if fails to make API call

    • updateRegisteredModelWithHttpInfo

      public ApiResponse<RegisteredModelInfo> updateRegisteredModelWithHttpInfo(String fullName, UpdateRegisteredModel updateRegisteredModel) throws ApiException
      Update a registered model Updates the specified registered model.
      Parameters:
      fullName - Full name of the model. (required)
      updateRegisteredModel - (optional)
      Returns:
      ApiResponse<RegisteredModelInfo>
      Throws:
      ApiException - if fails to make API call