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

Class TermsQuery.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.query_dsl.TermsQuery.Builder

All Implemented Interfaces:

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

Enclosing class:

TermsQuery

public static class TermsQuery.Builder
extends ObjectBuilderBase
implements CopyableBuilder<TermsQuery.Builder,TermsQuery>

Builder for TermsQuery.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final TermsQuery.Builder	boost(Float value)	API name: boost
TermsQuery	build()	Builds a TermsQuery.
TermsQuery.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final TermsQuery.Builder	field(String value)	Required -
final TermsQuery.Builder	name(String value)	API name: _name
final TermsQuery.Builder	terms(Function<TermsQueryField.Builder,ObjectBuilder<TermsQueryField>> fn)	Required -
final TermsQuery.Builder	terms(TermsQueryField value)	Required -
final TermsQuery.Builder	valueType(TermsQueryValueType value)	Specifies the types of values used for filtering.

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

Returns:

a new builder instance.

boost

@Nonnull
public final TermsQuery.Builder boost(@Nullable
 Float value)

API name: boost

field

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

Required -

name

@Nonnull
public final TermsQuery.Builder name(@Nullable
 String value)

API name: _name

terms

@Nonnull
public final TermsQuery.Builder terms(TermsQueryField value)

Required -

terms

@Nonnull
public final TermsQuery.Builder terms(Function<TermsQueryField.Builder,ObjectBuilder<TermsQueryField>> fn)

Required -

valueType

@Nonnull
public final TermsQuery.Builder valueType(@Nullable
 TermsQueryValueType value)

Specifies the types of values used for filtering. Valid values are default and bitmap. Default is default.

API name: value_type

build

@Nonnull
public TermsQuery build()

Builds a TermsQuery.

Specified by:

build in interface ObjectBuilder<TermsQuery>

Throws:

NullPointerException - if some of the required fields are null.