com.cloudera.api.v2

Interface RolesResourceV2

All Superinterfaces:

RolesResource

All Known Subinterfaces:

RolesResourceV11, RolesResourceV4, RolesResourceV6, RolesResourceV8

public interface RolesResourceV2
extends RolesResource

Method Summary

Methods

Modifier and Type	Method and Description
ApiCommand	enterMaintenanceMode(String roleName) Put the role into maintenance mode.
ApiCommand	exitMaintenanceMode(String roleName) Take the role out of maintenance mode.

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

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

Method Detail

enterMaintenanceMode

@Path(value="/{roleName}/commands/enterMaintenanceMode")
ApiCommand enterMaintenanceMode(String roleName)

Put the role into maintenance mode. This is a synchronous command. The result is known immediately upon return.

Available since API v2.

Parameters:

roleName - The role name.

Returns:

Synchronous command result.

exitMaintenanceMode

@Path(value="/{roleName}/commands/exitMaintenanceMode")
ApiCommand exitMaintenanceMode(String roleName)

Take the role out of maintenance mode. This is a synchronous command. The result is known immediately upon return.

Available since API v2.

Parameters:

roleName - The role name.

Returns:

Synchronous command result.