Pipeline processor
Pipeline processor
Executes another pipeline.
Table 31. Pipeline Options
Name | Required | Default | Description |
---|---|---|---|
| yes | - | The name of the pipeline to execute. Supports template snippets. |
| no | - | Description of the processor. Useful for describing the purpose of the processor or its configuration. |
| no | - | Conditionally execute the processor. See Conditionally run a processor. |
| no |
| Ignore failures for the processor. See Handling pipeline failures. |
| no | - | Handle failures for the processor. See Handling pipeline failures. |
| no | - | Identifier for the processor. Useful for debugging and metrics. |
{
"pipeline": {
"name": "inner-pipeline"
}
}
The name of the current pipeline can be accessed from the _ingest.pipeline
ingest metadata key.
An example of using this processor for nesting pipelines would be:
Define an inner pipeline:
PUT _ingest/pipeline/pipelineA
{
"description" : "inner pipeline",
"processors" : [
{
"set" : {
"field": "inner_pipeline_set",
"value": "inner"
}
}
]
}
Define another pipeline that uses the previously defined inner pipeline:
PUT _ingest/pipeline/pipelineB
{
"description" : "outer pipeline",
"processors" : [
{
"pipeline" : {
"name": "pipelineA"
}
},
{
"set" : {
"field": "outer_pipeline_set",
"value": "outer"
}
}
]
}
Now indexing a document while applying the outer pipeline will see the inner pipeline executed from the outer pipeline:
PUT /my-index/_doc/1?pipeline=pipelineB
{
"field": "value"
}
Response from the index request:
{
"_index": "my-index",
"_type": "_doc",
"_id": "1",
"_version": 1,
"result": "created",
"_shards": {
"total": 2,
"successful": 1,
"failed": 0
},
"_seq_no": 66,
"_primary_term": 1
}
Indexed document:
{
"field": "value",
"inner_pipeline_set": "inner",
"outer_pipeline_set": "outer"
}