Package co.elastic.clients.elasticsearch.ingest

Class FingerprintProcessor

java.lang.Object

co.elastic.clients.elasticsearch.ingest.ProcessorBase

co.elastic.clients.elasticsearch.ingest.FingerprintProcessor

All Implemented Interfaces:

ProcessorVariant, JsonpSerializable

@JsonpDeserializable
public class FingerprintProcessor
extends ProcessorBase
implements ProcessorVariant

See Also:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FingerprintProcessor.Builder	Builder for FingerprintProcessor.

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch.ingest.ProcessorBase

ProcessorBase.AbstractBuilder<BuilderT extends ProcessorBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<FingerprintProcessor>	_DESERIALIZER	Json deserializer for FingerprintProcessor

Method Summary

Modifier and Type	Method	Description
Processor.Kind	_processorKind()	Processor variant kind.
final List<String>	fields()	Required - Array of fields to include in the fingerprint.
final Boolean	ignoreMissing()	If true, the processor ignores any missing fields.
final FingerprintDigest	method()	The hash method used to compute the fingerprint.
static FingerprintProcessor	of(Function<FingerprintProcessor.Builder,ObjectBuilder<FingerprintProcessor>> fn)
final String	salt()	Salt value for the hash function.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupFingerprintProcessorDeserializer(ObjectDeserializer<FingerprintProcessor.Builder> op)
final String	targetField()	Output field for the fingerprint.

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

public static final JsonpDeserializer<FingerprintProcessor> _DESERIALIZER

Json deserializer for FingerprintProcessor

Method Details

of

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

_processorKind

public Processor.Kind _processorKind()

Processor variant kind.

Specified by:

_processorKind in interface ProcessorVariant

fields

public final List<String> fields()

Required - Array of fields to include in the fingerprint. For objects, the processor hashes both the field key and value. For other fields, the processor hashes only the field value.

API name: fields

targetField

@Nullable
public final String targetField()

Output field for the fingerprint.

API name: target_field

salt

@Nullable
public final String salt()

Salt value for the hash function.

API name: salt

method

@Nullable
public final FingerprintDigest method()

The hash method used to compute the fingerprint. Must be one of MD5, SHA-1, SHA-256, SHA-512, or MurmurHash3.

API name: method

ignoreMissing

@Nullable
public final Boolean ignoreMissing()

If true, the processor ignores any missing fields. If all fields are missing, the processor silently exits without modifying the document.

API name: ignore_missing

serializeInternal

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

Overrides:

serializeInternal in class ProcessorBase

setupFingerprintProcessorDeserializer

protected static void setupFingerprintProcessorDeserializer(ObjectDeserializer<FingerprintProcessor.Builder> op)