org.apache.nifi.controller.queue

Enum LoadBalanceStrategy

java.lang.Object

java.lang.Enum<LoadBalanceStrategy>

org.apache.nifi.controller.queue.LoadBalanceStrategy

All Implemented Interfaces:

Serializable, Comparable<LoadBalanceStrategy>

public enum LoadBalanceStrategy
extends Enum<LoadBalanceStrategy>

Enum Constant Summary

Enum Constants

Enum Constant and Description
DO_NOT_LOAD_BALANCE Do not load balance FlowFiles between nodes in the cluster.
PARTITION_BY_ATTRIBUTE Determine which node to send a given FlowFile to based on the value of a user-specified FlowFile Attribute.
ROUND_ROBIN FlowFiles will be distributed to nodes in the cluster in a Round-Robin fashion.
SINGLE_NODE All FlowFiles will be sent to the same node.

Method Summary

Modifier and Type	Method and Description
static LoadBalanceStrategy	valueOf(String name) Returns the enum constant of this type with the specified name.
static LoadBalanceStrategy[]	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

DO_NOT_LOAD_BALANCE

public static final LoadBalanceStrategy DO_NOT_LOAD_BALANCE

Do not load balance FlowFiles between nodes in the cluster.

PARTITION_BY_ATTRIBUTE

public static final LoadBalanceStrategy PARTITION_BY_ATTRIBUTE

Determine which node to send a given FlowFile to based on the value of a user-specified FlowFile Attribute. All FlowFiles that have the same value for said Attribute will be sent to the same node in the cluster.

ROUND_ROBIN

public static final LoadBalanceStrategy ROUND_ROBIN

FlowFiles will be distributed to nodes in the cluster in a Round-Robin fashion. However, if a node in the cluster is not able to receive data as fast as other nodes, that node may be skipped in one or more iterations in order to maximize throughput of data distribution across the cluster.

SINGLE_NODE

public static final LoadBalanceStrategy SINGLE_NODE

All FlowFiles will be sent to the same node. Which node they are sent to is not defined.

Method Detail

values

public static LoadBalanceStrategy[] 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 (LoadBalanceStrategy c : LoadBalanceStrategy.values())
    System.out.println(c);

Returns:

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

valueOf

public static LoadBalanceStrategy 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