From 94b7fcf33feb2fee2f4ecc4e10e6e0f6bab23199 Mon Sep 17 00:00:00 2001
From: Martijn van Groningen <martijn.v.groningen@gmail.com>
Date: Fri, 22 Mar 2019 13:41:42 +0100
Subject: [PATCH] Update ingest jdocs that a null return value will drop the
 current document.

---
 server/src/main/java/org/elasticsearch/ingest/Pipeline.java  | 3 +++
 server/src/main/java/org/elasticsearch/ingest/Processor.java | 3 +++
 2 files changed, 6 insertions(+)

diff --git a/server/src/main/java/org/elasticsearch/ingest/Pipeline.java b/server/src/main/java/org/elasticsearch/ingest/Pipeline.java
index fc5311be5cbde..218713383227e 100644
--- a/server/src/main/java/org/elasticsearch/ingest/Pipeline.java
+++ b/server/src/main/java/org/elasticsearch/ingest/Pipeline.java
@@ -89,6 +89,9 @@ public static Pipeline create(String id, Map<String, Object> config,
 
     /**
      * Modifies the data of a document to be indexed based on the processor this pipeline holds
+     *
+     * If <code>null</code> is returned then this document will be dropped and not indexed, otherwise
+     * this document will be kept and indexed.
      */
     public IngestDocument execute(IngestDocument ingestDocument) throws Exception {
         long startTimeInNanos = relativeTimeProvider.getAsLong();
diff --git a/server/src/main/java/org/elasticsearch/ingest/Processor.java b/server/src/main/java/org/elasticsearch/ingest/Processor.java
index 92b08bba77bf7..c064ddb35a129 100644
--- a/server/src/main/java/org/elasticsearch/ingest/Processor.java
+++ b/server/src/main/java/org/elasticsearch/ingest/Processor.java
@@ -39,6 +39,9 @@ public interface Processor {
 
     /**
      * Introspect and potentially modify the incoming data.
+     *
+     * @return If <code>null</code> is returned then the current document will be dropped and not be indexed,
+     *         otherwise this document will be kept and indexed
      */
     IngestDocument execute(IngestDocument ingestDocument) throws Exception;