com.cloudera.api.v1

Interface MgmtRolesResource

All Known Subinterfaces:

MgmtRolesResourceV8

public interface MgmtRolesResource

Method Summary

Methods

Modifier and Type	Method and Description
ApiRoleList	createRoles(ApiRoleList roles) Create new roles in the Cloudera Management Services.
ApiRole	deleteRole(String roleName) Delete a role from the Cloudera Management Services.
ApiCommandList	listActiveCommands(String roleName, DataView dataView) List active role commands.
ApiRole	readRole(String roleName) Retrieve detailed information about a Cloudera Management Services role.
ApiConfigList	readRoleConfig(String roleName, DataView dataView) Retrieve the configuration of a specific Cloudera Management Services role.
ApiRoleList	readRoles() List all roles of the Cloudera Management Services.
ApiConfigList	updateRoleConfig(String roleName, String message, ApiConfigList config) Update the configuration of a Cloudera Management Services role.

Method Detail

createRoles

@Path(value="/")
ApiRoleList createRoles(ApiRoleList roles)

Create new roles in the Cloudera Management Services.

Parameters:

roles - Roles to create.

Returns:

List of created roles.

deleteRole

@Path(value="/{roleName}")
ApiRole deleteRole(String roleName)

Delete a role from the Cloudera Management Services.

Parameters:

roleName - The role name.

Returns:

The details of the deleted role.

readRoles

@Path(value="/")
ApiRoleList readRoles()

List all roles of the Cloudera Management Services.

Returns:

List of roles.

readRole

@Path(value="/{roleName}")
ApiRole readRole(String roleName)

Retrieve detailed information about a Cloudera Management Services role.

Parameters:

roleName - The role name.

Returns:

The details of the role.

readRoleConfig

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

Retrieve the configuration of a specific Cloudera Management Services role.

Parameters:

roleName - The role to look up.

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

Returns:

List with configured and available configuration options.

updateRoleConfig

@Path(value="/{roleName}/config")
ApiConfigList updateRoleConfig(String roleName,
                                  String message,
                                  ApiConfigList config)

Update the configuration of a Cloudera Management Services role.

If a value is set in the given configuration, it will be added to the role's configuration, replacing any existing entries. If a value is unset (its value is null), the existing configuration for the attribute will be erased, if any.

Attributes that are not listed in the input will maintain their current values in the configuration.

Parameters:

roleName - The role to modify.

message - Optional message describing the changes.

config - Configuration changes.

Returns:

The new service configuration.

listActiveCommands

@Path(value="/{roleName}/commands")
ApiCommandList listActiveCommands(String roleName,
                                     DataView dataView)

List active role commands.

Parameters:

roleName - The role name.

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

Returns:

A list of active role commands.