elasticsearch/docs/reference/enrich-processor/drop-processor.md

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

30 lines
1.3 KiB
Markdown
Raw Normal View History

---
navigation_title: "Drop"
mapped_pages:
- https://www.elastic.co/guide/en/elasticsearch/reference/current/drop-processor.html
---
# Drop processor [drop-processor]
Drops the document without raising any errors. This is useful to prevent the document from getting indexed based on some condition.
$$$drop-options$$$
| Name | Required | Default | Description |
| --- | --- | --- | --- |
| `description` | no | - | Description of the processor. Useful for describing the purpose of the processor or its configuration. |
| `if` | no | - | Conditionally execute the processor. See [Conditionally run a processor](docs-content://manage-data/ingest/transform-enrich/ingest-pipelines.md#conditionally-run-processor). |
| `ignore_failure` | no | `false` | Ignore failures for the processor. See [Handling pipeline failures](docs-content://manage-data/ingest/transform-enrich/ingest-pipelines.md#handling-pipeline-failures). |
| `on_failure` | no | - | Handle failures for the processor. See [Handling pipeline failures](docs-content://manage-data/ingest/transform-enrich/ingest-pipelines.md#handling-pipeline-failures). |
| `tag` | no | - | Identifier for the processor. Useful for debugging and metrics. |
```js
{
"drop": {
"if" : "ctx.network_name == 'Guest'"
}
}
```