Package org.elasticsearch.client.core

Class TermVectorsRequest

java.lang.Object
org.elasticsearch.client.core.TermVectorsRequest
All Implemented Interfaces:
Validatable, ToXContent, ToXContentObject
public class TermVectorsRequest
extends java.lang.Object
implements ToXContentObject, Validatable

  • Constructor Details

    • TermVectorsRequest

      public TermVectorsRequest​(java.lang.String index, java.lang.String docId)
      Constructs TermVectorRequest for the given document
      Parameters:
      index - - index of the document
      docId - - id of the document

    • TermVectorsRequest

      @Deprecated public TermVectorsRequest​(java.lang.String index, java.lang.String type, java.lang.String docId)
      Deprecated.
      Types are in the process of being removed, use TermVectorsRequest(String, String) instead.
      Constructs TermVectorRequest for the given document
      Parameters:
      index - - index of the document
      type - - type of the document
      docId - - id of the document

    • TermVectorsRequest

      public TermVectorsRequest​(java.lang.String index, XContentBuilder docBuilder)
      Constructs TermVectorRequest for an artificial document
      Parameters:
      index - - index of the document
      docBuilder - - an artificial document

    • TermVectorsRequest

      @Deprecated public TermVectorsRequest​(java.lang.String index, java.lang.String type, XContentBuilder docBuilder)
      Deprecated.
      Types are in the process of being removed, use TermVectorsRequest(java.lang.String,org.elasticsearch.common.xcontent.XContentBuilder) instead.
      Constructs TermVectorRequest for an artificial document
      Parameters:
      index - - index of the document
      type - - type of the document
      docBuilder - - an artificial document

  • Method Details

    • getIndex

      public java.lang.String getIndex()
      Returns the index of the request

    • getType

      @Deprecated public java.lang.String getType()
      Deprecated.
      Types are in the process of being removed.
      Returns the type of the request

    • getId

      public java.lang.String getId()
      Returns the id of the request can be NULL if there is no document ID

    • setFields

      public void setFields​(java.lang.String... fields)
      Sets the fields for which term vectors information should be retrieved

    • getFields

      public java.lang.String[] getFields()

    • setPositions

      public void setPositions​(boolean requestPositions)
      Sets whether to request term positions

    • setPayloads

      public void setPayloads​(boolean requestPayloads)
      Sets whether to request term payloads

    • setOffsets

      public void setOffsets​(boolean requestOffsets)
      Sets whether to request term offsets

    • setFieldStatistics

      public void setFieldStatistics​(boolean requestFieldStatistics)
      Sets whether to request field statistics

    • setTermStatistics

      public void setTermStatistics​(boolean requestTermStatistics)
      Sets whether to request term statistics

    • setPerFieldAnalyzer

      public void setPerFieldAnalyzer​(java.util.Map<java.lang.String,​java.lang.String> perFieldAnalyzer)
      Sets different analyzers than the one at the fields

    • setFilterSettings

      public void setFilterSettings​(java.util.Map<java.lang.String,​java.lang.Integer> filterSettings)
      Sets conditions for terms filtering

    • setRouting

      public void setRouting​(java.lang.String routing)
      Sets a routing to route a request to a particular shard

    • getRouting

      public java.lang.String getRouting()

    • setPreference

      public void setPreference​(java.lang.String preference)
      Set a preference of which shard copies to execute the request

    • getPreference

      public java.lang.String getPreference()

    • setRealtime

      public void setRealtime​(boolean realtime)
      Sets if the request should be realtime or near-realtime

    • getRealtime

      public boolean getRealtime()
      Returns if the request is realtime(true) or near-realtime(false)

    • toXContent

      public XContentBuilder toXContent​(XContentBuilder builder, ToXContent.Params params) throws java.io.IOException
      Specified by:
      toXContent in interface ToXContent
      Throws:
      java.io.IOException