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.Writeable, org.elasticsearch.common.util.concurrent.RefCounted, 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 class org.elasticsearch.transport.TransportRequest

    org.elasticsearch.transport.TransportRequest.Empty

    Nested classes/interfaces inherited from interface org.elasticsearch.action.IndicesRequest

    org.elasticsearch.action.IndicesRequest.Replaceable

    Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

    org.elasticsearch.common.io.stream.Writeable.Reader<V extends java.lang.Object>, org.elasticsearch.common.io.stream.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.
    org.elasticsearch.action.support.IndicesOptions indicesOptions()  
    void indicesOptions​(org.elasticsearch.action.support.IndicesOptions indicesOptions)  
    org.elasticsearch.action.search.SearchType searchType()
    The type of search to execute.
    void searchType​(org.elasticsearch.action.search.SearchType searchType)
    The search type to execute, defaults to SearchType.DEFAULT.
    void setRankEvalSpec​(RankEvalSpec task)
    Set the specification of the ranking evaluation.
    org.elasticsearch.action.ActionRequestValidationException validate()  
    void writeTo​(org.elasticsearch.common.io.stream.StreamOutput out)  

    Methods inherited from class org.elasticsearch.action.ActionRequest

    getShouldStoreResult

    Methods inherited from class org.elasticsearch.transport.TransportRequest

    getParentTask, setParentTask, toString

    Methods inherited from class org.elasticsearch.transport.TransportMessage

    decRef, incRef, remoteAddress, remoteAddress, tryIncRef

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface org.elasticsearch.action.IndicesRequest

    includeDataStreams

    Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest

    createTask, getDescription, setParentTask

  • Constructor Details

    • RankEvalRequest

      public RankEvalRequest​(RankEvalSpec rankingEvaluationSpec, java.lang.String[] indices)

  • Method Details

    • validate

      public org.elasticsearch.action.ActionRequestValidationException validate()
      Specified by:
      validate in class org.elasticsearch.action.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​(java.lang.String... indices)
      Sets the indices the search will be executed on.
      Specified by:
      indices in interface org.elasticsearch.action.IndicesRequest.Replaceable

    • indices

      public java.lang.String[] indices()
      Specified by:
      indices in interface org.elasticsearch.action.IndicesRequest
      Returns:
      the indices for this request

    • indicesOptions

      public org.elasticsearch.action.support.IndicesOptions indicesOptions()
      Specified by:
      indicesOptions in interface org.elasticsearch.action.IndicesRequest

    • indicesOptions

      public void indicesOptions​(org.elasticsearch.action.support.IndicesOptions indicesOptions)

    • searchType

      public void searchType​(org.elasticsearch.action.search.SearchType searchType)
      The search type to execute, defaults to SearchType.DEFAULT.

    • searchType

      public org.elasticsearch.action.search.SearchType searchType()
      The type of search to execute.

    • writeTo

      public void writeTo​(org.elasticsearch.common.io.stream.StreamOutput out) throws java.io.IOException
      Specified by:
      writeTo in interface org.elasticsearch.common.io.stream.Writeable
      Overrides:
      writeTo in class org.elasticsearch.action.ActionRequest
      Throws:
      java.io.IOException

    • equals

      public boolean equals​(java.lang.Object o)
      Overrides:
      equals in class java.lang.Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class java.lang.Object