From 8eef7430bd8faec5c2a11c58d7421c3d05d69324 Mon Sep 17 00:00:00 2001 From: gaobinlong Date: Sat, 27 Jan 2024 04:47:22 +0800 Subject: [PATCH] Remove ingest processor supports excluding fields (#6244) * Remove ingest processor supports excluding fields Signed-off-by: gaobinlong * Update _ingest-pipelines/processors/remove.md Signed-off-by: Melissa Vagi * Update _ingest-pipelines/processors/remove.md Signed-off-by: Melissa Vagi * Update remove.md * Update remove.md --------- Signed-off-by: gaobinlong Signed-off-by: Melissa Vagi Co-authored-by: Melissa Vagi --- _ingest-pipelines/processors/remove.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/_ingest-pipelines/processors/remove.md b/_ingest-pipelines/processors/remove.md index ac87fd3f..36c41e59 100644 --- a/_ingest-pipelines/processors/remove.md +++ b/_ingest-pipelines/processors/remove.md @@ -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`. |