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

Class GeoShapeQuery.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

org.opensearch.client.opensearch._types.query_dsl.GeoShapeQuery.Builder

All Implemented Interfaces:

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

Enclosing class:

GeoShapeQuery

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

Builder for GeoShapeQuery.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

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

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

Returns:

a new builder instance.

self

@Nonnull
protected GeoShapeQuery.Builder self()

Specified by:

self in class QueryBase.AbstractBuilder<GeoShapeQuery.Builder>

field

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

Required -

ignoreUnmapped

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

API name: ignore_unmapped

shape

@Nonnull
public final GeoShapeQuery.Builder shape(GeoShapeQueryField value)

Required -

shape

@Nonnull
public final GeoShapeQuery.Builder shape(Function<GeoShapeQueryField.Builder,ObjectBuilder<GeoShapeQueryField>> fn)

Required -

build

@Nonnull
public GeoShapeQuery build()

Builds a GeoShapeQuery.

Specified by:

build in interface ObjectBuilder<GeoShapeQuery>

Throws:

NullPointerException - if some of the required fields are null.