Class MasterNodeReadRequest<Request extends MasterNodeReadRequest<Request>>
java.lang.Object
org.opensearch.transport.TransportMessage
org.opensearch.transport.TransportRequest
org.opensearch.action.ActionRequest
org.opensearch.action.support.master.MasterNodeRequest<Request>
org.opensearch.action.support.master.MasterNodeReadRequest<Request>
- All Implemented Interfaces:
Writeable
,TaskAwareRequest
- Direct Known Subclasses:
ClusterGetSettingsRequest
,ClusterHealthRequest
,ClusterInfoRequest
,ClusterSearchShardsRequest
,ClusterStateRequest
,GetAliasesRequest
,GetComponentTemplateAction.Request
,GetComposableIndexTemplateAction.Request
,GetDataStreamAction.Request
,GetIndexTemplatesRequest
,GetPipelineRequest
,GetRepositoriesRequest
,GetSettingsRequest
,GetStoredScriptRequest
,IndicesExistsRequest
,IndicesShardStoresRequest
,PendingClusterTasksRequest
,SimulateIndexTemplateRequest
,SimulateTemplateAction.Request
,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.opensearch.transport.TransportRequest
TransportRequest.Empty
Nested classes/interfaces inherited from interface org.opensearch.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.opensearch.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.opensearch.action.support.master.MasterNodeRequest
masterNodeTimeout, masterNodeTimeout, masterNodeTimeout
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.opensearch.tasks.TaskAwareRequest
createTask, getDescription, setParentTask
-
Field Details
-
local
protected boolean local
-
-
Constructor Details
-
MasterNodeReadRequest
protected MasterNodeReadRequest() -
MasterNodeReadRequest
- Throws:
java.io.IOException
-
-
Method Details
-
writeTo
Description copied from interface:Writeable
Write this into the StreamOutput.- Specified by:
writeTo
in interfaceWriteable
- Overrides:
writeTo
in classMasterNodeRequest<Request extends MasterNodeReadRequest<Request>>
- Throws:
java.io.IOException
-
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).
-