Class GeoIpProcessor
java.lang.Object
co.elastic.clients.elasticsearch.ingest.ProcessorBase
co.elastic.clients.elasticsearch.ingest.GeoIpProcessor
- 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<GeoIpProcessor>
Json deserializer forGeoIpProcessor
-
Method Summary
Modifier and TypeMethodDescriptionProcessor variant kind.final String
The database filename referring to a database the module ships with (GeoLite2-City.mmdb, GeoLite2-Country.mmdb, or GeoLite2-ASN.mmdb) or a custom database in the ingest-geoip config directory.final String
field()
Required - The field to get the ip address from for the geographical lookup.final Boolean
Iftrue
, only the first found geoip data will be returned, even if the field contains an array.final Boolean
Iftrue
andfield
does not exist, the processor quietly exits without modifying the document.static GeoIpProcessor
Controls what properties are added to thetarget_field
based on the geoip lookup.protected void
serializeInternal
(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper) protected static void
final String
The field that will hold the geographical information looked up from the MaxMind database.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 forGeoIpProcessor
-
-
Method Details
-
of
-
_processorKind
Processor variant kind.- Specified by:
_processorKind
in interfaceProcessorVariant
-
databaseFile
The database filename referring to a database the module ships with (GeoLite2-City.mmdb, GeoLite2-Country.mmdb, or GeoLite2-ASN.mmdb) or a custom database in the ingest-geoip config directory.API name:
database_file
-
field
Required - The field to get the ip address from for the geographical lookup.API name:
field
-
firstOnly
Iftrue
, only the first found geoip data will be returned, even if the field contains an array.API name:
first_only
-
ignoreMissing
Iftrue
andfield
does not exist, the processor quietly exits without modifying the document.API name:
ignore_missing
-
properties
Controls what properties are added to thetarget_field
based on the geoip lookup.API name:
properties
-
targetField
The field that will hold the geographical information looked up from the MaxMind database.API name:
target_field
-
serializeInternal
- Overrides:
serializeInternal
in classProcessorBase
-
setupGeoIpProcessorDeserializer
protected static void setupGeoIpProcessorDeserializer(ObjectDeserializer<GeoIpProcessor.Builder> op)
-