org.apache.flink.api.common.resources

Class Resource

java.lang.Object

org.apache.flink.api.common.resources.Resource

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

CPUResource, GPUResource

@Internal
public abstract class Resource
extends Object
implements Serializable

Base class for resources one can specify.

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Resource(String name, BigDecimal value)
protected	Resource(String name, double value)

Method Summary

Modifier and Type	Method and Description
protected abstract Resource	create(BigDecimal value) Create a new instance of the sub resource.
Resource	divide(BigDecimal by)
Resource	divide(int by)
boolean	equals(Object o)
String	getName()
BigDecimal	getValue()
int	hashCode()
Resource	merge(Resource other)
Resource	multiply(BigDecimal multiplier)
Resource	multiply(int multiplier)
Resource	subtract(Resource other)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Resource

protected Resource(String name,
                   double value)

Resource

protected Resource(String name,
                   BigDecimal value)

Method Detail

merge

public Resource merge(Resource other)

subtract

public Resource subtract(Resource other)

multiply

public Resource multiply(BigDecimal multiplier)

multiply

public Resource multiply(int multiplier)

divide

public Resource divide(BigDecimal by)

divide

public Resource divide(int by)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

getName

public String getName()

getValue

public BigDecimal getValue()

create

protected abstract Resource create(BigDecimal value)

Create a new instance of the sub resource.

Parameters:

value - The value of the resource

Returns:

A new instance of the sub resource