ClusterHealthRequest (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<ClusterHealthRequest>
        
        org.elasticsearch.action.admin.cluster.health.ClusterHealthRequest

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

IndicesRequest, IndicesRequest.Replaceable, HasContext, HasContextAndHeaders, HasHeaders, Streamable
```
public class ClusterHealthRequest
extends MasterNodeReadRequest<ClusterHealthRequest>
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

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

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

ClusterHealthRequest()

ClusterHealthRequest(String... indices)

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

メソッドのサマリー

すべてのメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`String[]`	`indices()` Returns the array of indices that the action relates to
`ClusterHealthRequest`	`indices(String[] indices)`
`IndicesOptions`	`indicesOptions()` Returns the indices options used to resolve indices.
`void`	`readFrom(StreamInput in)`
`TimeValue`	`timeout()`
`ClusterHealthRequest`	`timeout(String timeout)`
`ClusterHealthRequest`	`timeout(TimeValue timeout)`
`ActionRequestValidationException`	`validate()`
`int`	`waitForActiveShards()`
`ClusterHealthRequest`	`waitForActiveShards(int waitForActiveShards)`
`Priority`	`waitForEvents()`
`ClusterHealthRequest`	`waitForEvents(Priority waitForEvents)`
`ClusterHealthRequest`	`waitForGreenStatus()`
`String`	`waitForNodes()`
`ClusterHealthRequest`	`waitForNodes(String waitForNodes)` Waits for N number of nodes.
`int`	`waitForRelocatingShards()`
`ClusterHealthRequest`	`waitForRelocatingShards(int waitForRelocatingShards)`
`ClusterHealthStatus`	`waitForStatus()`
`ClusterHealthRequest`	`waitForStatus(ClusterHealthStatus waitForStatus)`
`ClusterHealthRequest`	`waitForYellowStatus()`
`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

- コンストラクタの詳細
  - ClusterHealthRequest
```
public ClusterHealthRequest()
```
  - ClusterHealthRequest
```
public ClusterHealthRequest(String... indices)
```
- メソッドの詳細
  - indices
```
public String[] indices()
```
    インタフェースからコピーされた説明: IndicesRequest
    
    Returns the array of indices that the action relates to
    
    定義:
    
    indices インタフェース内 IndicesRequest
  - indices
```
public ClusterHealthRequest indices(String[] indices)
```
    定義:
    
    indices インタフェース内 IndicesRequest.Replaceable
  - 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
  - timeout
```
public TimeValue timeout()
```
  - timeout
```
public ClusterHealthRequest timeout(TimeValue timeout)
```
  - timeout
```
public ClusterHealthRequest timeout(String timeout)
```
  - waitForStatus
```
public ClusterHealthStatus waitForStatus()
```
  - waitForStatus
```
public ClusterHealthRequest waitForStatus(ClusterHealthStatus waitForStatus)
```
  - waitForGreenStatus
```
public ClusterHealthRequest waitForGreenStatus()
```
  - waitForYellowStatus
```
public ClusterHealthRequest waitForYellowStatus()
```
  - waitForRelocatingShards
```
public int waitForRelocatingShards()
```
  - waitForRelocatingShards
```
public ClusterHealthRequest waitForRelocatingShards(int waitForRelocatingShards)
```
  - waitForActiveShards
```
public int waitForActiveShards()
```
  - waitForActiveShards
```
public ClusterHealthRequest waitForActiveShards(int waitForActiveShards)
```
  - waitForNodes
```
public String waitForNodes()
```
  - waitForNodes
```
public ClusterHealthRequest waitForNodes(String waitForNodes)
```
    Waits for N number of nodes. Use "12" for exact mapping, ">12" and "<12" for range.
  - waitForEvents
```
public ClusterHealthRequest waitForEvents(Priority waitForEvents)
```
  - waitForEvents
```
public Priority waitForEvents()
```
  - validate
```
public ActionRequestValidationException validate()
```
    定義:
    
    validate クラス内 ActionRequest<ClusterHealthRequest>
  - readFrom
```
public void readFrom(StreamInput in)
              throws IOException
```
    定義:
    
    readFrom インタフェース内 Streamable
    
    オーバーライド:
    
    readFrom クラス内 MasterNodeReadRequest<ClusterHealthRequest>
    
    例外:
    
    IOException
  - writeTo
```
public void writeTo(StreamOutput out)
             throws IOException
```
    定義:
    
    writeTo インタフェース内 Streamable
    
    オーバーライド:
    
    writeTo クラス内 MasterNodeReadRequest<ClusterHealthRequest>
    
    例外:
    
    IOException

クラス ClusterHealthRequest

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

クラスから継承されたネストされたクラス/インタフェース 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

コンストラクタの詳細

ClusterHealthRequest

ClusterHealthRequest

メソッドの詳細

indices

indices

indicesOptions

timeout

timeout

timeout

waitForStatus

waitForStatus

waitForGreenStatus

waitForYellowStatus

waitForRelocatingShards

waitForRelocatingShards

waitForActiveShards

waitForActiveShards

waitForNodes

waitForNodes

waitForEvents

waitForEvents

validate

readFrom

writeTo