Package org.apache.hadoop.yarn.api.protocolrecords

Class StopContainersResponse

java.lang.Object

org.apache.hadoop.yarn.api.protocolrecords.StopContainersResponse

@Public
@Stable
public abstract class StopContainersResponse
extends java.lang.Object

The response sent by the NodeManager to the ApplicationMaster when asked to stop allocated containers.

See Also:

ContainerManagementProtocol.stopContainers(StopContainersRequest)

Constructor Summary

Constructors

Constructor	Description
StopContainersResponse()

Method Summary

Modifier and Type	Method	Description
abstract java.util.Map<ContainerId,SerializedException>	getFailedRequests()	Get the containerId-to-exception map in which the exception indicates error from per container for failed requests.
abstract java.util.List<ContainerId>	getSuccessfullyStoppedContainers()	Get the list of containerIds of successfully stopped containers.
static StopContainersResponse	newInstance(java.util.List<ContainerId> succeededRequests, java.util.Map<ContainerId,SerializedException> failedRequests)
abstract void	setFailedRequests(java.util.Map<ContainerId,SerializedException> failedRequests)	Set the containerId-to-exception map in which the exception indicates error from per container for failed requests.
abstract void	setSuccessfullyStoppedContainers(java.util.List<ContainerId> succeededRequests)	Set the list of containerIds of successfully stopped containers.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StopContainersResponse

public StopContainersResponse()

Method Detail

newInstance

@Private
@Unstable
public static StopContainersResponse newInstance(java.util.List<ContainerId> succeededRequests,
                                                 java.util.Map<ContainerId,SerializedException> failedRequests)

getSuccessfullyStoppedContainers

@Public
@Stable
public abstract java.util.List<ContainerId> getSuccessfullyStoppedContainers()

Get the list of containerIds of successfully stopped containers.

Returns:

the list of containerIds of successfully stopped containers.

setSuccessfullyStoppedContainers

@Private
@Unstable
public abstract void setSuccessfullyStoppedContainers(java.util.List<ContainerId> succeededRequests)

Set the list of containerIds of successfully stopped containers.

Parameters:

succeededRequests - the list of containerIds of successfully stopped containers.

getFailedRequests

@Public
@Stable
public abstract java.util.Map<ContainerId,SerializedException> getFailedRequests()

Get the containerId-to-exception map in which the exception indicates error from per container for failed requests.

Returns:

map of containerId-to-exception.

setFailedRequests

@Private
@Unstable
public abstract void setFailedRequests(java.util.Map<ContainerId,SerializedException> failedRequests)

Set the containerId-to-exception map in which the exception indicates error from per container for failed requests.

Parameters:

failedRequests - map of containerId-to-exception.