org.apache.hadoop.yarn.api.records.impl.pb

Class ResourceRequestPBImpl

java.lang.Object

org.apache.hadoop.yarn.api.records.ResourceRequest

org.apache.hadoop.yarn.api.records.impl.pb.ResourceRequestPBImpl

All Implemented Interfaces:

Comparable<ResourceRequest>

@InterfaceAudience.Private
@InterfaceStability.Unstable
public class ResourceRequestPBImpl
extends ResourceRequest

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.hadoop.yarn.api.records.ResourceRequest

ResourceRequest.ResourceRequestComparator

Field Summary

Fields inherited from class org.apache.hadoop.yarn.api.records.ResourceRequest

ANY

Constructor Summary

Constructors

Constructor and Description
ResourceRequestPBImpl()
ResourceRequestPBImpl(YarnProtos.ResourceRequestProto proto)

Method Summary

Methods

Modifier and Type	Method and Description
Resource	getCapability() Get the Resource capability of the request.
int	getNumContainers() Get the number of containers required with the given specifications.
Priority	getPriority() Get the Priority of the request.
YarnProtos.ResourceRequestProto	getProto()
boolean	getRelaxLocality() Get whether locality relaxation is enabled with this ResourceRequest.
String	getResourceName() Get the resource (e.g.
void	setCapability(Resource capability) Set the Resource capability of the request
void	setNumContainers(int numContainers) Set the number of containers required with the given specifications
void	setPriority(Priority priority) Set the Priority of the request
void	setRelaxLocality(boolean relaxLocality) For a request at a network hierarchy level, set whether locality can be relaxed to that level and beyond.
void	setResourceName(String resourceName) Set the resource name (e.g.
String	toString()

Methods inherited from class org.apache.hadoop.yarn.api.records.ResourceRequest

compareTo, equals, hashCode, isAnyLocation, newInstance, newInstance

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ResourceRequestPBImpl

public ResourceRequestPBImpl()

ResourceRequestPBImpl

public ResourceRequestPBImpl(YarnProtos.ResourceRequestProto proto)

Method Detail

getProto

public YarnProtos.ResourceRequestProto getProto()

getPriority

public Priority getPriority()

Description copied from class: ResourceRequest

Get the Priority of the request.

Specified by:

getPriority in class ResourceRequest

Returns:

Priority of the request

setPriority

public void setPriority(Priority priority)

Description copied from class: ResourceRequest

Set the Priority of the request

Specified by:

setPriority in class ResourceRequest

Parameters:

priority - Priority of the request

getResourceName

public String getResourceName()

Description copied from class: ResourceRequest

Get the resource (e.g. host/rack) on which the allocation is desired. A special value of * signifies that any resource (host/rack) is acceptable.

Specified by:

getResourceName in class ResourceRequest

Returns:

resource (e.g. host/rack) on which the allocation is desired

setResourceName

public void setResourceName(String resourceName)

Description copied from class: ResourceRequest

Set the resource name (e.g. host/rack) on which the allocation is desired. A special value of * signifies that any resource name (e.g. host/rack) is acceptable.

Specified by:

setResourceName in class ResourceRequest

Parameters:

resourceName - (e.g. host/rack) on which the allocation is desired

getCapability

public Resource getCapability()

Description copied from class: ResourceRequest

Get the Resource capability of the request.

Specified by:

getCapability in class ResourceRequest

Returns:

Resource capability of the request

setCapability

public void setCapability(Resource capability)

Description copied from class: ResourceRequest

Set the Resource capability of the request

Specified by:

setCapability in class ResourceRequest

Parameters:

capability - Resource capability of the request

getNumContainers

public int getNumContainers()

Description copied from class: ResourceRequest

Get the number of containers required with the given specifications.

Specified by:

getNumContainers in class ResourceRequest

Returns:

number of containers required with the given specifications

setNumContainers

public void setNumContainers(int numContainers)

Description copied from class: ResourceRequest

Set the number of containers required with the given specifications

Specified by:

setNumContainers in class ResourceRequest

Parameters:

numContainers - number of containers required with the given specifications

getRelaxLocality

public boolean getRelaxLocality()

Description copied from class: ResourceRequest

Get whether locality relaxation is enabled with this ResourceRequest. Defaults to true.

Specified by:

getRelaxLocality in class ResourceRequest

Returns:

whether locality relaxation is enabled with this ResourceRequest.

setRelaxLocality

public void setRelaxLocality(boolean relaxLocality)

Description copied from class: ResourceRequest

For a request at a network hierarchy level, set whether locality can be relaxed to that level and beyond.

If the flag is off on a rack-level ResourceRequest, containers at that request's priority will not be assigned to nodes on that request's rack unless requests specifically for those nodes have also been submitted.

If the flag is off on an ResourceRequest.ANY-level ResourceRequest, containers at that request's priority will only be assigned on racks for which specific requests have also been submitted.

For example, to request a container strictly on a specific node, the corresponding rack-level and any-level requests should have locality relaxation set to false. Similarly, to request a container strictly on a specific rack, the corresponding any-level request should have locality relaxation set to false.

Specified by:

setRelaxLocality in class ResourceRequest

Parameters:

relaxLocality - whether locality relaxation is enabled with this ResourceRequest.

toString

public String toString()

Overrides:

toString in class Object