org.apache.slider.api

Interface SliderClusterProtocol

All Superinterfaces:

org.apache.hadoop.ipc.VersionedProtocol

All Known Implementing Classes:

SliderClusterProtocolProxy, SliderIPCService

public interface SliderClusterProtocol
extends org.apache.hadoop.ipc.VersionedProtocol

Cluster protocol. This can currently act as a versioned IPC endpoint or be relayed via protobuf

Field Summary

Fields

Modifier and Type	Field and Description
static long	versionID

Method Summary

Methods

Modifier and Type	Method and Description
Messages.AMSuicideResponseProto	amSuicide(Messages.AMSuicideRequestProto request) AM to commit suicide.
Messages.EchoResponseProto	echo(Messages.EchoRequestProto request) Echo back the submitted text (after logging it).
Messages.FlexClusterResponseProto	flexCluster(Messages.FlexClusterRequestProto request) Flex the cluster.
Messages.GetCertificateStoreResponseProto	getClientCertificateStore(Messages.GetCertificateStoreRequestProto request)
Messages.GetClusterNodesResponseProto	getClusterNodes(Messages.GetClusterNodesRequestProto request) Get the details on a list of nodes.
Messages.GetInstanceDefinitionResponseProto	getInstanceDefinition(Messages.GetInstanceDefinitionRequestProto request) Get the instance definition
Messages.GetJSONClusterStatusResponseProto	getJSONClusterStatus(Messages.GetJSONClusterStatusRequestProto request) Get the current cluster status
Messages.ComponentInformationProto	getLiveComponent(Messages.GetLiveComponentRequestProto request)
Messages.GetLiveComponentsResponseProto	getLiveComponents(Messages.GetLiveComponentsRequestProto request)
Messages.ContainerInformationProto	getLiveContainer(Messages.GetLiveContainerRequestProto request)
Messages.GetLiveContainersResponseProto	getLiveContainers(Messages.GetLiveContainersRequestProto request)
Messages.ApplicationLivenessInformationProto	getLivenessInformation(Messages.GetApplicationLivenessRequestProto request) Get the application liveness
Messages.NodeInformationProto	getLiveNode(Messages.GetLiveNodeRequestProto request)
Messages.GetLiveNodesResponseProto	getLiveNodes(Messages.GetLiveNodesRequestProto request)
Messages.WrappedJsonProto	getLiveResources(Messages.EmptyPayloadProto request)
Messages.WrappedJsonProto	getModelDesired(Messages.EmptyPayloadProto request)
Messages.WrappedJsonProto	getModelDesiredAppconf(Messages.EmptyPayloadProto request)
Messages.WrappedJsonProto	getModelDesiredResources(Messages.EmptyPayloadProto request)
Messages.WrappedJsonProto	getModelResolved(Messages.EmptyPayloadProto request)
Messages.WrappedJsonProto	getModelResolvedAppconf(Messages.EmptyPayloadProto request)
Messages.WrappedJsonProto	getModelResolvedResources(Messages.EmptyPayloadProto request)
Messages.GetNodeResponseProto	getNode(Messages.GetNodeRequestProto request) Get the details on a node
Messages.KillContainerResponseProto	killContainer(Messages.KillContainerRequestProto request) Kill an identified container
Messages.ListNodeUUIDsByRoleResponseProto	listNodeUUIDsByRole(Messages.ListNodeUUIDsByRoleRequestProto request) List all running nodes in a role
Messages.StopClusterResponseProto	stopCluster(Messages.StopClusterRequestProto request) Stop the cluster
Messages.UpgradeContainersResponseProto	upgradeContainers(Messages.UpgradeContainersRequestProto request) Upgrade the application containers

Methods inherited from interface org.apache.hadoop.ipc.VersionedProtocol

getProtocolSignature, getProtocolVersion

Field Detail

versionID

static final long versionID

See Also:

Constant Field Values

Method Detail

stopCluster

Messages.StopClusterResponseProto stopCluster(Messages.StopClusterRequestProto request)
                                              throws IOException,
                                                     org.apache.hadoop.yarn.exceptions.YarnException

Stop the cluster

Throws:

IOException

org.apache.hadoop.yarn.exceptions.YarnException

upgradeContainers

Messages.UpgradeContainersResponseProto upgradeContainers(Messages.UpgradeContainersRequestProto request)
                                                          throws IOException,
                                                                 org.apache.hadoop.yarn.exceptions.YarnException

Upgrade the application containers

Parameters:

request - upgrade containers request object

Returns:

upgrade containers response object

Throws:

IOException

org.apache.hadoop.yarn.exceptions.YarnException

flexCluster

Messages.FlexClusterResponseProto flexCluster(Messages.FlexClusterRequestProto request)
                                              throws IOException

Flex the cluster.

Throws:

IOException

getJSONClusterStatus

Messages.GetJSONClusterStatusResponseProto getJSONClusterStatus(Messages.GetJSONClusterStatusRequestProto request)
                                                                throws IOException,
                                                                       org.apache.hadoop.yarn.exceptions.YarnException

Get the current cluster status

Throws:

IOException

org.apache.hadoop.yarn.exceptions.YarnException

listNodeUUIDsByRole

Messages.ListNodeUUIDsByRoleResponseProto listNodeUUIDsByRole(Messages.ListNodeUUIDsByRoleRequestProto request)
                                                              throws IOException,
                                                                     org.apache.hadoop.yarn.exceptions.YarnException

List all running nodes in a role

Throws:

IOException

org.apache.hadoop.yarn.exceptions.YarnException

getNode

Messages.GetNodeResponseProto getNode(Messages.GetNodeRequestProto request)
                                      throws IOException,
                                             org.apache.hadoop.yarn.exceptions.YarnException

Get the details on a node

Throws:

IOException

org.apache.hadoop.yarn.exceptions.YarnException

getClusterNodes

Messages.GetClusterNodesResponseProto getClusterNodes(Messages.GetClusterNodesRequestProto request)
                                                      throws IOException,
                                                             org.apache.hadoop.yarn.exceptions.YarnException

Get the details on a list of nodes. Unknown nodes are not returned Important: the order of the results are undefined

Throws:

IOException

org.apache.hadoop.yarn.exceptions.YarnException

echo

Messages.EchoResponseProto echo(Messages.EchoRequestProto request)
                                throws IOException,
                                       org.apache.hadoop.yarn.exceptions.YarnException

Echo back the submitted text (after logging it). Useful for adding information to the log, and for testing round trip operations of the protocol

Parameters:

request - request

Returns:

response

Throws:

IOException

org.apache.hadoop.yarn.exceptions.YarnException

killContainer

Messages.KillContainerResponseProto killContainer(Messages.KillContainerRequestProto request)
                                                  throws IOException,
                                                         org.apache.hadoop.yarn.exceptions.YarnException

Kill an identified container

Parameters:

request - request containing the container to kill

Returns:

the response

Throws:

IOException

org.apache.hadoop.yarn.exceptions.YarnException

amSuicide

Messages.AMSuicideResponseProto amSuicide(Messages.AMSuicideRequestProto request)
                                          throws IOException

AM to commit suicide. If the Hadoop halt entry point has not been disabled, this will fail rather than return with a response.

Parameters:

request - request

Returns:

response (this is not the expected outcome)

Throws:

IOException

org.apache.hadoop.yarn.exceptions.YarnException

getInstanceDefinition

Messages.GetInstanceDefinitionResponseProto getInstanceDefinition(Messages.GetInstanceDefinitionRequestProto request)
                                                                  throws IOException,
                                                                         org.apache.hadoop.yarn.exceptions.YarnException

Get the instance definition

Throws:

IOException

org.apache.hadoop.yarn.exceptions.YarnException

getLivenessInformation

Messages.ApplicationLivenessInformationProto getLivenessInformation(Messages.GetApplicationLivenessRequestProto request)
                                                                    throws IOException

Get the application liveness

Returns:

current liveness information

Throws:

IOException

getLiveContainers

Messages.GetLiveContainersResponseProto getLiveContainers(Messages.GetLiveContainersRequestProto request)
                                                          throws IOException

Throws:

IOException

getLiveContainer

Messages.ContainerInformationProto getLiveContainer(Messages.GetLiveContainerRequestProto request)
                                                    throws IOException

Throws:

IOException

getLiveComponents

Messages.GetLiveComponentsResponseProto getLiveComponents(Messages.GetLiveComponentsRequestProto request)
                                                          throws IOException

Throws:

IOException

getLiveComponent

Messages.ComponentInformationProto getLiveComponent(Messages.GetLiveComponentRequestProto request)
                                                    throws IOException

Throws:

IOException

getLiveNodes

Messages.GetLiveNodesResponseProto getLiveNodes(Messages.GetLiveNodesRequestProto request)
                                                throws IOException

Throws:

IOException

getLiveNode

Messages.NodeInformationProto getLiveNode(Messages.GetLiveNodeRequestProto request)
                                          throws IOException

Throws:

IOException

getModelDesired

Messages.WrappedJsonProto getModelDesired(Messages.EmptyPayloadProto request)
                                          throws IOException

Throws:

IOException

getModelDesiredAppconf

Messages.WrappedJsonProto getModelDesiredAppconf(Messages.EmptyPayloadProto request)
                                                 throws IOException

Throws:

IOException

getModelDesiredResources

Messages.WrappedJsonProto getModelDesiredResources(Messages.EmptyPayloadProto request)
                                                   throws IOException

Throws:

IOException

getModelResolved

Messages.WrappedJsonProto getModelResolved(Messages.EmptyPayloadProto request)
                                           throws IOException

Throws:

IOException

getModelResolvedAppconf

Messages.WrappedJsonProto getModelResolvedAppconf(Messages.EmptyPayloadProto request)
                                                  throws IOException

Throws:

IOException

getModelResolvedResources

Messages.WrappedJsonProto getModelResolvedResources(Messages.EmptyPayloadProto request)
                                                    throws IOException

Throws:

IOException

getLiveResources

Messages.WrappedJsonProto getLiveResources(Messages.EmptyPayloadProto request)
                                           throws IOException

Throws:

IOException

getClientCertificateStore

Messages.GetCertificateStoreResponseProto getClientCertificateStore(Messages.GetCertificateStoreRequestProto request)
                                                                    throws IOException

Throws:

IOException