TermVectorsRequest (Elasticsearch: Core 2.3.5.1 API)

java.lang.Object
- org.elasticsearch.common.ContextAndHeaderHolder
- - org.elasticsearch.transport.TransportMessage<TransportRequest>
  - - org.elasticsearch.transport.TransportRequest
    - - org.elasticsearch.action.ActionRequest<T>
      - org.elasticsearch.action.support.single.shard.SingleShardRequest<TermVectorsRequest>
        
        org.elasticsearch.action.termvectors.TermVectorsRequest

すべての実装されたインタフェース:

DocumentRequest<TermVectorsRequest>, IndicesRequest, RealtimeRequest, HasContext, HasContextAndHeaders, HasHeaders, Streamable
```
public class TermVectorsRequest
extends SingleShardRequest<TermVectorsRequest>
implements DocumentRequest<TermVectorsRequest>, RealtimeRequest
```
Request returning the term vector (doc frequency, positions, offsets) for a document.
Note, the SingleShardRequest.index(), type(String) and id(String) are required.

ネストされたクラスのサマリー

ネストされたクラス
修飾子とタイプクラスと説明

static class TermVectorsRequest.FilterSettings

static class TermVectorsRequest.Flag
- クラスから継承されたネストされたクラス/インタフェース org.elasticsearch.transport.TransportRequest
  TransportRequest.Empty
- インタフェースから継承されたネストされたクラス/インタフェース org.elasticsearch.action.IndicesRequest
  IndicesRequest.Replaceable

ネストされたクラス
修飾子とタイプ	クラスと説明
`static class`	`TermVectorsRequest.FilterSettings`
`static class`	`TermVectorsRequest.Flag`

フィールドのサマリー

フィールド
修飾子とタイプフィールドと説明

protected String preference
- クラスから継承されたフィールド org.elasticsearch.action.support.single.shard.SingleShardRequest
  index, INDICES_OPTIONS
- クラスから継承されたフィールド org.elasticsearch.common.ContextAndHeaderHolder
  headers

フィールド
修飾子とタイプ	フィールドと説明
`protected String`	`preference`

コンストラクタのサマリー

コンストラクタ
コンストラクタと説明
`TermVectorsRequest()`
`TermVectorsRequest(MultiGetRequest.Item item)`
`TermVectorsRequest(String index, String type, 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.

メソッドのサマリー

すべてのメソッド staticメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`boolean`	`dfs()`
`TermVectorsRequest`	`dfs(boolean dfs)` Use distributed frequencies instead of shard statistics.
`BytesReference`	`doc()` Returns the artificial document from which term vectors are requested for.
`TermVectorsRequest`	`doc(BytesReference doc, boolean generateRandomId)` 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.
`EnumSet<TermVectorsRequest.Flag>`	`getFlags()`
`String`	`id()` Returns the id of document the term vector is requested for.
`TermVectorsRequest`	`id(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.
`TermVectorsRequest`	`parent(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.
`Map<String,String>`	`perFieldAnalyzer()` Return the overridden analyzers at each field.
`TermVectorsRequest`	`perFieldAnalyzer(Map<String,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.
`String`	`preference()`
`TermVectorsRequest`	`preference(String preference)` Sets the preference to execute the search.
`void`	`readFrom(StreamInput in)`
`static Map<String,String>`	`readPerFieldAnalyzer(Map<String,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)` Choose whether term vectors be generated real-time.
`String`	`routing()` Get the routing for this request
`TermVectorsRequest`	`routing(String routing)` Set the routing for this request
`Set<String>`	`selectedFields()` Return only term vectors for special selected fields.
`TermVectorsRequest`	`selectedFields(String... fields)` Return only term vectors for special selected fields.
`long`	`startTime()`
`boolean`	`termStatistics()`
`TermVectorsRequest`	`termStatistics(boolean termStatistics)` Return the term statistics for each term in the shard or skip.
`String`	`type()` Returns the type of document to get the term vector for.
`TermVectorsRequest`	`type(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)`

クラスから継承されたメソッド org.elasticsearch.action.support.single.shard.SingleShardRequest
index, index, indices, indicesOptions, operationThreaded, operationThreaded, validateNonNullIndex

クラスから継承されたメソッド org.elasticsearch.transport.TransportRequest
createTask, getDescription

クラスから継承されたメソッド org.elasticsearch.transport.TransportMessage
remoteAddress, remoteAddress

クラスから継承されたメソッド org.elasticsearch.common.ContextAndHeaderHolder
contextSize, copyContextAndHeadersFrom, copyContextFrom, copyHeadersFrom, getContext, getFromContext, getFromContext, getHeader, getHeaders, hasHeader, hasInContext, isContextEmpty, putAllInContext, putHeader, putInContext

クラスから継承されたメソッド java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

インタフェースから継承されたメソッド org.elasticsearch.action.DocumentRequest
index, indicesOptions

インタフェースから継承されたメソッド org.elasticsearch.action.IndicesRequest
indices

- フィールドの詳細
  - preference
```
protected String preference
```
- コンストラクタの詳細
  - TermVectorsRequest
```
public TermVectorsRequest()
```
  - TermVectorsRequest
```
public TermVectorsRequest(String index,
                          String type,
                          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.
  - TermVectorsRequest
```
public TermVectorsRequest(MultiGetRequest.Item item)
```
- メソッドの詳細
  - getFlags
```
public EnumSet<TermVectorsRequest.Flag> getFlags()
```
  - type
```
public TermVectorsRequest type(String type)
```
    Sets the type of document to get the term vector for.
  - type
```
public String type()
```
    Returns the type of document to get the term vector for.
    
    定義:
    
    type インタフェース内 DocumentRequest<TermVectorsRequest>
    
    戻り値:
    
    the type
  - id
```
public String id()
```
    Returns the id of document the term vector is requested for.
    
    定義:
    
    id インタフェース内 DocumentRequest<TermVectorsRequest>
    
    戻り値:
    
    the id
  - id
```
public TermVectorsRequest id(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.
  - doc
```
public TermVectorsRequest doc(XContentBuilder documentBuilder)
```
    Sets an artificial document from which term vectors are requested for.
  - doc
```
public TermVectorsRequest doc(BytesReference doc,
                              boolean generateRandomId)
```
    Sets an artificial document from which term vectors are requested for.
  - routing
```
public String routing()
```
    インタフェースからコピーされた説明: DocumentRequest
    
    Get the routing for this request
    
    定義:
    
    routing インタフェース内 DocumentRequest<TermVectorsRequest>
    
    戻り値:
    
    The routing for this request.
  - routing
```
public TermVectorsRequest routing(String routing)
```
    インタフェースからコピーされた説明: DocumentRequest
    
    Set the routing for this request
    
    定義:
    
    routing インタフェース内 DocumentRequest<TermVectorsRequest>
    
    戻り値:
    
    the Request
  - parent
```
public TermVectorsRequest parent(String parent)
```
    Sets the parent id of this document. Will simply set the routing to this value, as it is only used for routing with delete requests.
  - preference
```
public String preference()
```
  - preference
```
public TermVectorsRequest preference(String preference)
```
    Sets the preference to execute the search. Defaults to randomize across shards. Can be set to _local to prefer local shards, _primary to execute only on primary 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()
```
    戻り値:
    
    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 if the positions for each term should be returned if stored or skip.
  - payloads
```
public boolean payloads()
```
    戻り値:
    
    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()
```
    戻り値:
    
    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()
```
    戻り値:
    
    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.
  - dfs
```
public boolean dfs()
```
    戻り値:
    
    true if distributed frequencies should be returned. Otherwise false
  - dfs
```
public TermVectorsRequest dfs(boolean dfs)
```
    Use distributed frequencies instead of shard statistics.
  - selectedFields
```
public Set<String> selectedFields()
```
    Return only term vectors for special selected fields. Returns for term vectors for all fields if selectedFields == null
  - selectedFields
```
public TermVectorsRequest selectedFields(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)
```
    Choose whether term vectors be generated real-time.
    
    定義:
    
    realtime インタフェース内 RealtimeRequest
    
    パラメータ:
    
    realtime - Controls whether this request should be realtime by reading from the translog. If null is specified then whether the operation will be realtime depends on the api of the concrete request subclass.
  - perFieldAnalyzer
```
public Map<String,String> perFieldAnalyzer()
```
    Return the overridden analyzers at each field.
  - perFieldAnalyzer
```
public TermVectorsRequest perFieldAnalyzer(Map<String,String> perFieldAnalyzer)
```
    Override the analyzer used at each field when generating term vectors.
  - filterSettings
```
public TermVectorsRequest.FilterSettings filterSettings()
```
    Return the settings for filtering out terms.
  - filterSettings
```
public TermVectorsRequest filterSettings(TermVectorsRequest.FilterSettings settings)
```
    Sets the settings for filtering out terms.
  - version
```
public long version()
```
  - version
```
public TermVectorsRequest version(long version)
```
  - versionType
```
public VersionType versionType()
```
  - versionType
```
public TermVectorsRequest versionType(VersionType versionType)
```
  - startTime
```
public long startTime()
```
  - validate
```
public ActionRequestValidationException validate()
```
    定義:
    
    validate クラス内 ActionRequest<TermVectorsRequest>
  - readTermVectorsRequest
```
public static TermVectorsRequest readTermVectorsRequest(StreamInput in)
                                                 throws IOException
```
    例外:
    
    IOException
  - readFrom
```
public void readFrom(StreamInput in)
              throws IOException
```
    定義:
    
    readFrom インタフェース内 Streamable
    
    オーバーライド:
    
    readFrom クラス内 SingleShardRequest<TermVectorsRequest>
    
    例外:
    
    IOException
  - writeTo
```
public void writeTo(StreamOutput out)
             throws IOException
```
    定義:
    
    writeTo インタフェース内 Streamable
    
    オーバーライド:
    
    writeTo クラス内 SingleShardRequest<TermVectorsRequest>
    
    例外:
    
    IOException
  - parseRequest
```
public static void parseRequest(TermVectorsRequest termVectorsRequest,
                                XContentParser parser)
                         throws IOException
```
    populates a request object (pre-populated with defaults) based on a parser.
    
    例外:
    
    IOException
  - readPerFieldAnalyzer
```
public static Map<String,String> readPerFieldAnalyzer(Map<String,Object> map)
```

クラス TermVectorsRequest

ネストされたクラスのサマリー

クラスから継承されたネストされたクラス/インタフェース org.elasticsearch.transport.TransportRequest

インタフェースから継承されたネストされたクラス/インタフェース org.elasticsearch.action.IndicesRequest

フィールドのサマリー

クラスから継承されたフィールド org.elasticsearch.action.support.single.shard.SingleShardRequest

クラスから継承されたフィールド org.elasticsearch.common.ContextAndHeaderHolder

コンストラクタのサマリー

メソッドのサマリー

クラスから継承されたメソッド org.elasticsearch.action.support.single.shard.SingleShardRequest

クラスから継承されたメソッド org.elasticsearch.transport.TransportRequest

クラスから継承されたメソッド org.elasticsearch.transport.TransportMessage

クラスから継承されたメソッド org.elasticsearch.common.ContextAndHeaderHolder

クラスから継承されたメソッド java.lang.Object

インタフェースから継承されたメソッド org.elasticsearch.action.DocumentRequest

インタフェースから継承されたメソッド org.elasticsearch.action.IndicesRequest

フィールドの詳細

preference

コンストラクタの詳細

TermVectorsRequest

TermVectorsRequest

TermVectorsRequest

TermVectorsRequest

メソッドの詳細

getFlags

type

type

id

id

doc

doc

doc

routing

routing

parent

preference

preference

offsets

offsets

positions

positions

payloads

payloads

termStatistics

termStatistics

fieldStatistics

fieldStatistics

dfs

dfs

selectedFields

selectedFields

realtime

realtime

perFieldAnalyzer

perFieldAnalyzer

filterSettings

filterSettings

version

version

versionType

versionType

startTime

validate

readTermVectorsRequest

readFrom

writeTo

parseRequest

readPerFieldAnalyzer