Package org.elasticsearch.index.rankeval
Class RankEvalRequest
- java.lang.Object
-
- org.elasticsearch.transport.TransportMessage
-
- org.elasticsearch.transport.TransportRequest
-
- org.elasticsearch.action.ActionRequest
-
- org.elasticsearch.index.rankeval.RankEvalRequest
-
- All Implemented Interfaces:
IndicesRequest
,IndicesRequest.Replaceable
,Streamable
,Writeable
,TaskAwareRequest
public class RankEvalRequest extends ActionRequest implements IndicesRequest.Replaceable
Request to perform a search ranking evaluation.
-
-
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 extends java.lang.Object>, Writeable.Writer<V extends java.lang.Object>
-
-
Constructor Summary
Constructors Constructor Description RankEvalRequest(RankEvalSpec rankingEvaluationSpec, java.lang.String[] indices)
-
Method Summary
Modifier and Type Method Description boolean
equals(java.lang.Object o)
RankEvalSpec
getRankEvalSpec()
Returns the specification of the ranking evaluation.int
hashCode()
java.lang.String[]
indices()
RankEvalRequest
indices(java.lang.String... indices)
Sets the indices the search will be executed on.IndicesOptions
indicesOptions()
void
indicesOptions(IndicesOptions indicesOptions)
void
readFrom(StreamInput in)
void
setRankEvalSpec(RankEvalSpec task)
Set the the specification of the ranking evaluation.ActionRequestValidationException
validate()
void
writeTo(StreamOutput out)
-
Methods inherited from class org.elasticsearch.action.ActionRequest
getShouldStoreResult
-
Methods inherited from class org.elasticsearch.transport.TransportRequest
getParentTask, setParentTask
-
Methods inherited from class org.elasticsearch.transport.TransportMessage
remoteAddress, remoteAddress
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest
createTask, getDescription, setParentTask
-
-
-
-
Constructor Detail
-
RankEvalRequest
public RankEvalRequest(RankEvalSpec rankingEvaluationSpec, java.lang.String[] indices)
-
-
Method Detail
-
validate
public ActionRequestValidationException validate()
- Specified by:
validate
in classActionRequest
-
getRankEvalSpec
public RankEvalSpec getRankEvalSpec()
Returns the specification of the ranking evaluation.
-
setRankEvalSpec
public void setRankEvalSpec(RankEvalSpec task)
Set the the specification of the ranking evaluation.
-
indices
public RankEvalRequest indices(java.lang.String... indices)
Sets the indices the search will be executed on.- Specified by:
indices
in interfaceIndicesRequest.Replaceable
-
indices
public java.lang.String[] indices()
- Specified by:
indices
in interfaceIndicesRequest
- Returns:
- the indices for this request
-
indicesOptions
public IndicesOptions indicesOptions()
- Specified by:
indicesOptions
in interfaceIndicesRequest
-
indicesOptions
public void indicesOptions(IndicesOptions indicesOptions)
-
readFrom
public void readFrom(StreamInput in) throws java.io.IOException
- Specified by:
readFrom
in interfaceStreamable
- Overrides:
readFrom
in classActionRequest
- Throws:
java.io.IOException
-
writeTo
public void writeTo(StreamOutput out) throws java.io.IOException
- Specified by:
writeTo
in interfaceStreamable
- Specified by:
writeTo
in interfaceWriteable
- Overrides:
writeTo
in classActionRequest
- Throws:
java.io.IOException
-
equals
public boolean equals(java.lang.Object o)
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
-