com.cloudera.api.v6

Interface RolesResourceV6

All Superinterfaces:

RolesResource, RolesResourceV2, RolesResourceV4

All Known Subinterfaces:

RolesResourceV11, RolesResourceV8

public interface RolesResourceV6
extends RolesResourceV4

Method Summary

Methods

Modifier and Type	Method and Description
ApiRoleList	bulkDeleteRoles(ApiRoleNameList roleNames) Bulk delete roles in a particular service by name.
ApiCommandMetadataList	listCommands(String roleName) Lists all the commands that can be executed by name on the provided role.
ApiRoleList	readRoles(String filter) Lists all roles of a given service that match the provided filter.

Methods inherited from interface com.cloudera.api.v4.RolesResourceV4

getProcessesResource

Methods inherited from interface com.cloudera.api.v2.RolesResourceV2

enterMaintenanceMode, exitMaintenanceMode

Methods inherited from interface com.cloudera.api.v1.RolesResource

createRoles, deleteRole, getFullLog, getMetrics, getStandardError, getStandardOutput, listActiveCommands, readRole, readRoleConfig, readRoles, updateRoleConfig

Method Detail

bulkDeleteRoles

@Path(value="/bulkDelete")
ApiRoleList bulkDeleteRoles(ApiRoleNameList roleNames)

Bulk delete roles in a particular service by name. Fails if any role cannot be found.

Parameters:

roleNames - list of role names to be deleted

Returns:

list of roles deleted, index-aligned with roleNames. Export view.

readRoles

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

Lists all roles of a given service that match the provided filter.

Parameters:

filter - Optional query to filter the roles by.

The query specifies the intersection of a list of constraints, joined together with semicolons (without spaces). For example: hostname==host1.abc.com;type==DATANODE

Currently supports filtering by:

• hostname: The hostname of the host the role is running on.
• hostId: The unique identifier of the host the role is running on.
• type: The role's type.

Returns:

List of roles.

listCommands

@Path(value="/{roleName}/commandsByName")
ApiCommandMetadataList listCommands(String roleName)

Lists all the commands that can be executed by name on the provided role.

Parameters:

roleName - the role name.

Returns:

a list of command metadata objects.