Controls the rate at which data is transferred to follow-on processors.
Tags: rate control, throttle, rate, throughput
Properties:
In the list below, the names of required properties appear in bold. Anyother properties (not in bold) are considered optional. The table also indicates any default values, whether a property supports the NiFi Expression Language (or simply EL), and whether a property is considered "sensitive", meaning that its value will be encrypted. Before entering a value in a sensitive property, ensure that the nifi.properties file has an entry for the property nifi.sensitive.props.key.
| Name | Description | Default Value | Valid Values | EL | Sensitive |
|---|---|---|---|---|---|
| Rate Control Criteria | Indicates the criteria that is used to control the throughput rate. Changing this value resets the rate counters. | data rate |
| No | No |
| 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'. | No | No | ||
| 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 integer, 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. | No | No | ||
| Time Duration | The amount of time to which the Maximum Data Size and Maximum Number of Files pertains. Changing this value resets the rate counters. | 1 min | No | No | |
| 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. | No | No |
Relationships:
| Name | Description |
|---|---|
| success | All FlowFiles are transferred to this relationship |