Package org.elasticsearch.action.termvectors

Class TermVectorsRequest

    • Field Detail

      • preference

        protected java.lang.String preference

    • Constructor Detail

      • TermVectorsRequest

        public TermVectorsRequest()

      • TermVectorsRequest

        public TermVectorsRequest​(java.lang.String index,
                          java.lang.String type,
                          java.lang.String id)
        Constructs a new term vector request for a document that will be fetch from the provided index. Use type(String) and id(String) to specify the document to load.

      • TermVectorsRequest

        public TermVectorsRequest​(TermVectorsRequest other)
        Constructs a new term vector request for a document that will be fetch from the provided index. Use type(String) and id(String) to specify the document to load.

    • Method Detail

      • type

        public TermVectorsRequest type​(java.lang.String type)
        Sets the type of document to get the term vector for.

      • type

        public java.lang.String type()
        Returns the type of document to get the term vector for.

      • id

        public java.lang.String id()
        Returns the id of document the term vector is requested for.

      • id

        public TermVectorsRequest id​(java.lang.String id)
        Sets the id of document the term vector is requested for.

      • doc

        public BytesReference doc()
        Returns the artificial document from which term vectors are requested for.

      • routing

        public java.lang.String routing()
        Returns:
        The routing for this request.

      • preference

        public java.lang.String preference()

      • preference

        public TermVectorsRequest preference​(java.lang.String preference)
        Sets the preference to execute the search. Defaults to randomize across shards. Can be set to _local to prefer local shards or a custom value, which guarantees that the same order will be used across different requests.

      • offsets

        public TermVectorsRequest offsets​(boolean offsets)
        Return the start and stop offsets for each term if they were stored or skip offsets.

      • offsets

        public boolean offsets()
        Returns:
        true if term offsets should be returned. Otherwise false

      • positions

        public TermVectorsRequest positions​(boolean positions)
        Return the positions for each term if stored or skip.

      • positions

        public boolean positions()
        Returns:
        Returns if the positions for each term should be returned if stored or skip.

      • payloads

        public boolean payloads()
        Returns:
        true if term payloads should be returned. Otherwise false

      • payloads

        public TermVectorsRequest payloads​(boolean payloads)
        Return the payloads for each term or skip.

      • termStatistics

        public boolean termStatistics()
        Returns:
        true if term statistics should be returned. Otherwise false

      • termStatistics

        public TermVectorsRequest termStatistics​(boolean termStatistics)
        Return the term statistics for each term in the shard or skip.

      • fieldStatistics

        public boolean fieldStatistics()
        Returns:
        true if field statistics should be returned. Otherwise false

      • fieldStatistics

        public TermVectorsRequest fieldStatistics​(boolean fieldStatistics)
        Return the field statistics for each term in the shard or skip.

      • selectedFields

        public java.util.Set<java.lang.String> selectedFields()
        Return only term vectors for special selected fields. Returns for term vectors for all fields if selectedFields == null

      • selectedFields

        public TermVectorsRequest selectedFields​(java.lang.String... fields)
        Return only term vectors for special selected fields. Returns the term vectors for all fields if selectedFields == null

      • realtime

        public boolean realtime()
        Return whether term vectors should be generated real-time (default to true).

      • realtime

        public TermVectorsRequest realtime​(boolean realtime)
        Specified by:
        realtime in interface RealtimeRequest
        Parameters:
        realtime - Controls whether this request should be realtime by reading from the translog.

      • perFieldAnalyzer

        public java.util.Map<java.lang.String,​java.lang.String> perFieldAnalyzer()
        Return the overridden analyzers at each field.

      • perFieldAnalyzer

        public TermVectorsRequest perFieldAnalyzer​(java.util.Map<java.lang.String,​java.lang.String> perFieldAnalyzer)
        Override the analyzer used at each field when generating term vectors.

      • version

        public long version()

      • readTermVectorsRequest

        public static TermVectorsRequest readTermVectorsRequest​(StreamInput in)
                                                 throws java.io.IOException
        Throws:
        java.io.IOException

      • parseRequest

        public static void parseRequest​(TermVectorsRequest termVectorsRequest,
                                XContentParser parser)
                         throws java.io.IOException
        populates a request object (pre-populated with defaults) based on a parser.
        Throws:
        java.io.IOException

      • readPerFieldAnalyzer

        public static java.util.Map<java.lang.String,​java.lang.String> readPerFieldAnalyzer​(java.util.Map<java.lang.String,​java.lang.Object> map)