From bcfdc95e28fd8d4f8441e961d4bae83c586d7508 Mon Sep 17 00:00:00 2001
From: Pete Gillin <pete.gillin@elastic.co>
Date: Thu, 10 Oct 2024 20:25:11 +0100
Subject: [PATCH] Add `terminate` ingest processor (#3003)

---
 specification/_doc_ids/table.csv          | 1 +
 specification/ingest/_types/Processors.ts | 8 ++++++++
 2 files changed, 9 insertions(+)

diff --git a/specification/_doc_ids/table.csv b/specification/_doc_ids/table.csv
index 286e15e033..d62eed207b 100644
--- a/specification/_doc_ids/table.csv
+++ b/specification/_doc_ids/table.csv
@@ -596,6 +596,7 @@ stop-transform,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/
 supported-flags,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/query-dsl-simple-query-string-query.html#supported-flags
 tasks,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/tasks.html
 templating-role-query,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/field-and-document-access-control.html#templating-role-query
+terminate-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/terminate-processor.html
 time-value,https://github.com/elastic/elasticsearch/blob/{branch}/libs/core/src/main/java/org/elasticsearch/core/TimeValue.java
 trim-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/trim-processor.html
 unfreeze-index-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/unfreeze-index-api.html
diff --git a/specification/ingest/_types/Processors.ts b/specification/ingest/_types/Processors.ts
index 27b0729437..0ee0ad8021 100644
--- a/specification/ingest/_types/Processors.ts
+++ b/specification/ingest/_types/Processors.ts
@@ -230,6 +230,12 @@ export class ProcessorContainer {
    * @doc_id split-processor
    */
   split?: SplitProcessor
+  /**
+   * Terminates the current ingest pipeline, causing no further processors to be run.
+   * This will normally be executed conditionally, using the `if` option.
+   * @doc_id terminate-processor
+   */
+  terminate?: TerminateProcessor
   /**
    * Trims whitespace from a field.
    * If the field is an array of strings, all members of the array will be trimmed.
@@ -1279,6 +1285,8 @@ export class SplitProcessor extends ProcessorBase {
   target_field?: Field
 }
 
+export class TerminateProcessor extends ProcessorBase {}
+
 export class TrimProcessor extends ProcessorBase {
   /**
    * The string-valued field to trim whitespace from.