com.cloudera.api.v3

Interface RoleConfigGroupsResource

public interface RoleConfigGroupsResource

Method Summary

Methods

Modifier and Type	Method and Description
ApiRoleConfigGroupList	createRoleConfigGroups(ApiRoleConfigGroupList groupList) Creates new role config groups.
ApiRoleConfigGroup	deleteRoleConfigGroup(String roleConfigGroupName) Deletes a role config group.
ApiRoleList	moveRoles(String roleConfigGroupName, ApiRoleNameList roles) Moves roles to the specified role config group.
ApiRoleList	moveRolesToBaseGroup(ApiRoleNameList roles) Moves roles to the base role config group.
ApiConfigList	readConfig(String roleConfigGroupName, DataView dataView) Returns the current revision of the config for the specified role config group.
ApiRoleConfigGroup	readRoleConfigGroup(String roleConfigGroupName) Returns the information for a role config group.
ApiRoleConfigGroupList	readRoleConfigGroups() Returns the information for all role config groups for a given cluster and service.
ApiRoleList	readRoles(String roleConfigGroupName) Returns all roles in the given role config group.
ApiConfigList	updateConfig(String roleConfigGroupName, String message, ApiConfigList config) Updates the config for the given role config group.
ApiRoleConfigGroup	updateRoleConfigGroup(String roleConfigGroupName, ApiRoleConfigGroup roleConfigGroup, String message) Updates an existing role config group

Method Detail

createRoleConfigGroups

@Path(value="/")
ApiRoleConfigGroupList createRoleConfigGroups(ApiRoleConfigGroupList groupList)

Creates new role config groups. It is not allowed to create base groups (base must be set to false.)

Available since API v3.

Parameters:

groupList - The list of groups to be created.

Returns:

The list of new role config groups.

readRoleConfigGroups

@Path(value="/")
ApiRoleConfigGroupList readRoleConfigGroups()

Returns the information for all role config groups for a given cluster and service.

Available since API v3.

Returns:

The list of role config groups for the given service.

readRoleConfigGroup

@Path(value="/{roleConfigGroupName}")
ApiRoleConfigGroup readRoleConfigGroup(String roleConfigGroupName)

Returns the information for a role config group.

Available since API v3.

Parameters:

roleConfigGroupName - The name of the requested group.

Returns:

The requested role config group.

updateRoleConfigGroup

@Path(value="/{roleConfigGroupName}")
ApiRoleConfigGroup updateRoleConfigGroup(String roleConfigGroupName,
                                            ApiRoleConfigGroup roleConfigGroup,
                                            String message)

Updates an existing role config group

Available since API v3.

Parameters:

roleConfigGroupName - The name of the group to update.

roleConfigGroup - The updated role config group.

message - The optional message describing the changes.

Returns:

Role updated role config group.

deleteRoleConfigGroup

@Path(value="/{roleConfigGroupName}")
ApiRoleConfigGroup deleteRoleConfigGroup(String roleConfigGroupName)

Deletes a role config group.

Available since API v3.

Parameters:

roleConfigGroupName - The name of the group to delete.

Returns:

The deleted role config group.

readRoles

@Path(value="/{roleConfigGroupName}/roles")
ApiRoleList readRoles(String roleConfigGroupName)

Returns all roles in the given role config group.

Available since API v3.

Parameters:

roleConfigGroupName - The name of the role config group.

Returns:

The roles in the role config group.

moveRoles

@Path(value="/{roleConfigGroupName}/roles")
ApiRoleList moveRoles(String roleConfigGroupName,
                         ApiRoleNameList roles)

Moves roles to the specified role config group. The roles can be moved from any role config group belonging to the same service. The role type of the destination group must match the role type of the roles.

Available since API v3.

Parameters:

roleConfigGroupName - The name of the group the roles will be moved to.

roles - The names of the roles to move.

Returns:

The roles which have been moved successfully.

moveRolesToBaseGroup

@Path(value="/roles")
ApiRoleList moveRolesToBaseGroup(ApiRoleNameList roles)

Moves roles to the base role config group. The roles can be moved from any role config group belonging to the same service. The role type of the roles may vary. Each role will be moved to its corresponding base group depending on its role type.

Available since API v3.

Parameters:

roles - The names of the roles to move.

Returns:

The roles which have been moved successfully.

readConfig

@Path(value="/{roleConfigGroupName}/config")
ApiConfigList readConfig(String roleConfigGroupName,
                            DataView dataView)

Returns the current revision of the config for the specified role config group.

Available since API v3.

Parameters:

roleConfigGroupName - The name of the role config group.

dataView - The view of the data to materialize, either "summary" or "full".

Returns:

The current configuration of the role config group.

updateConfig

@Path(value="/{roleConfigGroupName}/config")
ApiConfigList updateConfig(String roleConfigGroupName,
                              String message,
                              ApiConfigList config)

Updates the config for the given role config group.

Parameters:

roleConfigGroupName - The name of the role config group.

message - Optional message describing the changes.

config - The new config information for the group.

Returns:

The updated config of the role config group.