Package co.elastic.clients.elasticsearch.ingest

Class GeoGridProcessor.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>

co.elastic.clients.elasticsearch.ingest.ProcessorBase.AbstractBuilder<GeoGridProcessor.Builder>

co.elastic.clients.elasticsearch.ingest.GeoGridProcessor.Builder

All Implemented Interfaces:

WithJson<GeoGridProcessor.Builder>, ObjectBuilder<GeoGridProcessor>

Enclosing class:

GeoGridProcessor

public static class GeoGridProcessor.Builder
extends ProcessorBase.AbstractBuilder<GeoGridProcessor.Builder>
implements ObjectBuilder<GeoGridProcessor>

Builder for GeoGridProcessor.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
GeoGridProcessor	build()	Builds a GeoGridProcessor.
final GeoGridProcessor.Builder	childrenField(String value)	If specified and children tiles exist, save those tile addresses to this field as an array of strings.
final GeoGridProcessor.Builder	field(String value)	Required - The field to interpret as a geo-tile.= The field format is determined by the tile_type.
final GeoGridProcessor.Builder	ignoreMissing(Boolean value)	If true and field does not exist, the processor quietly exits without modifying the document.
final GeoGridProcessor.Builder	nonChildrenField(String value)	If specified and intersecting non-child tiles exist, save their addresses to this field as an array of strings.
final GeoGridProcessor.Builder	parentField(String value)	If specified and a parent tile exists, save that tile address to this field.
final GeoGridProcessor.Builder	precisionField(String value)	If specified, save the tile precision (zoom) as an integer to this field.
protected GeoGridProcessor.Builder	self()
final GeoGridProcessor.Builder	targetField(String value)	The field to assign the polygon shape to, by default, the field is updated in-place.
final GeoGridProcessor.Builder	targetFormat(GeoGridTargetFormat value)	Which format to save the generated polygon in.
final GeoGridProcessor.Builder	tileType(GeoGridTileType value)	Required - Three tile formats are understood: geohash, geotile and geohex.

Methods inherited from class co.elastic.clients.elasticsearch.ingest.ProcessorBase.AbstractBuilder

description, if_, ignoreFailure, onFailure, onFailure, onFailure, onFailure, tag

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

field

public final GeoGridProcessor.Builder field(String value)

Required - The field to interpret as a geo-tile.= The field format is determined by the tile_type.

API name: field

tileType

public final GeoGridProcessor.Builder tileType(GeoGridTileType value)

Required - Three tile formats are understood: geohash, geotile and geohex.

API name: tile_type

targetField

public final GeoGridProcessor.Builder targetField(@Nullable
 String value)

The field to assign the polygon shape to, by default, the field is updated in-place.

API name: target_field

parentField

public final GeoGridProcessor.Builder parentField(@Nullable
 String value)

If specified and a parent tile exists, save that tile address to this field.

API name: parent_field

childrenField

public final GeoGridProcessor.Builder childrenField(@Nullable
 String value)

If specified and children tiles exist, save those tile addresses to this field as an array of strings.

API name: children_field

nonChildrenField

public final GeoGridProcessor.Builder nonChildrenField(@Nullable
 String value)

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

public final GeoGridProcessor.Builder precisionField(@Nullable
 String value)

If specified, save the tile precision (zoom) as an integer to this field.

API name: precision_field

ignoreMissing

public final GeoGridProcessor.Builder ignoreMissing(@Nullable
 Boolean value)

If true and field does not exist, the processor quietly exits without modifying the document.

API name: ignore_missing

targetFormat

public final GeoGridProcessor.Builder targetFormat(@Nullable
 GeoGridTargetFormat value)

Which format to save the generated polygon in.

API name: target_format

self

protected GeoGridProcessor.Builder self()

Specified by:

self in class ProcessorBase.AbstractBuilder<GeoGridProcessor.Builder>

build

public GeoGridProcessor build()

Builds a GeoGridProcessor.

Specified by:

build in interface ObjectBuilder<GeoGridProcessor>

Throws:

NullPointerException - if some of the required fields are null.