Package org.opensearch.client.opensearch.indices

Class AnalyzeRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.indices.AnalyzeRequest

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class AnalyzeRequest
extends RequestBase
implements JsonpSerializable

Performs the analysis process on a text and return the tokens breakdown of the text.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AnalyzeRequest.Builder	Builder for AnalyzeRequest.

Nested classes/interfaces inherited from class org.opensearch.client.opensearch._types.RequestBase

RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static JsonpDeserializer<AnalyzeRequest>	_DESERIALIZER	Json deserializer for AnalyzeRequest
static Endpoint<AnalyzeRequest,AnalyzeResponse,ErrorResponse>	_ENDPOINT	Endpoint "indices.analyze".

Method Summary

Modifier and Type	Method	Description
java.lang.String	analyzer()	API name: analyzer
java.util.List<java.lang.String>	attributes()	API name: attributes
java.util.List<CharFilter>	charFilter()	API name: char_filter
java.lang.Boolean	explain()	API name: explain
java.lang.String	field()	API name: field
java.util.List<TokenFilter>	filter()	API name: filter
java.lang.String	index()	The name of the index to scope the operation
java.lang.String	normalizer()	API name: normalizer
static AnalyzeRequest	of(java.util.function.Function<AnalyzeRequest.Builder,ObjectBuilder<AnalyzeRequest>> fn)
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupAnalyzeRequestDeserializer(ObjectDeserializer<AnalyzeRequest.Builder> op)
java.util.List<java.lang.String>	text()	API name: text
Tokenizer	tokenizer()	API name: tokenizer

Methods inherited from class java.lang.Object

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

Field Detail

_DESERIALIZER

public static final JsonpDeserializer<AnalyzeRequest> _DESERIALIZER

Json deserializer for AnalyzeRequest

_ENDPOINT

public static final Endpoint<AnalyzeRequest,AnalyzeResponse,ErrorResponse> _ENDPOINT

Endpoint "indices.analyze".

Method Detail

of

public static AnalyzeRequest of(java.util.function.Function<AnalyzeRequest.Builder,ObjectBuilder<AnalyzeRequest>> fn)

analyzer

@Nullable
public final java.lang.String analyzer()

API name: analyzer

attributes

public final java.util.List<java.lang.String> attributes()

API name: attributes

charFilter

public final java.util.List<CharFilter> charFilter()

API name: char_filter

explain

@Nullable
public final java.lang.Boolean explain()

API name: explain

field

@Nullable
public final java.lang.String field()

API name: field

filter

public final java.util.List<TokenFilter> filter()

API name: filter

index

@Nullable
public final java.lang.String index()

The name of the index to scope the operation

API name: index

normalizer

@Nullable
public final java.lang.String normalizer()

API name: normalizer

text

public final java.util.List<java.lang.String> text()

API name: text

tokenizer

@Nullable
public final Tokenizer tokenizer()

API name: tokenizer

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
                      JsonpMapper mapper)

Serialize this object to JSON.

Specified by:

serialize in interface JsonpSerializable

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
                                 JsonpMapper mapper)

setupAnalyzeRequestDeserializer

protected static void setupAnalyzeRequestDeserializer(ObjectDeserializer<AnalyzeRequest.Builder> op)