Package co.elastic.clients.elasticsearch.ingest

Class GeoGridProcessor

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

  • Field Details

  • Method Details

    • of

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

    • _processorKind

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

    • field

      public final String field()
      Required - The field to interpret as a geo-tile.= The field format is determined by the tile_type.

      API name: field

    • tileType

      public final GeoGridTileType tileType()
      Required - Three tile formats are understood: geohash, geotile and geohex.

      API name: tile_type

    • targetField

      @Nullable public final String targetField()
      The field to assign the polygon shape to, by default, the field is updated in-place.

      API name: target_field

    • parentField

      @Nullable public final String parentField()
      If specified and a parent tile exists, save that tile address to this field.

      API name: parent_field

    • childrenField

      @Nullable public final String childrenField()
      If specified and children tiles exist, save those tile addresses to this field as an array of strings.

      API name: children_field

    • nonChildrenField

      @Nullable public final String nonChildrenField()
      If specified and intersecting non-child tiles exist, save their addresses to this field as an array of strings.

      API name: non_children_field

    • precisionField

      @Nullable public final String precisionField()
      If specified, save the tile precision (zoom) as an integer to this field.

      API name: precision_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

    • targetFormat

      @Nullable public final GeoGridTargetFormat targetFormat()
      Which format to save the generated polygon in.

      API name: target_format

    • serializeInternal

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

    • setupGeoGridProcessorDeserializer

      protected static void setupGeoGridProcessorDeserializer(ObjectDeserializer<GeoGridProcessor.Builder> op)