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

Class GeoBoundingBoxQuery.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

org.opensearch.client.opensearch._types.query_dsl.GeoBoundingBoxQuery.Builder

All Implemented Interfaces:

ObjectBuilder<GeoBoundingBoxQuery>

Enclosing class:

GeoBoundingBoxQuery

public static class GeoBoundingBoxQuery.Builder
extends QueryBase.AbstractBuilder<GeoBoundingBoxQuery.Builder>
implements ObjectBuilder<GeoBoundingBoxQuery>

Builder for GeoBoundingBoxQuery.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
GeoBoundingBoxQuery.Builder	boundingBox(java.util.function.Function<GeoBounds.Builder,ObjectBuilder<GeoBounds>> fn)	Required -
GeoBoundingBoxQuery.Builder	boundingBox(GeoBounds value)	Required -
GeoBoundingBoxQuery	build()	Builds a GeoBoundingBoxQuery.
GeoBoundingBoxQuery.Builder	field(java.lang.String value)	Required -
GeoBoundingBoxQuery.Builder	ignoreUnmapped(java.lang.Boolean value)	API name: ignore_unmapped
protected GeoBoundingBoxQuery.Builder	self()
GeoBoundingBoxQuery.Builder	type(GeoExecution value)	Deprecated. 7.14.0
GeoBoundingBoxQuery.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, _listAdd, _listAddAll, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

field

public final GeoBoundingBoxQuery.Builder field(java.lang.String value)

Required -

boundingBox

public final GeoBoundingBoxQuery.Builder boundingBox(GeoBounds value)

Required -

boundingBox

public final GeoBoundingBoxQuery.Builder boundingBox(java.util.function.Function<GeoBounds.Builder,ObjectBuilder<GeoBounds>> fn)

Required -

type

@Deprecated
public final GeoBoundingBoxQuery.Builder type(@Nullable
                                              GeoExecution value)

Deprecated.

7.14.0

API name: type

validationMethod

public final GeoBoundingBoxQuery.Builder validationMethod(@Nullable
                                                          GeoValidationMethod value)

API name: validation_method

ignoreUnmapped

public final GeoBoundingBoxQuery.Builder ignoreUnmapped(@Nullable
                                                        java.lang.Boolean value)

API name: ignore_unmapped

self

protected GeoBoundingBoxQuery.Builder self()

Specified by:

self in class QueryBase.AbstractBuilder<GeoBoundingBoxQuery.Builder>

build

public GeoBoundingBoxQuery build()

Builds a GeoBoundingBoxQuery.

Specified by:

build in interface ObjectBuilder<GeoBoundingBoxQuery>

Throws:

java.lang.NullPointerException - if some of the required fields are null.