Controls the rate at which data is transferred to follow-on processors. If you configure a very small Time Duration, then the accuracy of the throttle gets worse. You can improve this accuracy by decreasing the Yield Duration, at the expense of more Tasks given to the processor.
| Display Name | API Name | Default Value | Allowable Values | Description |
|---|
| Rate Control Criteria | Rate Control Criteria | data rate | - data rate
 - flowfile count
- attribute value
- data rate or flowfile count
| Indicates the criteria that is used to control the throughput rate. Changing this value resets the rate counters. |
| Time Duration | Time Duration | 1 min | | The amount of time to which the Maximum Rate pertains. Changing this value resets the rate counters. |
| Maximum Rate | Maximum Rate | | | The maximum rate at which data should pass through this processor. The format of this property is expected to be a positive integer, or a Data Size (such as '1 MB') if Rate Control Criteria is set to 'data rate'.
This Property is only considered if the [Rate Control Criteria] Property is set to one of the following values: [data rate], [attribute value], [flowfile count] |
| Maximum Data Rate | Maximum Data Rate | | | The maximum rate at which data should pass through this processor. The format of this property is expected to be a Data Size (such as '1 MB') representing bytes per Time Duration.
This Property is only considered if the [Rate Control Criteria] Property has a value of "data rate or flowfile count". |
| Maximum FlowFile Rate | Maximum FlowFile Rate | | | The maximum rate at which FlowFiles should pass through this processor. The format of this property is expected to be a positive integer representing FlowFiles count per Time Duration
This Property is only considered if the [Rate Control Criteria] Property has a value of "data rate or flowfile count". |
| Rate Controlled Attribute | Rate Controlled Attribute | | | The name of an attribute whose values build toward the rate limit if Rate Control Criteria is set to 'attribute value'. The value of the attribute referenced by this property must be a positive long, or the FlowFile will be routed to failure. This value is ignored if Rate Control Criteria is not set to 'attribute value'. Changing this value resets the rate counters.
This Property is only considered if the [Rate Control Criteria] Property has a value of "attribute value". |
| Grouping Attribute | 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. |