com.edmunds.rest.databricks.service

Interface GroupsService

All Known Implementing Classes:

GroupsServiceImpl

public interface GroupsService

A wrapper around Databricks' Groups API.

See Also:

https://docs.databricks.com/api/latest/groups.html

Method Summary

Modifier and Type	Method and Description
void	addGroupToGroup(String groupName, String parentName) Adds a group to a group.
void	addUserToGroup(String userName, String parentName) Adds a user to a group.
String	createGroup(String groupName) Creates a new group.
void	deleteGroup(String groupName) Removes a group from this organization.
boolean	groupExists(String groupName) Check to see if a group exists with a given name.
String[]	listGroups() Returns all the groups in an organization.
PrincipalNameDTO[]	listMembers(String groupName) Returns all of the members of a particular group.
String[]	listParentsOfGroup(String groupName) Retrieves all groups in which a given group is a member.
String[]	listParentsOfUser(String userName) Retrieves all groups in which a given user is a member.
void	removeGroupFromGroup(String groupName, String parentName) Removes a group from a group.
void	removeUserFromGroup(String userName, String parentName) Removes a user from a group.

Method Detail

addUserToGroup

void addUserToGroup(String userName,
                    String parentName)
             throws IOException,
                    DatabricksRestException

Adds a user to a group.

Parameters:

userName - the userName to be added

parentName - name of the parent group to which the new member will be added

Throws:

IOException - other connection errors

DatabricksRestException - any errors with the request

See Also:

https://docs.databricks.com/api/latest/groups.html#add-member

addGroupToGroup

void addGroupToGroup(String groupName,
                     String parentName)
              throws IOException,
                     DatabricksRestException

Adds a group to a group.

Parameters:

groupName - the groupName to be added

parentName - name of the parent group to which the new member will be added

Throws:

IOException - other connection errors

DatabricksRestException - any errors with the request

See Also:

https://docs.databricks.com/api/latest/groups.html#add-member

createGroup

String createGroup(String groupName)
            throws IOException,
                   DatabricksRestException

Creates a new group.

Parameters:

groupName - the groupName to be created

Returns:

the groupName

Throws:

IOException - other connection errors

DatabricksRestException - any errors with the request

See Also:

https://docs.databricks.com/api/latest/groups.html#create

listMembers

PrincipalNameDTO[] listMembers(String groupName)
                        throws IOException,
                               DatabricksRestException

Returns all of the members of a particular group.

Parameters:

groupName - the groupName whose members we want to retrieve

Returns:

all users and groups that belong to a given group

Throws:

IOException - other connection errors

DatabricksRestException - any errors with the request

See Also:

https://docs.databricks.com/api/latest/groups.html#list-members

listGroups

String[] listGroups()
             throws IOException,
                    DatabricksRestException

Returns all the groups in an organization.

Returns:

the groupNames of all groups

Throws:

IOException - other connection errors

DatabricksRestException - any errors with the request

See Also:

https://docs.databricks.com/api/latest/groups.html#list

listParentsOfUser

String[] listParentsOfUser(String userName)
                    throws IOException,
                           DatabricksRestException

Retrieves all groups in which a given user is a member.

Parameters:

userName - name of the user

Returns:

the groupNames of all groups the user belongs to

Throws:

IOException - other connection errors

DatabricksRestException - any errors with the request

See Also:

https://docs.databricks.com/api/latest/groups.html#list-parents

listParentsOfGroup

String[] listParentsOfGroup(String groupName)
                     throws IOException,
                            DatabricksRestException

Retrieves all groups in which a given group is a member.

Parameters:

groupName - name of the group

Returns:

the groupNames of all groups the group belongs to

Throws:

IOException - other connection errors

DatabricksRestException - any errors with the request

See Also:

https://docs.databricks.com/api/latest/groups.html#list-parents

removeUserFromGroup

void removeUserFromGroup(String userName,
                         String parentName)
                  throws IOException,
                         DatabricksRestException

Removes a user from a group.

Parameters:

userName - name of the user

parentName - name of parent group

Throws:

IOException - other connection errors

DatabricksRestException - any errors with the request

See Also:

https://docs.databricks.com/api/latest/groups.html#remove-member

removeGroupFromGroup

void removeGroupFromGroup(String groupName,
                          String parentName)
                   throws IOException,
                          DatabricksRestException

Removes a group from a group.

Parameters:

groupName - name of the group

parentName - name of parent group

Throws:

IOException - other connection errors

DatabricksRestException - any errors with the request

See Also:

https://docs.databricks.com/api/latest/groups.html#remove-member

deleteGroup

void deleteGroup(String groupName)
          throws IOException,
                 DatabricksRestException

Removes a group from this organization.

Parameters:

groupName - name of the group to be deleted

Throws:

IOException - other connection errors

DatabricksRestException - any errors with the request

See Also:

https://docs.databricks.com/api/latest/groups.html#delete

groupExists

boolean groupExists(String groupName)
             throws IOException,
                    DatabricksRestException

Check to see if a group exists with a given name.

Parameters:

groupName - name to check

Returns:

whether or not the groupName was found in the list of groups

Throws:

IOException - other connection errors

DatabricksRestException - any errors with the request