org.apache.slider.api

Interface SliderApplicationApi

All Known Implementing Classes:

SliderApplicationApiRestClient, SliderApplicationIpcClient

public interface SliderApplicationApi

API exported by the slider remote REST/IPC endpoints.

Method Summary

Methods

Modifier and Type	Method and Description
Map<String,ComponentInformation>	enumComponents() List all components into a map of [name:info]
Map<String,ContainerInformation>	enumContainers() Get a map of live containers [containerId:info]
ApplicationLivenessInformation	getApplicationLiveness() Get the application liveness
ComponentInformation	getComponent(String componentName) Get information about a component
ContainerInformation	getContainer(String containerId) Get a container from the container Id
ConfTreeOperations	getDesiredAppconf() Get the desired application configuration
AggregateConf	getDesiredModel() Get the aggregate desired model
ConfTreeOperations	getDesiredResources() Get the desired YARN resources
NodeInformation	getLiveNode(String hostname) Get information about a node
NodeInformationList	getLiveNodes() List all nodes into a map of [name:info]
ConfTreeOperations	getLiveResources() Get the live YARN resources
ConfTreeOperations	getResolvedAppconf() Get the resolved application configuration
AggregateConf	getResolvedModel() Get the aggregate resolved model
ConfTreeOperations	getResolvedResources() Get the resolved YARN resources
PingInformation	ping(String text) Ping as a GET
void	putDesiredResources(ConfTree updated) Put an updated resources structure.
void	stop(String text) Stop the AM (async operation)

Method Detail

getDesiredModel

AggregateConf getDesiredModel()
                              throws IOException

Get the aggregate desired model

Returns:

the aggregate configuration of what was asked for -before resolution has taken place

Throws:

IOException - on any failure

getDesiredAppconf

ConfTreeOperations getDesiredAppconf()
                                     throws IOException

Get the desired application configuration

Returns:

the application configuration asked for -before resolution has taken place

Throws:

IOException - on any failure

getDesiredResources

ConfTreeOperations getDesiredResources()
                                       throws IOException

Get the desired YARN resources

Returns:

the resources asked for -before resolution has taken place

Throws:

IOException - on any failure

putDesiredResources

void putDesiredResources(ConfTree updated)
                         throws IOException

Put an updated resources structure. This triggers a cluster flex operation

Parameters:

updated - updated resources

Throws:

IOException - on any problem.

getResolvedModel

AggregateConf getResolvedModel()
                               throws IOException

Get the aggregate resolved model

Returns:

the aggregate configuration of what was asked for -after resolution has taken place

Throws:

IOException - on any failure

getResolvedAppconf

ConfTreeOperations getResolvedAppconf()
                                      throws IOException

Get the resolved application configuration

Returns:

the application configuration asked for -after resolution has taken place

Throws:

IOException - on any failure

getResolvedResources

ConfTreeOperations getResolvedResources()
                                        throws IOException

Get the resolved YARN resources

Returns:

the resources asked for -after resolution has taken place

Throws:

IOException - on any failure

getLiveResources

ConfTreeOperations getLiveResources()
                                    throws IOException

Get the live YARN resources

Returns:

the live set of resources in the cluster

Throws:

IOException - on any failure

enumContainers

Map<String,ContainerInformation> enumContainers()
                                                throws IOException

Get a map of live containers [containerId:info]

Returns:

a possibly empty list of serialized containers

Throws:

IOException - on any failure

getContainer

ContainerInformation getContainer(String containerId)
                                  throws IOException

Get a container from the container Id

Parameters:

containerId - YARN container ID

Returns:

the container information

Throws:

IOException - on any failure

enumComponents

Map<String,ComponentInformation> enumComponents()
                                                throws IOException

List all components into a map of [name:info]

Returns:

a possibly empty map of components

Throws:

IOException - on any failure

getComponent

ComponentInformation getComponent(String componentName)
                                  throws IOException

Get information about a component

Parameters:

componentName - name of the component

Returns:

the component details

Throws:

IOException - on any failure

getLiveNodes

NodeInformationList getLiveNodes()
                                 throws IOException

List all nodes into a map of [name:info]

Returns:

a possibly empty list of nodes

Throws:

IOException - on any failure

getLiveNode

NodeInformation getLiveNode(String hostname)
                            throws IOException

Get information about a node

Parameters:

hostname - name of the node

Returns:

the node details

Throws:

IOException - on any failure

ping

PingInformation ping(String text)
                     throws IOException

Ping as a GET

Parameters:

text - text to include

Returns:

the response

Throws:

IOException - on any failure

stop

void stop(String text)
          throws IOException

Stop the AM (async operation)

Parameters:

text - text to include

Throws:

IOException - on any failure

getApplicationLiveness

ApplicationLivenessInformation getApplicationLiveness()
                                                      throws IOException

Get the application liveness

Returns:

current liveness information

Throws:

IOException