com.cloudera.api.v3

Interface MgmtRoleConfigGroupsResource

public interface MgmtRoleConfigGroupsResource

Method Summary

Methods

Modifier and Type	Method and Description
ApiConfigList	readConfig(String roleConfigGroupName, DataView dataView) Returns the current revision of the config for the specified role config group in the Cloudera Management Services.
ApiRoleConfigGroup	readRoleConfigGroup(String roleConfigGroupName) Returns the information for a given role config group in the Cloudera Management Services.
ApiRoleConfigGroupList	readRoleConfigGroups() Returns the information for all role config groups in the Cloudera Management Services.
ApiRoleList	readRoles(String roleConfigGroupName) Returns all roles in the given role config group in the Cloudera Management Services.
ApiConfigList	updateConfig(String roleConfigGroupName, String message, ApiConfigList config) Updates the config for the given role config group in the Cloudera Management Services.
ApiRoleConfigGroup	updateRoleConfigGroup(String roleConfigGroupName, ApiRoleConfigGroup roleConfigGroup, String message) Updates an existing role config group in the Cloudera Management Services.

Method Detail

readRoleConfigGroups

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

Returns the information for all role config groups in the Cloudera Management Services.

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 given role config group in the Cloudera Management Services.

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 in the Cloudera Management Services.

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.

readRoles

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

Returns all roles in the given role config group in the Cloudera Management Services.

Available since API v3.

Parameters:

roleConfigGroupName - The name of the role config group.

Returns:

The roles in the role config group.

readConfig

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

Returns the current revision of the config for the specified role config group in the Cloudera Management Services.

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 in the Cloudera Management Services.

Available since API v3.

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.