Package io.unitycatalog.client.api

Class CatalogsApi

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

  • Constructor Details

    • CatalogsApi

      public CatalogsApi()

    • CatalogsApi

      public CatalogsApi(ApiClient apiClient)

  • Method Details

    • getApiException

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

    • createCatalog

      public CatalogInfo createCatalog(CreateCatalog createCatalog) throws ApiException
      Create a catalog Creates a new catalog instance.
      Parameters:
      createCatalog - (optional)
      Returns:
      CatalogInfo
      Throws:
      ApiException - if fails to make API call

    • createCatalogWithHttpInfo

      public ApiResponse<CatalogInfo> createCatalogWithHttpInfo(CreateCatalog createCatalog) throws ApiException
      Create a catalog Creates a new catalog instance.
      Parameters:
      createCatalog - (optional)
      Returns:
      ApiResponse<CatalogInfo>
      Throws:
      ApiException - if fails to make API call

    • deleteCatalog

      public Object deleteCatalog(String name, Boolean force) throws ApiException
      Delete a catalog Deletes the catalog that matches the supplied name.
      Parameters:
      name - The name of the catalog. (required)
      force - Force deletion even if the catalog is not empty. (optional)
      Returns:
      Object
      Throws:
      ApiException - if fails to make API call

    • deleteCatalogWithHttpInfo

      public ApiResponse<Object> deleteCatalogWithHttpInfo(String name, Boolean force) throws ApiException
      Delete a catalog Deletes the catalog that matches the supplied name.
      Parameters:
      name - The name of the catalog. (required)
      force - Force deletion even if the catalog is not empty. (optional)
      Returns:
      ApiResponse<Object>
      Throws:
      ApiException - if fails to make API call

    • getCatalog

      public CatalogInfo getCatalog(String name) throws ApiException
      Get a catalog Gets the specified catalog.
      Parameters:
      name - The name of the catalog. (required)
      Returns:
      CatalogInfo
      Throws:
      ApiException - if fails to make API call

    • getCatalogWithHttpInfo

      public ApiResponse<CatalogInfo> getCatalogWithHttpInfo(String name) throws ApiException
      Get a catalog Gets the specified catalog.
      Parameters:
      name - The name of the catalog. (required)
      Returns:
      ApiResponse<CatalogInfo>
      Throws:
      ApiException - if fails to make API call

    • listCatalogs

      public ListCatalogsResponse listCatalogs(String pageToken, Integer maxResults) throws ApiException
      List catalogs Lists the available catalogs. There is no guarantee of a specific ordering of the elements in the list.
      Parameters:
      pageToken - Opaque pagination token to go to next page based on previous query. (optional)
      maxResults - Maximum number of catalogs 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)
      Returns:
      ListCatalogsResponse
      Throws:
      ApiException - if fails to make API call

    • listCatalogsWithHttpInfo

      public ApiResponse<ListCatalogsResponse> listCatalogsWithHttpInfo(String pageToken, Integer maxResults) throws ApiException
      List catalogs Lists the available catalogs. There is no guarantee of a specific ordering of the elements in the list.
      Parameters:
      pageToken - Opaque pagination token to go to next page based on previous query. (optional)
      maxResults - Maximum number of catalogs 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)
      Returns:
      ApiResponse<ListCatalogsResponse>
      Throws:
      ApiException - if fails to make API call

    • updateCatalog

      public CatalogInfo updateCatalog(String name, UpdateCatalog updateCatalog) throws ApiException
      Update a catalog Updates the catalog that matches the supplied name.
      Parameters:
      name - The name of the catalog. (required)
      updateCatalog - (optional)
      Returns:
      CatalogInfo
      Throws:
      ApiException - if fails to make API call

    • updateCatalogWithHttpInfo

      public ApiResponse<CatalogInfo> updateCatalogWithHttpInfo(String name, UpdateCatalog updateCatalog) throws ApiException
      Update a catalog Updates the catalog that matches the supplied name.
      Parameters:
      name - The name of the catalog. (required)
      updateCatalog - (optional)
      Returns:
      ApiResponse<CatalogInfo>
      Throws:
      ApiException - if fails to make API call