Package org.opensearch.client.opensearch._types.query_dsl

Class GeoPolygonQuery.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.query_dsl.QueryBase.AbstractBuilder<GeoPolygonQuery.Builder>

org.opensearch.client.opensearch._types.query_dsl.GeoPolygonQuery.Builder

All Implemented Interfaces:

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

Enclosing class:

GeoPolygonQuery

public static class GeoPolygonQuery.Builder
extends QueryBase.AbstractBuilder<GeoPolygonQuery.Builder>
implements CopyableBuilder<GeoPolygonQuery.Builder,GeoPolygonQuery>

Builder for GeoPolygonQuery.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
GeoPolygonQuery	build()	Builds a GeoPolygonQuery.
GeoPolygonQuery.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final GeoPolygonQuery.Builder	field(String value)	Required -
final GeoPolygonQuery.Builder	ignoreUnmapped(Boolean value)	API name: ignore_unmapped
final GeoPolygonQuery.Builder	polygon(Function<GeoPolygonPoints.Builder,ObjectBuilder<GeoPolygonPoints>> fn)	Required -
final GeoPolygonQuery.Builder	polygon(GeoPolygonPoints value)	Required -
protected GeoPolygonQuery.Builder	self()
final GeoPolygonQuery.Builder	validationMethod(GeoValidationMethod value)	API name: validation_method

Methods inherited from class org.opensearch.client.opensearch._types.query_dsl.QueryBase.AbstractBuilder

boost, queryName

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 GeoPolygonQuery.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<GeoPolygonQuery.Builder,GeoPolygonQuery>

Returns:

a new builder instance.

self

@Nonnull
protected GeoPolygonQuery.Builder self()

Specified by:

self in class QueryBase.AbstractBuilder<GeoPolygonQuery.Builder>

field

@Nonnull
public final GeoPolygonQuery.Builder field(String value)

Required -

ignoreUnmapped

@Nonnull
public final GeoPolygonQuery.Builder ignoreUnmapped(@Nullable
 Boolean value)

API name: ignore_unmapped

polygon

@Nonnull
public final GeoPolygonQuery.Builder polygon(GeoPolygonPoints value)

Required -

polygon

@Nonnull
public final GeoPolygonQuery.Builder polygon(Function<GeoPolygonPoints.Builder,ObjectBuilder<GeoPolygonPoints>> fn)

Required -

validationMethod

@Nonnull
public final GeoPolygonQuery.Builder validationMethod(@Nullable
 GeoValidationMethod value)

API name: validation_method

build

@Nonnull
public GeoPolygonQuery build()

Builds a GeoPolygonQuery.

Specified by:

build in interface ObjectBuilder<GeoPolygonQuery>

Throws:

NullPointerException - if some of the required fields are null.