com.edmunds.rest.databricks.service.GroupsService 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
package com.edmunds.rest.databricks.service;

import com.edmunds.rest.databricks.DTO.groups.PrincipalNameDTO;
import com.edmunds.rest.databricks.DatabricksRestException;
import java.io.IOException;

/**
 * A wrapper around Databricks' Groups API.
 *
 * @see https://docs.databricks.com/api/latest/groups.html
 */
public interface GroupsService {

  /**
   * Adds a user to a group.
   *
   * @param userName   the userName to be added
   * @param parentName name of the parent group to which the new member will be added
   * @throws IOException             other connection errors
   * @throws DatabricksRestException any errors with the request
   * @see https://docs.databricks.com/api/latest/groups.html#add-member
   */
  void addUserToGroup(String userName, String parentName) throws IOException, DatabricksRestException;

  /**
   * Adds a group to a group.
   *
   * @param groupName  the groupName to be added
   * @param parentName name of the parent group to which the new member will be added
   * @throws IOException             other connection errors
   * @throws DatabricksRestException any errors with the request
   * @see https://docs.databricks.com/api/latest/groups.html#add-member
   */
  void addGroupToGroup(String groupName, String parentName) throws IOException, DatabricksRestException;

  /**
   * Creates a new group.
   *
   * @param groupName the groupName to be created
   * @return the groupName
   * @throws IOException             other connection errors
   * @throws DatabricksRestException any errors with the request
   * @see https://docs.databricks.com/api/latest/groups.html#create
   */
  String createGroup(String groupName) throws IOException, DatabricksRestException;

  /**
   * Returns all of the members of a particular group.
   *
   * @param groupName the groupName whose members we want to retrieve
   * @return all users and groups that belong to a given group
   * @throws IOException             other connection errors
   * @throws DatabricksRestException any errors with the request
   * @see https://docs.databricks.com/api/latest/groups.html#list-members
   */
  PrincipalNameDTO[] listMembers(String groupName) throws IOException, DatabricksRestException;

  /**
   * Returns all the groups in an organization.
   *
   * @return the groupNames of all groups
   * @throws IOException             other connection errors
   * @throws DatabricksRestException any errors with the request
   * @see https://docs.databricks.com/api/latest/groups.html#list
   */
  String[] listGroups() throws IOException, DatabricksRestException;

  /**
   * Retrieves all groups in which a given user is a member.
   *
   * @param userName name of the user
   * @return the groupNames of all groups the user belongs to
   * @throws IOException             other connection errors
   * @throws DatabricksRestException any errors with the request
   * @see https://docs.databricks.com/api/latest/groups.html#list-parents
   */
  String[] listParentsOfUser(String userName) throws IOException, DatabricksRestException;

  /**
   * Retrieves all groups in which a given group is a member.
   *
   * @param groupName name of the group
   * @return the groupNames of all groups the group belongs to
   * @throws IOException             other connection errors
   * @throws DatabricksRestException any errors with the request
   * @see https://docs.databricks.com/api/latest/groups.html#list-parents
   */
  String[] listParentsOfGroup(String groupName) throws IOException, DatabricksRestException;

  /**
   * Removes a user from a group.
   *
   * @param userName   name of the user
   * @param parentName name of parent group
   * @throws IOException             other connection errors
   * @throws DatabricksRestException any errors with the request
   * @see https://docs.databricks.com/api/latest/groups.html#remove-member
   */
  void removeUserFromGroup(String userName, String parentName) throws IOException, DatabricksRestException;

  /**
   * Removes a group from a group.
   *
   * @param groupName  name of the group
   * @param parentName name of parent group
   * @throws IOException             other connection errors
   * @throws DatabricksRestException any errors with the request
   * @see https://docs.databricks.com/api/latest/groups.html#remove-member
   */
  void removeGroupFromGroup(String groupName, String parentName) throws IOException, DatabricksRestException;

  /**
   * Removes a group from this organization.
   *
   * @param groupName name of the group to be deleted
   * @throws IOException             other connection errors
   * @throws DatabricksRestException any errors with the request
   * @see https://docs.databricks.com/api/latest/groups.html#delete
   */
  void deleteGroup(String groupName) throws IOException, DatabricksRestException;

  /**
   * Check to see if a group exists with a given name.
   *
   * @param groupName name to check
   * @return whether or not the groupName was found in the list of groups
   * @throws IOException             other connection errors
   * @throws DatabricksRestException any errors with the request
   */
  boolean groupExists(String groupName) throws IOException, DatabricksRestException;
}