Class EnrichProcessor
java.lang.Object
co.elastic.clients.elasticsearch.ingest.ProcessorBase
co.elastic.clients.elasticsearch.ingest.EnrichProcessor
- All Implemented Interfaces:
ProcessorVariant
,JsonpSerializable
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch.ingest.ProcessorBase
ProcessorBase.AbstractBuilder<BuilderT extends ProcessorBase.AbstractBuilder<BuilderT>>
-
Field Summary
Modifier and TypeFieldDescriptionstatic final JsonpDeserializer<EnrichProcessor>
Json deserializer forEnrichProcessor
-
Method Summary
Modifier and TypeMethodDescriptionProcessor variant kind.final String
field()
Required - The field in the input document that matches the policies match_field used to retrieve the enrichment data.final Boolean
Iftrue
andfield
does not exist, the processor quietly exits without modifying the document.final Integer
The maximum number of matched documents to include under the configured target field.static EnrichProcessor
final Boolean
override()
If processor will update fields with pre-existing non-null-valued field.final String
Required - The name of the enrich policy to use.protected void
serializeInternal
(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper) protected static void
final GeoShapeRelation
A spatial relation operator used to match the geoshape of incoming documents to documents in the enrich index.final String
Required - Field added to incoming documents to contain enrich data.Methods inherited from class co.elastic.clients.elasticsearch.ingest.ProcessorBase
description, if_, ignoreFailure, onFailure, serialize, setupProcessorBaseDeserializer, tag, toString
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface co.elastic.clients.elasticsearch.ingest.ProcessorVariant
_toProcessor
-
Field Details
-
_DESERIALIZER
Json deserializer forEnrichProcessor
-
-
Method Details
-
of
public static EnrichProcessor of(Function<EnrichProcessor.Builder, ObjectBuilder<EnrichProcessor>> fn) -
_processorKind
Processor variant kind.- Specified by:
_processorKind
in interfaceProcessorVariant
-
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
Iftrue
andfield
does not exist, the processor quietly exits without modifying the document.API name:
ignore_missing
-
maxMatches
The maximum number of matched documents to include under the configured target field. Thetarget_field
will be turned into a json array ifmax_matches
is higher than 1, otherwisetarget_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
If processor will update fields with pre-existing non-null-valued field. When set tofalse
, such fields will not be touched.API name:
override
-
policyName
Required - The name of the enrich policy to use.API name:
policy_name
-
shapeRelation
A spatial relation operator used to match the geoshape of incoming documents to documents in the enrich index. This option is only used forgeo_match
enrich policy types.API name:
shape_relation
-
targetField
Required - Field added to incoming documents to contain enrich data. This field contains both thematch_field
andenrich_fields
specified in the enrich policy. Supports template snippets.API name:
target_field
-
serializeInternal
- Overrides:
serializeInternal
in classProcessorBase
-
setupEnrichProcessorDeserializer
protected static void setupEnrichProcessorDeserializer(ObjectDeserializer<EnrichProcessor.Builder> op)
-