Package org.apache.flink.runtime.taskexecutor

Class TaskExecutorMemoryConfiguration

java.lang.Object

org.apache.flink.runtime.taskexecutor.TaskExecutorMemoryConfiguration

All Implemented Interfaces:

Serializable

public class TaskExecutorMemoryConfiguration
extends Object
implements Serializable

TaskExecutorConfiguration collects the configuration of a TaskExecutor instance.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static String	FIELD_NAME_FRAMEWORK_HEAP
static String	FIELD_NAME_FRAMEWORK_OFFHEAP
static String	FIELD_NAME_JVM_METASPACE
static String	FIELD_NAME_JVM_OVERHEAD
static String	FIELD_NAME_MANAGED_MEMORY
static String	FIELD_NAME_NETWORK_MEMORY
static String	FIELD_NAME_TASK_HEAP
static String	FIELD_NAME_TASK_OFFHEAP
static String	FIELD_NAME_TOTAL_FLINK_MEMORY
static String	FIELD_NAME_TOTAL_PROCESS_MEMORY

Constructor Summary

Constructors

Constructor	Description
TaskExecutorMemoryConfiguration(Long frameworkHeap, Long taskHeap, Long frameworkOffHeap, Long taskOffHeap, Long networkMemory, Long managedMemoryTotal, Long jvmMetaspace, Long jvmOverhead, Long totalFlinkMemory, Long totalProcessMemory)

Method Summary

Modifier and Type	Method	Description
static TaskExecutorMemoryConfiguration	create(Configuration config)	Factory method for initializing a TaskExecutorMemoryConfiguration based on the passed Configuration.
boolean	equals(Object o)
Long	getFrameworkHeap()	Returns the configured heap size used by the framework.
Long	getFrameworkOffHeap()	Returns the configured off-heap size used by the framework.
Long	getJvmMetaspace()	Returns the maximum Metaspace size allowed for the task manager.
Long	getJvmOverhead()	Returns the threshold for defining the maximum amount of memory used for the JVM overhead.
Long	getManagedMemoryTotal()	Returns the total amount of memory reserved for by the MemoryManager.
Long	getNetworkMemory()	Returns the configured maximum network memory.
Long	getTaskHeap()	Returns the configured heap size used by the tasks.
Long	getTaskOffHeap()	Returns the configured off-heap size used by the tasks.
Long	getTotalFlinkMemory()	Returns the amount of memory configured to be used by Flink excluding things like JVM Metaspace and other JVM overhead.
Long	getTotalProcessMemory()	Returns the total amount of memory configured to be used by the JVM including all the different memory pools.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

FIELD_NAME_FRAMEWORK_HEAP

public static final String FIELD_NAME_FRAMEWORK_HEAP

See Also:

Constant Field Values

FIELD_NAME_TASK_HEAP

public static final String FIELD_NAME_TASK_HEAP

See Also:

Constant Field Values

FIELD_NAME_FRAMEWORK_OFFHEAP

public static final String FIELD_NAME_FRAMEWORK_OFFHEAP

See Also:

Constant Field Values

FIELD_NAME_TASK_OFFHEAP

public static final String FIELD_NAME_TASK_OFFHEAP

See Also:

Constant Field Values

FIELD_NAME_NETWORK_MEMORY

public static final String FIELD_NAME_NETWORK_MEMORY

See Also:

Constant Field Values

FIELD_NAME_MANAGED_MEMORY

public static final String FIELD_NAME_MANAGED_MEMORY

See Also:

Constant Field Values

FIELD_NAME_JVM_METASPACE

public static final String FIELD_NAME_JVM_METASPACE

See Also:

Constant Field Values

FIELD_NAME_JVM_OVERHEAD

public static final String FIELD_NAME_JVM_OVERHEAD

See Also:

Constant Field Values

FIELD_NAME_TOTAL_FLINK_MEMORY

public static final String FIELD_NAME_TOTAL_FLINK_MEMORY

See Also:

Constant Field Values

FIELD_NAME_TOTAL_PROCESS_MEMORY

public static final String FIELD_NAME_TOTAL_PROCESS_MEMORY

See Also:

Constant Field Values

Constructor Detail

TaskExecutorMemoryConfiguration

public TaskExecutorMemoryConfiguration(Long frameworkHeap,
                                       Long taskHeap,
                                       Long frameworkOffHeap,
                                       Long taskOffHeap,
                                       Long networkMemory,
                                       Long managedMemoryTotal,
                                       Long jvmMetaspace,
                                       Long jvmOverhead,
                                       Long totalFlinkMemory,
                                       Long totalProcessMemory)

Method Detail

create

public static TaskExecutorMemoryConfiguration create(Configuration config)

Factory method for initializing a TaskExecutorMemoryConfiguration based on the passed Configuration.

Parameters:

config - The Configuration used for initializing the TaskExecutorMemoryConfiguration.

Returns:

The newly instantiated TaskExecutorMemoryConfiguration.

getFrameworkHeap

public Long getFrameworkHeap()

Returns the configured heap size used by the framework.

getTaskHeap

public Long getTaskHeap()

Returns the configured heap size used by the tasks.

getFrameworkOffHeap

public Long getFrameworkOffHeap()

Returns the configured off-heap size used by the framework.

getTaskOffHeap

public Long getTaskOffHeap()

Returns the configured off-heap size used by the tasks.

getNetworkMemory

public Long getNetworkMemory()

Returns the configured maximum network memory.

getManagedMemoryTotal

public Long getManagedMemoryTotal()

Returns the total amount of memory reserved for by the MemoryManager.

getJvmMetaspace

public Long getJvmMetaspace()

Returns the maximum Metaspace size allowed for the task manager.

getJvmOverhead

public Long getJvmOverhead()

Returns the threshold for defining the maximum amount of memory used for the JVM overhead.

getTotalFlinkMemory

public Long getTotalFlinkMemory()

Returns the amount of memory configured to be used by Flink excluding things like JVM Metaspace and other JVM overhead.

getTotalProcessMemory

public Long getTotalProcessMemory()

Returns the total amount of memory configured to be used by the JVM including all the different memory pools.

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