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

Class WildcardQuery

java.lang.Object

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

org.opensearch.client.opensearch._types.query_dsl.WildcardQuery

All Implemented Interfaces:

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

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

Nested Class Summary

Nested Classes

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

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<WildcardQuery>	_DESERIALIZER	Json deserializer for WildcardQuery

Method Summary

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

Json deserializer for WildcardQuery

Method Details

of

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

_queryKind

public Query.Kind _queryKind()

Query variant kind.

Specified by:

_queryKind in interface QueryVariant

caseInsensitive

@Nullable
public final Boolean caseInsensitive()

Allows case insensitive matching of the pattern 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

@Nullable
public final String value()

Wildcard pattern for terms you wish to find in the provided field. Required, when wildcard is not set.

API name: value

wildcard

@Nullable
public final String wildcard()

Wildcard pattern for terms you wish to find in the provided field. Required, when value is not set.

API name: wildcard

serializeInternal

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

Overrides:

serializeInternal in class QueryBase

toBuilder

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

Returns:

a new builder instance.

builder

@Nonnull
public static WildcardQuery.Builder builder()

setupWildcardQueryDeserializer

protected static void setupWildcardQueryDeserializer(ObjectDeserializer<WildcardQuery.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class QueryBase

equals

public boolean equals(Object o)

Overrides:

equals in class QueryBase