Class AnalyzeAction.Request
java.lang.Object
org.opensearch.transport.TransportMessage
org.opensearch.transport.TransportRequest
org.opensearch.action.ActionRequest
org.opensearch.action.support.single.shard.SingleShardRequest<AnalyzeAction.Request>
org.opensearch.action.admin.indices.analyze.AnalyzeAction.Request
- All Implemented Interfaces:
IndicesRequest
,Writeable
,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.opensearch.transport.TransportRequest
TransportRequest.Empty
Nested classes/interfaces inherited from interface org.opensearch.action.IndicesRequest
IndicesRequest.Replaceable
Nested classes/interfaces inherited from interface org.opensearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V>
-
Field Summary
Fields inherited from class org.opensearch.action.support.single.shard.SingleShardRequest
index, INDICES_OPTIONS
-
Constructor Summary
-
Method Summary
Modifier and Type Method Description AnalyzeAction.Request
addCharFilter(java.lang.String charFilter)
AnalyzeAction.Request
addCharFilter(java.util.Map<java.lang.String,?> charFilter)
AnalyzeAction.Request
addTokenFilter(java.lang.String tokenFilter)
AnalyzeAction.Request
addTokenFilter(java.util.Map<java.lang.String,?> tokenFilter)
java.lang.String
analyzer()
AnalyzeAction.Request
analyzer(java.lang.String analyzer)
java.lang.String[]
attributes()
AnalyzeAction.Request
attributes(java.lang.String... attributes)
void
attributes(java.util.List<java.lang.String> attributes)
java.util.List<NameOrDefinition>
charFilters()
boolean
explain()
AnalyzeAction.Request
explain(boolean explain)
java.lang.String
field()
AnalyzeAction.Request
field(java.lang.String field)
static AnalyzeAction.Request
fromXContent(org.opensearch.common.xcontent.XContentParser parser, java.lang.String index)
java.lang.String
normalizer()
AnalyzeAction.Request
normalizer(java.lang.String normalizer)
void
setCharFilters(java.util.List<NameOrDefinition> charFilters)
void
setTokenFilters(java.util.List<NameOrDefinition> tokenFilters)
java.lang.String[]
text()
AnalyzeAction.Request
text(java.lang.String... text)
AnalyzeAction.Request
text(java.util.List<java.lang.String> text)
java.util.List<NameOrDefinition>
tokenFilters()
NameOrDefinition
tokenizer()
AnalyzeAction.Request
tokenizer(java.lang.String tokenizer)
AnalyzeAction.Request
tokenizer(java.util.Map<java.lang.String,?> tokenizer)
void
tokenizer(NameOrDefinition tokenizer)
ActionRequestValidationException
validate()
void
writeTo(StreamOutput out)
Write this into the StreamOutput.Methods inherited from class org.opensearch.action.support.single.shard.SingleShardRequest
index, index, indices, indicesOptions, validateNonNullIndex
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.opensearch.tasks.TaskAwareRequest
createTask, getDescription, setParentTask
-
Constructor Details
-
Method Details
-
text
public java.lang.String[] text() -
text
-
text
-
analyzer
-
analyzer
public java.lang.String analyzer() -
tokenizer
-
tokenizer
-
tokenizer
-
tokenizer
-
addTokenFilter
-
addTokenFilter
-
setTokenFilters
-
tokenFilters
-
addCharFilter
-
addCharFilter
-
setCharFilters
-
charFilters
-
field
-
field
public java.lang.String field() -
explain
-
explain
public boolean explain() -
attributes
-
attributes
public void attributes(java.util.List<java.lang.String> attributes) -
attributes
public java.lang.String[] attributes() -
normalizer
public java.lang.String normalizer() -
normalizer
-
validate
- Specified by:
validate
in classActionRequest
-
writeTo
Description copied from interface:Writeable
Write this into the StreamOutput.- Specified by:
writeTo
in interfaceWriteable
- Overrides:
writeTo
in classSingleShardRequest<AnalyzeAction.Request>
- Throws:
java.io.IOException
-
fromXContent
public static AnalyzeAction.Request fromXContent(org.opensearch.common.xcontent.XContentParser parser, java.lang.String index) throws java.io.IOException- Throws:
java.io.IOException
-