public class TermVectorsRequest extends SingleShardRequest<TermVectorsRequest> implements RealtimeRequest
Note, the SingleShardRequest.index()
, type(String)
and id(String)
are
required.
Modifier and Type | Class and Description |
---|---|
static class |
TermVectorsRequest.FilterSettings |
static class |
TermVectorsRequest.Flag |
TransportRequest.Empty
IndicesRequest.Replaceable
Modifier and Type | Field and Description |
---|---|
protected java.lang.String |
preference |
index, INDICES_OPTIONS
Constructor and Description |
---|
TermVectorsRequest() |
TermVectorsRequest(MultiGetRequest.Item item) |
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.
|
TermVectorsRequest(TermVectorsRequest other)
Constructs a new term vector request for a document that will be fetch
from the provided index.
|
Modifier and Type | Method and Description |
---|---|
BytesReference |
doc()
Returns the artificial document from which term vectors are requested for.
|
TermVectorsRequest |
doc(BytesReference doc,
boolean generateRandomId)
Deprecated.
use
doc(BytesReference, boolean, XContentType) to avoid content auto detection |
TermVectorsRequest |
doc(BytesReference doc,
boolean generateRandomId,
XContentType xContentType)
Sets an artificial document from which term vectors are requested for.
|
TermVectorsRequest |
doc(XContentBuilder documentBuilder)
Sets an artificial document from which term vectors are requested for.
|
boolean |
fieldStatistics() |
TermVectorsRequest |
fieldStatistics(boolean fieldStatistics)
Return the field statistics for each term in the shard or skip.
|
TermVectorsRequest.FilterSettings |
filterSettings()
Return the settings for filtering out terms.
|
TermVectorsRequest |
filterSettings(TermVectorsRequest.FilterSettings settings)
Sets the settings for filtering out terms.
|
java.util.EnumSet<TermVectorsRequest.Flag> |
getFlags() |
java.lang.String |
id()
Returns the id of document the term vector is requested for.
|
TermVectorsRequest |
id(java.lang.String id)
Sets the id of document the term vector is requested for.
|
boolean |
offsets() |
TermVectorsRequest |
offsets(boolean offsets)
Return the start and stop offsets for each term if they were stored or
skip offsets.
|
java.lang.String |
parent() |
TermVectorsRequest |
parent(java.lang.String parent)
Sets the parent id of this document.
|
static void |
parseRequest(TermVectorsRequest termVectorsRequest,
XContentParser parser)
populates a request object (pre-populated with defaults) based on a parser.
|
boolean |
payloads() |
TermVectorsRequest |
payloads(boolean payloads)
Return the payloads for each term or skip.
|
java.util.Map<java.lang.String,java.lang.String> |
perFieldAnalyzer()
Return the overridden analyzers at each field.
|
TermVectorsRequest |
perFieldAnalyzer(java.util.Map<java.lang.String,java.lang.String> perFieldAnalyzer)
Override the analyzer used at each field when generating term vectors.
|
boolean |
positions() |
TermVectorsRequest |
positions(boolean positions)
Return the positions for each term if stored or skip.
|
java.lang.String |
preference() |
TermVectorsRequest |
preference(java.lang.String preference)
Sets the preference to execute the search.
|
void |
readFrom(StreamInput in)
Set this object's fields from a StreamInput.
|
static java.util.Map<java.lang.String,java.lang.String> |
readPerFieldAnalyzer(java.util.Map<java.lang.String,java.lang.Object> map) |
static TermVectorsRequest |
readTermVectorsRequest(StreamInput in) |
boolean |
realtime()
Return whether term vectors should be generated real-time (default to true).
|
TermVectorsRequest |
realtime(boolean realtime) |
java.lang.String |
routing() |
TermVectorsRequest |
routing(java.lang.String routing) |
java.util.Set<java.lang.String> |
selectedFields()
Return only term vectors for special selected fields.
|
TermVectorsRequest |
selectedFields(java.lang.String... fields)
Return only term vectors for special selected fields.
|
boolean |
termStatistics() |
TermVectorsRequest |
termStatistics(boolean termStatistics)
Return the term statistics for each term in the shard or skip.
|
java.lang.String |
type()
Returns the type of document to get the term vector for.
|
TermVectorsRequest |
type(java.lang.String type)
Sets the type of document to get the term vector for.
|
ActionRequestValidationException |
validate() |
long |
version() |
TermVectorsRequest |
version(long version) |
VersionType |
versionType() |
TermVectorsRequest |
versionType(VersionType versionType) |
void |
writeTo(StreamOutput out)
Write this object's fields to a StreamOutput.
|
XContentType |
xContentType() |
index, index, indices, indicesOptions, operationThreaded, operationThreaded, validateNonNullIndex
getShouldStoreResult
getParentTask, setParentTask
remoteAddress, remoteAddress
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
createTask, getDescription, setParentTask
public TermVectorsRequest()
public TermVectorsRequest(java.lang.String index, java.lang.String type, java.lang.String id)
type(String)
and
id(String)
to specify the document to load.public TermVectorsRequest(TermVectorsRequest other)
type(String)
and
id(String)
to specify the document to load.public TermVectorsRequest(MultiGetRequest.Item item)
public java.util.EnumSet<TermVectorsRequest.Flag> getFlags()
public TermVectorsRequest type(java.lang.String type)
public java.lang.String type()
public java.lang.String id()
public TermVectorsRequest id(java.lang.String id)
public BytesReference doc()
public XContentType xContentType()
public TermVectorsRequest doc(XContentBuilder documentBuilder)
@Deprecated public TermVectorsRequest doc(BytesReference doc, boolean generateRandomId)
doc(BytesReference, boolean, XContentType)
to avoid content auto detectionpublic TermVectorsRequest doc(BytesReference doc, boolean generateRandomId, XContentType xContentType)
public java.lang.String routing()
public TermVectorsRequest routing(java.lang.String routing)
public java.lang.String parent()
public TermVectorsRequest parent(java.lang.String parent)
public java.lang.String preference()
public TermVectorsRequest preference(java.lang.String preference)
public TermVectorsRequest offsets(boolean offsets)
public boolean offsets()
true
if term offsets should be returned. Otherwise
false
public TermVectorsRequest positions(boolean positions)
public boolean positions()
public boolean payloads()
true
if term payloads should be returned. Otherwise
false
public TermVectorsRequest payloads(boolean payloads)
public boolean termStatistics()
true
if term statistics should be returned.
Otherwise false
public TermVectorsRequest termStatistics(boolean termStatistics)
public boolean fieldStatistics()
true
if field statistics should be returned.
Otherwise false
public TermVectorsRequest fieldStatistics(boolean fieldStatistics)
public java.util.Set<java.lang.String> selectedFields()
public TermVectorsRequest selectedFields(java.lang.String... fields)
public boolean realtime()
public TermVectorsRequest realtime(boolean realtime)
realtime
in interface RealtimeRequest
realtime
- Controls whether this request should be realtime by reading from the translog.public java.util.Map<java.lang.String,java.lang.String> perFieldAnalyzer()
public TermVectorsRequest perFieldAnalyzer(java.util.Map<java.lang.String,java.lang.String> perFieldAnalyzer)
public TermVectorsRequest.FilterSettings filterSettings()
public TermVectorsRequest filterSettings(TermVectorsRequest.FilterSettings settings)
public long version()
public TermVectorsRequest version(long version)
public VersionType versionType()
public TermVectorsRequest versionType(VersionType versionType)
public ActionRequestValidationException validate()
validate
in class ActionRequest
public static TermVectorsRequest readTermVectorsRequest(StreamInput in) throws java.io.IOException
java.io.IOException
public void readFrom(StreamInput in) throws java.io.IOException
Streamable
readFrom
in interface Streamable
readFrom
in class SingleShardRequest<TermVectorsRequest>
java.io.IOException
public void writeTo(StreamOutput out) throws java.io.IOException
Streamable
writeTo
in interface Streamable
writeTo
in class SingleShardRequest<TermVectorsRequest>
java.io.IOException
public static void parseRequest(TermVectorsRequest termVectorsRequest, XContentParser parser) throws java.io.IOException
java.io.IOException
public static java.util.Map<java.lang.String,java.lang.String> readPerFieldAnalyzer(java.util.Map<java.lang.String,java.lang.Object> map)