Module org.elasticsearch.server
Package org.elasticsearch.tasks

Interface TaskAwareRequest

All Known Implementing Classes:
AbstractBulkByScrollRequest, AbstractBulkIndexByScrollRequest, AbstractSynonymsPagedResultAction.Request, AcknowledgedRequest, AcknowledgedRequest.Plain, ActionRequest, AddIndexBlockRequest, AddVotingConfigExclusionsRequest, AnalyzeAction.Request, AnalyzeIndexDiskUsageRequest, ApplyCommitRequest, BaseNodesRequest, BaseTasksRequest, BasicReplicationRequest, BroadcastRequest, BroadcastShardRequest, BroadcastUnpromotableRequest, BulkRequest, BulkShardRequest, BytesTransportRequest, CancelTasksRequest, CanMatchNodeRequest, CleanupRepositoryRequest, ClearIndicesCacheRequest, ClearScrollRequest, ClearVotingConfigExclusionsRequest, CloneSnapshotRequest, CloseIndexRequest, ClosePointInTimeRequest, ClusterAllocationExplainRequest, ClusterFormationInfoAction.Request, ClusterGetSettingsAction.Request, ClusterHealthRequest, ClusterInfoRequest, ClusterRerouteRequest, ClusterSearchShardsRequest, ClusterStateRequest, ClusterStatsRequest, ClusterUpdateSettingsRequest, CompletionPersistentTaskAction.Request, CoordinationDiagnosticsAction.Request, CreateDataStreamAction.Request, CreateIndexRequest, CreateSnapshotRequest, DataStreamsStatsAction.Request, DeleteByQueryRequest, DeleteDanglingIndexRequest, DeleteDataStreamAction.Request, DeleteIndexRequest, DeleteIndexTemplateRequest, DeletePipelineRequest, DeleteRepositoryRequest, DeleteRequest, DeleteSnapshotRequest, DeleteStoredScriptRequest, DeleteSynonymRuleAction.Request, DeleteSynonymsAction.Request, DesiredBalanceRequest, DownsampleAction.Request, ExplainDataStreamLifecycleAction.Request, ExplainRequest, FetchHealthInfoCacheAction.Request, FieldCapabilitiesRequest, FieldUsageStatsRequest, FindDanglingIndexRequest, FlushRequest, FollowersChecker.FollowerCheckRequest, ForceMergeRequest, GetAliasesRequest, GetComponentTemplateAction.Request, GetComposableIndexTemplateAction.Request, GetDataStreamAction.Request, GetDataStreamLifecycleAction.Request, GetDesiredNodesAction.Request, GetFieldMappingsIndexRequest, GetFieldMappingsRequest, GetHealthAction.Request, GetIndexRequest, GetIndexTemplatesRequest, GetMappingsRequest, GetPipelineRequest, GetRepositoriesRequest, GetRequest, GetScriptContextRequest, GetScriptLanguageRequest, GetSettingsRequest, GetShardSnapshotRequest, GetSnapshotsRequest, GetSnapshottableFeaturesRequest, GetStoredScriptRequest, GetSynonymRuleAction.Request, GetSynonymsAction.Request, GetSynonymsSetsAction.Request, GetTaskRequest, GlobalCheckpointSyncAction.Request, HealthApiStatsAction.Request, HealthApiStatsAction.Request.Node, HealthNodeRequest, ImportDanglingIndexRequest, IndexModeStatsActionType.NodeRequest, IndexModeStatsActionType.StatsRequest, IndexRequest, IndicesAliasesRequest, IndicesSegmentsRequest, IndicesShardStoresRequest, IndicesStatsRequest, InstanceShardOperationRequest, InternalScrollSearchRequest, JoinRequest, ListDanglingIndicesRequest, ListTasksRequest, LocalAllocateDangledIndices.AllocateDangledRequest, LocalClusterStateRequest, MasterHistoryAction.Request, MasterNodeReadRequest, MasterNodeRequest, MigrateToDataStreamAction.Request, ModifyDataStreamsAction.Request, MultiGetRequest, MultiGetShardRequest, MultiSearchRequest, MultiTermVectorsRequest, MultiTermVectorsShardRequest, NodeFindDanglingIndexRequest, NodeListDanglingIndicesRequest, NodePrevalidateShardPathRequest, NodesCapabilitiesRequest, NodesFeaturesRequest, NodesHotThreadsRequest, NodesInfoRequest, NodesReloadSecureSettingsRequest, NodesReloadSecureSettingsRequest.NodeRequest, NodesStatsRequest, NodesUsageRequest, OpenIndexRequest, OpenPointInTimeRequest, PeersRequest, PendingClusterTasksRequest, PrevalidateNodeRemovalRequest, PrevalidateShardPathRequest, PreVoteRequest, PrimaryReplicaSyncer.ResyncRequest, PromoteDataStreamAction.Request, PutComponentTemplateAction.Request, PutDataStreamLifecycleAction.Request, PutIndexTemplateRequest, PutMappingRequest, PutPipelineRequest, PutRepositoryRequest, PutStoredScriptRequest, PutSynonymRuleAction.Request, PutSynonymsAction.Request, QuerySearchRequest, RankFeatureShardRequest, RecoveryCleanFilesRequest, RecoveryFileChunkRequest, RecoveryFilesInfoRequest, RecoveryRequest, RecoverySnapshotFileRequest, RecoveryTranslogOperationsRequest, RecoveryTransportRequest, ReestablishRecoveryRequest, RefreshRequest, ReindexRequest, ReloadAnalyzersRequest, RemoteClusterNodesAction.Request, RemoteClusterStatsRequest, RemoteInfoRequest, RemovePersistentTaskAction.Request, ReplicatedWriteRequest, ReplicationRequest, ResetFeatureStateRequest, ResizeRequest, ResolveClusterActionRequest, ResolveIndexAction.Request, RestoreSnapshotRequest, ResyncReplicationRequest, RetentionLeaseActions.AddRequest, RetentionLeaseActions.RemoveRequest, RetentionLeaseActions.RenewRequest, RetentionLeaseBackgroundSyncAction.Request, RetentionLeaseSyncAction.Request, RolloverRequest, SearchRequest, SearchScrollRequest, SearchShardsRequest, ShardFetchRequest, ShardFetchSearchRequest, ShardFlushRequest, ShardRefreshReplicaRequest, ShardSearchRequest, ShardStateAction.FailedShardEntry, ShardStateAction.StartedShardEntry, ShardValidateQueryRequest, SimulateBulkRequest, SimulateIndexTemplateRequest, SimulatePipelineRequest, SimulateTemplateAction.Request, SingleShardRequest, SnapshotsStatusRequest, StartJoinRequest, StartPersistentTaskAction.Request, StartRecoveryRequest, StatelessPrimaryRelocationAction.Request, TermVectorsRequest, TransportClusterStatsAction.ClusterStatsNodeRequest, TransportDeleteComponentTemplateAction.Request, TransportDeleteComposableIndexTemplateAction.Request, TransportDeleteDesiredNodesAction.Request, TransportGetAllocationStatsAction.Request, TransportGetFromTranslogAction.Request, TransportNodesCapabilitiesAction.NodeCapabilitiesRequest, TransportNodesFeaturesAction.NodeFeaturesRequest, TransportNodesHotThreadsAction.NodeRequest, TransportNodesInfoAction.NodeInfoRequest, TransportNodesListGatewayStartedShards.NodeRequest, TransportNodesListGatewayStartedShards.Request, TransportNodesListShardStoreMetadata.NodeRequest, TransportNodesListShardStoreMetadata.Request, TransportNodesSnapshotsStatus.NodeRequest, TransportNodesSnapshotsStatus.Request, TransportNodesStatsAction.NodeStatsRequest, TransportNodesUsageAction.NodeUsageRequest, TransportPutComposableIndexTemplateAction.Request, TransportReplicationAction.ConcreteReplicaRequest, TransportReplicationAction.ConcreteShardRequest, TransportRequest, TransportShardMultiGetFomTranslogAction.Request, TransportVerifyShardBeforeCloseAction.ShardRequest, TransportVerifyShardIndexBlockAction.ShardRequest, UnpromotableShardRefreshRequest, UpdateByQueryRequest, UpdateDesiredNodesRequest, UpdateHealthInfoCacheAction.Request, UpdateIndexShardSnapshotStatusRequest, UpdatePersistentTaskStatusAction.Request, UpdateRequest, UpdateSettingsRequest, ValidateQueryRequest, VerifyNodeRepositoryAction.Request, VerifyRepositoryRequest
public interface TaskAwareRequest
An interface for a request that can be used to register a task manager task

  • Method Summary

    Modifier and Type
    Method
    Description
    default Task
    createTask(long id, String type, String action, TaskId parentTaskId, Map<String,String> headers)
    Returns the task object that should be used to keep track of the processing of the request.
    default String
    getDescription()
    Returns optional description of the request to be displayed by the task manager
    TaskId
    getParentTask()
    Get a reference to the task that created this request.
    default long
    getRequestId()
    Gets the request ID.
    default void
    setParentTask(String parentTaskNode, long parentTaskId)
    Set a reference to task that caused this task to be run.
    void
    setParentTask(TaskId taskId)
    Set a reference to task that created this request.
    void
    setRequestId(long requestId)
    Set the request ID related to this task.

  • Method Details

    • setParentTask

      default void setParentTask(String parentTaskNode, long parentTaskId)
      Set a reference to task that caused this task to be run.

    • setParentTask

      void setParentTask(TaskId taskId)
      Set a reference to task that created this request.

    • getRequestId

      default long getRequestId()
      Gets the request ID. Defaults to -1, meaning "no request ID is set".

    • setRequestId

      void setRequestId(long requestId)
      Set the request ID related to this task.

    • getParentTask

      TaskId getParentTask()
      Get a reference to the task that created this request. Implementers should default to TaskId.EMPTY_TASK_ID, meaning "there is no parent".

    • createTask

      default Task createTask(long id, String type, String action, TaskId parentTaskId, Map<String,String> headers)
      Returns the task object that should be used to keep track of the processing of the request.

    • getDescription

      default String getDescription()
      Returns optional description of the request to be displayed by the task manager