ClusterSearchShardsRequest (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<Request>
      - org.elasticsearch.action.support.ChildTaskActionRequest<T>
        
        org.elasticsearch.action.support.master.MasterNodeRequest<T>
        
        org.elasticsearch.action.support.master.MasterNodeReadRequest<ClusterSearchShardsRequest>
        
        org.elasticsearch.action.admin.cluster.shards.ClusterSearchShardsRequest

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

IndicesRequest, IndicesRequest.Replaceable, HasContext, HasContextAndHeaders, HasHeaders, Streamable
```
public class ClusterSearchShardsRequest
extends MasterNodeReadRequest<ClusterSearchShardsRequest>
implements IndicesRequest.Replaceable
```

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

フィールドのサマリー
- クラスから継承されたフィールド org.elasticsearch.action.support.master.MasterNodeReadRequest
  local
- クラスから継承されたフィールド org.elasticsearch.action.support.master.MasterNodeRequest
  DEFAULT_MASTER_NODE_TIMEOUT, masterNodeTimeout
- クラスから継承されたフィールド org.elasticsearch.common.ContextAndHeaderHolder
  headers

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

コンストラクタ
コンストラクタと説明

ClusterSearchShardsRequest()

ClusterSearchShardsRequest(String... indices)

コンストラクタ
コンストラクタと説明
`ClusterSearchShardsRequest()`
`ClusterSearchShardsRequest(String... indices)`

メソッドのサマリー

すべてのメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`String[]`	`indices()` The indices
`ClusterSearchShardsRequest`	`indices(String... indices)` Sets the indices the search will be executed on.
`IndicesOptions`	`indicesOptions()` Returns the indices options used to resolve indices.
`ClusterSearchShardsRequest`	`indicesOptions(IndicesOptions indicesOptions)`
`String`	`preference()`
`ClusterSearchShardsRequest`	`preference(String preference)` Sets the preference to execute the search.
`void`	`readFrom(StreamInput in)`
`String`	`routing()` A comma separated list of routing values to control the shards the search will be executed on.
`ClusterSearchShardsRequest`	`routing(String... routings)` The routing values to control the shards that the search will be executed on.
`ClusterSearchShardsRequest`	`routing(String routing)` A comma separated list of routing values to control the shards the search will be executed on.
`String[]`	`types()` The document types to execute the search against.
`ClusterSearchShardsRequest`	`types(String... types)` The document types to execute the search against.
`ActionRequestValidationException`	`validate()`
`void`	`writeTo(StreamOutput out)`

クラスから継承されたメソッド org.elasticsearch.action.support.master.MasterNodeReadRequest
local, local

クラスから継承されたメソッド org.elasticsearch.action.support.master.MasterNodeRequest
masterNodeTimeout, masterNodeTimeout, masterNodeTimeout

クラスから継承されたメソッド org.elasticsearch.action.support.ChildTaskActionRequest
createTask, createTask, setParentTask

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

- コンストラクタの詳細
  - ClusterSearchShardsRequest
```
public ClusterSearchShardsRequest()
```
  - ClusterSearchShardsRequest
```
public ClusterSearchShardsRequest(String... indices)
```
- メソッドの詳細
  - validate
```
public ActionRequestValidationException validate()
```
    定義:
    
    validate クラス内 ActionRequest<ClusterSearchShardsRequest>
  - indices
```
public ClusterSearchShardsRequest indices(String... indices)
```
    Sets the indices the search will be executed on.
    
    定義:
    
    indices インタフェース内 IndicesRequest.Replaceable
  - indices
```
public String[] indices()
```
    The indices
    
    定義:
    
    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
  - indicesOptions
```
public ClusterSearchShardsRequest indicesOptions(IndicesOptions indicesOptions)
```
  - types
```
public String[] types()
```
    The document types to execute the search against. Defaults to be executed against all types.
  - types
```
public ClusterSearchShardsRequest types(String... types)
```
    The document types to execute the search against. Defaults to be executed against all types.
  - routing
```
public String routing()
```
    A comma separated list of routing values to control the shards the search will be executed on.
  - routing
```
public ClusterSearchShardsRequest routing(String routing)
```
    A comma separated list of routing values to control the shards the search will be executed on.
  - routing
```
public ClusterSearchShardsRequest routing(String... routings)
```
    The routing values to control the shards that the search will be executed on.
  - preference
```
public ClusterSearchShardsRequest 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.
  - preference
```
public String preference()
```
  - readFrom
```
public void readFrom(StreamInput in)
              throws IOException
```
    定義:
    
    readFrom インタフェース内 Streamable
    
    オーバーライド:
    
    readFrom クラス内 MasterNodeReadRequest<ClusterSearchShardsRequest>
    
    例外:
    
    IOException
  - writeTo
```
public void writeTo(StreamOutput out)
             throws IOException
```
    定義:
    
    writeTo インタフェース内 Streamable
    
    オーバーライド:
    
    writeTo クラス内 MasterNodeReadRequest<ClusterSearchShardsRequest>
    
    例外:
    
    IOException

クラス ClusterSearchShardsRequest

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

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

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

フィールドのサマリー

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

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

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

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

メソッドのサマリー

クラスから継承されたメソッド org.elasticsearch.action.support.master.MasterNodeReadRequest

クラスから継承されたメソッド org.elasticsearch.action.support.master.MasterNodeRequest

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

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

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

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

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

コンストラクタの詳細

ClusterSearchShardsRequest

ClusterSearchShardsRequest

メソッドの詳細

validate

indices

indices

indicesOptions

indicesOptions

types

types

routing

routing

routing

preference

preference

readFrom

writeTo