Package co.elastic.clients.elasticsearch.ingest

Class CircleProcessor

java.lang.Object

co.elastic.clients.elasticsearch.ingest.ProcessorBase

co.elastic.clients.elasticsearch.ingest.CircleProcessor

All Implemented Interfaces:

ProcessorVariant, JsonpSerializable

@JsonpDeserializable
public class CircleProcessor
extends ProcessorBase
implements ProcessorVariant

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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<CircleProcessor>	_DESERIALIZER	Json deserializer for CircleProcessor

Method Summary

Modifier and Type	Method	Description
Processor.Kind	_processorKind()	Processor variant kind.
final double	errorDistance()	Required - The difference between the resulting inscribed distance from center to side and the circle’s radius (measured in meters for geo_shape, unit-less for shape).
final String	field()	Required - The field to interpret as a circle.
final Boolean	ignoreMissing()	If true and field does not exist, the processor quietly exits without modifying the document.
static CircleProcessor	of(Function<CircleProcessor.Builder,ObjectBuilder<CircleProcessor>> fn)
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupCircleProcessorDeserializer(ObjectDeserializer<CircleProcessor.Builder> op)
final ShapeType	shapeType()	Required - Which field mapping type is to be used when processing the circle: geo_shape or shape.
final String	targetField()	The field to assign the polygon shape to By default, the field is updated in-place.

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<CircleProcessor> _DESERIALIZER

Json deserializer for CircleProcessor

Method Details

of

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

_processorKind

public Processor.Kind _processorKind()

Processor variant kind.

Specified by:

_processorKind in interface ProcessorVariant

errorDistance

public final double errorDistance()

Required - The difference between the resulting inscribed distance from center to side and the circle’s radius (measured in meters for geo_shape, unit-less for shape).

API name: error_distance

field

public final String field()

Required - The field to interpret as a circle. Either a string in WKT format or a map for GeoJSON.

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

shapeType

public final ShapeType shapeType()

Required - Which field mapping type is to be used when processing the circle: geo_shape or shape.

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

serializeInternal

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

Overrides:

serializeInternal in class ProcessorBase

setupCircleProcessorDeserializer

protected static void setupCircleProcessorDeserializer(ObjectDeserializer<CircleProcessor.Builder> op)