com.cloudera.api.v2

Interface ServicesResourceV2

All Superinterfaces:

ServicesResource

All Known Subinterfaces:

ServicesResourceV3, ServicesResourceV4, ServicesResourceV6, ServicesResourceV7, ServicesResourceV8

public interface ServicesResourceV2
extends ServicesResource

Method Summary

Methods

Modifier and Type	Method and Description
ApiCommand	createOozieDb(String serviceName) Creates the Oozie Database Schema in the configured database.
ApiCommand	enterMaintenanceMode(String serviceName) Put the service into maintenance mode.
ApiCommand	exitMaintenanceMode(String serviceName) Take the service out of maintenance mode.
org.apache.cxf.jaxrs.ext.multipart.InputStreamDataSource	getClientConfig(String serviceName) Download a zip-compressed archive of the client configuration, of a specific service.
RolesResourceV2	getRolesResource(String serviceName)
ApiCommand	hdfsCreateTmpDir(String serviceName) Creates a tmp directory on the HDFS filesystem.
ApiCommand	recommissionCommand(String serviceName, ApiRoleNameList roleNames) Recommission roles of a service.

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

createBeeswaxWarehouseCommand, createHBaseRootCommand, createServices, decommissionCommand, deleteService, deployClientConfigCommand, getActivitiesResource, getMetrics, getNameservicesResource, getRoleCommandsResource, hdfsDisableAutoFailoverCommand, hdfsDisableHaCommand, hdfsEnableAutoFailoverCommand, hdfsEnableHaCommand, hdfsFailoverCommand, listActiveCommands, listRoleTypes, readService, readServiceConfig, readServices, restartCommand, startCommand, stopCommand, updateServiceConfig, zooKeeperCleanupCommand, zooKeeperInitCommand

Method Detail

getClientConfig

@PermitAll
@Path(value="/{serviceName}/clientConfig")
org.apache.cxf.jaxrs.ext.multipart.InputStreamDataSource getClientConfig(String serviceName)

Download a zip-compressed archive of the client configuration, of a specific service. This resource does not require any authentication.

Parameters:

serviceName - The service name.

Returns:

The archive data.

getRolesResource

@Path(value="/{serviceName}/roles")
RolesResourceV2 getRolesResource(String serviceName)

Specified by:

getRolesResource in interface ServicesResource

Returns:

The roles resource handler.

enterMaintenanceMode

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

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

Available since API v2.

Parameters:

serviceName - The service name.

Returns:

Synchronous command result.

exitMaintenanceMode

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

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

Available since API v2.

Parameters:

serviceName - The service name.

Returns:

Synchronous command result.

recommissionCommand

@Path(value="/{serviceName}/commands/recommission")
ApiCommand recommissionCommand(String serviceName,
                                  ApiRoleNameList roleNames)

Recommission roles of a service.

The list should contain names of slave roles to recommission.

Available since API v2.

Parameters:

serviceName - Name of the service on which to run the command.

roleNames - List of role names to recommision.

Returns:

Information about the submitted command.

hdfsCreateTmpDir

@Path(value="/{serviceName}/commands/hdfsCreateTmpDir")
ApiCommand hdfsCreateTmpDir(String serviceName)

Creates a tmp directory on the HDFS filesystem.

Available since API v2.

Parameters:

serviceName - Name of the HDFS service on which to run the command.

Returns:

Information about the submitted command

createOozieDb

@Path(value="/{serviceName}/commands/createOozieDb")
ApiCommand createOozieDb(String serviceName)

Creates the Oozie Database Schema in the configured database.

Available since API v2.

Parameters:

serviceName - Name of the Oozie service on which to run the command.

Returns:

Information about the submitted command