com.cloudera.api.v11
Interface RolesResourceV11
- All Superinterfaces:
- RolesResource, RolesResourceV2, RolesResourceV4, RolesResourceV6, RolesResourceV8
public interface RolesResourceV11
- extends RolesResourceV8
Methods inherited from interface com.cloudera.api.v1.RolesResource |
createRoles, deleteRole, getFullLog, getMetrics, getStandardError, getStandardOutput, listActiveCommands, readRole, readRoleConfig, readRoles, updateRoleConfig |
readRoles
@Path(value="/")
ApiRoleList readRoles(String filter,
DataView dataView)
- Lists all roles of a given service.
- 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.
dataView
- DataView for getting roles. Defaults to 'summary'.
- Returns:
- List of roles.
readRole
@Path(value="/{roleName}")
ApiRole readRole(String roleName,
DataView dataView)
- Retrieves detailed information about a role.
- Parameters:
roleName
- The role name.dataView
- The view to materialize. Defaults to 'full'.
- Returns:
- The details of the role.
Copyright © Cloudera, Inc. Released under Apache License, Version 2.0.