Package org.opensearch.action.termvectors

Class TermVectorsResponse

java.lang.Object
org.opensearch.core.transport.TransportMessage
org.opensearch.core.transport.TransportResponse
org.opensearch.core.action.ActionResponse
org.opensearch.action.termvectors.TermVectorsResponse
All Implemented Interfaces:
org.opensearch.core.common.io.stream.Writeable, org.opensearch.core.xcontent.ToXContent, org.opensearch.core.xcontent.ToXContentObject
@PublicApi(since="1.0.0") public class TermVectorsResponse extends org.opensearch.core.action.ActionResponse implements org.opensearch.core.xcontent.ToXContentObject
Response returning the term vector (doc frequency, positions, offsets) for a document.
Opensearch.api:

  • Nested Class Summary

    Nested classes/interfaces inherited from class org.opensearch.core.transport.TransportResponse

    org.opensearch.core.transport.TransportResponse.Empty

    Nested classes/interfaces inherited from interface org.opensearch.core.xcontent.ToXContent

    org.opensearch.core.xcontent.ToXContent.DelegatingMapParams, org.opensearch.core.xcontent.ToXContent.MapParams, org.opensearch.core.xcontent.ToXContent.Params

    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>

  • Field Summary

    Fields inherited from interface org.opensearch.core.xcontent.ToXContent

    EMPTY_PARAMS

  • Constructor Summary

    Constructors
    Constructor
    Description
    TermVectorsResponse(String index, String id)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    org.apache.lucene.index.Fields
    getFields()
     
    String
    getId()
     
    String
    getIndex()
     
    org.opensearch.common.unit.TimeValue
    getTook()
     
    Long
    getVersion()
     
    boolean
    isArtificial()
     
    boolean
    isExists()
     
    void
    setArtificial(boolean artificial)
     
    void
    setDocVersion(long version)
     
    void
    setExists(boolean exists)
     
    void
    setFields(org.apache.lucene.index.Fields termVectorsByField, Set<String> selectedFields, EnumSet<TermVectorsRequest.Flag> flags, org.apache.lucene.index.Fields topLevelFields)
     
    void
    setFields(org.apache.lucene.index.Fields termVectorsByField, Set<String> selectedFields, EnumSet<TermVectorsRequest.Flag> flags, org.apache.lucene.index.Fields topLevelFields, TermVectorsFilter termVectorsFilter)
     
    void
    setHeader(org.opensearch.core.common.bytes.BytesReference header)
     
    void
    setTermVectorsField(BytesStreamOutput output)
     
    void
    setTookInMillis(long tookInMillis)
     
    org.opensearch.core.xcontent.XContentBuilder
    toXContent(org.opensearch.core.xcontent.XContentBuilder builder, org.opensearch.core.xcontent.ToXContent.Params params)
     
    void
    writeTo(org.opensearch.core.common.io.stream.StreamOutput out)
     

    Methods inherited from class org.opensearch.core.transport.TransportMessage

    remoteAddress, remoteAddress

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface org.opensearch.core.xcontent.ToXContentObject

    isFragment

  • Constructor Details

    • TermVectorsResponse

      public TermVectorsResponse(String index, String id)

  • Method Details

    • 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
      Throws:
      IOException

    • getFields

      public org.apache.lucene.index.Fields getFields() throws IOException
      Throws:
      IOException

    • toXContent

      public org.opensearch.core.xcontent.XContentBuilder toXContent(org.opensearch.core.xcontent.XContentBuilder builder, org.opensearch.core.xcontent.ToXContent.Params params) throws IOException
      Specified by:
      toXContent in interface org.opensearch.core.xcontent.ToXContent
      Throws:
      IOException

    • setTookInMillis

      public void setTookInMillis(long tookInMillis)

    • getTook

      public org.opensearch.common.unit.TimeValue getTook()

    • isExists

      public boolean isExists()

    • setExists

      public void setExists(boolean exists)

    • setFields

      public void setFields(org.apache.lucene.index.Fields termVectorsByField, Set<String> selectedFields, EnumSet<TermVectorsRequest.Flag> flags, org.apache.lucene.index.Fields topLevelFields) throws IOException
      Throws:
      IOException

    • setFields

      public void setFields(org.apache.lucene.index.Fields termVectorsByField, Set<String> selectedFields, EnumSet<TermVectorsRequest.Flag> flags, org.apache.lucene.index.Fields topLevelFields, TermVectorsFilter termVectorsFilter) throws IOException
      Throws:
      IOException

    • setTermVectorsField

      public void setTermVectorsField(BytesStreamOutput output)

    • setHeader

      public void setHeader(org.opensearch.core.common.bytes.BytesReference header)

    • setDocVersion

      public void setDocVersion(long version)

    • getVersion

      public Long getVersion()

    • getIndex

      public String getIndex()

    • getId

      public String getId()

    • isArtificial

      public boolean isArtificial()

    • setArtificial

      public void setArtificial(boolean artificial)