Class RegexpQuery.Builder
java.lang.Object
org.opensearch.client.util.ObjectBuilderBase
org.opensearch.client.opensearch._types.query_dsl.QueryBase.AbstractBuilder<RegexpQuery.Builder>
org.opensearch.client.opensearch._types.query_dsl.RegexpQuery.Builder
- All Implemented Interfaces:
CopyableBuilder<RegexpQuery.Builder,,RegexpQuery> MutableBuilder<RegexpQuery.Builder,,RegexpQuery> ObjectBuilder<RegexpQuery>
- Enclosing class:
RegexpQuery
public static class RegexpQuery.Builder
extends QueryBase.AbstractBuilder<RegexpQuery.Builder>
implements CopyableBuilder<RegexpQuery.Builder,RegexpQuery>
Builder for
RegexpQuery.-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbuild()Builds aRegexpQuery.final RegexpQuery.BuildercaseInsensitive(Boolean value) Allows case insensitive matching of the regular expression value with the indexed field values when set totrue.copy()Create a new builderCopyableBuilderthat is a copy of this one.final RegexpQuery.BuilderRequired - The target fieldfinal RegexpQuery.BuilderEnables optional operators for the regular expression.final RegexpQuery.BuildermaxDeterminizedStates(Integer value) Maximum number of automaton states required for the query.final RegexpQuery.BuilderAPI name:rewriteprotected RegexpQuery.Builderself()final RegexpQuery.BuilderRequired - Regular expression for terms you wish to find in the provided field.Methods inherited from class org.opensearch.client.opensearch._types.query_dsl.QueryBase.AbstractBuilder
boost, queryNameMethods inherited from class org.opensearch.client.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAllMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.opensearch.client.util.MutableBuilder
applyMutation
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
copy
Description copied from interface:CopyableBuilderCreate a new builderCopyableBuilderthat is a copy of this one.- Specified by:
copyin interfaceCopyableBuilder<RegexpQuery.Builder,RegexpQuery> - Returns:
- a new builder instance.
-
self
- Specified by:
selfin classQueryBase.AbstractBuilder<RegexpQuery.Builder>
-
caseInsensitive
Allows case insensitive matching of the regular expression value with the indexed field values when set totrue. Whenfalse, case sensitivity of matching depends on the underlying field's mapping.API name:
case_insensitive -
field
Required - The target field -
flags
Enables optional operators for the regular expression.API name:
flags -
maxDeterminizedStates
Maximum number of automaton states required for the query.API name:
max_determinized_states -
rewrite
API name:rewrite -
value
Required - Regular expression for terms you wish to find in the provided field.API name:
value -
build
Builds aRegexpQuery.- Specified by:
buildin interfaceObjectBuilder<RegexpQuery>- Throws:
NullPointerException- if some of the required fields are null.
-