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

Class WildcardQuery.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.query_dsl.QueryBase.AbstractBuilder<WildcardQuery.Builder>

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

All Implemented Interfaces:

ObjectBuilder<WildcardQuery>

Enclosing class:

WildcardQuery

public static class WildcardQuery.Builder
extends QueryBase.AbstractBuilder<WildcardQuery.Builder>
implements ObjectBuilder<WildcardQuery>

Builder for WildcardQuery.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
WildcardQuery	build()	Builds a WildcardQuery.
WildcardQuery.Builder	caseInsensitive(java.lang.Boolean value)	Allows case insensitive matching of the pattern with the indexed field values when set to true.
WildcardQuery.Builder	field(java.lang.String value)	Required - The target field
WildcardQuery.Builder	rewrite(java.lang.String value)	Method used to rewrite the query
protected WildcardQuery.Builder	self()
WildcardQuery.Builder	value(java.lang.String value)	Wildcard pattern for terms you wish to find in the provided field.
WildcardQuery.Builder	wildcard(java.lang.String value)	Wildcard pattern for terms you wish to find in the provided field.

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

boost, queryName

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

field

public final WildcardQuery.Builder field(java.lang.String value)

Required - The target field

caseInsensitive

public final WildcardQuery.Builder caseInsensitive(@Nullable
                                                   java.lang.Boolean value)

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

rewrite

public final WildcardQuery.Builder rewrite(@Nullable
                                           java.lang.String value)

Method used to rewrite the query

API name: rewrite

value

public final WildcardQuery.Builder value(@Nullable
                                         java.lang.String value)

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

API name: value

wildcard

public final WildcardQuery.Builder wildcard(@Nullable
                                            java.lang.String value)

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

API name: wildcard

self

protected WildcardQuery.Builder self()

Specified by:

self in class QueryBase.AbstractBuilder<WildcardQuery.Builder>

build

public WildcardQuery build()

Builds a WildcardQuery.

Specified by:

build in interface ObjectBuilder<WildcardQuery>

Throws:

java.lang.NullPointerException - if some of the required fields are null.