Package org.opensearch.client.core

Class MultiTermVectorsRequest

  • All Implemented Interfaces:
    Validatable, org.opensearch.common.xcontent.ToXContent, org.opensearch.common.xcontent.ToXContentObject
    public class MultiTermVectorsRequest
extends java.lang.Object
implements org.opensearch.common.xcontent.ToXContentObject, Validatable

    • Nested Class Summary

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

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

    • Field Summary

      • Fields inherited from interface org.opensearch.common.xcontent.ToXContent

        EMPTY_PARAMS

    • Constructor Summary

      Constructors 
      Constructor Description
      MultiTermVectorsRequest()
      Constructs an empty MultiTermVectorsRequest After that use add method to add individual TermVectorsRequest to it.
      MultiTermVectorsRequest​(java.lang.String[] ids, TermVectorsRequest template)
      Constructs a MultiTermVectorsRequest from the given document ids and a template TermVectorsRequest.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void add​(TermVectorsRequest request)
      Adds another TermVectorsRequest to this MultiTermVectorsRequest
      org.opensearch.common.xcontent.XContentBuilder toXContent​(org.opensearch.common.xcontent.XContentBuilder builder, org.opensearch.common.xcontent.ToXContent.Params params)  

      • Methods inherited from class java.lang.Object

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

      • Methods inherited from interface org.opensearch.common.xcontent.ToXContentObject

        isFragment

    • Constructor Detail

      • MultiTermVectorsRequest

        public MultiTermVectorsRequest()
        Constructs an empty MultiTermVectorsRequest After that use add method to add individual TermVectorsRequest to it.

      • MultiTermVectorsRequest

        public MultiTermVectorsRequest​(java.lang.String[] ids,
                               TermVectorsRequest template)
        Constructs a MultiTermVectorsRequest from the given document ids and a template TermVectorsRequest. Used when individual requests share the same index, type and other settings.
        Parameters:
        ids - - ids of documents for which term vectors are requested
        template - - a template TermVectorsRequest that allows to set all settings only once for all requests.

    • Method Detail

      • add

        public void add​(TermVectorsRequest request)
        Adds another TermVectorsRequest to this MultiTermVectorsRequest
        Parameters:
        request - - TermVectorsRequest to add

      • toXContent

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