Description:
This processor controls the rate at which data is
transferred to follow-on processors.
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.
- Rate Control Criteria
- Indicates the criteria used to control the throughput rate.
Changing this value resets the rate counters. Possible values are:
- data rate
- flowfile count
- attribute value
- Default value: data rate
- Supports expression language: false
- Maximum Rate
- The maximum rate at which data should pass through this
processor. The format of this value is expected to be a
non-negative integer or, if the Rate Control Criteria is set to
data rate, a data size (such as 1MB).
- Default value: no default
- Supports expression language: false
- Rate Controlled Attribute
- The name of an attribute whose values build toward the rate
limit if the Rate Control Criteria is set to attribute value. The
value of the attribute referenced by this property must be a
non-negative integer; otherwise, the flowfile will be routed to the
failure relationship. This value is ignored if the Rate Control
Criteria is not set to attribute value. Changing this value resets
the rate counters.
- Default value: no default
- Supports expression language: true.
- Time Duration
- The amount of time to which the Maximum Rate property
pertains. Changing this value resets the rate counters.
- Default value: 1 min
- Supports expression language: false.
- Grouping Attribute
- By default, a single "throttle" is used for all FlowFiles.
If this value is specified, a separate throttle is used for each
value specified by the attribute with this name. Changing this
value resets the rate counters.
- Default value: no default
- Supports expression language: true.
Relationships:
- success
- If FlowFiles are successfully processed, then they follow
this relationship.