Package org.apache.hadoop.yarn.api.records

Class ResourceInformation

java.lang.Object

org.apache.hadoop.yarn.api.records.ResourceInformation

All Implemented Interfaces:

java.lang.Comparable<ResourceInformation>

public class ResourceInformation
extends java.lang.Object
implements java.lang.Comparable<ResourceInformation>

Class to encapsulate information about a Resource - the name of the resource, the units(milli, micro, etc), the type(countable), and the value.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	DISKS_URI
static java.lang.String	FPGA_URI
static ResourceInformation	FPGAS
static java.lang.String	GPU_URI
static ResourceInformation	GPUS
static ResourceInformation	MEMORY_MB
static java.lang.String	MEMORY_URI
static java.util.Map<java.lang.String,ResourceInformation>	SPECIAL_RESOURCES	Special resources that should be treated separately from arbitrary resource types.
static ResourceInformation	VCORES
static java.lang.String	VCORES_URI

Constructor Summary

Constructors

Constructor	Description
ResourceInformation()

Method Summary

Modifier and Type	Method	Description
int	compareTo(ResourceInformation other)
static void	copy(ResourceInformation src, ResourceInformation dst)	Copies the content of the source ResourceInformation object to the destination object, overwriting all properties of the destination object.
boolean	equals(java.lang.Object obj)
java.util.Map<java.lang.String,java.lang.String>	getAttributes()	Get the attributes of the resource.
long	getMaximumAllocation()	Get the maximum allocation for the resource.
long	getMinimumAllocation()	Get the minimum allocation for the resource.
java.lang.String	getName()	Get the name for the resource.
ResourceTypes	getResourceType()	Get the resource type.
java.lang.String	getShorthandRepresentation()
java.util.Set<java.lang.String>	getTags()	Get resource tags.
java.lang.String	getUnits()	Get units for the resource.
long	getValue()	Get the value for the resource.
int	hashCode()
static ResourceInformation	newInstance(java.lang.String name)
static ResourceInformation	newInstance(java.lang.String name, long value)
static ResourceInformation	newInstance(java.lang.String name, java.lang.String units)
static ResourceInformation	newInstance(java.lang.String name, java.lang.String units, long value)
static ResourceInformation	newInstance(java.lang.String name, java.lang.String units, long minRes, long maxRes)
static ResourceInformation	newInstance(java.lang.String name, java.lang.String units, long value, java.util.Set<java.lang.String> tags, java.util.Map<java.lang.String,java.lang.String> attributes)
static ResourceInformation	newInstance(java.lang.String name, java.lang.String units, long value, ResourceTypes type, long minimumAllocation, long maximumAllocation)
static ResourceInformation	newInstance(java.lang.String name, java.lang.String units, long value, ResourceTypes type, long minimumAllocation, long maximumAllocation, java.util.Set<java.lang.String> tags, java.util.Map<java.lang.String,java.lang.String> attributes)
static ResourceInformation	newInstance(java.lang.String name, java.lang.String units, ResourceTypes resourceType)
static ResourceInformation	newInstance(ResourceInformation other)	Create a new instance of ResourceInformation from another object.
void	setAttributes(java.util.Map<java.lang.String,java.lang.String> attributes)	Set a map of attributes to the resource.
void	setMaximumAllocation(long maximumAllocation)	Set the maximum allocation for the resource.
void	setMinimumAllocation(long minimumAllocation)	Set the minimum allocation for the resource.
void	setName(java.lang.String rName)	Set the name for the resource.
void	setResourceType(ResourceTypes type)	Set the resource type.
void	setTags(java.util.Set<java.lang.String> tags)	Add tags to the resource.
void	setUnits(java.lang.String rUnits)	Set the units for the resource.
void	setUnitsWithoutValidation(java.lang.String rUnits)	Checking if a unit included by KNOWN_UNITS is an expensive operation.
void	setValue(long rValue)	Set the value for the resource.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

MEMORY_URI

public static final java.lang.String MEMORY_URI

See Also:

Constant Field Values

VCORES_URI

public static final java.lang.String VCORES_URI

See Also:

Constant Field Values

DISKS_URI

public static final java.lang.String DISKS_URI

See Also:

Constant Field Values

GPU_URI

public static final java.lang.String GPU_URI

See Also:

Constant Field Values

FPGA_URI

public static final java.lang.String FPGA_URI

See Also:

Constant Field Values

MEMORY_MB

public static final ResourceInformation MEMORY_MB

VCORES

public static final ResourceInformation VCORES

GPUS

public static final ResourceInformation GPUS

FPGAS

public static final ResourceInformation FPGAS

SPECIAL_RESOURCES

public static final java.util.Map<java.lang.String,ResourceInformation> SPECIAL_RESOURCES

Special resources that should be treated separately from arbitrary resource types.

Constructor Detail

ResourceInformation

public ResourceInformation()

Method Detail

getName

public java.lang.String getName()

Get the name for the resource.

Returns:

resource name

setName

public void setName(java.lang.String rName)

Set the name for the resource. A valid resource name must begin with a letter and contain only letters, numbers, and any of: '.', '_', or '-'. A valid resource name may also be optionally preceded by a name space followed by a slash. A valid name space consists of period-separated groups of letters, numbers, and dashes."

Parameters:

rName - name for the resource

getUnits

public java.lang.String getUnits()

Get units for the resource.

Returns:

units for the resource

setUnits

public void setUnits(java.lang.String rUnits)

Set the units for the resource.

Parameters:

rUnits - units for the resource

setUnitsWithoutValidation

@Private
public void setUnitsWithoutValidation(java.lang.String rUnits)

Checking if a unit included by KNOWN_UNITS is an expensive operation. This can be avoided in critical path in RM.

Parameters:

rUnits - units for the resource

getResourceType

public ResourceTypes getResourceType()

Get the resource type.

Returns:

the resource type

setResourceType

public void setResourceType(ResourceTypes type)

Set the resource type.

Parameters:

type - the resource type

getValue

public long getValue()

Get the value for the resource.

Returns:

the resource value

setValue

public void setValue(long rValue)

Set the value for the resource.

Parameters:

rValue - the resource value

getMinimumAllocation

public long getMinimumAllocation()

Get the minimum allocation for the resource.

Returns:

the minimum allocation for the resource

setMinimumAllocation

public void setMinimumAllocation(long minimumAllocation)

Set the minimum allocation for the resource.

Parameters:

minimumAllocation - the minimum allocation for the resource

getMaximumAllocation

public long getMaximumAllocation()

Get the maximum allocation for the resource.

Returns:

the maximum allocation for the resource

setMaximumAllocation

public void setMaximumAllocation(long maximumAllocation)

Set the maximum allocation for the resource.

Parameters:

maximumAllocation - the maximum allocation for the resource

getAttributes

public java.util.Map<java.lang.String,java.lang.String> getAttributes()

Get the attributes of the resource.

Returns:

resource attributes

setAttributes

public void setAttributes(java.util.Map<java.lang.String,java.lang.String> attributes)

Set a map of attributes to the resource.

Parameters:

attributes - resource attributes

getTags

public java.util.Set<java.lang.String> getTags()

Get resource tags.

Returns:

resource tags

setTags

public void setTags(java.util.Set<java.lang.String> tags)

Add tags to the resource.

Parameters:

tags - resource tags

newInstance

public static ResourceInformation newInstance(ResourceInformation other)

Create a new instance of ResourceInformation from another object.

Parameters:

other - the object from which the new object should be created

Returns:

the new ResourceInformation object

newInstance

public static ResourceInformation newInstance(java.lang.String name,
                                              java.lang.String units,
                                              long value,
                                              ResourceTypes type,
                                              long minimumAllocation,
                                              long maximumAllocation)

newInstance

public static ResourceInformation newInstance(java.lang.String name,
                                              java.lang.String units,
                                              long value,
                                              ResourceTypes type,
                                              long minimumAllocation,
                                              long maximumAllocation,
                                              java.util.Set<java.lang.String> tags,
                                              java.util.Map<java.lang.String,java.lang.String> attributes)

newInstance

public static ResourceInformation newInstance(java.lang.String name,
                                              java.lang.String units,
                                              long value)

newInstance

public static ResourceInformation newInstance(java.lang.String name,
                                              java.lang.String units)

newInstance

public static ResourceInformation newInstance(java.lang.String name,
                                              java.lang.String units,
                                              long value,
                                              java.util.Set<java.lang.String> tags,
                                              java.util.Map<java.lang.String,java.lang.String> attributes)

newInstance

public static ResourceInformation newInstance(java.lang.String name,
                                              java.lang.String units,
                                              ResourceTypes resourceType)

newInstance

public static ResourceInformation newInstance(java.lang.String name,
                                              java.lang.String units,
                                              long minRes,
                                              long maxRes)

newInstance

public static ResourceInformation newInstance(java.lang.String name,
                                              long value)

newInstance

public static ResourceInformation newInstance(java.lang.String name)

copy

public static void copy(ResourceInformation src,
                        ResourceInformation dst)

Copies the content of the source ResourceInformation object to the destination object, overwriting all properties of the destination object.

Parameters:

src - Source ResourceInformation object

dst - Destination ResourceInformation object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getShorthandRepresentation

public java.lang.String getShorthandRepresentation()

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

compareTo

public int compareTo(ResourceInformation other)

Specified by:

compareTo in interface java.lang.Comparable<ResourceInformation>