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:
org.elasticsearch.action.IndicesRequest
,org.elasticsearch.action.IndicesRequest.Replaceable
,org.elasticsearch.common.io.stream.Streamable
,org.elasticsearch.common.io.stream.Writeable
,org.elasticsearch.tasks.TaskAwareRequest
public class RankEvalRequest extends org.elasticsearch.action.ActionRequest implements org.elasticsearch.action.IndicesRequest.Replaceable
Request to perform a search ranking evaluation.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.elasticsearch.action.IndicesRequest
org.elasticsearch.action.IndicesRequest.Replaceable
-
-
Constructor Summary
Constructors Constructor Description RankEvalRequest(RankEvalSpec rankingEvaluationSpec, java.lang.String[] indices)
-
Method Summary
All Methods Instance Methods Concrete Methods 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.org.elasticsearch.action.support.IndicesOptions
indicesOptions()
void
indicesOptions(org.elasticsearch.action.support.IndicesOptions indicesOptions)
void
readFrom(org.elasticsearch.common.io.stream.StreamInput in)
void
setRankEvalSpec(RankEvalSpec task)
Set the the specification of the ranking evaluation.org.elasticsearch.action.ActionRequestValidationException
validate()
void
writeTo(org.elasticsearch.common.io.stream.StreamOutput out)
-
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 org.elasticsearch.action.ActionRequestValidationException validate()
- Specified by:
validate
in classorg.elasticsearch.action.ActionRequest
-
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 interfaceorg.elasticsearch.action.IndicesRequest.Replaceable
-
indices
public java.lang.String[] indices()
- Specified by:
indices
in interfaceorg.elasticsearch.action.IndicesRequest
- Returns:
- the indices for this request
-
indicesOptions
public org.elasticsearch.action.support.IndicesOptions indicesOptions()
- Specified by:
indicesOptions
in interfaceorg.elasticsearch.action.IndicesRequest
-
indicesOptions
public void indicesOptions(org.elasticsearch.action.support.IndicesOptions indicesOptions)
-
readFrom
public void readFrom(org.elasticsearch.common.io.stream.StreamInput in) throws java.io.IOException
- Specified by:
readFrom
in interfaceorg.elasticsearch.common.io.stream.Streamable
- Overrides:
readFrom
in classorg.elasticsearch.action.ActionRequest
- Throws:
java.io.IOException
-
writeTo
public void writeTo(org.elasticsearch.common.io.stream.StreamOutput out) throws java.io.IOException
- Specified by:
writeTo
in interfaceorg.elasticsearch.common.io.stream.Streamable
- Specified by:
writeTo
in interfaceorg.elasticsearch.common.io.stream.Writeable
- Overrides:
writeTo
in classorg.elasticsearch.action.ActionRequest
- 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
-
-