Package org.opensearch.client.opensearch.ingest

Class CircleProcessor

java.lang.Object

org.opensearch.client.opensearch.ingest.ProcessorBase

org.opensearch.client.opensearch.ingest.CircleProcessor

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable, ProcessorVariant, ToCopyableBuilder<CircleProcessor.Builder,CircleProcessor>

@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public class CircleProcessor
extends ProcessorBase
implements ProcessorVariant, ToCopyableBuilder<CircleProcessor.Builder,CircleProcessor>

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.opensearch.client.opensearch.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.
static CircleProcessor.Builder	builder()
boolean	equals(Object o)
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 - API name: field
int	hashCode()
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 - API name: shape_type
final String	targetField()	API name: target_field
CircleProcessor.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Methods inherited from class org.opensearch.client.opensearch.ingest.ProcessorBase

description, if_, ignoreFailure, onFailure, serialize, setupProcessorBaseDeserializer, tag

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.json.PlainJsonSerializable

toJsonString

Methods inherited from interface org.opensearch.client.opensearch.ingest.ProcessorVariant

toProcessor

Methods inherited from interface org.opensearch.client.util.ToCopyableBuilder

copy

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

@Nonnull
public final String field()

Required - 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

@Nonnull
public final ShapeType shapeType()

Required - API name: shape_type

targetField

@Nullable
public final String targetField()

API name: target_field

serializeInternal

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

Overrides:

serializeInternal in class ProcessorBase

toBuilder

@Nonnull
public CircleProcessor.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<CircleProcessor.Builder,CircleProcessor>

Returns:

a new builder instance.

builder

@Nonnull
public static CircleProcessor.Builder builder()

setupCircleProcessorDeserializer

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

hashCode

public int hashCode()

Overrides:

hashCode in class ProcessorBase

equals

public boolean equals(Object o)

Overrides:

equals in class ProcessorBase