add some documentation/notes on inner design

elastic · Oct 18, 2018 · f331658 · f331658
1 parent 50669ca
commit f331658
Showing 1 changed file with 6 additions and 1 deletion.
diff --git a/...n/java/org/elasticsearch/xpack/ml/featureindexbuilder/job/FeatureIndexBuilderIndexer.java b/...n/java/org/elasticsearch/xpack/ml/featureindexbuilder/job/FeatureIndexBuilderIndexer.java
@@ -64,7 +64,12 @@ protected IterationResult<Map<String, Object>> doProcess(SearchResponse searchRe
     }
 
     /*
-     * Parses the result and creates indexable documents
+     * Parses the result and creates a stream of indexable documents
+     *
+     * Implementation decisions:
+     *
+     * Extraction uses generic maps as intermediate exchange format in order to hook in ingest pipelines/processors
+     * in later versions, see {@link IngestDocument).
      */
     private Stream<IndexRequest> processBucketsToIndexRequests(CompositeAggregation agg) {
         String indexName = job.getConfig().getDestinationIndex();