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

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

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
RegexpQuery	build()	Builds a RegexpQuery.
final RegexpQuery.Builder	caseInsensitive(Boolean value)	Allows case insensitive matching of the regular expression value with the indexed field values when set to true.
RegexpQuery.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final RegexpQuery.Builder	field(String value)	Required - The target field
final RegexpQuery.Builder	flags(String value)	Enables optional operators for the regular expression.
final RegexpQuery.Builder	maxDeterminizedStates(Integer value)	Maximum number of automaton states required for the query.
final RegexpQuery.Builder	rewrite(String value)	API name: rewrite
protected RegexpQuery.Builder	self()
final RegexpQuery.Builder	value(String value)	Required - 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, queryName

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

_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.util.MutableBuilder

applyMutation

Constructor Details

Builder

public Builder()

Method Details

copy

@Nonnull
public RegexpQuery.Builder copy()

Description copied from interface: CopyableBuilder

Create a new builder CopyableBuilder that is a copy of this one.

Specified by:

copy in interface CopyableBuilder<RegexpQuery.Builder,RegexpQuery>

Returns:

a new builder instance.

self

@Nonnull
protected RegexpQuery.Builder self()

Specified by:

self in class QueryBase.AbstractBuilder<RegexpQuery.Builder>

caseInsensitive

@Nonnull
public final RegexpQuery.Builder caseInsensitive(@Nullable
 Boolean value)

Allows case insensitive matching of the regular expression value with the indexed field values when set to true. When false, case sensitivity of matching depends on the underlying field's mapping.

API name: case_insensitive

field

@Nonnull
public final RegexpQuery.Builder field(String value)

Required - The target field

flags

@Nonnull
public final RegexpQuery.Builder flags(@Nullable
 String value)

Enables optional operators for the regular expression.

API name: flags

maxDeterminizedStates

@Nonnull
public final RegexpQuery.Builder maxDeterminizedStates(@Nullable
 Integer value)

Maximum number of automaton states required for the query.

API name: max_determinized_states

rewrite

@Nonnull
public final RegexpQuery.Builder rewrite(@Nullable
 String value)

API name: rewrite

value

@Nonnull
public final RegexpQuery.Builder value(String value)

Required - Regular expression for terms you wish to find in the provided field.

API name: value

build

@Nonnull
public RegexpQuery build()

Builds a RegexpQuery.

Specified by:

build in interface ObjectBuilder<RegexpQuery>

Throws:

NullPointerException - if some of the required fields are null.