Snap Functions and Properties
In this Page
label
Description | The label of the Snap. |
|---|---|
Syntax | snap.label |
Example | Expression: Result: Mapper+%28Data%29 for Mapper (Data) |
instanceId
Description | The UUID of the Snap (not the runtime UUID of the Pipeline, which is different). |
|---|---|
Syntax | snap.instanceId |
Example | Expression: Result: The alphanumeric ID for the Snap in the form of xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx |
inputViews
Description | The input view names and number of documents that have been read from these views. |
|---|---|
Syntax | snap.inputViews |
Example | Expression: Result:
"Target": {
"input_name": {
"count": n,
"name": "input_name"
}where: |
outputViews
Description | The output view names and number of documents that have been written to these views. |
|---|---|
Syntax | snap.outputViews |
Example | Expression: Result:
"Target": {
"output_name": {
"count": n,
"name": "output_name"
}where:
|
errorViews
Description | The error view and number of documents that have been written to this view. |
|---|---|
Syntax | snap.errorViews |
Example | Expression: Result: For each view defined, it returns: "Target": {
"error0": {
"count": n,
"name": "error0"
}where:
|
in.totalCount
Description | The total number of documents that have passed through all of the Snap's input views. |
|---|---|
Syntax | snap.in.totalCount |
Example | Expression: Result: The number of documents. |
out.totalCount
Description | The total number of documents that have passed through all of the Snap's output views. |
|---|---|
Syntax | snap.out.totalCount |
Example | Expression: Result: The number of documents. |
error.totalCount
Description | The total number of documents that have passed through all of the Snap's error views. |
|---|---|
Syntax | snap.error.totalCount |
Example | Expression: Result: The number of error documents |
original.load()
Description | Loads the original message (document) coming to the FeedMaster when using an Ultra pipeline. This expression is usable only in Snaps inside an Ultra Pipeline. |
|---|---|
Syntax | snap.original.load() |
Example | Expression: Result: The original content of the document, along with the entire request sent to the feedmaster. |
original.id
Description | The unique ID associated with the message (document) coming into the Ultra pipeline. This expression is usable only in Snaps inside an Ultra Pipeline. |
|---|---|
Syntax | snap.original.id |
Example | Expression: Result: Unique ID of the message of type String. |