Package co.elastic.clients.elasticsearch.ingest

Class EnrichProcessor

java.lang.Object
co.elastic.clients.elasticsearch.ingest.ProcessorBase
co.elastic.clients.elasticsearch.ingest.EnrichProcessor
All Implemented Interfaces:
ProcessorVariant, JsonpSerializable
@JsonpDeserializable public class EnrichProcessor extends ProcessorBase implements ProcessorVariant
See Also:

  • Field Details

  • Method Details

    • of

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

    • _processorKind

      public Processor.Kind _processorKind()
      Processor variant kind.
      Specified by:
      _processorKind in interface ProcessorVariant

    • field

      public final String field()
      Required - The field in the input document that matches the policies match_field used to retrieve the enrichment data. Supports template snippets.

      API name: field

    • ignoreMissing

      @Nullable public final Boolean ignoreMissing()
      If true and field does not exist, the processor quietly exits without modifying the document.

      API name: ignore_missing

    • maxMatches

      @Nullable public final Integer maxMatches()
      The maximum number of matched documents to include under the configured target field. The target_field will be turned into a json array if max_matches is higher than 1, otherwise target_field will become a json object. In order to avoid documents getting too large, the maximum allowed value is 128.

      API name: max_matches

    • override

      @Nullable public final Boolean override()
      If processor will update fields with pre-existing non-null-valued field. When set to false, such fields will not be touched.

      API name: override

    • policyName

      public final String policyName()
      Required - The name of the enrich policy to use.

      API name: policy_name

    • shapeRelation

      @Nullable public final GeoShapeRelation shapeRelation()
      A spatial relation operator used to match the geoshape of incoming documents to documents in the enrich index. This option is only used for geo_match enrich policy types.

      API name: shape_relation

    • targetField

      public final String targetField()
      Required - Field added to incoming documents to contain enrich data. This field contains both the match_field and enrich_fields specified in the enrich policy. Supports template snippets.

      API name: target_field

    • serializeInternal

      protected void serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
      Overrides:
      serializeInternal in class ProcessorBase

    • setupEnrichProcessorDeserializer

      protected static void setupEnrichProcessorDeserializer(ObjectDeserializer<EnrichProcessor.Builder> op)