com.edmunds.rest.databricks.service.WorkspaceService Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of databricks-rest-client Show documentation

A simple java rest client to interact with the Databricks Rest Service https://docs.databricks.com/api/latest/index.html

There is a newer version: 3.3.3

Show newest version

/*
 * Copyright 2018 Edmunds.com, Inc.
 *
 *    Licensed under the Apache License, Version 2.0 (the "License");
 *    you may not use this file except in compliance with the License.
 *    You may obtain a copy of the License at
 *
 *        http://www.apache.org/licenses/LICENSE-2.0
 *
 *    Unless required by applicable law or agreed to in writing, software
 *    distributed under the License is distributed on an "AS IS" BASIS,
 *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *    See the License for the specific language governing permissions and
 *    limitations under the License.
 */

package com.edmunds.rest.databricks.service;

import com.edmunds.rest.databricks.DTO.workspace.ObjectInfoDTO;
import com.edmunds.rest.databricks.DatabricksRestException;
import com.edmunds.rest.databricks.request.ExportWorkspaceRequest;
import com.edmunds.rest.databricks.request.ImportWorkspaceRequest;
import java.io.IOException;

/**
 * Wrapper around the Worspace API.
 * @see https://docs.databricks.com/api/latest/workspace.html
 */
public interface WorkspaceService {

  /**
   * Deletes a specific workspace path.
   * @see https://docs.databricks.com/api/latest/workspace.html#delete
   * @param path the workspace path to delete
   * @param recursive whether or not its recursive
   * @throws IOException any other errors
   * @throws DatabricksRestException databricks specific errors
   */
  void delete(String path, boolean recursive) throws IOException, DatabricksRestException;

  /**
   * Exports a workspace path FROM databricks to local machine.
   * @see https://docs.databricks.com/api/latest/workspace.html#export
   * @param exportWorkspaceRequest the request object
   * @return the bytes of the export
   * @throws IOException any other errors
   * @throws DatabricksRestException any specific db errors
   */
  byte[] exportWorkspace(ExportWorkspaceRequest exportWorkspaceRequest)
      throws IOException, DatabricksRestException;

  /**
   * Gets the status of a specific workspace path.
   * @see https://docs.databricks.com/api/latest/workspace.html#get-status
   * @param path the workspace path
   * @return the workspace info object
   * @throws IOException any other errors
   * @throws DatabricksRestException any specific db errors
   */
  ObjectInfoDTO getStatus(String path) throws IOException, DatabricksRestException;

  /**
   * Imports files INTO databricks from local machine.
   * @see https://docs.databricks.com/api/latest/workspace.html#import
   * @param importWorkspaceRequest the import workspace request
   * @throws IOException any other errors
   * @throws DatabricksRestException specific db exceptions
   */
  void importWorkspace(ImportWorkspaceRequest importWorkspaceRequest)
      throws IOException, DatabricksRestException;

  /**
   * Lists all objects in a specific db workspace path.
   * @see https://docs.databricks.com/api/latest/workspace.html#list
   * @param path the db workspace path
   * @return the array of objects
   * @throws IOException any other errors
   * @throws DatabricksRestException specific db exceptions
   */
  ObjectInfoDTO[] listStatus(String path) throws IOException, DatabricksRestException;

  /**
   * Makes a path (and any parent paths if they do not exist) on db workspace.
   * @see https://docs.databricks.com/api/latest/workspace.html#mkdirs
   * @param path the db workspace path to create
   * @throws IOException any other errors
   * @throws DatabricksRestException any specific db exceptions
   */
  void mkdirs(String path) throws IOException, DatabricksRestException;

}