org.elasticsearch.action.admin.indices.analyze

Class AnalyzeRequestBuilder

java.lang.Object

org.elasticsearch.action.ActionRequestBuilder<Request,Response,RequestBuilder>

org.elasticsearch.action.support.single.shard.SingleShardOperationRequestBuilder<AnalyzeRequest,AnalyzeResponse,AnalyzeRequestBuilder>

org.elasticsearch.action.admin.indices.analyze.AnalyzeRequestBuilder

public class AnalyzeRequestBuilder
extends SingleShardOperationRequestBuilder<AnalyzeRequest,AnalyzeResponse,AnalyzeRequestBuilder>

Field Summary

Fields inherited from class org.elasticsearch.action.ActionRequestBuilder

action, client, request

Constructor Summary

Constructors

Constructor and Description
AnalyzeRequestBuilder(ElasticsearchClient client, AnalyzeAction action)
AnalyzeRequestBuilder(ElasticsearchClient client, AnalyzeAction action, String index, String... text)

Method Summary

Methods

Modifier and Type	Method and Description
AnalyzeRequestBuilder	setAnalyzer(String analyzer) Sets the analyzer name to use in order to analyze the text.
AnalyzeRequestBuilder	setAttributes(String attributes) Sets attributes that will include results
AnalyzeRequestBuilder	setCharFilters(String... charFilters) Sets char filters that will be used before the tokenizer.
AnalyzeRequestBuilder	setExplain(boolean explain) Sets explain
AnalyzeRequestBuilder	setField(String field) Sets the field that its analyzer will be used to analyze the text.
AnalyzeRequestBuilder	setText(String... texts) Sets texts to analyze
AnalyzeRequestBuilder	setTokenFilters(String... tokenFilters) Sets token filters that will be used on top of a tokenizer provided.
AnalyzeRequestBuilder	setTokenizer(String tokenizer) Instead of setting the analyzer, sets the tokenizer that will be used as part of a custom analyzer.

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

setIndex, setOperationThreaded

Methods inherited from class org.elasticsearch.action.ActionRequestBuilder

beforeExecute, execute, execute, get, get, get, putHeader, request

Methods inherited from class java.lang.Object

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

Constructor Detail

AnalyzeRequestBuilder

public AnalyzeRequestBuilder(ElasticsearchClient client,
                     AnalyzeAction action)

AnalyzeRequestBuilder

public AnalyzeRequestBuilder(ElasticsearchClient client,
                     AnalyzeAction action,
                     String index,
                     String... text)

Method Detail

setAnalyzer

public AnalyzeRequestBuilder setAnalyzer(String analyzer)

Sets the analyzer name to use in order to analyze the text.

Parameters:

analyzer - The analyzer name.

setField

public AnalyzeRequestBuilder setField(String field)

Sets the field that its analyzer will be used to analyze the text. Note, requires an index to be set.

setTokenizer

public AnalyzeRequestBuilder setTokenizer(String tokenizer)

Instead of setting the analyzer, sets the tokenizer that will be used as part of a custom analyzer.

setTokenFilters

public AnalyzeRequestBuilder setTokenFilters(String... tokenFilters)

Sets token filters that will be used on top of a tokenizer provided.

setCharFilters

public AnalyzeRequestBuilder setCharFilters(String... charFilters)

Sets char filters that will be used before the tokenizer.

setExplain

public AnalyzeRequestBuilder setExplain(boolean explain)

Sets explain

setAttributes

public AnalyzeRequestBuilder setAttributes(String attributes)

Sets attributes that will include results

setText

public AnalyzeRequestBuilder setText(String... texts)

Sets texts to analyze