Package org.apache.hadoop.yarn.server.scheduler

Class ResourceRequestSet

java.lang.Object

org.apache.hadoop.yarn.server.scheduler.ResourceRequestSet

public class ResourceRequestSet
extends java.lang.Object

A set of resource requests of the same scheduler key ResourceRequestSetKey.

Constructor Summary

Constructors

Constructor	Description
ResourceRequestSet(ResourceRequestSet other)	Create a shallow copy of the request set.
ResourceRequestSet(ResourceRequestSetKey key)	Create a empty set with given key.

Method Summary

Modifier and Type	Method	Description
void	addAndOverrideRR(org.apache.hadoop.yarn.api.records.ResourceRequest ask)	Add a ResourceRequest into the requestSet.
void	addAndOverrideRRSet(ResourceRequestSet requestSet)	Merge a requestSet into this one.
void	cleanupZeroNonAnyRR()	Remove all non-Any ResourceRequests from the set.
java.util.Map<java.lang.String,org.apache.hadoop.yarn.api.records.ResourceRequest>	getAsks()
int	getNumContainers()
java.util.Collection<org.apache.hadoop.yarn.api.records.ResourceRequest>	getRRs()
boolean	isANYRelaxable()	Whether the request set is relaxable at ANY level.
void	setNumContainers(int newValue)	Force set the # of containers to ask for this requestSet to a given value.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourceRequestSet

public ResourceRequestSet(ResourceRequestSetKey key)
                   throws org.apache.hadoop.yarn.exceptions.YarnException

Create a empty set with given key.

Parameters:

key - the key of the request set

Throws:

org.apache.hadoop.yarn.exceptions.YarnException - if fails

ResourceRequestSet

public ResourceRequestSet(ResourceRequestSet other)

Create a shallow copy of the request set.

Parameters:

other - the set of copy from

Method Detail

addAndOverrideRR

public void addAndOverrideRR(org.apache.hadoop.yarn.api.records.ResourceRequest ask)
                      throws org.apache.hadoop.yarn.exceptions.YarnException

Add a ResourceRequest into the requestSet. If there's already an RR with the same resource name, override it and update accordingly.

Parameters:

ask - the new ResourceRequest

Throws:

org.apache.hadoop.yarn.exceptions.YarnException - indicates exceptions from yarn servers.

addAndOverrideRRSet

public void addAndOverrideRRSet(ResourceRequestSet requestSet)
                         throws org.apache.hadoop.yarn.exceptions.YarnException

Merge a requestSet into this one.

Parameters:

requestSet - the requestSet to merge

Throws:

org.apache.hadoop.yarn.exceptions.YarnException - indicates exceptions from yarn servers.

cleanupZeroNonAnyRR

public void cleanupZeroNonAnyRR()

Remove all non-Any ResourceRequests from the set. This is necessary cleanup to avoid requestSet getting too big.

getAsks

public java.util.Map<java.lang.String,org.apache.hadoop.yarn.api.records.ResourceRequest> getAsks()

getRRs

public java.util.Collection<org.apache.hadoop.yarn.api.records.ResourceRequest> getRRs()

getNumContainers

public int getNumContainers()

setNumContainers

public void setNumContainers(int newValue)
                      throws org.apache.hadoop.yarn.exceptions.YarnException

Force set the # of containers to ask for this requestSet to a given value.

Parameters:

newValue - the new # of containers value

Throws:

org.apache.hadoop.yarn.exceptions.YarnException - indicates exceptions from yarn servers.

isANYRelaxable

public boolean isANYRelaxable()

Whether the request set is relaxable at ANY level.

Returns:

whether the request set is relaxable at ANY level

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object