com.edmunds.rest.databricks.restclient.DatabricksRestClient 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.restclient;

import com.edmunds.rest.databricks.DatabricksRestException;
import com.edmunds.rest.databricks.RequestMethod;
import java.util.Map;

/**
 * A Simple Databricks Rest Client Interface. Will perform a given rest request.
 */
public interface DatabricksRestClient {

  /**
   * Performs the given query.
   *
   * @param requestMethod Type of request method. Only supports GET and POST methods.
   * @param path Path of the request URL
   * @param data Any data needed for the request
   * @return Returns a byte array of the response from the server
   */
  byte[] performQuery(RequestMethod requestMethod, String path, Map data)
      throws DatabricksRestException;

  /**
   * Performs the given query with no parameters
   *
   * @param requestMethod Type of request method. Only supports GET and POST methods.
   * @param path Path of the request URL
   * @return Returns a byte array of the response from the server
   */
  byte[] performQuery(RequestMethod requestMethod, String path)
          throws DatabricksRestException;

  /**
   * Returns the host string.
   *
   * @return Host string.
   */
  String getHost();
}