Package co.elastic.clients.elasticsearch.indices

Class AnalyzeRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

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

co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<AnalyzeRequest.Builder>

co.elastic.clients.elasticsearch.indices.AnalyzeRequest.Builder

All Implemented Interfaces:

WithJson<AnalyzeRequest.Builder>, ObjectBuilder<AnalyzeRequest>

Enclosing class:

AnalyzeRequest

public static class AnalyzeRequest.Builder
extends RequestBase.AbstractBuilder<AnalyzeRequest.Builder>
implements ObjectBuilder<AnalyzeRequest>

Builder for AnalyzeRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final AnalyzeRequest.Builder	analyzer(String value)	The name of the analyzer that should be applied to the provided text.
final AnalyzeRequest.Builder	attributes(String value, String... values)	Array of token attributes used to filter the output of the explain parameter.
final AnalyzeRequest.Builder	attributes(List<String> list)	Array of token attributes used to filter the output of the explain parameter.
AnalyzeRequest	build()	Builds a AnalyzeRequest.
final AnalyzeRequest.Builder	charFilter(CharFilter value, CharFilter... values)	Array of character filters used to preprocess characters before the tokenizer.
final AnalyzeRequest.Builder	charFilter(Function<CharFilter.Builder,ObjectBuilder<CharFilter>> fn)	Array of character filters used to preprocess characters before the tokenizer.
final AnalyzeRequest.Builder	charFilter(List<CharFilter> list)	Array of character filters used to preprocess characters before the tokenizer.
final AnalyzeRequest.Builder	explain(Boolean value)	If true, the response includes token attributes and additional details.
final AnalyzeRequest.Builder	field(String value)	Field used to derive the analyzer.
final AnalyzeRequest.Builder	filter(TokenFilter value, TokenFilter... values)	Array of token filters used to apply after the tokenizer.
final AnalyzeRequest.Builder	filter(Function<TokenFilter.Builder,ObjectBuilder<TokenFilter>> fn)	Array of token filters used to apply after the tokenizer.
final AnalyzeRequest.Builder	filter(List<TokenFilter> list)	Array of token filters used to apply after the tokenizer.
final AnalyzeRequest.Builder	index(String value)	Index used to derive the analyzer.
final AnalyzeRequest.Builder	normalizer(String value)	Normalizer to use to convert text into a single token.
protected AnalyzeRequest.Builder	self()
final AnalyzeRequest.Builder	text(String value, String... values)	Text to analyze.
final AnalyzeRequest.Builder	text(List<String> list)	Text to analyze.
final AnalyzeRequest.Builder	tokenizer(Tokenizer value)	Tokenizer to use to convert text into tokens.
final AnalyzeRequest.Builder	tokenizer(Function<Tokenizer.Builder,ObjectBuilder<Tokenizer>> fn)	Tokenizer to use to convert text into tokens.

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 AnalyzeRequest.Builder analyzer(@Nullable
 String value)

The name of the analyzer that should be applied to the provided text. This could be a built-in analyzer, or an analyzer that’s been configured in the index.

API name: analyzer

attributes

public final AnalyzeRequest.Builder attributes(List<String> list)

Array of token attributes used to filter the output of the explain parameter.

API name: attributes

Adds all elements of list to attributes.

attributes

public final AnalyzeRequest.Builder attributes(String value,
 String... values)

Array of token attributes used to filter the output of the explain parameter.

API name: attributes

Adds one or more values to attributes.

charFilter

public final AnalyzeRequest.Builder charFilter(List<CharFilter> list)

Array of character filters used to preprocess characters before the tokenizer.

API name: char_filter

Adds all elements of list to charFilter.

charFilter

public final AnalyzeRequest.Builder charFilter(CharFilter value,
 CharFilter... values)

Array of character filters used to preprocess characters before the tokenizer.

API name: char_filter

Adds one or more values to charFilter.

charFilter

public final AnalyzeRequest.Builder charFilter(Function<CharFilter.Builder,ObjectBuilder<CharFilter>> fn)

Array of character filters used to preprocess characters before the tokenizer.

API name: char_filter

Adds a value to charFilter using a builder lambda.

explain

public final AnalyzeRequest.Builder explain(@Nullable
 Boolean value)

If true, the response includes token attributes and additional details.

API name: explain

field

public final AnalyzeRequest.Builder field(@Nullable
 String value)

Field used to derive the analyzer. To use this parameter, you must specify an index. If specified, the analyzer parameter overrides this value.

API name: field

filter

public final AnalyzeRequest.Builder filter(List<TokenFilter> list)

Array of token filters used to apply after the tokenizer.

API name: filter

Adds all elements of list to filter.

filter

public final AnalyzeRequest.Builder filter(TokenFilter value,
 TokenFilter... values)

Array of token filters used to apply after the tokenizer.

API name: filter

Adds one or more values to filter.

filter

public final AnalyzeRequest.Builder filter(Function<TokenFilter.Builder,ObjectBuilder<TokenFilter>> fn)

Array of token filters used to apply after the tokenizer.

API name: filter

Adds a value to filter using a builder lambda.

index

public final AnalyzeRequest.Builder index(@Nullable
 String value)

Index used to derive the analyzer. If specified, the analyzer or field parameter overrides this value. If no index is specified or the index does not have a default analyzer, the analyze API uses the standard analyzer.

API name: index

normalizer

public final AnalyzeRequest.Builder normalizer(@Nullable
 String value)

Normalizer to use to convert text into a single token.

API name: normalizer

text

public final AnalyzeRequest.Builder text(List<String> list)

Text to analyze. If an array of strings is provided, it is analyzed as a multi-value field.

API name: text

Adds all elements of list to text.

text

public final AnalyzeRequest.Builder text(String value,
 String... values)

Text to analyze. If an array of strings is provided, it is analyzed as a multi-value field.

API name: text

Adds one or more values to text.

tokenizer

public final AnalyzeRequest.Builder tokenizer(@Nullable
 Tokenizer value)

Tokenizer to use to convert text into tokens.

API name: tokenizer

tokenizer

public final AnalyzeRequest.Builder tokenizer(Function<Tokenizer.Builder,ObjectBuilder<Tokenizer>> fn)

Tokenizer to use to convert text into tokens.

API name: tokenizer

self

protected AnalyzeRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<AnalyzeRequest.Builder>

build

public AnalyzeRequest build()

Builds a AnalyzeRequest.

Specified by:

build in interface ObjectBuilder<AnalyzeRequest>

Throws:

NullPointerException - if some of the required fields are null.