Update remove ingest processor documentation for some metadata fields are not allowed to remove (#5870)

* Update remove ingest processor documentation for some metadata fields are not allowed to remove

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

* use latest change

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

* Change the wording

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

---------

Signed-off-by: gaobinlong <gbinlong@amazon.com>
Co-authored-by: Melissa Vagi <vagimeli@amazon.com>
This commit is contained in:
gaobinlong 2023-12-20 04:05:16 +08:00 committed by GitHub
parent ceb22313fc
commit ac1c5a0e8b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 1 additions and 1 deletions

View File

@ -30,7 +30,7 @@ The following table lists the required and optional parameters for the `remove`
| Parameter | Required/Optional | Description | | Parameter | Required/Optional | Description |
|---|---|---| |---|---|---|
`field` | Required | The name of the field containing the data to be appended. Supports [template snippets]({{site.url}}{{site.baseurl}}/ingest-pipelines/create-ingest/#template-snippets). | `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. |
`description` | Optional | A brief description of the processor. | `description` | Optional | A brief description of the processor. |
`if` | Optional | A condition for running 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`. | `ignore_failure` | Optional | Specifies whether the processor continues execution even if it encounters errors. If set to `true`, failures are ignored. Default is `false`. |