Package org.elasticsearch.client.core
Class TermVectorsRequest
java.lang.Object
org.elasticsearch.client.core.TermVectorsRequest
- All Implemented Interfaces:
Validatable
,org.elasticsearch.xcontent.ToXContent
,org.elasticsearch.xcontent.ToXContentObject
public class TermVectorsRequest
extends Object
implements org.elasticsearch.xcontent.ToXContentObject, Validatable
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent
org.elasticsearch.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.xcontent.ToXContent.MapParams, org.elasticsearch.xcontent.ToXContent.Params
-
Field Summary
Fields inherited from interface org.elasticsearch.xcontent.ToXContent
EMPTY_PARAMS
Fields inherited from interface org.elasticsearch.client.Validatable
EMPTY
-
Constructor Summary
ConstructorDescriptionTermVectorsRequest
(String index, String docId) Constructs TermVectorRequest for the given documentTermVectorsRequest
(String index, String type, String docId) Deprecated.TermVectorsRequest
(String index, String type, org.elasticsearch.xcontent.XContentBuilder docBuilder) Deprecated.Types are in the process of being removed, useTermVectorsRequest(java.lang.String,org.elasticsearch.xcontent.XContentBuilder)
instead.TermVectorsRequest
(String index, org.elasticsearch.xcontent.XContentBuilder docBuilder) Constructs TermVectorRequest for an artificial document -
Method Summary
Modifier and TypeMethodDescriptionString[]
getId()
Returns the id of the request can be NULL if there is no document IDgetIndex()
Returns the index of the requestboolean
Returns if the request is realtime(true) or near-realtime(false)getType()
Deprecated.Types are in the process of being removed.void
Sets the fields for which term vectors information should be retrievedvoid
setFieldStatistics
(boolean fieldStatistics) Sets whether to request field statisticsvoid
setFilterSettings
(Map<String, Integer> filterSettings) Sets conditions for terms filteringvoid
setOffsets
(boolean offsets) Sets whether to request term offsetsvoid
setPayloads
(boolean payloads) Sets whether to request term payloadsvoid
setPerFieldAnalyzer
(Map<String, String> perFieldAnalyzer) Sets different analyzers than the one at the fieldsvoid
setPositions
(boolean positions) Sets whether to request term positionsvoid
setPreference
(String preference) Set a preference of which shard copies to execute the requestvoid
setRealtime
(boolean realtime) Sets if the request should be realtime or near-realtimevoid
setRouting
(String routing) Sets a routing to route a request to a particular shardvoid
setTermStatistics
(boolean termStatistics) Sets whether to request term statisticsorg.elasticsearch.xcontent.XContentBuilder
toXContent
(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.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.elasticsearch.xcontent.ToXContentObject
isFragment
Methods inherited from interface org.elasticsearch.client.Validatable
validate
-
Constructor Details
-
TermVectorsRequest
Constructs TermVectorRequest for the given document- Parameters:
index
- - index of the documentdocId
- - id of the document
-
TermVectorsRequest
Deprecated.Types are in the process of being removed, useTermVectorsRequest(String, String)
instead.Constructs TermVectorRequest for the given document- Parameters:
index
- - index of the documenttype
- - type of the documentdocId
- - id of the document
-
TermVectorsRequest
Constructs TermVectorRequest for an artificial document- Parameters:
index
- - index of the documentdocBuilder
- - an artificial document
-
TermVectorsRequest
@Deprecated public TermVectorsRequest(String index, String type, org.elasticsearch.xcontent.XContentBuilder docBuilder) Deprecated.Types are in the process of being removed, useTermVectorsRequest(java.lang.String,org.elasticsearch.xcontent.XContentBuilder)
instead.Constructs TermVectorRequest for an artificial document- Parameters:
index
- - index of the documenttype
- - type of the documentdocBuilder
- - an artificial document
-
-
Method Details
-
getIndex
Returns the index of the request -
getType
Deprecated.Types are in the process of being removed.Returns the type of the request -
getId
Returns the id of the request can be NULL if there is no document ID -
setFields
Sets the fields for which term vectors information should be retrieved -
getFields
-
setPositions
public void setPositions(boolean positions) Sets whether to request term positions -
setPayloads
public void setPayloads(boolean payloads) Sets whether to request term payloads -
setOffsets
public void setOffsets(boolean offsets) Sets whether to request term offsets -
setFieldStatistics
public void setFieldStatistics(boolean fieldStatistics) Sets whether to request field statistics -
setTermStatistics
public void setTermStatistics(boolean termStatistics) Sets whether to request term statistics -
setPerFieldAnalyzer
Sets different analyzers than the one at the fields -
setFilterSettings
Sets conditions for terms filtering -
setRouting
Sets a routing to route a request to a particular shard -
getRouting
-
setPreference
Set a preference of which shard copies to execute the request -
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 org.elasticsearch.xcontent.XContentBuilder toXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) throws IOException - Specified by:
toXContent
in interfaceorg.elasticsearch.xcontent.ToXContent
- Throws:
IOException
-
TermVectorsRequest(String, String)
instead.