Package co.elastic.clients.elasticsearch.ingest

Class GeoIpProcessor

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

  • Field Details

  • Method Details

    • of

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

    • _processorKind

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

    • databaseFile

      @Nullable public final String 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

      public final String field()
      Required - The field to get the ip address from for the geographical lookup.

      API name: field

    • firstOnly

      @Nullable public final Boolean firstOnly()
      If true, only the first found geoip data will be returned, even if the field contains an array.

      API name: first_only

    • 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

    • properties

      public final List<String> properties()
      Controls what properties are added to the target_field based on the geoip lookup.

      API name: properties

    • targetField

      @Nullable public final String targetField()
      The field that will hold the geographical information looked up from the MaxMind database.

      API name: target_field

    • downloadDatabaseOnPipelineCreation

      @Nullable public final Boolean downloadDatabaseOnPipelineCreation()
      If true (and if ingest.geoip.downloader.eager.download is false), the missing database is downloaded when the pipeline is created. Else, the download is triggered by when the pipeline is used as the default_pipeline or final_pipeline in an index.

      API name: download_database_on_pipeline_creation

    • serializeInternal

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

    • setupGeoIpProcessorDeserializer

      protected static void setupGeoIpProcessorDeserializer(ObjectDeserializer<GeoIpProcessor.Builder> op)