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:

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

Enclosing class:

GeoBoundingBoxQuery

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

Builder for GeoBoundingBoxQuery.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final GeoBoundingBoxQuery.Builder	boundingBox(Function<GeoBounds.Builder,ObjectBuilder<GeoBounds>> fn)	Required -
final GeoBoundingBoxQuery.Builder	boundingBox(GeoBounds value)	Required -
GeoBoundingBoxQuery	build()	Builds a GeoBoundingBoxQuery.
GeoBoundingBoxQuery.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final GeoBoundingBoxQuery.Builder	field(String value)	Required -
final GeoBoundingBoxQuery.Builder	ignoreUnmapped(Boolean value)	API name: ignore_unmapped
protected GeoBoundingBoxQuery.Builder	self()
final GeoBoundingBoxQuery.Builder	type(GeoExecution value)	API name: type
final 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, _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 GeoBoundingBoxQuery.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<GeoBoundingBoxQuery.Builder,GeoBoundingBoxQuery>

Returns:

a new builder instance.

self

@Nonnull
protected GeoBoundingBoxQuery.Builder self()

Specified by:

self in class QueryBase.AbstractBuilder<GeoBoundingBoxQuery.Builder>

boundingBox

@Nonnull
public final GeoBoundingBoxQuery.Builder boundingBox(GeoBounds value)

Required -

A geo-bounding box. It can be represented in the following ways:

• As 4 top/bottom/left/right coordinates.
• As 2 top_left/bottom_right points.
• As 2 top_right/bottom_left points.
• As a Well Known Text (WKT) bounding box.

boundingBox

@Nonnull
public final GeoBoundingBoxQuery.Builder boundingBox(Function<GeoBounds.Builder,ObjectBuilder<GeoBounds>> fn)

Required -

A geo-bounding box. It can be represented in the following ways:

• As 4 top/bottom/left/right coordinates.
• As 2 top_left/bottom_right points.
• As 2 top_right/bottom_left points.
• As a Well Known Text (WKT) bounding box.

field

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

Required -

ignoreUnmapped

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

API name: ignore_unmapped

type

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

API name: type

validationMethod

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

API name: validation_method

build

@Nonnull
public GeoBoundingBoxQuery build()

Builds a GeoBoundingBoxQuery.

Specified by:

build in interface ObjectBuilder<GeoBoundingBoxQuery>

Throws:

NullPointerException - if some of the required fields are null.