MasterNodeReadRequest (server 7.5.2 API)

java.lang.Object
- org.elasticsearch.transport.TransportMessage
- - org.elasticsearch.transport.TransportRequest
  - - org.elasticsearch.action.ActionRequest
    - - org.elasticsearch.action.support.master.MasterNodeRequest<Request>
      - org.elasticsearch.action.support.master.MasterNodeReadRequest<Request>

All Implemented Interfaces:

Writeable, TaskAwareRequest

Direct Known Subclasses:

ClusterGetSettingsRequest, ClusterHealthRequest, ClusterInfoRequest, ClusterSearchShardsRequest, ClusterStateRequest, GetAliasesRequest, GetIndexTemplatesRequest, GetPipelineRequest, GetRepositoriesRequest, GetSettingsRequest, GetStoredScriptRequest, IndicesExistsRequest, IndicesShardStoresRequest, PendingClusterTasksRequest, TypesExistsRequest
```
public abstract class MasterNodeReadRequest<Request extends MasterNodeReadRequest<Request>>
extends MasterNodeRequest<Request>
```
Base request for master based read operations that allows to read the cluster state from the local node if needed

Nested Class Summary
- Nested classes/interfaces inherited from class org.elasticsearch.transport.TransportRequest
  TransportRequest.Empty
- Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
  Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields
Modifier and Type Field Description

protected boolean local
- Fields inherited from class org.elasticsearch.action.support.master.MasterNodeRequest
  DEFAULT_MASTER_NODE_TIMEOUT, masterNodeTimeout

Constructor Summary

Constructors
Modifier Constructor Description

protected MasterNodeReadRequest()

protected MasterNodeReadRequest(StreamInput in)

Method Summary

Modifier and Type	Method	Description
`boolean`	`local()`	Return local information, do not retrieve the state from master node (default: false).
`Request`	`local(boolean local)`
`void`	`writeTo(StreamOutput out)`	Write this into the StreamOutput.

Methods inherited from class org.elasticsearch.action.support.master.MasterNodeRequest
masterNodeTimeout, masterNodeTimeout, masterNodeTimeout

Methods inherited from class org.elasticsearch.action.ActionRequest
getShouldStoreResult, validate

Methods inherited from class org.elasticsearch.transport.TransportRequest
getParentTask, setParentTask

Methods inherited from class org.elasticsearch.transport.TransportMessage
remoteAddress, remoteAddress

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest
createTask, getDescription, setParentTask

- Field Detail
  - local
```
protected boolean local
```
- Constructor Detail
  - MasterNodeReadRequest
```
protected MasterNodeReadRequest()
```
  - MasterNodeReadRequest
```
protected MasterNodeReadRequest(StreamInput in)
                         throws java.io.IOException
```
    Throws:
    
    java.io.IOException
- Method Detail
  - writeTo
```
public void writeTo(StreamOutput out)
             throws java.io.IOException
```
    Description copied from interface: Writeable
    
    Write this into the StreamOutput.
    
    Specified by:
    
    writeTo in interface Writeable
    
    Overrides:
    
    writeTo in class MasterNodeRequest<Request extends MasterNodeReadRequest<Request>>
    
    Throws:
    
    java.io.IOException
  - local
```
public final Request local(boolean local)
```
  - local
```
public final boolean local()
```
    Return local information, do not retrieve the state from master node (default: false).
    
    Returns:
    
    true if local information is to be returned; false if information is to be retrieved from master node (default).