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:

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

Enclosing class:

WildcardQuery

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

Builder for WildcardQuery.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
WildcardQuery	build()	Builds a WildcardQuery.
final WildcardQuery.Builder	caseInsensitive(Boolean value)	Allows case insensitive matching of the pattern with the indexed field values when set to true.
WildcardQuery.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final WildcardQuery.Builder	field(String value)	Required - The target field
final WildcardQuery.Builder	rewrite(String value)	API name: rewrite
protected WildcardQuery.Builder	self()
final WildcardQuery.Builder	value(String value)	Wildcard pattern for terms you wish to find in the provided field.
final WildcardQuery.Builder	wildcard(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, _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 WildcardQuery.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<WildcardQuery.Builder,WildcardQuery>

Returns:

a new builder instance.

self

@Nonnull
protected WildcardQuery.Builder self()

Specified by:

self in class QueryBase.AbstractBuilder<WildcardQuery.Builder>

caseInsensitive

@Nonnull
public final WildcardQuery.Builder caseInsensitive(@Nullable
 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

field

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

Required - The target field

rewrite

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

API name: rewrite

value

@Nonnull
public final WildcardQuery.Builder value(@Nullable
 String value)

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

API name: value

wildcard

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

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

API name: wildcard

build

@Nonnull
public WildcardQuery build()

Builds a WildcardQuery.

Specified by:

build in interface ObjectBuilder<WildcardQuery>

Throws:

NullPointerException - if some of the required fields are null.