DistributeLoad
Description
Distributes FlowFiles to downstream processors based on a Distribution Strategy. If using the Round Robin strategy, the default is to assign each destination a weighting of 1 (evenly distributed). However, optional properties can be added to the change this; adding a property with the name '5' and value '10' means that the relationship with name '5' will be receive 10 FlowFiles in each iteration instead of 1.
Tags
distribute, load balance, round robin, route, weighted
Properties
In the list below required Properties are shown with an asterisk (*). Other properties are considered optional. The table also indicates any default values, and whether a property supports the NiFi Expression Language.
| Display Name | API Name | Default Value | Allowable Values | Description |
|---|---|---|---|---|
| Number of Relationships * | Number of Relationships | 1 | Determines the number of Relationships to which the load should be distributed | |
| Distribution Strategy * | Distribution Strategy | round robin |
| Determines how the load will be distributed. Relationship weight is in numeric order where '1' has the greatest weight. |
Dynamic Properties
| Name | Value | Description |
|---|---|---|
| The relationship name (positive number) | The relationship Weight (positive number) | Adding a property with the name '5' and value '10' means that the relationship with name '5' will receive 10 FlowFiles in each iteration instead of 1. Supports Expression Language: No |
Relationships
| Name | Description |
|---|---|
| 1 | Where to route flowfiles for this relationship index |
Reads Attributes
This processor does not read attributes.
Writes Attributes
| Name | Description |
|---|---|
| distribute.load.relationship | The name of the specific relationship the FlowFile has been routed through |
State Management
This component does not store state.
Restricted
This component is not restricted.
Input Requirement
This component requires an incoming relationship.
System Resource Considerations
This component does not specify system resource considerations.