Package io.unitycatalog.client.api

Class VolumesApi

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

  • Constructor Details

    • VolumesApi

      public VolumesApi()

    • VolumesApi

      public VolumesApi(ApiClient apiClient)

  • Method Details

    • getApiException

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

    • createVolume

      public VolumeInfo createVolume(CreateVolumeRequestContent createVolumeRequestContent) throws ApiException
      Create a Volume Creates a new volume.
      Parameters:
      createVolumeRequestContent - (required)
      Returns:
      VolumeInfo
      Throws:
      ApiException - if fails to make API call

    • createVolumeWithHttpInfo

      public ApiResponse<VolumeInfo> createVolumeWithHttpInfo(CreateVolumeRequestContent createVolumeRequestContent) throws ApiException
      Create a Volume Creates a new volume.
      Parameters:
      createVolumeRequestContent - (required)
      Returns:
      ApiResponse<VolumeInfo>
      Throws:
      ApiException - if fails to make API call

    • deleteVolume

      public Object deleteVolume(String name) throws ApiException
      Delete a Volume Deletes a volume from the specified parent catalog and schema.
      Parameters:
      name - The three-level (fully qualified) name of the volume (required)
      Returns:
      Object
      Throws:
      ApiException - if fails to make API call

    • deleteVolumeWithHttpInfo

      public ApiResponse<Object> deleteVolumeWithHttpInfo(String name) throws ApiException
      Delete a Volume Deletes a volume from the specified parent catalog and schema.
      Parameters:
      name - The three-level (fully qualified) name of the volume (required)
      Returns:
      ApiResponse<Object>
      Throws:
      ApiException - if fails to make API call

    • getVolume

      public VolumeInfo getVolume(String name) throws ApiException
      Get a Volume Gets a volume for a specific catalog and schema.
      Parameters:
      name - The three-level (fully qualified) name of the volume (required)
      Returns:
      VolumeInfo
      Throws:
      ApiException - if fails to make API call

    • getVolumeWithHttpInfo

      public ApiResponse<VolumeInfo> getVolumeWithHttpInfo(String name) throws ApiException
      Get a Volume Gets a volume for a specific catalog and schema.
      Parameters:
      name - The three-level (fully qualified) name of the volume (required)
      Returns:
      ApiResponse<VolumeInfo>
      Throws:
      ApiException - if fails to make API call

    • listVolumes

      public ListVolumesResponseContent listVolumes(String catalogName, String schemaName, Integer maxResults, String pageToken) throws ApiException
      List Volumes Gets an array of available volumes under the parent catalog and schema. There is no guarantee of a specific ordering of the elements in the array.
      Parameters:
      catalogName - The identifier of the catalog (required)
      schemaName - The identifier of the schema (required)
      maxResults - Maximum number of volumes to return (page length). If not set, the page length is set to a server configured value. - 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; Note: this parameter controls only the maximum number of volumes to return. The actual number of volumes returned in a page may be smaller than this value, including 0, even if there are more pages. (optional)
      pageToken - Opaque token returned by a previous request. It must be included in the request to retrieve the next page of results (pagination). (optional)
      Returns:
      ListVolumesResponseContent
      Throws:
      ApiException - if fails to make API call

    • listVolumesWithHttpInfo

      public ApiResponse<ListVolumesResponseContent> listVolumesWithHttpInfo(String catalogName, String schemaName, Integer maxResults, String pageToken) throws ApiException
      List Volumes Gets an array of available volumes under the parent catalog and schema. There is no guarantee of a specific ordering of the elements in the array.
      Parameters:
      catalogName - The identifier of the catalog (required)
      schemaName - The identifier of the schema (required)
      maxResults - Maximum number of volumes to return (page length). If not set, the page length is set to a server configured value. - 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; Note: this parameter controls only the maximum number of volumes to return. The actual number of volumes returned in a page may be smaller than this value, including 0, even if there are more pages. (optional)
      pageToken - Opaque token returned by a previous request. It must be included in the request to retrieve the next page of results (pagination). (optional)
      Returns:
      ApiResponse<ListVolumesResponseContent>
      Throws:
      ApiException - if fails to make API call

    • updateVolume

      public VolumeInfo updateVolume(String name, UpdateVolumeRequestContent updateVolumeRequestContent) throws ApiException
      Update a Volume Updates the specified volume under the specified parent catalog and schema. Currently only the name or the comment of the volume could be updated.
      Parameters:
      name - The three-level (fully qualified) name of the volume (required)
      updateVolumeRequestContent - (optional)
      Returns:
      VolumeInfo
      Throws:
      ApiException - if fails to make API call

    • updateVolumeWithHttpInfo

      public ApiResponse<VolumeInfo> updateVolumeWithHttpInfo(String name, UpdateVolumeRequestContent updateVolumeRequestContent) throws ApiException
      Update a Volume Updates the specified volume under the specified parent catalog and schema. Currently only the name or the comment of the volume could be updated.
      Parameters:
      name - The three-level (fully qualified) name of the volume (required)
      updateVolumeRequestContent - (optional)
      Returns:
      ApiResponse<VolumeInfo>
      Throws:
      ApiException - if fails to make API call