ShardSearchLocalRequest (Elasticsearch: Core 2.3.5.1 API)

java.lang.Object
- org.elasticsearch.common.ContextAndHeaderHolder
- - org.elasticsearch.search.internal.ShardSearchLocalRequest

すべての実装されたインタフェース:: HasContext, HasContextAndHeaders, HasHeaders, ShardSearchRequest

public class ShardSearchLocalRequest
extends ContextAndHeaderHolder
implements ShardSearchRequest

Shard level search request that gets created and consumed on the local node. Used by warmers and by api that need to create a search context within their execution. Source structure:

 {
  from : 0, size : 20, (optional, can be set on the request)
  sort : { "name.first" : {}, "name.last" : { reverse : true } }
  fields : [ "name.first", "name.last" ]
  query : { ... }
  aggs : {
      "agg1" : {
          terms : { ... }
      }
  }
 }

フィールドのサマリー
- クラスから継承されたフィールド org.elasticsearch.common.ContextAndHeaderHolder
  headers

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

コンストラクタ
コンストラクタと説明
`ShardSearchLocalRequest(ShardId shardId, int numberOfShards, SearchType searchType, BytesReference source, String[] types, Boolean requestCache)`
`ShardSearchLocalRequest(String[] types, long nowInMillis)`
`ShardSearchLocalRequest(String[] types, long nowInMillis, String[] filteringAliases)`

メソッドのサマリー

すべてのメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`BytesReference`	`cacheKey()` Returns the cache key for this shard search request, based on its content
`BytesReference`	`extraSource()`
`String[]`	`filteringAliases()`
`String`	`index()`
`protected void`	`innerReadFrom(StreamInput in)`
`protected void`	`innerWriteTo(StreamOutput out, boolean asKey)`
`boolean`	`isProfile()` Returns true if this shard search is being profiled or not
`long`	`nowInMillis()`
`int`	`numberOfShards()`
`Boolean`	`requestCache()`
`Scroll`	`scroll()`
`SearchType`	`searchType()`
`void`	`setProfile(boolean profile)` Sets if this shard search needs to be profiled or not
`int`	`shardId()`
`BytesReference`	`source()`
`void`	`source(BytesReference source)`
`Template`	`template()`
`BytesReference`	`templateSource()`
`String[]`	`types()`

クラスから継承されたメソッド 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.common.HasContextAndHeaders
copyContextAndHeadersFrom

インタフェースから継承されたメソッド org.elasticsearch.common.HasContext
contextSize, copyContextFrom, getContext, getFromContext, getFromContext, hasInContext, isContextEmpty, putAllInContext, putInContext

インタフェースから継承されたメソッド org.elasticsearch.common.HasHeaders
copyHeadersFrom, getHeader, getHeaders, hasHeader, putHeader

- コンストラクタの詳細
  - ShardSearchLocalRequest
```
public ShardSearchLocalRequest(String[] types,
                               long nowInMillis)
```
  - ShardSearchLocalRequest
```
public ShardSearchLocalRequest(String[] types,
                               long nowInMillis,
                               String[] filteringAliases)
```
  - ShardSearchLocalRequest
```
public ShardSearchLocalRequest(ShardId shardId,
                               int numberOfShards,
                               SearchType searchType,
                               BytesReference source,
                               String[] types,
                               Boolean requestCache)
```
- メソッドの詳細
  - index
```
public String index()
```
    定義:
    
    index インタフェース内 ShardSearchRequest
  - shardId
```
public int shardId()
```
    定義:
    
    shardId インタフェース内 ShardSearchRequest
  - types
```
public String[] types()
```
    定義:
    
    types インタフェース内 ShardSearchRequest
  - source
```
public BytesReference source()
```
    定義:
    
    source インタフェース内 ShardSearchRequest
  - source
```
public void source(BytesReference source)
```
    定義:
    
    source インタフェース内 ShardSearchRequest
  - extraSource
```
public BytesReference extraSource()
```
    定義:
    
    extraSource インタフェース内 ShardSearchRequest
  - numberOfShards
```
public int numberOfShards()
```
    定義:
    
    numberOfShards インタフェース内 ShardSearchRequest
  - searchType
```
public SearchType searchType()
```
    定義:
    
    searchType インタフェース内 ShardSearchRequest
  - filteringAliases
```
public String[] filteringAliases()
```
    定義:
    
    filteringAliases インタフェース内 ShardSearchRequest
  - nowInMillis
```
public long nowInMillis()
```
    定義:
    
    nowInMillis インタフェース内 ShardSearchRequest
  - template
```
public Template template()
```
    定義:
    
    template インタフェース内 ShardSearchRequest
  - templateSource
```
public BytesReference templateSource()
```
    定義:
    
    templateSource インタフェース内 ShardSearchRequest
  - requestCache
```
public Boolean requestCache()
```
    定義:
    
    requestCache インタフェース内 ShardSearchRequest
  - scroll
```
public Scroll scroll()
```
    定義:
    
    scroll インタフェース内 ShardSearchRequest
  - setProfile
```
public void setProfile(boolean profile)
```
    インタフェースからコピーされた説明: ShardSearchRequest
    
    Sets if this shard search needs to be profiled or not
    
    定義:
    
    setProfile インタフェース内 ShardSearchRequest
    
    パラメータ:
    
    profile - True if the shard should be profiled
  - isProfile
```
public boolean isProfile()
```
    インタフェースからコピーされた説明: ShardSearchRequest
    
    Returns true if this shard search is being profiled or not
    
    定義:
    
    isProfile インタフェース内 ShardSearchRequest
  - innerReadFrom
```
protected void innerReadFrom(StreamInput in)
                      throws IOException
```
    例外:
    
    IOException
  - innerWriteTo
```
protected void innerWriteTo(StreamOutput out,
                            boolean asKey)
                     throws IOException
```
    例外:
    
    IOException
  - cacheKey
```
public BytesReference cacheKey()
                        throws IOException
```
    インタフェースからコピーされた説明: ShardSearchRequest
    
    Returns the cache key for this shard search request, based on its content
    
    定義:
    
    cacheKey インタフェース内 ShardSearchRequest
    
    例外:
    
    IOException

クラス ShardSearchLocalRequest

フィールドのサマリー

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

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

メソッドのサマリー

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

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

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

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

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

コンストラクタの詳細

ShardSearchLocalRequest

ShardSearchLocalRequest

ShardSearchLocalRequest

メソッドの詳細

index

shardId

types

source

source

extraSource

numberOfShards

searchType

filteringAliases

nowInMillis

template

templateSource

requestCache

scroll

setProfile

isProfile

innerReadFrom

innerWriteTo

cacheKey