Remove ingest processor supports excluding fields (#6244)

* Remove ingest processor supports excluding fields

Signed-off-by: gaobinlong <gbinlong@amazon.com>

* Update _ingest-pipelines/processors/remove.md

Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

* Update _ingest-pipelines/processors/remove.md

Signed-off-by: Melissa Vagi <vagimeli@amazon.com>

* Update remove.md

* Update remove.md

---------

Signed-off-by: gaobinlong <gbinlong@amazon.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
Co-authored-by: Melissa Vagi <vagimeli@amazon.com>
This commit is contained in:
gaobinlong 2024-01-27 04:47:22 +08:00 committed by GitHub
parent b8ef73fa60
commit 8eef7430bd
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 2 additions and 1 deletions

View File

@ -30,7 +30,8 @@ The following table lists the required and optional parameters for the `remove`
| Parameter | Required/Optional | Description |
|---|---|---|
`field` | Required | The name of the field containing the data to be removed. Supports [template snippets]({{site.url}}{{site.baseurl}}/ingest-pipelines/create-ingest/#template-snippets). The following metadata fields are not allowed to be removed: `_index`, `_version`, `_version_type`, and `_id`. Note that `_id` is not allowed to be removed when there's a specified external version for the ingesting document. |
`field` | Optional | The field name containing the data to be removed. Supports [template snippets]({{site.url}}{{site.baseurl}}/ingest-pipelines/create-ingest/#template-snippets). The metadata fields `_index`, `_version`, `_version_type`, and `_id` cannot be removed. If `version` is specified, `_id` cannot be removed from the ingested document. |
`exclude_field` | Optional | The field name to be retained. All other fields, except metadata fields, will be removed. The `exclude_field` and `field` options are mutually exclusive. Supports [template snippets]({{site.url}}{{site.baseurl}}/ingest-pipelines/create-ingest/#template-snippets). |
`description` | Optional | A brief description of the processor. |
`if` | Optional | A condition for running the processor. |
`ignore_failure` | Optional | Specifies whether the processor continues execution even if it encounters errors. If set to `true`, failures are ignored. Default is `false`. |