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

Class TermsQuery

java.lang.Object

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

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable, QueryVariant, ToCopyableBuilder<TermsQuery.Builder,TermsQuery>

@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public class TermsQuery
extends Object
implements QueryVariant, PlainJsonSerializable, ToCopyableBuilder<TermsQuery.Builder,TermsQuery>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TermsQuery.Builder	Builder for TermsQuery.

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<TermsQuery>	_DESERIALIZER	Json deserializer for TermsQuery

Method Summary

Modifier and Type	Method	Description
Query.Kind	_queryKind()	Query variant kind.
final Float	boost()	API name: boost
static TermsQuery.Builder	builder()
boolean	equals(Object o)
final String	field()	Required -
int	hashCode()
final String	name()	API name: _name
static TermsQuery	of(Function<TermsQuery.Builder,ObjectBuilder<TermsQuery>> fn)
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupTermsQueryDeserializer(ObjectDeserializer<TermsQuery.Builder> op)
final TermsQueryField	terms()	Required -
TermsQuery.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.
final TermsQueryValueType	valueType()	Specifies the types of values used for filtering.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.opensearch.client.json.PlainJsonSerializable

toJsonString

Methods inherited from interface org.opensearch.client.opensearch._types.query_dsl.QueryVariant

toQuery

Methods inherited from interface org.opensearch.client.util.ToCopyableBuilder

copy

Field Details

_DESERIALIZER

public static final JsonpDeserializer<TermsQuery> _DESERIALIZER

Json deserializer for TermsQuery

Method Details

of

public static TermsQuery of(Function<TermsQuery.Builder,ObjectBuilder<TermsQuery>> fn)

_queryKind

public Query.Kind _queryKind()

Query variant kind.

Specified by:

_queryKind in interface QueryVariant

boost

@Nullable
public final Float boost()

API name: boost

field

@Nonnull
public final String field()

Required -

name

@Nullable
public final String name()

API name: _name

terms

@Nonnull
public final TermsQueryField terms()

Required -

valueType

@Nullable
public final TermsQueryValueType valueType()

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

API name: value_type

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Serialize this object to JSON.

Specified by:

serialize in interface JsonpSerializable

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

toBuilder

@Nonnull
public TermsQuery.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<TermsQuery.Builder,TermsQuery>

Returns:

a new builder instance.

builder

@Nonnull
public static TermsQuery.Builder builder()

setupTermsQueryDeserializer

protected static void setupTermsQueryDeserializer(ObjectDeserializer<TermsQuery.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object