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

Class UpdateNodeResourceRequest

java.lang.Object

org.apache.hadoop.yarn.server.api.protocolrecords.UpdateNodeResourceRequest

@Public
@Evolving
public abstract class UpdateNodeResourceRequest
extends java.lang.Object

The request sent by admin to change a list of nodes' resource to the ResourceManager.

The request contains details such as a map from NodeId to ResourceOption for updating the RMNodes' resources in ResourceManager.

See Also:

ResourceManagerAdministrationProtocol.updateNodeResource( UpdateNodeResourceRequest)

Constructor Summary

Constructors

Constructor	Description
UpdateNodeResourceRequest()

Method Summary

Modifier and Type	Method	Description
abstract java.util.Map<NodeId,ResourceOption>	getNodeResourceMap()	Get the map from NodeId to ResourceOption.
abstract java.lang.String	getSubClusterId()	Get the subClusterId.
static UpdateNodeResourceRequest	newInstance(java.util.Map<NodeId,ResourceOption> nodeResourceMap)
static UpdateNodeResourceRequest	newInstance(java.util.Map<NodeId,ResourceOption> nodeResourceMap, java.lang.String subClusterId)
abstract void	setNodeResourceMap(java.util.Map<NodeId,ResourceOption> nodeResourceMap)	Set the map from NodeId to ResourceOption.
abstract void	setSubClusterId(java.lang.String subClusterId)	Set the subClusterId.

Methods inherited from class java.lang.Object

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

Constructor Detail

UpdateNodeResourceRequest

public UpdateNodeResourceRequest()

Method Detail

newInstance

@Public
@Evolving
public static UpdateNodeResourceRequest newInstance(java.util.Map<NodeId,ResourceOption> nodeResourceMap)

newInstance

@Public
@Evolving
public static UpdateNodeResourceRequest newInstance(java.util.Map<NodeId,ResourceOption> nodeResourceMap,
                                                    java.lang.String subClusterId)

getNodeResourceMap

@Public
@Evolving
public abstract java.util.Map<NodeId,ResourceOption> getNodeResourceMap()

Get the map from NodeId to ResourceOption.

Returns:

the map of <NodeId, ResourceOption>

setNodeResourceMap

@Public
@Evolving
public abstract void setNodeResourceMap(java.util.Map<NodeId,ResourceOption> nodeResourceMap)

Set the map from NodeId to ResourceOption.

Parameters:

nodeResourceMap - the map of <NodeId, ResourceOption>

getSubClusterId

@Public
@Evolving
public abstract java.lang.String getSubClusterId()

Get the subClusterId.

Returns:

subClusterId.

setSubClusterId

@Public
@Evolving
public abstract void setSubClusterId(java.lang.String subClusterId)

Set the subClusterId.

Parameters:

subClusterId - subCluster Id.