org.apache.hadoop.yarn.api.records
Class ApplicationResourceUsageReport

java.lang.Object
  org.apache.hadoop.yarn.api.records.ApplicationResourceUsageReport

@InterfaceAudience.Public
@InterfaceStability.Stable
public abstract class ApplicationResourceUsageReport
extends Object

Contains various scheduling metrics to be reported by UI and CLI.

Constructor Summary

ApplicationResourceUsageReport()

Method Summary

abstract Resource	getNeededResources() Get the needed Resource
abstract int	getNumReservedContainers() Get the number of reserved containers
abstract int	getNumUsedContainers() Get the number of used containers
abstract Resource	getReservedResources() Get the reserved Resource
abstract Resource	getUsedResources() Get the used Resource
static ApplicationResourceUsageReport	newInstance(int numUsedContainers, int numReservedContainers, Resource usedResources, Resource reservedResources, Resource neededResources)
abstract void	setNeededResources(Resource needed_resources)
abstract void	setNumReservedContainers(int num_reserved_containers) Set the number of reserved containers
abstract void	setNumUsedContainers(int num_containers) Set the number of used containers
abstract void	setReservedResources(Resource reserved_resources)
abstract void	setUsedResources(Resource resources)

Methods inherited from class java.lang.Object

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

Constructor Detail

ApplicationResourceUsageReport

public ApplicationResourceUsageReport()

Method Detail

newInstance

@InterfaceAudience.Private
@InterfaceStability.Unstable
public static ApplicationResourceUsageReport newInstance(int numUsedContainers,
                                                                                                               int numReservedContainers,
                                                                                                               Resource usedResources,
                                                                                                               Resource reservedResources,
                                                                                                               Resource neededResources)

getNumUsedContainers

@InterfaceAudience.Public
@InterfaceStability.Stable
public abstract int getNumUsedContainers()

Get the number of used containers

Returns:

the number of used containers

setNumUsedContainers

@InterfaceAudience.Private
@InterfaceStability.Unstable
public abstract void setNumUsedContainers(int num_containers)

Set the number of used containers

Parameters:

num_containers - the number of used containers

getNumReservedContainers

@InterfaceAudience.Private
@InterfaceStability.Unstable
public abstract int getNumReservedContainers()

Get the number of reserved containers

Returns:

the number of reserved containers

setNumReservedContainers

@InterfaceAudience.Private
@InterfaceStability.Unstable
public abstract void setNumReservedContainers(int num_reserved_containers)

Set the number of reserved containers

Parameters:

num_reserved_containers - the number of reserved containers

getUsedResources

@InterfaceAudience.Public
@InterfaceStability.Stable
public abstract Resource getUsedResources()

Get the used Resource

Returns:

the used Resource

setUsedResources

@InterfaceAudience.Private
@InterfaceStability.Unstable
public abstract void setUsedResources(Resource resources)

getReservedResources

@InterfaceAudience.Public
@InterfaceStability.Stable
public abstract Resource getReservedResources()

Get the reserved Resource

Returns:

the reserved Resource

setReservedResources

@InterfaceAudience.Private
@InterfaceStability.Unstable
public abstract void setReservedResources(Resource reserved_resources)

getNeededResources

@InterfaceAudience.Public
@InterfaceStability.Stable
public abstract Resource getNeededResources()

Get the needed Resource

Returns:

the needed Resource

setNeededResources

@InterfaceAudience.Private
@InterfaceStability.Unstable
public abstract void setNeededResources(Resource needed_resources)