com.cloudera.api.v11

Interface CmPeersResourceV11

All Superinterfaces:

CmPeersResource

public interface CmPeersResourceV11
extends CmPeersResource

Method Summary

Methods

Modifier and Type	Method and Description
ApiCmPeer	deletePeer(String peerName, ApiCmPeerType peerType) Delete Cloudera Manager peer.
ApiCmPeer	readPeer(String peerName, ApiCmPeerType peerType) Fetch information about an existing Cloudera Manager peer.
ApiCommand	testPeer(String peerName, ApiCmPeerType peerType) Test the connectivity of a peer.

Methods inherited from interface com.cloudera.api.v3.CmPeersResource

createPeer, deletePeer, listPeers, readPeer, testPeer, updatePeer

Method Detail

readPeer

@Path(value="/{peerName}")
ApiCmPeer readPeer(String peerName,
                      ApiCmPeerType peerType)

Fetch information about an existing Cloudera Manager peer.

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

Parameters:

peerName - Name of peer to retrieve.

peerType - Type of peer to retrieve. If null, REPLICATION peer type will be returned.

Returns:

Peer information.

deletePeer

@Path(value="/{peerName}")
ApiCmPeer deletePeer(String peerName,
                        ApiCmPeerType peerType)

Delete Cloudera Manager peer.

An attempt will be made to contact the peer server, so that the configured user can be deleted.. Errors while contacting the remote server are non-fatal.

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

Parameters:

peerName - Name of peer to delete.

peerType - Type of peer to delete. If null, REPLICATION peer type will be deleted.

Returns:

Information about the deleted peer.

testPeer

@Path(value="/{peerName}/commands/test")
ApiCommand testPeer(String peerName,
                       ApiCmPeerType peerType)

Test the connectivity of a peer.

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

Parameters:

peerName - Name of peer to test.

peerType - Type of peer to test. If null, REPLICATION peer type will be tested.

Returns:

Information about the submitted command.