Package io.unitycatalog.client.api

Class ExternalLocationsApi

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

  • Constructor Details

    • ExternalLocationsApi

      public ExternalLocationsApi()

    • ExternalLocationsApi

      public ExternalLocationsApi(ApiClient apiClient)

  • Method Details

    • getApiException

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

    • createExternalLocation

      public ExternalLocationInfo createExternalLocation(CreateExternalLocation createExternalLocation) throws ApiException
      Create an external location Creates a new external location entry in the metastore. The caller must be a metastore admin to be able to create external locations.
      Parameters:
      createExternalLocation - (required)
      Returns:
      ExternalLocationInfo
      Throws:
      ApiException - if fails to make API call

    • createExternalLocationWithHttpInfo

      public ApiResponse<ExternalLocationInfo> createExternalLocationWithHttpInfo(CreateExternalLocation createExternalLocation) throws ApiException
      Create an external location Creates a new external location entry in the metastore. The caller must be a metastore admin to be able to create external locations.
      Parameters:
      createExternalLocation - (required)
      Returns:
      ApiResponse<ExternalLocationInfo>
      Throws:
      ApiException - if fails to make API call

    • deleteExternalLocation

      public void deleteExternalLocation(String name, Boolean force) throws ApiException
      Delete an external location Deletes the specified external location from the metastore. The caller must be a metastore admin or the owner of the external location.
      Parameters:
      name - Name of the external location. (required)
      force - Force deletion even if there are dependent external tables or mounts. (optional)
      Throws:
      ApiException - if fails to make API call

    • deleteExternalLocationWithHttpInfo

      public ApiResponse<Void> deleteExternalLocationWithHttpInfo(String name, Boolean force) throws ApiException
      Delete an external location Deletes the specified external location from the metastore. The caller must be a metastore admin or the owner of the external location.
      Parameters:
      name - Name of the external location. (required)
      force - Force deletion even if there are dependent external tables or mounts. (optional)
      Returns:
      ApiResponse<Void>
      Throws:
      ApiException - if fails to make API call

    • getExternalLocation

      public ExternalLocationInfo getExternalLocation(String name) throws ApiException
      Get an external location Gets an external location from the metastore. The caller must be a metastore admin, the owner of the external location, or a user with some privilege on the external location.
      Parameters:
      name - Name of the external location. (required)
      Returns:
      ExternalLocationInfo
      Throws:
      ApiException - if fails to make API call

    • getExternalLocationWithHttpInfo

      public ApiResponse<ExternalLocationInfo> getExternalLocationWithHttpInfo(String name) throws ApiException
      Get an external location Gets an external location from the metastore. The caller must be a metastore admin, the owner of the external location, or a user with some privilege on the external location.
      Parameters:
      name - Name of the external location. (required)
      Returns:
      ApiResponse<ExternalLocationInfo>
      Throws:
      ApiException - if fails to make API call

    • listExternalLocations

      public ListExternalLocationsResponse listExternalLocations(Integer maxResults, String pageToken) throws ApiException
      List external locations Gets an array of external locations (ExternalLocationInfo objects) from the metastore. The caller must be a metastore admin, the owner of the external location, or a user with some privilege on the external location.
      Parameters:
      maxResults - Maximum number of external locations to return. If not set, all external locations are returned. (optional)
      pageToken - Opaque pagination token to go to the next page. (optional)
      Returns:
      ListExternalLocationsResponse
      Throws:
      ApiException - if fails to make API call

    • listExternalLocationsWithHttpInfo

      public ApiResponse<ListExternalLocationsResponse> listExternalLocationsWithHttpInfo(Integer maxResults, String pageToken) throws ApiException
      List external locations Gets an array of external locations (ExternalLocationInfo objects) from the metastore. The caller must be a metastore admin, the owner of the external location, or a user with some privilege on the external location.
      Parameters:
      maxResults - Maximum number of external locations to return. If not set, all external locations are returned. (optional)
      pageToken - Opaque pagination token to go to the next page. (optional)
      Returns:
      ApiResponse<ListExternalLocationsResponse>
      Throws:
      ApiException - if fails to make API call

    • updateExternalLocation

      public ExternalLocationInfo updateExternalLocation(String name, UpdateExternalLocation updateExternalLocation) throws ApiException
      Update an external location Updates an external location in the metastore. The caller must be the owner of the external location or a metastore admin.
      Parameters:
      name - Name of the external location. (required)
      updateExternalLocation - (required)
      Returns:
      ExternalLocationInfo
      Throws:
      ApiException - if fails to make API call

    • updateExternalLocationWithHttpInfo

      public ApiResponse<ExternalLocationInfo> updateExternalLocationWithHttpInfo(String name, UpdateExternalLocation updateExternalLocation) throws ApiException
      Update an external location Updates an external location in the metastore. The caller must be the owner of the external location or a metastore admin.
      Parameters:
      name - Name of the external location. (required)
      updateExternalLocation - (required)
      Returns:
      ApiResponse<ExternalLocationInfo>
      Throws:
      ApiException - if fails to make API call