org.apache.flink.runtime.taskmanager

Class NettyShuffleEnvironmentConfiguration

java.lang.Object

org.apache.flink.runtime.taskmanager.NettyShuffleEnvironmentConfiguration

public class NettyShuffleEnvironmentConfiguration
extends Object

Configuration object for the network stack.

Constructor Summary

Constructors

Constructor and Description

NettyShuffleEnvironmentConfiguration(int numNetworkBuffers, int networkBufferSize, int partitionRequestInitialBackoff, int partitionRequestMaxBackoff, int networkBuffersPerChannel, int floatingNetworkBuffersPerGate, Optional<Integer> maxRequiredBuffersPerGate, java.time.Duration requestSegmentsTimeout, boolean isNetworkDetailedMetrics, NettyConfig nettyConfig, String[] tempDirs, BoundedBlockingSubpartitionType blockingSubpartitionType, boolean batchShuffleCompressionEnabled, String compressionCodec, int maxBuffersPerChannel, long batchShuffleReadMemoryBytes, int sortShuffleMinBuffers, int sortShuffleMinParallelism, BufferDebloatConfiguration debloatConfiguration, int maxNumberOfConnections, boolean connectionReuseEnabled, int maxOverdraftBuffersPerGate, int hybridShuffleSpilledIndexSegmentSize, long hybridShuffleNumRetainedInMemoryRegionsMax)

Method Summary

Modifier and Type	Method and Description
long	batchShuffleReadMemoryBytes()
boolean	equals(Object obj)
int	floatingNetworkBuffersPerGate()
static NettyShuffleEnvironmentConfiguration	fromConfiguration(Configuration configuration, MemorySize networkMemorySize, boolean localTaskManagerCommunication, InetAddress taskManagerAddress) Utility method to extract network related parameters from the configuration and to sanity check them.
BoundedBlockingSubpartitionType	getBlockingSubpartitionType()
String	getCompressionCodec()
BufferDebloatConfiguration	getDebloatConfiguration()
long	getHybridShuffleNumRetainedInMemoryRegionsMax()
int	getHybridShuffleSpilledIndexSegmentSize()
int	getMaxBuffersPerChannel()
int	getMaxNumberOfConnections()
int	getMaxOverdraftBuffersPerGate()
java.time.Duration	getRequestSegmentsTimeout()
String[]	getTempDirs()
int	hashCode()
boolean	isBatchShuffleCompressionEnabled()
boolean	isConnectionReuseEnabled()
boolean	isNetworkDetailedMetrics()
boolean	isSSLEnabled()
Optional<Integer>	maxRequiredBuffersPerGate()
NettyConfig	nettyConfig()
int	networkBufferSize()
int	networkBuffersPerChannel()
int	numNetworkBuffers()
int	partitionRequestInitialBackoff()
int	partitionRequestMaxBackoff()
int	sortShuffleMinBuffers()
int	sortShuffleMinParallelism()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

NettyShuffleEnvironmentConfiguration

public NettyShuffleEnvironmentConfiguration(int numNetworkBuffers,
                                            int networkBufferSize,
                                            int partitionRequestInitialBackoff,
                                            int partitionRequestMaxBackoff,
                                            int networkBuffersPerChannel,
                                            int floatingNetworkBuffersPerGate,
                                            Optional<Integer> maxRequiredBuffersPerGate,
                                            java.time.Duration requestSegmentsTimeout,
                                            boolean isNetworkDetailedMetrics,
                                            @Nullable
                                            NettyConfig nettyConfig,
                                            String[] tempDirs,
                                            BoundedBlockingSubpartitionType blockingSubpartitionType,
                                            boolean batchShuffleCompressionEnabled,
                                            String compressionCodec,
                                            int maxBuffersPerChannel,
                                            long batchShuffleReadMemoryBytes,
                                            int sortShuffleMinBuffers,
                                            int sortShuffleMinParallelism,
                                            BufferDebloatConfiguration debloatConfiguration,
                                            int maxNumberOfConnections,
                                            boolean connectionReuseEnabled,
                                            int maxOverdraftBuffersPerGate,
                                            int hybridShuffleSpilledIndexSegmentSize,
                                            long hybridShuffleNumRetainedInMemoryRegionsMax)

Method Detail

numNetworkBuffers

public int numNetworkBuffers()

networkBufferSize

public int networkBufferSize()

partitionRequestInitialBackoff

public int partitionRequestInitialBackoff()

partitionRequestMaxBackoff

public int partitionRequestMaxBackoff()

networkBuffersPerChannel

public int networkBuffersPerChannel()

floatingNetworkBuffersPerGate

public int floatingNetworkBuffersPerGate()

maxRequiredBuffersPerGate

public Optional<Integer> maxRequiredBuffersPerGate()

batchShuffleReadMemoryBytes

public long batchShuffleReadMemoryBytes()

sortShuffleMinBuffers

public int sortShuffleMinBuffers()

sortShuffleMinParallelism

public int sortShuffleMinParallelism()

getRequestSegmentsTimeout

public java.time.Duration getRequestSegmentsTimeout()

nettyConfig

public NettyConfig nettyConfig()

isNetworkDetailedMetrics

public boolean isNetworkDetailedMetrics()

getTempDirs

public String[] getTempDirs()

isConnectionReuseEnabled

public boolean isConnectionReuseEnabled()

getBlockingSubpartitionType

public BoundedBlockingSubpartitionType getBlockingSubpartitionType()

isBatchShuffleCompressionEnabled

public boolean isBatchShuffleCompressionEnabled()

getDebloatConfiguration

public BufferDebloatConfiguration getDebloatConfiguration()

isSSLEnabled

public boolean isSSLEnabled()

getCompressionCodec

public String getCompressionCodec()

getMaxBuffersPerChannel

public int getMaxBuffersPerChannel()

getMaxNumberOfConnections

public int getMaxNumberOfConnections()

getMaxOverdraftBuffersPerGate

public int getMaxOverdraftBuffersPerGate()

getHybridShuffleNumRetainedInMemoryRegionsMax

public long getHybridShuffleNumRetainedInMemoryRegionsMax()

getHybridShuffleSpilledIndexSegmentSize

public int getHybridShuffleSpilledIndexSegmentSize()

fromConfiguration

public static NettyShuffleEnvironmentConfiguration fromConfiguration(Configuration configuration,
                                                                     MemorySize networkMemorySize,
                                                                     boolean localTaskManagerCommunication,
                                                                     InetAddress taskManagerAddress)

Utility method to extract network related parameters from the configuration and to sanity check them.

Parameters:

configuration - configuration object

networkMemorySize - the size of memory reserved for shuffle environment

localTaskManagerCommunication - true, to skip initializing the network stack

taskManagerAddress - identifying the IP address under which the TaskManager will be accessible

Returns:

NettyShuffleEnvironmentConfiguration

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object