Module org.elasticsearch.server
Package org.elasticsearch.action.support.master

Class MasterNodeReadRequest<Request extends MasterNodeReadRequest<Request>>

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, RefCounted, TaskAwareRequest
Direct Known Subclasses:
ClusterGetSettingsAction.Request, ClusterHealthRequest, ClusterInfoRequest, ClusterSearchShardsRequest, ClusterStateRequest, DesiredBalanceRequest, ExplainDataStreamLifecycleAction.Request, GetAliasesRequest, GetComponentTemplateAction.Request, GetComposableIndexTemplateAction.Request, GetDataStreamAction.Request, GetDataStreamLifecycleAction.Request, GetDesiredNodesAction.Request, GetIndexTemplatesRequest, GetPipelineRequest, GetRepositoriesRequest, GetSettingsRequest, GetStoredScriptRequest, IndicesShardStoresRequest, PendingClusterTasksRequest, PrevalidateNodeRemovalRequest, SimulateIndexTemplateRequest, SimulateTemplateAction.Request, TransportGetAllocationStatsAction.Request
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

  • Field Details

    • local

      protected boolean local

  • Constructor Details

    • MasterNodeReadRequest

      protected MasterNodeReadRequest(TimeValue masterNodeTimeout)
      Parameters:
      masterNodeTimeout - Specifies how long to wait when the master has not been discovered yet, or is disconnected, or is busy processing other tasks. The value TimeValue.MINUS_ONE means to wait forever in 8.15.0 onwards.

      For requests which originate in the REST layer, use RestUtils.getMasterNodeTimeout(org.elasticsearch.rest.RestRequest) to determine the timeout.

      For internally-generated requests, choose an appropriate timeout. Often this will be TimeValue.MAX_VALUE (or TimeValue.MINUS_ONE which means an infinite timeout in 8.15.0 onwards) since usually we want internal requests to wait for as long as necessary to complete.

    • MasterNodeReadRequest

      protected MasterNodeReadRequest(StreamInput in) throws IOException
      Throws:
      IOException

  • Method Details