org.apache.flink.api.common.operators

Class ResourceSpec

java.lang.Object

org.apache.flink.api.common.operators.ResourceSpec

All Implemented Interfaces:

Serializable

@Internal
public class ResourceSpec
extends Object
implements Serializable

Describe the different resource factors of the operator with UDF.

The state backend provides the method to estimate memory usages based on state size in the resource.

Resource provides merge(ResourceSpec) method for chained operators when generating job graph.

Resource provides lessThanOrEqual(ResourceSpec) method to compare these fields in sequence:

1. CPU cores
2. Heap Memory Size
3. Direct Memory Size
4. Native Memory Size
5. State Size
6. Extended resources

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ResourceSpec.Builder Builder for the ResourceSpec.

Field Summary

Fields

Modifier and Type	Field and Description
static ResourceSpec	DEFAULT
static String	GPU_NAME

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ResourceSpec(double cpuCores, int heapMemoryInMB, int directMemoryInMB, int nativeMemoryInMB, int stateSizeInMB, Resource... extendedResources) Creates a new ResourceSpec with full resources.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
double	getCpuCores()
int	getDirectMemory()
Map<String,Resource>	getExtendedResources()
double	getGPUResource()
int	getHeapMemory()
int	getNativeMemory()
int	getStateSize()
int	hashCode()
boolean	isValid() Check whether all the field values are valid.
boolean	lessThanOrEqual(ResourceSpec other) Checks the current resource less than or equal with the other resource by comparing all the fields in the resource.
ResourceSpec	merge(ResourceSpec other) Used by system internally to merge the other resources of chained operators when generating the job graph or merge the resource consumed by state backend.
static ResourceSpec.Builder	newBuilder()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT

public static final ResourceSpec DEFAULT

GPU_NAME

public static final String GPU_NAME

See Also:

Constant Field Values

Constructor Detail

ResourceSpec

protected ResourceSpec(double cpuCores,
                       int heapMemoryInMB,
                       int directMemoryInMB,
                       int nativeMemoryInMB,
                       int stateSizeInMB,
                       Resource... extendedResources)

Creates a new ResourceSpec with full resources.

Parameters:

cpuCores - The number of CPU cores (possibly fractional, i.e., 0.2 cores)

heapMemoryInMB - The size of the java heap memory, in megabytes.

directMemoryInMB - The size of the java nio direct memory, in megabytes.

nativeMemoryInMB - The size of the native memory, in megabytes.

stateSizeInMB - The state size for storing in checkpoint.

extendedResources - The extended resources, associated with the resource manager used

Method Detail

merge

public ResourceSpec merge(ResourceSpec other)

Used by system internally to merge the other resources of chained operators when generating the job graph or merge the resource consumed by state backend.

Parameters:

other - Reference to resource to merge in.

Returns:

The new resource with merged values.

getCpuCores

public double getCpuCores()

getHeapMemory

public int getHeapMemory()

getDirectMemory

public int getDirectMemory()

getNativeMemory

public int getNativeMemory()

getStateSize

public int getStateSize()

getGPUResource

public double getGPUResource()

getExtendedResources

public Map<String,Resource> getExtendedResources()

isValid

public boolean isValid()

Check whether all the field values are valid.

Returns:

True if all the values are equal or greater than 0, otherwise false.

lessThanOrEqual

public boolean lessThanOrEqual(@Nonnull
                               ResourceSpec other)

Checks the current resource less than or equal with the other resource by comparing all the fields in the resource.

Parameters:

other - The resource to compare

Returns:

True if current resource is less than or equal with the other resource, otherwise return false.

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

newBuilder

public static ResourceSpec.Builder newBuilder()