Module org.elasticsearch.server

Package org.elasticsearch.action.admin.indices.analyze

Class AnalyzeAction.Request

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportRequest

org.elasticsearch.action.ActionRequest

org.elasticsearch.action.support.single.shard.SingleShardRequest<AnalyzeAction.Request>

org.elasticsearch.action.admin.indices.analyze.AnalyzeAction.Request

All Implemented Interfaces:

IndicesRequest, Writeable, RefCounted, TaskAwareRequest

Enclosing class:

AnalyzeAction

public static class AnalyzeAction.Request
extends SingleShardRequest<AnalyzeAction.Request>

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

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields inherited from class org.elasticsearch.action.support.single.shard.SingleShardRequest

index, INDICES_OPTIONS

Constructor Summary

Constructors

Constructor	Description
Request()
Request(String index)	Constructs a new analyzer request for the provided index.

Method Summary

Modifier and Type	Method	Description
AnalyzeAction.Request	addCharFilter(String charFilter)
AnalyzeAction.Request	addCharFilter(Map<String,?> charFilter)
AnalyzeAction.Request	addTokenFilter(String tokenFilter)
AnalyzeAction.Request	addTokenFilter(Map<String,?> tokenFilter)
String	analyzer()
AnalyzeAction.Request	analyzer(String analyzer)
String[]	attributes()
AnalyzeAction.Request	attributes(String... attributes)
void	attributes(List<String> attributes)
List<NameOrDefinition>	charFilters()
boolean	explain()
AnalyzeAction.Request	explain(boolean explain)
String	field()
AnalyzeAction.Request	field(String field)
static AnalyzeAction.Request	fromXContent(XContentParser parser, String index)
String	normalizer()
AnalyzeAction.Request	normalizer(String normalizer)
void	setCharFilters(List<NameOrDefinition> charFilters)
void	setTokenFilters(List<NameOrDefinition> tokenFilters)
String[]	text()
AnalyzeAction.Request	text(String... text)
AnalyzeAction.Request	text(List<String> text)
List<NameOrDefinition>	tokenFilters()
NameOrDefinition	tokenizer()
AnalyzeAction.Request	tokenizer(String tokenizer)
AnalyzeAction.Request	tokenizer(Map<String,?> tokenizer)
void	tokenizer(NameOrDefinition tokenizer)
ActionRequestValidationException	validate()
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class org.elasticsearch.action.support.single.shard.SingleShardRequest

index, index, indices, indicesOptions, validateNonNullIndex

Methods inherited from class org.elasticsearch.action.ActionRequest

getShouldStoreResult

Methods inherited from class org.elasticsearch.transport.TransportRequest

getParentTask, setParentTask, toString

Methods inherited from class org.elasticsearch.transport.TransportMessage

decRef, hasReferences, incRef, remoteAddress, remoteAddress, tryIncRef

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.action.IndicesRequest

includeDataStreams

Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest

createTask, getDescription, setParentTask

Constructor Details

Request

public Request()

Request

public Request(String index)

Constructs a new analyzer request for the provided index.

Parameters:

index - The text to analyze

Method Details

text

public String[] text()

text

public AnalyzeAction.Request text(String... text)

text

public AnalyzeAction.Request text(List<String> text)

analyzer

public AnalyzeAction.Request analyzer(String analyzer)

analyzer

public String analyzer()

tokenizer

public AnalyzeAction.Request tokenizer(String tokenizer)

tokenizer

public AnalyzeAction.Request tokenizer(Map<String,?> tokenizer)

tokenizer

public void tokenizer(NameOrDefinition tokenizer)

tokenizer

public NameOrDefinition tokenizer()

addTokenFilter

public AnalyzeAction.Request addTokenFilter(String tokenFilter)

addTokenFilter

public AnalyzeAction.Request addTokenFilter(Map<String,?> tokenFilter)

setTokenFilters

public void setTokenFilters(List<NameOrDefinition> tokenFilters)

tokenFilters

public List<NameOrDefinition> tokenFilters()

addCharFilter

public AnalyzeAction.Request addCharFilter(Map<String,?> charFilter)

addCharFilter

public AnalyzeAction.Request addCharFilter(String charFilter)

setCharFilters

public void setCharFilters(List<NameOrDefinition> charFilters)

charFilters

public List<NameOrDefinition> charFilters()

field

public AnalyzeAction.Request field(String field)

field

public String field()

explain

public AnalyzeAction.Request explain(boolean explain)

explain

public boolean explain()

attributes

public AnalyzeAction.Request attributes(String... attributes)

attributes

public void attributes(List<String> attributes)

attributes

public String[] attributes()

normalizer

public String normalizer()

normalizer

public AnalyzeAction.Request normalizer(String normalizer)

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class SingleShardRequest<AnalyzeAction.Request>

Throws:

IOException

fromXContent

public static AnalyzeAction.Request fromXContent(XContentParser parser,
 String index)
                                          throws IOException

Throws:

IOException