Package org.opensearch.client.opensearch.indices

Class AnalyzeRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder<AnalyzeRequest.Builder>

org.opensearch.client.opensearch.indices.AnalyzeRequest.Builder

All Implemented Interfaces:

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

Enclosing class:

AnalyzeRequest

public static class AnalyzeRequest.Builder
extends RequestBase.AbstractBuilder<AnalyzeRequest.Builder>
implements CopyableBuilder<AnalyzeRequest.Builder,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(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	charFilter(CharFilter value, CharFilter... values)	Array of character filters used to preprocess characters before the tokenizer.
AnalyzeRequest.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final AnalyzeRequest.Builder	explain(Boolean value)	If true, the response includes token attributes and additional details.
final AnalyzeRequest.Builder	field(String value)	API name: field
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	filter(TokenFilter value, TokenFilter... values)	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)	API name: text
final AnalyzeRequest.Builder	text(List<String> list)	API name: text
final AnalyzeRequest.Builder	tokenizer(Function<Tokenizer.Builder,ObjectBuilder<Tokenizer>> fn)	API name: tokenizer
final AnalyzeRequest.Builder	tokenizer(Tokenizer value)	API name: tokenizer

Methods inherited from class org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder

errorTrace, human

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

Returns:

a new builder instance.

self

@Nonnull
protected AnalyzeRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<AnalyzeRequest.Builder>

analyzer

@Nonnull
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

@Nonnull
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

@Nonnull
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

@Nonnull
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

@Nonnull
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

@Nonnull
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

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

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

API name: explain

field

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

API name: field

filter

@Nonnull
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

@Nonnull
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

@Nonnull
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

@Nonnull
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

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

Normalizer to use to convert text into a single token.

API name: normalizer

text

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

API name: text

Adds all elements of list to text.

text

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

API name: text

Adds one or more values to text.

tokenizer

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

API name: tokenizer

tokenizer

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

API name: tokenizer

build

@Nonnull
public AnalyzeRequest build()

Builds a AnalyzeRequest.

Specified by:

build in interface ObjectBuilder<AnalyzeRequest>

Throws:

NullPointerException - if some of the required fields are null.