com.cloudera.api.v3

Interface ClustersResourceV3

All Superinterfaces:

ClustersResource, ClustersResourceV2

All Known Subinterfaces:

ClustersResourceV10, ClustersResourceV11, ClustersResourceV12, ClustersResourceV13, ClustersResourceV14, ClustersResourceV15, ClustersResourceV16, ClustersResourceV17, ClustersResourceV4, ClustersResourceV5, ClustersResourceV6, ClustersResourceV7, ClustersResourceV8, ClustersResourceV9

public interface ClustersResourceV3
extends ClustersResourceV2

Method Summary

Methods

Modifier and Type	Method and Description
ApiHostRefList	addHosts(String clusterName, ApiHostRefList hosts)
HostTemplatesResource	getHostTemplatesResource(String clusterName)
ParcelsResource	getParcelsResource(String clusterName)
ServicesResourceV3	getServicesResource(String clusterName)
ApiHostRefList	listHosts(String clusterName)
ApiHostRefList	removeAllHosts(String clusterName)
ApiHostRef	removeHost(String clusterName, String hostId)

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

deployClientConfig, enterMaintenanceMode, exitMaintenanceMode, updateCluster

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

createClusters, deleteCluster, listActiveCommands, readCluster, readClusters, restartCommand, startCommand, stopCommand, upgradeServicesCommand

Method Detail

getServicesResource

@Path(value="/{clusterName}/services")
ServicesResourceV3 getServicesResource(String clusterName)

Specified by:

getServicesResource in interface ClustersResource

Specified by:

getServicesResource in interface ClustersResourceV2

Returns:

The services resource handler.

getParcelsResource

@Path(value="/{clusterName}/parcels")
ParcelsResource getParcelsResource(String clusterName)

Returns:

the parcels resource handler.

getHostTemplatesResource

@Path(value="/{clusterName}/hostTemplates")
HostTemplatesResource getHostTemplatesResource(String clusterName)

Returns:

The host templates handler.

listHosts

@Path(value="/{clusterName}/hosts")
ApiHostRefList listHosts(String clusterName)

Returns:

the hosts associated with the cluster

addHosts

@Path(value="/{clusterName}/hosts")
ApiHostRefList addHosts(String clusterName,
                           ApiHostRefList hosts)

Returns:

the newly added hosts to the cluster. if a host is already a member, it will be excluded from the list

removeHost

@Path(value="/{clusterName}/hosts/{hostId}")
ApiHostRef removeHost(String clusterName,
                         String hostId)

Returns:

the host that was unassociated with the cluster. if the host is not part of the cluster, return null

removeAllHosts

@Path(value="/{clusterName}/hosts")
ApiHostRefList removeAllHosts(String clusterName)

Returns:

all the hosts that were unassociated with the cluster