Package org.opensearch.client.opensearch.ingest

Class CircleProcessor.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.ingest.ProcessorBase.AbstractBuilder<CircleProcessor.Builder>

org.opensearch.client.opensearch.ingest.CircleProcessor.Builder

All Implemented Interfaces:

CopyableBuilder<CircleProcessor.Builder,CircleProcessor>, MutableBuilder<CircleProcessor.Builder,CircleProcessor>, ObjectBuilder<CircleProcessor>

Enclosing class:

CircleProcessor

public static class CircleProcessor.Builder
extends ProcessorBase.AbstractBuilder<CircleProcessor.Builder>
implements CopyableBuilder<CircleProcessor.Builder,CircleProcessor>

Builder for CircleProcessor.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CircleProcessor	build()	Builds a CircleProcessor.
CircleProcessor.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final CircleProcessor.Builder	errorDistance(double value)	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 CircleProcessor.Builder	field(String value)	Required - API name: field
final CircleProcessor.Builder	ignoreMissing(Boolean value)	If true and field does not exist, the processor quietly exits without modifying the document.
protected CircleProcessor.Builder	self()
final CircleProcessor.Builder	shapeType(ShapeType value)	Required - API name: shape_type
final CircleProcessor.Builder	targetField(String value)	API name: target_field

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

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

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

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

applyMutation

Constructor Details

Builder

public Builder()

Method Details

copy

@Nonnull
public CircleProcessor.Builder copy()

Description copied from interface: CopyableBuilder

Create a new builder CopyableBuilder that is a copy of this one.

Specified by:

copy in interface CopyableBuilder<CircleProcessor.Builder,CircleProcessor>

Returns:

a new builder instance.

self

@Nonnull
protected CircleProcessor.Builder self()

Specified by:

self in class ProcessorBase.AbstractBuilder<CircleProcessor.Builder>

errorDistance

@Nonnull
public final CircleProcessor.Builder errorDistance(double value)

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 CircleProcessor.Builder field(String value)

Required - API name: field

ignoreMissing

@Nonnull
public final CircleProcessor.Builder ignoreMissing(@Nullable
 Boolean value)

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

API name: ignore_missing

shapeType

@Nonnull
public final CircleProcessor.Builder shapeType(ShapeType value)

Required - API name: shape_type

targetField

@Nonnull
public final CircleProcessor.Builder targetField(@Nullable
 String value)

API name: target_field

build

@Nonnull
public CircleProcessor build()

Builds a CircleProcessor.

Specified by:

build in interface ObjectBuilder<CircleProcessor>

Throws:

NullPointerException - if some of the required fields are null.