Package co.elastic.clients.elasticsearch._types.query_dsl

Class SimpleQueryStringQuery.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>

co.elastic.clients.elasticsearch._types.query_dsl.QueryBase.AbstractBuilder<SimpleQueryStringQuery.Builder>

co.elastic.clients.elasticsearch._types.query_dsl.SimpleQueryStringQuery.Builder

All Implemented Interfaces:

WithJson<SimpleQueryStringQuery.Builder>, ObjectBuilder<SimpleQueryStringQuery>

Enclosing class:

SimpleQueryStringQuery

public static class SimpleQueryStringQuery.Builder
extends QueryBase.AbstractBuilder<SimpleQueryStringQuery.Builder>
implements ObjectBuilder<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.
final SimpleQueryStringQuery.Builder	defaultOperator(Operator value)	Default boolean logic used to interpret text in the query string if no operators are specified.
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(SimpleQueryStringFlag value, SimpleQueryStringFlag... values)	List of enabled operators for the simple query string syntax.
final SimpleQueryStringQuery.Builder	flags(List<SimpleQueryStringFlag> list)	List of enabled operators for the simple query string syntax.
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)	Minimum number of clauses that must match for a document to be returned.
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 co.elastic.clients.elasticsearch._types.query_dsl.QueryBase.AbstractBuilder

boost, queryName

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

analyzer

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

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

API name: analyzer

analyzeWildcard

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

autoGenerateSynonymsPhraseQuery

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

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

Default boolean logic used to interpret text in the query string if no operators are specified.

API name: default_operator

fields

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

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

public final SimpleQueryStringQuery.Builder flags(List<SimpleQueryStringFlag> list)

List of enabled operators for the simple query string syntax.

API name: flags

Adds all elements of list to flags.

flags

public final SimpleQueryStringQuery.Builder flags(SimpleQueryStringFlag value,
 SimpleQueryStringFlag... values)

List of enabled operators for the simple query string syntax.

API name: flags

Adds one or more values to flags.

fuzzyMaxExpansions

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

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

Number of beginning characters left unchanged for fuzzy matching.

API name: fuzzy_prefix_length

fuzzyTranspositions

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

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

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

Minimum number of clauses that must match for a document to be returned.

API name: minimum_should_match

query

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

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

Suffix appended to quoted text in the query string.

API name: quote_field_suffix

self

protected SimpleQueryStringQuery.Builder self()

Specified by:

self in class QueryBase.AbstractBuilder<SimpleQueryStringQuery.Builder>

build

public SimpleQueryStringQuery build()

Builds a SimpleQueryStringQuery.

Specified by:

build in interface ObjectBuilder<SimpleQueryStringQuery>

Throws:

NullPointerException - if some of the required fields are null.