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

Class SimpleQueryStringQuery.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

org.opensearch.client.opensearch._types.query_dsl.SimpleQueryStringQuery.Builder

All Implemented Interfaces:

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

Enclosing class:

SimpleQueryStringQuery

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

Builder for SimpleQueryStringQuery.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final SimpleQueryStringQuery.Builder	analyzer(String value)	Analyzer used to convert text in the query string into tokens.
final SimpleQueryStringQuery.Builder	analyzeWildcard(Boolean value)	If true, the query attempts to analyze wildcard terms in the query string.
final SimpleQueryStringQuery.Builder	autoGenerateSynonymsPhraseQuery(Boolean value)	If true, the parser creates a match_phrase query for each multi-position token.
SimpleQueryStringQuery	build()	Builds a SimpleQueryStringQuery.
SimpleQueryStringQuery.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final SimpleQueryStringQuery.Builder	defaultOperator(Operator value)	API name: default_operator
final SimpleQueryStringQuery.Builder	fields(String value, String... values)	Array of fields you wish to search.
final SimpleQueryStringQuery.Builder	fields(List<String> list)	Array of fields you wish to search.
final SimpleQueryStringQuery.Builder	flags(Function<SimpleQueryStringFlags.Builder,ObjectBuilder<SimpleQueryStringFlags>> fn)	API name: flags
final SimpleQueryStringQuery.Builder	flags(SimpleQueryStringFlags value)	API name: flags
final SimpleQueryStringQuery.Builder	fuzzyMaxExpansions(Integer value)	Maximum number of terms to which the query expands for fuzzy matching.
final SimpleQueryStringQuery.Builder	fuzzyPrefixLength(Integer value)	Number of beginning characters left unchanged for fuzzy matching.
final SimpleQueryStringQuery.Builder	fuzzyTranspositions(Boolean value)	If true, edits for fuzzy matching include transpositions of two adjacent characters (for example, ab to ba).
final SimpleQueryStringQuery.Builder	lenient(Boolean value)	If true, format-based errors, such as providing a text value for a numeric field, are ignored.
final SimpleQueryStringQuery.Builder	minimumShouldMatch(String value)	API name: minimum_should_match
final SimpleQueryStringQuery.Builder	query(String value)	Required - Query string in the simple query string syntax you wish to parse and use for search.
final SimpleQueryStringQuery.Builder	quoteFieldSuffix(String value)	Suffix appended to quoted text in the query string.
protected SimpleQueryStringQuery.Builder	self()

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 SimpleQueryStringQuery.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<SimpleQueryStringQuery.Builder,SimpleQueryStringQuery>

Returns:

a new builder instance.

self

@Nonnull
protected SimpleQueryStringQuery.Builder self()

Specified by:

self in class QueryBase.AbstractBuilder<SimpleQueryStringQuery.Builder>

analyzeWildcard

@Nonnull
public final SimpleQueryStringQuery.Builder analyzeWildcard(@Nullable
 Boolean value)

If true, the query attempts to analyze wildcard terms in the query string.

API name: analyze_wildcard

analyzer

@Nonnull
public final SimpleQueryStringQuery.Builder analyzer(@Nullable
 String value)

Analyzer used to convert text in the query string into tokens.

API name: analyzer

autoGenerateSynonymsPhraseQuery

@Nonnull
public final SimpleQueryStringQuery.Builder autoGenerateSynonymsPhraseQuery(@Nullable
 Boolean value)

If true, the parser creates a match_phrase query for each multi-position token.

API name: auto_generate_synonyms_phrase_query

defaultOperator

@Nonnull
public final SimpleQueryStringQuery.Builder defaultOperator(@Nullable
 Operator value)

API name: default_operator

fields

@Nonnull
public final SimpleQueryStringQuery.Builder fields(List<String> list)

Array of fields you wish to search. Accepts wildcard expressions. You also can boost relevance scores for matches to particular fields using a caret (^) notation. Defaults to the index.query.default_field index setting, which has a default value of *.

API name: fields

Adds all elements of list to fields.

fields

@Nonnull
public final SimpleQueryStringQuery.Builder fields(String value,
 String... values)

Array of fields you wish to search. Accepts wildcard expressions. You also can boost relevance scores for matches to particular fields using a caret (^) notation. Defaults to the index.query.default_field index setting, which has a default value of *.

API name: fields

Adds one or more values to fields.

flags

@Nonnull
public final SimpleQueryStringQuery.Builder flags(@Nullable
 SimpleQueryStringFlags value)

API name: flags

flags

@Nonnull
public final SimpleQueryStringQuery.Builder flags(Function<SimpleQueryStringFlags.Builder,ObjectBuilder<SimpleQueryStringFlags>> fn)

API name: flags

fuzzyMaxExpansions

@Nonnull
public final SimpleQueryStringQuery.Builder fuzzyMaxExpansions(@Nullable
 Integer value)

Maximum number of terms to which the query expands for fuzzy matching.

API name: fuzzy_max_expansions

fuzzyPrefixLength

@Nonnull
public final SimpleQueryStringQuery.Builder fuzzyPrefixLength(@Nullable
 Integer value)

Number of beginning characters left unchanged for fuzzy matching.

API name: fuzzy_prefix_length

fuzzyTranspositions

@Nonnull
public final SimpleQueryStringQuery.Builder fuzzyTranspositions(@Nullable
 Boolean value)

If true, edits for fuzzy matching include transpositions of two adjacent characters (for example, ab to ba).

API name: fuzzy_transpositions

lenient

@Nonnull
public final SimpleQueryStringQuery.Builder lenient(@Nullable
 Boolean value)

If true, format-based errors, such as providing a text value for a numeric field, are ignored.

API name: lenient

minimumShouldMatch

@Nonnull
public final SimpleQueryStringQuery.Builder minimumShouldMatch(@Nullable
 String value)

API name: minimum_should_match

query

@Nonnull
public final SimpleQueryStringQuery.Builder query(String value)

Required - Query string in the simple query string syntax you wish to parse and use for search.

API name: query

quoteFieldSuffix

@Nonnull
public final SimpleQueryStringQuery.Builder quoteFieldSuffix(@Nullable
 String value)

Suffix appended to quoted text in the query string.

API name: quote_field_suffix

build

@Nonnull
public SimpleQueryStringQuery build()

Builds a SimpleQueryStringQuery.

Specified by:

build in interface ObjectBuilder<SimpleQueryStringQuery>

Throws:

NullPointerException - if some of the required fields are null.