org.apache.gobblin.util.request_allocation

Class ResourcePool

java.lang.Object

org.apache.gobblin.util.request_allocation.ResourcePool

public class ResourcePool
extends Object

Represents a pool of available resources for a RequestAllocator. The resources pool is essentially a vector of doubles where each dimension represents a resource. A set of resource requests exceeds the availability of the pool if the vector sum of those requests is larger than the vector of resources in the pool along any dimension.

Field Summary

Fields

Modifier and Type	Field and Description
static double	DEFAULT_DIMENSION_TOLERANCE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ResourcePool(Map<String,Double> maxResources, Map<String,Double> tolerances, Map<String,Double> defaultRequirements)
protected	ResourcePool(ResourcePool other)

Method Summary

Modifier and Type	Method and Description
protected ResourcePool	contractPool(ResourceRequirement requirement)
boolean	exceedsHardBound(ResourceRequirement requirement, boolean orEqual)
boolean	exceedsSoftBound(ResourceRequirement requirement, boolean orEqual)
ResourceRequirement.Builder	getResourceRequirementBuilder() Use to create a ResourceRequirement compatible with this ResourcePool.
String	stringifyRequirement(ResourceRequirement requirement) Stringify a ResourceRequirement with the appropriate dimension labels.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_DIMENSION_TOLERANCE

public static final double DEFAULT_DIMENSION_TOLERANCE

See Also:

Constant Field Values

Constructor Detail

ResourcePool

protected ResourcePool(Map<String,Double> maxResources,
                       Map<String,Double> tolerances,
                       Map<String,Double> defaultRequirements)

Parameters:

maxResources - Maximum resource availability along each dimension. Each entry in this map is a dimension. Note this is considered a soft bound (e.g. max resources may be exceeded by a tolerance).

tolerances - The hard limit on resources availability along each dimension is set to maxResource * tolerance. The default tolerance is DEFAULT_DIMENSION_TOLERANCE. It is recommended to always have a tolerance >1, as some RequestAllocators will do unnecessary work if the soft and hard bounds are too close to each other.

defaultRequirements - Specifies the default usage of the resources along each dimension when creating a ResourceRequirement. Default is 0.

ResourcePool

protected ResourcePool(ResourcePool other)

Method Detail

toString

public String toString()

Overrides:

toString in class Object

stringifyRequirement

public String stringifyRequirement(ResourceRequirement requirement)

Stringify a ResourceRequirement with the appropriate dimension labels.

exceedsSoftBound

public boolean exceedsSoftBound(ResourceRequirement requirement,
                                boolean orEqual)

Returns:

true if input ResourceRequirement exceeds the soft bound long any dimension. If the parameter orEqual is true, then matching along any dimension will also return true.

exceedsHardBound

public boolean exceedsHardBound(ResourceRequirement requirement,
                                boolean orEqual)

Returns:

true if input ResourceRequirement exceeds the hard bound long any dimension. If the parameter orEqual is true, then matching along any dimension will also return true.

getResourceRequirementBuilder

public ResourceRequirement.Builder getResourceRequirementBuilder()

Use to create a ResourceRequirement compatible with this ResourcePool.

contractPool

protected ResourcePool contractPool(ResourceRequirement requirement)

Returns:

a new ResourcePool which is a copy of this ResourcePool except its resource vector has been reduced by the input ResourceRequirement.