org.elasticsearch.action.admin.indices.analyze

Class AnalyzeRequest

java.lang.Object

org.elasticsearch.common.ContextAndHeaderHolder

org.elasticsearch.transport.TransportMessage<TransportRequest>

org.elasticsearch.transport.TransportRequest

org.elasticsearch.action.ActionRequest<T>

org.elasticsearch.action.support.single.custom.SingleCustomOperationRequest<AnalyzeRequest>

org.elasticsearch.action.admin.indices.analyze.AnalyzeRequest

All Implemented Interfaces:

IndicesRequest, HasContext, HasContextAndHeaders, HasHeaders, Streamable

public class AnalyzeRequest
extends SingleCustomOperationRequest<AnalyzeRequest>

A request to analyze a text associated with a specific index. Allow to provide the actual analyzer name to perform the analysis with.

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.transport.TransportRequest

TransportRequest.Empty

Nested classes/interfaces inherited from interface org.elasticsearch.action.IndicesRequest

IndicesRequest.Replaceable

Field Summary

Fields inherited from class org.elasticsearch.common.ContextAndHeaderHolder

headers

Constructor Summary

Constructors

Constructor and Description
AnalyzeRequest(String text) Constructs a new analyzer request for the provided text.
AnalyzeRequest(String index, String text) Constructs a new analyzer request for the provided index and text.

Method Summary

Modifier and Type	Method and Description
String	analyzer()
AnalyzeRequest	analyzer(String analyzer)
String[]	charFilters()
AnalyzeRequest	charFilters(String... charFilters)
String	field()
AnalyzeRequest	field(String field)
void	readFrom(StreamInput in)
String	text()
String[]	tokenFilters()
AnalyzeRequest	tokenFilters(String... tokenFilters)
String	tokenizer()
AnalyzeRequest	tokenizer(String tokenizer)
ActionRequestValidationException	validate()
void	writeTo(StreamOutput out)

Methods inherited from class org.elasticsearch.action.support.single.custom.SingleCustomOperationRequest

beforeLocalFork, index, index, indices, indicesOptions, operationThreaded, operationThreaded, preferLocal, preferLocalShard, readIndex, writeIndex

Methods inherited from class org.elasticsearch.action.ActionRequest

listenerThreaded, listenerThreaded

Methods inherited from class org.elasticsearch.transport.TransportMessage

putHeader, remoteAddress, remoteAddress

Methods inherited from class org.elasticsearch.common.ContextAndHeaderHolder

contextSize, copyContextAndHeadersFrom, copyContextFrom, copyHeadersFrom, getContext, getFromContext, getFromContext, getHeader, getHeaders, hasHeader, hasInContext, isContextEmpty, putAllInContext, putInContext

Methods inherited from class java.lang.Object

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

Constructor Detail

AnalyzeRequest

public AnalyzeRequest(String text)

Constructs a new analyzer request for the provided text.

Parameters:

text - The text to analyze

AnalyzeRequest

public AnalyzeRequest(@Nullable
                      String index,
                      String text)

Constructs a new analyzer request for the provided index and text.

Parameters:

index - The index name

text - The text to analyze

Method Detail

text

public String text()

analyzer

public AnalyzeRequest analyzer(String analyzer)

analyzer

public String analyzer()

tokenizer

public AnalyzeRequest tokenizer(String tokenizer)

tokenizer

public String tokenizer()

tokenFilters

public AnalyzeRequest tokenFilters(String... tokenFilters)

tokenFilters

public String[] tokenFilters()

charFilters

public AnalyzeRequest charFilters(String... charFilters)

charFilters

public String[] charFilters()

field

public AnalyzeRequest field(String field)

field

public String field()

validate

public ActionRequestValidationException validate()

Overrides:

validate in class SingleCustomOperationRequest<AnalyzeRequest>

readFrom

public void readFrom(StreamInput in)
              throws IOException

Specified by:

readFrom in interface Streamable

Overrides:

readFrom in class SingleCustomOperationRequest<AnalyzeRequest>

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Streamable

Overrides:

writeTo in class SingleCustomOperationRequest<AnalyzeRequest>

Throws:

IOException