Package co.elastic.clients.elasticsearch._types.query_dsl

Class PrefixQuery

java.lang.Object

co.elastic.clients.elasticsearch._types.query_dsl.QueryBase

co.elastic.clients.elasticsearch._types.query_dsl.PrefixQuery

All Implemented Interfaces:

QueryVariant, ApiKeyQueryVariant, JsonpSerializable

@JsonpDeserializable
public class PrefixQuery
extends QueryBase
implements ApiKeyQueryVariant, QueryVariant

See Also:

• API specification

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._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
ApiKeyQuery.Kind	_apiKeyQueryKind()	ApiKeyQuery variant kind.
Query.Kind	_queryKind()	Query variant kind.
final Boolean	caseInsensitive()	Allows ASCII case insensitive matching of the value with the indexed field values when set to true.
final String	field()	Required - The target field
static PrefixQuery	of(Function<PrefixQuery.Builder,ObjectBuilder<PrefixQuery>> fn)
final String	rewrite()	Method used to rewrite the query.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupPrefixQueryDeserializer(ObjectDeserializer<PrefixQuery.Builder> op)
final String	value()	Required - Beginning characters of terms you wish to find in the provided field.

Methods inherited from class co.elastic.clients.elasticsearch._types.query_dsl.QueryBase

boost, queryName, serialize, setupQueryBaseDeserializer, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface co.elastic.clients.elasticsearch.security.query_api_keys.ApiKeyQueryVariant

_toApiKeyQuery

Methods inherited from interface co.elastic.clients.elasticsearch._types.query_dsl.QueryVariant

_toQuery

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)

_apiKeyQueryKind

public ApiKeyQuery.Kind _apiKeyQueryKind()

ApiKeyQuery variant kind.

Specified by:

_apiKeyQueryKind in interface ApiKeyQueryVariant

_queryKind

public Query.Kind _queryKind()

Query variant kind.

Specified by:

_queryKind in interface QueryVariant

field

public final String field()

Required - The target field

rewrite

@Nullable
public final String rewrite()

Method used to rewrite the query.

API name: rewrite

value

public final String value()

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

API name: value

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

serializeInternal

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

Overrides:

serializeInternal in class QueryBase

setupPrefixQueryDeserializer

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