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 ClassesNested classes/interfaces inherited from class org.opensearch.client.opensearch.ingest.ProcessorBase
ProcessorBase.AbstractBuilder<BuilderT extends ProcessorBase.AbstractBuilder<BuilderT>> -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final JsonpDeserializer<CircleProcessor> Json deserializer forCircleProcessor -
Method Summary
Modifier and TypeMethodDescriptionProcessorvariant kind.static CircleProcessor.Builderbuilder()booleanfinal doubleRequired - The difference between the resulting inscribed distance from center to side and the circle's radius (measured in meters forgeo_shape, unit-less forshape).final Stringfield()Required - API name:fieldinthashCode()final BooleanIftrueandfielddoes not exist, the processor quietly exits without modifying the document.static CircleProcessorprotected voidserializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper) protected static voidfinal ShapeTypeRequired - API name:shape_typefinal StringAPI name:target_fieldCreate a new builderToCopyableBuilderthat 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, tagMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.opensearch.client.json.PlainJsonSerializable
toJsonStringMethods inherited from interface org.opensearch.client.opensearch.ingest.ProcessorVariant
toProcessorMethods inherited from interface org.opensearch.client.util.ToCopyableBuilder
copy
-
Field Details
-
_DESERIALIZER
Json deserializer forCircleProcessor
-
-
Method Details
-
of
public static CircleProcessor of(Function<CircleProcessor.Builder, ObjectBuilder<CircleProcessor>> fn) -
_processorKind
Processorvariant kind.- Specified by:
_processorKindin interfaceProcessorVariant
-
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 forgeo_shape, unit-less forshape).API name:
error_distance -
field
Required - API name:field -
ignoreMissing
Iftrueandfielddoes not exist, the processor quietly exits without modifying the document.API name:
ignore_missing -
shapeType
Required - API name:shape_type -
targetField
API name:target_field -
serializeInternal
- Overrides:
serializeInternalin classProcessorBase
-
toBuilder
Description copied from interface:ToCopyableBuilderCreate a new builderToCopyableBuilderthat is initialised with the current state of this object.- Specified by:
toBuilderin interfaceToCopyableBuilder<CircleProcessor.Builder,CircleProcessor> - Returns:
- a new builder instance.
-
builder
-
setupCircleProcessorDeserializer
protected static void setupCircleProcessorDeserializer(ObjectDeserializer<CircleProcessor.Builder> op) -
hashCode
public int hashCode()- Overrides:
hashCodein classProcessorBase
-
equals
- Overrides:
equalsin classProcessorBase
-