Package org.opensearch.index.rankeval

Class RankEvalRequest

java.lang.Object

org.opensearch.core.transport.TransportMessage

org.opensearch.transport.TransportRequest

org.opensearch.action.ActionRequest

org.opensearch.index.rankeval.RankEvalRequest

All Implemented Interfaces:

IndicesRequest, IndicesRequest.Replaceable, org.opensearch.core.common.io.stream.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.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.core.common.io.stream.Writeable

org.opensearch.core.common.io.stream.Writeable.Reader<V>, org.opensearch.core.common.io.stream.Writeable.WriteableRegistry, org.opensearch.core.common.io.stream.Writeable.Writer<V>

Constructor Summary

Constructors

Constructor	Description
RankEvalRequest(RankEvalSpec rankingEvaluationSpec, String[] indices)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
RankEvalSpec	getRankEvalSpec()	Returns the specification of the ranking evaluation.
int	hashCode()
String[]	indices()
RankEvalRequest	indices(String... indices)	Sets the indices the search will be executed on.
IndicesOptions	indicesOptions()
void	indicesOptions(IndicesOptions indicesOptions)
SearchType	searchType()	The type of search to execute.
void	searchType(SearchType searchType)	The search type to execute, defaults to SearchType.DEFAULT.
void	setRankEvalSpec(RankEvalSpec task)	Set the specification of the ranking evaluation.
ActionRequestValidationException	validate()
void	writeTo(org.opensearch.core.common.io.stream.StreamOutput out)

Methods inherited from class org.opensearch.action.ActionRequest

getShouldStoreResult

Methods inherited from class org.opensearch.transport.TransportRequest

getParentTask, setParentTask

Methods inherited from class org.opensearch.core.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.opensearch.action.IndicesRequest

includeDataStreams

Methods inherited from interface org.opensearch.tasks.TaskAwareRequest

createTask, getDescription, setParentTask

Constructor Details

RankEvalRequest

public RankEvalRequest(RankEvalSpec rankingEvaluationSpec,
 String[] indices)

Method Details

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest

getRankEvalSpec

public RankEvalSpec getRankEvalSpec()

Returns the specification of the ranking evaluation.

setRankEvalSpec

public void setRankEvalSpec(RankEvalSpec task)

Set the specification of the ranking evaluation.

indices

public RankEvalRequest indices(String... indices)

Sets the indices the search will be executed on.

Specified by:

indices in interface IndicesRequest.Replaceable

indices

public String[] indices()

Specified by:

indices in interface IndicesRequest

Returns:

the indices for this request

indicesOptions

public IndicesOptions indicesOptions()

Specified by:

indicesOptions in interface IndicesRequest

indicesOptions

public void indicesOptions(IndicesOptions indicesOptions)

searchType

public void searchType(SearchType searchType)

The search type to execute, defaults to SearchType.DEFAULT.

searchType

public SearchType searchType()

The type of search to execute.

writeTo

public void writeTo(org.opensearch.core.common.io.stream.StreamOutput out)
             throws IOException

Specified by:

writeTo in interface org.opensearch.core.common.io.stream.Writeable

Overrides:

writeTo in class ActionRequest

Throws:

IOException

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object