Package co.elastic.clients.elasticsearch.simulate.ingest

Class IngestDocumentSimulation

java.lang.Object
co.elastic.clients.elasticsearch.simulate.ingest.IngestDocumentSimulation
All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable public class IngestDocumentSimulation extends Object implements JsonpSerializable
The results of ingest simulation on a single document. The _source of the document contains the results after running all pipelines listed in executed_pipelines on the document. The list of executed pipelines is derived from the pipelines that would be executed if this document had been ingested into _index.
See Also:

  • Field Details

  • Method Details

    • of

      public static IngestDocumentSimulation of(Function<IngestDocumentSimulation.Builder,ObjectBuilder<IngestDocumentSimulation>> fn)

    • metadata

      public final Map<String,String> metadata()
      Additional metadata

    • id

      public final String id()
      Required - Identifier for the document.

      API name: _id

    • index

      public final String index()
      Required - Name of the index that the document would be indexed into if this were not a simulation.

      API name: _index

    • source

      public final Map<String,JsonData> source()
      Required - JSON body for the document.

      API name: _source

    • version

      public final long version()
      Required -

      API name: _version

    • executedPipelines

      public final List<String> executedPipelines()
      Required - A list of the names of the pipelines executed on this document.

      API name: executed_pipelines

    • ignoredFields

      public final List<Map<String,String>> ignoredFields()
      A list of the fields that would be ignored at the indexing step. For example, a field whose value is larger than the allowed limit would make it through all of the pipelines, but would not be indexed into Elasticsearch.

      API name: ignored_fields

    • error

      @Nullable public final ErrorCause error()
      Any error resulting from simulatng ingest on this doc. This can be an error generated by executing a processor, or a mapping validation error when simulating indexing the resulting doc.

      API name: error

    • effectiveMapping

      @Nullable public final TypeMapping effectiveMapping()
      API name: effective_mapping

    • serialize

      public void serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
      Serialize this object to JSON.
      Specified by:
      serialize in interface JsonpSerializable

    • serializeInternal

      protected void serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • setupIngestDocumentSimulationDeserializer

      protected static void setupIngestDocumentSimulationDeserializer(ObjectDeserializer<IngestDocumentSimulation.Builder> op)