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

Class TermQuery.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

org.opensearch.client.opensearch._types.query_dsl.TermQuery.Builder

All Implemented Interfaces:

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

Enclosing class:

TermQuery

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

Builder for TermQuery.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
TermQuery	build()	Builds a TermQuery.
final TermQuery.Builder	caseInsensitive(Boolean value)	Allows ASCII case insensitive matching of the value with the indexed field values when set to true.
TermQuery.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final TermQuery.Builder	field(String value)	Required - The target field
protected TermQuery.Builder	self()
final TermQuery.Builder	value(Function<FieldValue.Builder,ObjectBuilder<FieldValue>> fn)	Required - API name: value
final TermQuery.Builder	value(FieldValue value)	Required - API name: value

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

Returns:

a new builder instance.

self

@Nonnull
protected TermQuery.Builder self()

Specified by:

self in class QueryBase.AbstractBuilder<TermQuery.Builder>

caseInsensitive

@Nonnull
public final TermQuery.Builder caseInsensitive(@Nullable
 Boolean value)

Allows ASCII case insensitive matching of the value with the indexed field values when set to true. When false, the case sensitivity of matching depends on the underlying field's mapping.

API name: case_insensitive

field

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

Required - The target field

value

@Nonnull
public final TermQuery.Builder value(FieldValue value)

Required - API name: value

value

@Nonnull
public final TermQuery.Builder value(Function<FieldValue.Builder,ObjectBuilder<FieldValue>> fn)

Required - API name: value

build

@Nonnull
public TermQuery build()

Builds a TermQuery.

Specified by:

build in interface ObjectBuilder<TermQuery>

Throws:

NullPointerException - if some of the required fields are null.