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

Class PrefixQuery

java.lang.Object

org.opensearch.client.opensearch._types.query_dsl.QueryBase

org.opensearch.client.opensearch._types.query_dsl.PrefixQuery

All Implemented Interfaces:

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

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

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.opensearch.client.opensearch._types.query_dsl.QueryBase

QueryBase.AbstractBuilder<BuilderT extends QueryBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
Query.Kind	_queryKind()	Query variant kind.
static PrefixQuery.Builder	builder()
final Boolean	caseInsensitive()	Allows ASCII case insensitive matching of the value with the indexed field values when set to true.
boolean	equals(Object o)
final String	field()	Required - The target field
int	hashCode()
static PrefixQuery	of(Function<PrefixQuery.Builder,ObjectBuilder<PrefixQuery>> fn)
final String	rewrite()	API name: rewrite
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupPrefixQueryDeserializer(ObjectDeserializer<PrefixQuery.Builder> op)
PrefixQuery.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.
final String	value()	Required - Beginning characters of terms you wish to find in the provided field.

Methods inherited from class org.opensearch.client.opensearch._types.query_dsl.QueryBase

boost, queryName, serialize, setupQueryBaseDeserializer

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<PrefixQuery> _DESERIALIZER

Json deserializer for PrefixQuery

Method Details

of

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

_queryKind

public Query.Kind _queryKind()

Query variant kind.

Specified by:

_queryKind in interface QueryVariant

caseInsensitive

@Nullable
public final Boolean caseInsensitive()

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

API name: case_insensitive

field

@Nonnull
public final String field()

Required - The target field

rewrite

@Nullable
public final String rewrite()

API name: rewrite

value

@Nonnull
public final String value()

Required - Beginning characters of terms you wish to find in the provided field.

API name: value

serializeInternal

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

Overrides:

serializeInternal in class QueryBase

toBuilder

@Nonnull
public PrefixQuery.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<PrefixQuery.Builder,PrefixQuery>

Returns:

a new builder instance.

builder

@Nonnull
public static PrefixQuery.Builder builder()

setupPrefixQueryDeserializer

protected static void setupPrefixQueryDeserializer(ObjectDeserializer<PrefixQuery.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class QueryBase

equals

public boolean equals(Object o)

Overrides:

equals in class QueryBase