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

Class PrefixQuery.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

org.opensearch.client.opensearch._types.query_dsl.PrefixQuery.Builder

All Implemented Interfaces:

CopyableBuilder<PrefixQuery.Builder,PrefixQuery>, MutableBuilder<PrefixQuery.Builder,PrefixQuery>, ObjectBuilder<PrefixQuery>

Enclosing class:

PrefixQuery

public static class PrefixQuery.Builder
extends QueryBase.AbstractBuilder<PrefixQuery.Builder>
implements CopyableBuilder<PrefixQuery.Builder,PrefixQuery>

Builder for PrefixQuery.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
PrefixQuery	build()	Builds a PrefixQuery.
final PrefixQuery.Builder	caseInsensitive(Boolean value)	Allows ASCII case insensitive matching of the value with the indexed field values when set to true.
PrefixQuery.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final PrefixQuery.Builder	field(String value)	Required - The target field
final PrefixQuery.Builder	rewrite(String value)	API name: rewrite
protected PrefixQuery.Builder	self()
final PrefixQuery.Builder	value(String value)	Required - Beginning characters of 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 PrefixQuery.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<PrefixQuery.Builder,PrefixQuery>

Returns:

a new builder instance.

self

@Nonnull
protected PrefixQuery.Builder self()

Specified by:

self in class QueryBase.AbstractBuilder<PrefixQuery.Builder>

caseInsensitive

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

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

field

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

Required - The target field

rewrite

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

API name: rewrite

value

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

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

API name: value

build

@Nonnull
public PrefixQuery build()

Builds a PrefixQuery.

Specified by:

build in interface ObjectBuilder<PrefixQuery>

Throws:

NullPointerException - if some of the required fields are null.