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

Class XyShapeQuery.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

org.opensearch.client.opensearch._types.query_dsl.XyShapeQuery.Builder

All Implemented Interfaces:

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

Enclosing class:

XyShapeQuery

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

Builder for XyShapeQuery.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

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

Returns:

a new builder instance.

self

@Nonnull
protected XyShapeQuery.Builder self()

Specified by:

self in class QueryBase.AbstractBuilder<XyShapeQuery.Builder>

field

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

Required -

ignoreUnmapped

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

API name: ignore_unmapped

xyShape

@Nonnull
public final XyShapeQuery.Builder xyShape(XyShapeQueryField value)

Required -

xyShape

@Nonnull
public final XyShapeQuery.Builder xyShape(Function<XyShapeQueryField.Builder,ObjectBuilder<XyShapeQueryField>> fn)

Required -

build

@Nonnull
public XyShapeQuery build()

Builds a XyShapeQuery.

Specified by:

build in interface ObjectBuilder<XyShapeQuery>

Throws:

NullPointerException - if some of the required fields are null.