org.apache.hadoop.yarn.api.protocolrecords
Interface StartContainerResponse

@InterfaceAudience.Public
@InterfaceStability.Stable
public interface StartContainerResponse

The response sent by the NodeManager to the ApplicationMaster when asked to start an allocated container.

See Also:

ContainerManager.startContainer(StartContainerRequest)

Method Summary

void	addAllServiceResponse(Map<String,ByteBuffer> serviceResponse) Add to the list of auxiliary services which have been started on the NodeManager.
void	clearServiceResponse() Remove all the auxiliary services from the StartContainerResponse object
Map<String,ByteBuffer>	getAllServiceResponse() Get the responses from all auxiliary services running on the NodeManager.
ByteBuffer	getServiceResponse(String key) Get the response from a single auxiliary service running on the NodeManager
void	removeServiceResponse(String key) Remove a single auxiliary service from the StartContainerResponse object
void	setServiceResponse(String key, ByteBuffer value) Add to the list of auxiliary services which have been started on the NodeManager.

Method Detail

getAllServiceResponse

Map<String,ByteBuffer> getAllServiceResponse()

Get the responses from all auxiliary services running on the NodeManager.

The responses are returned as a Map between the auxiliary service names and their corresponding opaque blob ByteBuffers

Returns:

a Map between the auxiliary service names and their outputs

getServiceResponse

ByteBuffer getServiceResponse(String key)

Get the response from a single auxiliary service running on the NodeManager

Parameters:

key - The auxiliary service name whose response is desired.

Returns:

The opaque blob ByteBuffer returned by the auxiliary service.

addAllServiceResponse

void addAllServiceResponse(Map<String,ByteBuffer> serviceResponse)

Add to the list of auxiliary services which have been started on the NodeManager. This is done only once when the NodeManager starts up

Parameters:

serviceResponse - A map from auxiliary service names to the opaque blob ByteBuffers for that auxiliary service

setServiceResponse

void setServiceResponse(String key,
                        ByteBuffer value)

Add to the list of auxiliary services which have been started on the NodeManager. This is done only once when the NodeManager starts up

Parameters:

key - The auxiliary service name

value - The opaque blob ByteBuffer managed by the auxiliary service

removeServiceResponse

void removeServiceResponse(String key)

Remove a single auxiliary service from the StartContainerResponse object

Parameters:

key - The auxiliary service to remove

clearServiceResponse

void clearServiceResponse()

Remove all the auxiliary services from the StartContainerResponse object