In this article

Overview

You can use this Snap to throttle all incoming documents at the configured throttle speed.

Speed at which documents should be throttled (in milli seconds). In case of Random throttling type, the value of this property is used as the maximum random value that will be generated. In case of Exponential throttling type, this value is used as the constant that is multiplied with the calculated exponential value, a exp(b) where a is the value of this property and b is the document index. In case of logarithmic throttling type, this value is used as the constant that is multiplied with the calculated log value i.e., a log(b) where a is the value of this property and b is the document index.

Snap Type

This is a write-type Snap that throttles all incoming documents at the configured throttle speed.

Prerequisites

None.

Limitations and Known Issues

None.

Snap Views

Type	Format	Number of Views	Examples of Upstream and Downstream Snaps	Description

Type

Format

Number of Views

Examples of Upstream and Downstream Snaps

Description

Input

Document

Min: 1
Max: 1

Mapper Snap
Binary to Document Snap
Sort Snap

Each input document contains data in the JSON format.

Output

Document

Min: 1
Max: 1

Mapper Snap
Join Snap
Union Snap

Each document contains a corresponding response in the JSON format.

Error

Error handling is a generic way to handle errors without losing data or failing the Snap execution. You can handle the errors that the Snap might encounter when running the Pipeline by choosing one of the following options from the When errors occur list under the Views tab:

Stop Pipeline Execution: Stops the current Pipeline execution if the Snap encounters an error.
Discard Error Data and Continue: Ignores the error, discards that record, and continues with the remaining records.
Route Error Data to Error View: Routes the error data to an error view without stopping the Snap execution.

Learn more about Error handling in Pipelines.

Snap Settings

Asterisk ( * ): Indicates a mandatory field.
Suggestion icon (): Indicates a list that is dynamically populated based on the configuration.
Expression icon ( ): Indicates the value is an expression (if enabled) or a static value (if disabled). Learn more about Using Expressions in SnapLogic.
Add icon ( ): Indicates that you can add fields in the field set.
Remove icon ( ): Indicates that you can remove fields from the field set.
The upload icon ( ): Indicates that you can upload files.

Field Name	Field Type	Description

Field Name	Field Type	Description
Label* Default Value: Throttle Example: Throttle	String	The name for the Snap. You can modify this to be more specific, especially if you have more than one of the same Snap in your Pipeline.
Throttle type* Default Value: Fixed Example: Random	Dropdown list	Select the throttle type.
Speed* Default Value: 5000 Example: 5000	Number	Specify the value for throttle speed in milli seconds.
Snap Execution Default Value: Execute Only Example: Validate & Execute	Dropdown list	Select one of the following three modes in which the Snap executes: Validate & Execute: Performs limited execution of the Snap, and generates a data preview during Pipeline validation. Subsequently, performs full execution of the Snap (unlimited records) during Pipeline runtime. Execute only: Performs full execution of the Snap during Pipeline execution without generating preview data. Disabled: Disables the Snap and all Snaps that are downstream from it.