Description:
This processor distributes FlowFiles to downstream
processors based on a distribution strategy. The user may select the strategy "round robin", the
strategy "next available", or "load distribution service". If using the round robin
strategy, the default is to assign each destination (i.e., relationship) a weighting of 1
(evenly distributed). However, the user may add optional properties to change this weighting. When
adding a property, the name must be a positive integer between 1 and the number of relationships (inclusive).
For example, if Number of Relationships has a value of 8 and a property is added with the name 5
and the value 10, then relationship 5 (among the 8) will receive 10
FlowFiles in each iteration instead of 1. All other relationships will receive 1 FlowFile in each iteration.
Properties:
In the list below, the names of required properties appear
in bold. Any other properties (not in bold) are considered optional.
If a property has a default value, it is indicated. If a property
supports the use of the NiFi Expression Language (or simply,
"expression language"), that is also indicated.
- Number of Relationships
- The number of relationships to which the load should be
distributed. A valid value is a non-negative integer.
- Default value: 1
- Supports expression language: false
- Distribution Strategy
- This property determines how the load is distributed. If
the round robin strategy is used, the processor does not distribute
any FlowFiles unless all destinations can accept FlowFiles. If the
next available strategy is used, the processor distributes
FlowFiles as long as at least one destination can accept FlowFiles.
If the load distribution service is used, the processor ignores any
user specified optional properties, requires the service id of the
Load Distribution Service, and requires a list of fully qualified host
names, or FQDN's, which are the distribution end points.
Valid values are:
- round robin
- next available
- load distribution service
- Default value: round robin
- Supports expression language: false
- Hostnames - this is required when using 'load distribution service' strategy
- List of remote servers to distribute across. Each server must be FQDN and use either ',', ';', or 'space' as a delimiter
- Default Value: none
- Supports expression language: false
- Load Distribution Service ID - this is required when using 'load distribution service' strategy
- The identifier of the Load Distribution Service
- Default Value: none
- Supports expression language: false
Relationships:
- 1
- By default, there is one relationship, named 1. The number
of relationships is determined by the value of the <Number of
Relationships> property.