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

Class SpanNearQuery.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

org.opensearch.client.opensearch._types.query_dsl.SpanNearQuery.Builder

All Implemented Interfaces:

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

Enclosing class:

SpanNearQuery

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

Builder for SpanNearQuery.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
SpanNearQuery	build()	Builds a SpanNearQuery.
final SpanNearQuery.Builder	clauses(Function<SpanQuery.Builder,ObjectBuilder<SpanQuery>> fn)	Required - Array of one or more other span type queries.
final SpanNearQuery.Builder	clauses(List<SpanQuery> list)	Required - Array of one or more other span type queries.
final SpanNearQuery.Builder	clauses(SpanQuery value, SpanQuery... values)	Required - Array of one or more other span type queries.
SpanNearQuery.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final SpanNearQuery.Builder	inOrder(Boolean value)	Controls whether matches are required to be in-order.
protected SpanNearQuery.Builder	self()
final SpanNearQuery.Builder	slop(Integer value)	Controls the maximum number of intervening unmatched positions permitted.

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

Returns:

a new builder instance.

self

@Nonnull
protected SpanNearQuery.Builder self()

Specified by:

self in class QueryBase.AbstractBuilder<SpanNearQuery.Builder>

clauses

@Nonnull
public final SpanNearQuery.Builder clauses(List<SpanQuery> list)

Required - Array of one or more other span type queries.

API name: clauses

Adds all elements of list to clauses.

clauses

@Nonnull
public final SpanNearQuery.Builder clauses(SpanQuery value,
 SpanQuery... values)

Required - Array of one or more other span type queries.

API name: clauses

Adds one or more values to clauses.

clauses

@Nonnull
public final SpanNearQuery.Builder clauses(Function<SpanQuery.Builder,ObjectBuilder<SpanQuery>> fn)

Required - Array of one or more other span type queries.

API name: clauses

Adds a value to clauses using a builder lambda.

inOrder

@Nonnull
public final SpanNearQuery.Builder inOrder(@Nullable
 Boolean value)

Controls whether matches are required to be in-order.

API name: in_order

slop

@Nonnull
public final SpanNearQuery.Builder slop(@Nullable
 Integer value)

Controls the maximum number of intervening unmatched positions permitted.

API name: slop

build

@Nonnull
public SpanNearQuery build()

Builds a SpanNearQuery.

Specified by:

build in interface ObjectBuilder<SpanNearQuery>

Throws:

NullPointerException - if some of the required fields are null.