ShardSearchTransportRequest (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.search.internal.ShardSearchTransportRequest

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

IndicesRequest, HasContext, HasContextAndHeaders, HasHeaders, Streamable, ShardSearchRequest
```
public class ShardSearchTransportRequest
extends TransportRequest
implements ShardSearchRequest, IndicesRequest
```
Shard level search request that represents an actual search sent from the coordinating node to the nodes holding the shards where the query needs to be executed. Holds the same info as ShardSearchLocalRequest but gets sent over the transport and holds also the indices coming from the original request that generated it, plus its headers and context.

ネストされたクラスのサマリー
- クラスから継承されたネストされたクラス/インタフェース org.elasticsearch.transport.TransportRequest
  TransportRequest.Empty
- インタフェースから継承されたネストされたクラス/インタフェース org.elasticsearch.action.IndicesRequest
  IndicesRequest.Replaceable

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

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

コンストラクタ
コンストラクタと説明
`ShardSearchTransportRequest()`
`ShardSearchTransportRequest(SearchRequest searchRequest, ShardRouting shardRouting, int numberOfShards, String[] filteringAliases, long nowInMillis)`

メソッドのサマリー

すべてのメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`BytesReference`	`cacheKey()` Returns the cache key for this shard search request, based on its content
`BytesReference`	`extraSource()`
`String[]`	`filteringAliases()`
`String`	`index()`
`String[]`	`indices()` Returns the array of indices that the action relates to
`IndicesOptions`	`indicesOptions()` Returns the indices options used to resolve indices.
`boolean`	`isProfile()` Returns true if this shard search is being profiled or not
`long`	`nowInMillis()`
`int`	`numberOfShards()`
`void`	`readFrom(StreamInput in)`
`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()`
`void`	`writeTo(StreamOutput out)`

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

- コンストラクタの詳細
  - ShardSearchTransportRequest
```
public ShardSearchTransportRequest()
```
  - ShardSearchTransportRequest
```
public ShardSearchTransportRequest(SearchRequest searchRequest,
                                   ShardRouting shardRouting,
                                   int numberOfShards,
                                   String[] filteringAliases,
                                   long nowInMillis)
```
- メソッドの詳細
  - indices
```
public String[] indices()
```
    インタフェースからコピーされた説明: IndicesRequest
    
    Returns the array of indices that the action relates to
    
    定義:
    
    indices インタフェース内 IndicesRequest
  - indicesOptions
```
public IndicesOptions indicesOptions()
```
    インタフェースからコピーされた説明: IndicesRequest
    
    Returns the indices options used to resolve indices. They tell for instance whether a single index is accepted, whether an empty array will be converted to _all, and how wildcards will be expanded if needed.
    
    定義:
    
    indicesOptions インタフェース内 IndicesRequest
  - 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
  - readFrom
```
public void readFrom(StreamInput in)
              throws IOException
```
    定義:
    
    readFrom インタフェース内 Streamable
    
    オーバーライド:
    
    readFrom クラス内 TransportMessage<TransportRequest>
    
    例外:
    
    IOException
  - writeTo
```
public void writeTo(StreamOutput out)
             throws IOException
```
    定義:
    
    writeTo インタフェース内 Streamable
    
    オーバーライド:
    
    writeTo クラス内 TransportMessage<TransportRequest>
    
    例外:
    
    IOException
  - cacheKey
```
public BytesReference cacheKey()
                        throws IOException
```
    インタフェースからコピーされた説明: ShardSearchRequest
    
    Returns the cache key for this shard search request, based on its content
    
    定義:
    
    cacheKey インタフェース内 ShardSearchRequest
    
    例外:
    
    IOException
  - 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

クラス ShardSearchTransportRequest

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

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

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

フィールドのサマリー

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

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

メソッドのサマリー

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

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

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

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

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

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

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

コンストラクタの詳細

ShardSearchTransportRequest

ShardSearchTransportRequest

メソッドの詳細

indices

indicesOptions

index

shardId

types

source

source

extraSource

numberOfShards

searchType

filteringAliases

nowInMillis

template

templateSource

requestCache

scroll

readFrom

writeTo

cacheKey

setProfile

isProfile