com.cloudera.api.v3

Interface ServicesResourceV3

All Superinterfaces:

ServicesResource, ServicesResourceV2

All Known Subinterfaces:

ServicesResourceV10, ServicesResourceV11, ServicesResourceV13, ServicesResourceV14, ServicesResourceV15, ServicesResourceV16, ServicesResourceV17, ServicesResourceV4, ServicesResourceV6, ServicesResourceV7, ServicesResourceV8

public interface ServicesResourceV3
extends ServicesResourceV2

Method Summary

Methods

Modifier and Type	Method and Description
ApiCommand	createHiveWarehouseCommand(String serviceName) Create the Hive warehouse directory, on Hive services.
ReplicationsResource	getReplicationsResource(String serviceName) Returns the replications resource handler.
RoleCommandsResourceV3	getRoleCommandsResource(String serviceName)
RoleConfigGroupsResource	getRoleConfigGroupsResource(String serviceName)
ApiCommand	hdfsRollEditsCommand(String serviceName, ApiRollEditsArgs rollEditsArgs) Roll the edits of an HDFS NameNode or Nameservice.
ApiCommand	hiveCreateMetastoreDatabaseTablesCommand(String serviceName) Create the Hive Metastore Database tables.
ApiCommand	installOozieShareLib(String serviceName) Creates directory for Oozie user in HDFS and installs the ShareLib in it.
ApiCommand	rollingRestart(String serviceName, ApiRollingRestartArgs args) Command to run rolling restart of roles in a service.
ApiService	updateService(String serviceName, ApiService service) Updates service information.

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

createOozieDb, enterMaintenanceMode, exitMaintenanceMode, getClientConfig, getRolesResource, hdfsCreateTmpDir, recommissionCommand

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

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

Method Detail

getReplicationsResource

@Path(value="/{serviceName}/replications")
ReplicationsResource getReplicationsResource(String serviceName)

Returns the replications resource handler.

Available since API v3. Only available with Cloudera Manager Enterprise Edition.

rollingRestart

@Path(value="/{serviceName}/commands/rollingRestart")
ApiCommand rollingRestart(String serviceName,
                             ApiRollingRestartArgs args)

Command to run rolling restart of roles in a service. The sequence is:

1. Restart all the non-slave roles
2. If slaves are present restart them in batches of size specified in RollingRestartCmdArgs
3. Perform any post-command needed after rolling restart

Available since API v3. Only available with Cloudera Manager Enterprise Edition.

installOozieShareLib

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

Creates directory for Oozie user in HDFS and installs the ShareLib in it.

This command should be re-run after a major version upgrade to refresh the ShareLib to the latest version.

Available since API v3.

Parameters:

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

Returns:

Information about the submitted command

getRoleConfigGroupsResource

@Path(value="/{serviceName}/roleConfigGroups")
RoleConfigGroupsResource getRoleConfigGroupsResource(String serviceName)

Returns:

The role config group resource handler.

hdfsRollEditsCommand

@Path(value="/{serviceName}/commands/hdfsRollEdits")
ApiCommand hdfsRollEditsCommand(String serviceName,
                                   ApiRollEditsArgs rollEditsArgs)

Roll the edits of an HDFS NameNode or Nameservice.

Available since API v3.

Parameters:

serviceName - The HDFS service name.

rollEditsArgs - Arguments to the Roll Edits command.

Returns:

Information about the submitted command.

updateService

@Path(value="/{serviceName}")
ApiService updateService(String serviceName,
                            ApiService service)

Updates service information.

This method will update only writable fields of the service information. Currently this only includes the service display name.

Available since API v3.

Parameters:

serviceName - The service name.

service - Updated service information.

Returns:

The updated service information.

hiveCreateMetastoreDatabaseTablesCommand

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

Create the Hive Metastore Database tables.

This command is to be run whenever a new database has been specified. Will do nothing if tables already exist. Will not perform an upgrade. Only Available when all Hive Metastore Servers are stopped.

Available since API v3.

Parameters:

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

Returns:

Information about the submitted command

createHiveWarehouseCommand

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

Create the Hive warehouse directory, on Hive services.

Available since API v3.

Parameters:

serviceName - The Hive service name.

Returns:

Information about the submitted command.

getRoleCommandsResource

@Path(value="/{serviceName}/roleCommands")
RoleCommandsResourceV3 getRoleCommandsResource(String serviceName)

Specified by:

getRoleCommandsResource in interface ServicesResource

Returns:

The role command resource handler.