io.searchbox.indices

Class Analyze.Builder

java.lang.Object

io.searchbox.action.AbstractAction.Builder<Analyze,Analyze.Builder>

io.searchbox.indices.Analyze.Builder

Enclosing class:

Analyze

public static class Analyze.Builder
extends AbstractAction.Builder<Analyze,Analyze.Builder>

Field Summary

Fields inherited from class io.searchbox.action.AbstractAction.Builder

cleanApiParameters, headers, parameters

Constructor Summary

Constructors

Constructor and Description
Analyze.Builder()

Method Summary

Methods

Modifier and Type	Method and Description
Analyze.Builder	analyzer(String analyzer)
Analyze	build()
Analyze.Builder	field(String field) The analyzer can be derived based on a field mapping.
Analyze.Builder	filter(String filter)
Analyze.Builder	format(String format) By default, the format the tokens are returned in are in json and its called detailed.
Analyze.Builder	index(String index)
Analyze.Builder	text(Collection<? extends String> textToAnalyze)
Analyze.Builder	text(String textToAnalyze)
Analyze.Builder	tokenizer(String tokenizer)

Methods inherited from class io.searchbox.action.AbstractAction.Builder

addCleanApiParameter, refresh, removeCleanApiParameter, resultCasing, setHeader, setHeader, setParameter, setParameter, toggleApiParameter

Methods inherited from class java.lang.Object

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

Constructor Detail

Analyze.Builder

public Analyze.Builder()

Method Detail

index

public Analyze.Builder index(String index)

text

public Analyze.Builder text(String textToAnalyze)

text

public Analyze.Builder text(Collection<? extends String> textToAnalyze)

analyzer

public Analyze.Builder analyzer(String analyzer)

field

public Analyze.Builder field(String field)

The analyzer can be derived based on a field mapping.

tokenizer

public Analyze.Builder tokenizer(String tokenizer)

filter

public Analyze.Builder filter(String filter)

format

public Analyze.Builder format(String format)

By default, the format the tokens are returned in are in json and its called detailed. The text format value provides the analyzed data in a text stream that is a bit more readable.

build

public Analyze build()

Specified by:

build in class AbstractAction.Builder<Analyze,Analyze.Builder>