org.apache.flink.runtime.io.network.partition

Enum ResultPartitionType

java.lang.Object

java.lang.Enum<ResultPartitionType>

org.apache.flink.runtime.io.network.partition.ResultPartitionType

All Implemented Interfaces:

Serializable, Comparable<ResultPartitionType>

public enum ResultPartitionType
extends Enum<ResultPartitionType>

Enum Constant Summary

Enum Constants

Enum Constant and Description
BLOCKING
PIPELINED
PIPELINED_BOUNDED Pipelined partitions with a bounded (local) buffer pool.
PIPELINED_CREDIT_BASED Pipelined partitions with a bounded (local) buffer pool for floating buffers in input gate, and a number of exclusive buffers per input channel.

Method Summary

Modifier and Type	Method and Description
boolean	hasBackPressure()
boolean	isBlocking()
boolean	isBounded() Whether this partition uses a limited number of (network) buffers or not.
boolean	isCreditBased() Whether this partition uses the credit-based mode to transfer data or not.
boolean	isPipelined()
static ResultPartitionType	valueOf(String name) Returns the enum constant of this type with the specified name.
static ResultPartitionType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

BLOCKING

public static final ResultPartitionType BLOCKING

PIPELINED

public static final ResultPartitionType PIPELINED

PIPELINED_BOUNDED

public static final ResultPartitionType PIPELINED_BOUNDED

Pipelined partitions with a bounded (local) buffer pool. For streaming jobs, a fixed limit on the buffer pool size should help avoid that too much data is being buffered and checkpoint barriers are delayed. In contrast to limiting the overall network buffer pool size, this, however, still allows to be flexible with regards to the total number of partitions by selecting an appropriately big network buffer pool size. For batch jobs, it will be best to keep this unlimited (PIPELINED) since there are no checkpoint barriers.

PIPELINED_CREDIT_BASED

public static final ResultPartitionType PIPELINED_CREDIT_BASED

Pipelined partitions with a bounded (local) buffer pool for floating buffers in input gate, and a number of exclusive buffers per input channel. The producer transfers data based on consumer's available credits.

Method Detail

values

public static ResultPartitionType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ResultPartitionType c : ResultPartitionType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ResultPartitionType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

hasBackPressure

public boolean hasBackPressure()

isBlocking

public boolean isBlocking()

isPipelined

public boolean isPipelined()

isBounded

public boolean isBounded()

Whether this partition uses a limited number of (network) buffers or not.

Returns:

true if the number of buffers should be bound to some limit

isCreditBased

public boolean isCreditBased()

Whether this partition uses the credit-based mode to transfer data or not.

Returns:

true if the data is transferred based on consumer's credit