类的使用
org.apache.flink.runtime.rest.handler.HandlerRequest

使用HandlerRequest的程序包

程序包	说明
org.apache.flink.runtime.rest.handler
org.apache.flink.runtime.rest.handler.async
org.apache.flink.runtime.rest.handler.cluster
org.apache.flink.runtime.rest.handler.dataset
org.apache.flink.runtime.rest.handler.job
org.apache.flink.runtime.rest.handler.job.checkpoints
org.apache.flink.runtime.rest.handler.job.coordination
org.apache.flink.runtime.rest.handler.job.metrics
org.apache.flink.runtime.rest.handler.job.rescaling
org.apache.flink.runtime.rest.handler.job.savepoints
org.apache.flink.runtime.rest.handler.resourcemanager
org.apache.flink.runtime.rest.handler.taskmanager
org.apache.flink.runtime.rest.handler.util

org.apache.flink.runtime.rest.handler中HandlerRequest的使用

返回HandlerRequest的org.apache.flink.runtime.rest.handler中的方法

限定符和类型	方法和说明
static <R extends RequestBody,M extends MessageParameters> HandlerRequest<R>	HandlerRequest.create(R requestBody, M messageParameters) Short-cut for create(RequestBody, MessageParameters, Collection) without any uploaded files.
static <R extends RequestBody,M extends MessageParameters> HandlerRequest<R>	HandlerRequest.create(R requestBody, M messageParameters, Collection<File> uploadedFiles) Creates a new HandlerRequest.
static <R extends RequestBody,M extends MessageParameters> HandlerRequest<R>	HandlerRequest.resolveParametersAndCreate(R requestBody, M messageParameters, Map<String,String> receivedPathParameters, Map<String,List<String>> receivedQueryParameters, Collection<File> uploadedFiles) Creates a new HandlerRequest after resolving the given MessageParameters against the given query/path parameter maps.

参数类型为HandlerRequest的org.apache.flink.runtime.rest.handler中的方法

限定符和类型	方法和说明
protected abstract CompletableFuture<P>	AbstractRestHandler.handleRequest(HandlerRequest<R> request, T gateway) This method is called for every incoming request and returns a CompletableFuture containing a the response.
protected abstract CompletableFuture<Void>	AbstractHandler.respondToRequest(org.apache.flink.shaded.netty4.io.netty.channel.ChannelHandlerContext ctx, org.apache.flink.shaded.netty4.io.netty.handler.codec.http.HttpRequest httpRequest, HandlerRequest<R> handlerRequest, T gateway) Respond to the given HandlerRequest.
protected CompletableFuture<Void>	AbstractRestHandler.respondToRequest(org.apache.flink.shaded.netty4.io.netty.channel.ChannelHandlerContext ctx, org.apache.flink.shaded.netty4.io.netty.handler.codec.http.HttpRequest httpRequest, HandlerRequest<R> handlerRequest, T gateway)

org.apache.flink.runtime.rest.handler.async中HandlerRequest的使用

参数类型为HandlerRequest的org.apache.flink.runtime.rest.handler.async中的方法

限定符和类型	方法和说明
protected abstract K	AbstractAsynchronousOperationHandlers.TriggerHandler.createOperationKey(HandlerRequest<B> request) Create the operation key under which the result future of the asynchronous operation will be stored.
protected abstract K	AbstractAsynchronousOperationHandlers.StatusHandler.getOperationKey(HandlerRequest<EmptyRequestBody> request) Extract the operation key under which the operation result future is stored.
CompletableFuture<TriggerResponse>	AbstractAsynchronousOperationHandlers.TriggerHandler.handleRequest(HandlerRequest<B> request, T gateway)
CompletableFuture<AsynchronousOperationResult<V>>	AbstractAsynchronousOperationHandlers.StatusHandler.handleRequest(HandlerRequest<EmptyRequestBody> request, T gateway)
protected abstract CompletableFuture<R>	AbstractAsynchronousOperationHandlers.TriggerHandler.triggerOperation(HandlerRequest<B> request, T gateway) Trigger the asynchronous operation and return its future result.

org.apache.flink.runtime.rest.handler.cluster中HandlerRequest的使用

参数类型为HandlerRequest的org.apache.flink.runtime.rest.handler.cluster中的方法

限定符和类型	方法和说明
protected File	JobManagerLogFileHandler.getFile(HandlerRequest<EmptyRequestBody> handlerRequest)
protected abstract File	AbstractJobManagerFileHandler.getFile(HandlerRequest<EmptyRequestBody> handlerRequest)
protected File	JobManagerCustomLogHandler.getFile(HandlerRequest<EmptyRequestBody> handlerRequest)
CompletableFuture<ClusterOverviewWithVersion>	ClusterOverviewHandler.handleRequest(HandlerRequest<EmptyRequestBody> request, RestfulGateway gateway)
CompletableFuture<DashboardConfiguration>	DashboardConfigHandler.handleRequest(HandlerRequest<EmptyRequestBody> request, RestfulGateway gateway)
protected CompletableFuture<EmptyResponseBody>	ShutdownHandler.handleRequest(HandlerRequest<EmptyRequestBody> request, RestfulGateway gateway)
protected CompletableFuture<LogListInfo>	JobManagerLogListHandler.handleRequest(HandlerRequest<EmptyRequestBody> request, RestfulGateway gateway)
protected CompletableFuture<EnvironmentInfo>	JobManagerEnvironmentHandler.handleRequest(HandlerRequest<EmptyRequestBody> request, RestfulGateway gateway)
protected CompletableFuture<ThreadDumpInfo>	JobManagerThreadDumpHandler.handleRequest(HandlerRequest<EmptyRequestBody> request, RestfulGateway gateway)
protected CompletableFuture<ConfigurationInfo>	ClusterConfigHandler.handleRequest(HandlerRequest<EmptyRequestBody> request, RestfulGateway gateway)
protected CompletableFuture<Void>	AbstractJobManagerFileHandler.respondToRequest(org.apache.flink.shaded.netty4.io.netty.channel.ChannelHandlerContext ctx, org.apache.flink.shaded.netty4.io.netty.handler.codec.http.HttpRequest httpRequest, HandlerRequest<EmptyRequestBody> handlerRequest, RestfulGateway gateway)

org.apache.flink.runtime.rest.handler.dataset中HandlerRequest的使用

参数类型为HandlerRequest的org.apache.flink.runtime.rest.handler.dataset中的方法

限定符和类型	方法和说明
protected OperationKey	ClusterDataSetDeleteHandlers.ClusterDataSetDeleteTriggerHandler.createOperationKey(HandlerRequest<EmptyRequestBody> request)
protected OperationKey	ClusterDataSetDeleteHandlers.ClusterDataSetDeleteStatusHandler.getOperationKey(HandlerRequest<EmptyRequestBody> request)
protected CompletableFuture<ClusterDataSetListResponseBody>	ClusterDataSetListHandler.handleRequest(HandlerRequest<EmptyRequestBody> request, ResourceManagerGateway gateway)
protected CompletableFuture<ClusterDataSetDeleteHandlers.SerializableVoid>	ClusterDataSetDeleteHandlers.ClusterDataSetDeleteTriggerHandler.triggerOperation(HandlerRequest<EmptyRequestBody> request, RestfulGateway gateway)

org.apache.flink.runtime.rest.handler.job中HandlerRequest的使用

参数类型为HandlerRequest的org.apache.flink.runtime.rest.handler.job中的方法

限定符和类型	方法和说明
protected SubtaskExecutionAttemptDetailsInfo	SubtaskExecutionAttemptDetailsHandler.handleRequest(HandlerRequest<EmptyRequestBody> request, AccessExecution execution)
protected SubtaskExecutionAttemptAccumulatorsInfo	SubtaskExecutionAttemptAccumulatorsHandler.handleRequest(HandlerRequest<EmptyRequestBody> request, AccessExecution execution)
protected abstract R	AbstractSubtaskAttemptHandler.handleRequest(HandlerRequest<EmptyRequestBody> request, AccessExecution execution) Called for each request after the corresponding AccessExecution has been retrieved from the AccessExecutionVertex.
protected JobVertexTaskManagersInfo	JobVertexTaskManagersHandler.handleRequest(HandlerRequest<EmptyRequestBody> request, AccessExecutionGraph executionGraph)
protected JobAccumulatorsInfo	JobAccumulatorsHandler.handleRequest(HandlerRequest<EmptyRequestBody> request, AccessExecutionGraph graph)
protected JobDetailsInfo	JobDetailsHandler.handleRequest(HandlerRequest<EmptyRequestBody> request, AccessExecutionGraph executionGraph)
protected abstract R	AbstractAccessExecutionGraphHandler.handleRequest(HandlerRequest<EmptyRequestBody> request, AccessExecutionGraph executionGraph)
protected JobVertexDetailsInfo	JobVertexDetailsHandler.handleRequest(HandlerRequest<EmptyRequestBody> request, AccessExecutionGraph executionGraph)
protected JobConfigInfo	JobConfigHandler.handleRequest(HandlerRequest<EmptyRequestBody> request, AccessExecutionGraph executionGraph)
protected JobPlanInfo	JobPlanHandler.handleRequest(HandlerRequest<EmptyRequestBody> request, AccessExecutionGraph executionGraph)
protected R	AbstractJobVertexHandler.handleRequest(HandlerRequest<EmptyRequestBody> request, AccessExecutionGraph executionGraph)
protected R	AbstractSubtaskHandler.handleRequest(HandlerRequest<EmptyRequestBody> request, AccessExecutionJobVertex jobVertex)
protected SubtasksAllAccumulatorsInfo	SubtasksAllAccumulatorsHandler.handleRequest(HandlerRequest<EmptyRequestBody> request, AccessExecutionJobVertex jobVertex)
protected JobVertexFlameGraph	JobVertexFlameGraphHandler.handleRequest(HandlerRequest<EmptyRequestBody> request, AccessExecutionJobVertex jobVertex)
protected SubtasksTimesInfo	SubtasksTimesHandler.handleRequest(HandlerRequest<EmptyRequestBody> request, AccessExecutionJobVertex jobVertex)
protected JobVertexAccumulatorsInfo	JobVertexAccumulatorsHandler.handleRequest(HandlerRequest<EmptyRequestBody> request, AccessExecutionJobVertex jobVertex)
protected abstract R	AbstractJobVertexHandler.handleRequest(HandlerRequest<EmptyRequestBody> request, AccessExecutionJobVertex jobVertex) Called for each request after the corresponding AccessExecutionJobVertex has been retrieved from the AccessExecutionGraph.
protected abstract R	AbstractSubtaskHandler.handleRequest(HandlerRequest<EmptyRequestBody> request, AccessExecutionVertex executionVertex) Called for each request after the corresponding AccessExecutionVertex has been retrieved from the AccessExecutionJobVertex.
protected R	AbstractSubtaskAttemptHandler.handleRequest(HandlerRequest<EmptyRequestBody> request, AccessExecutionVertex executionVertex)
protected SubtaskExecutionAttemptDetailsInfo	SubtaskCurrentAttemptDetailsHandler.handleRequest(HandlerRequest<EmptyRequestBody> request, AccessExecutionVertex executionVertex)
protected R	AbstractAccessExecutionGraphHandler.handleRequest(HandlerRequest<EmptyRequestBody> request, ExecutionGraphInfo executionGraphInfo)
protected abstract R	AbstractExecutionGraphHandler.handleRequest(HandlerRequest<EmptyRequestBody> request, ExecutionGraphInfo executionGraphInfo) Called for each request after the corresponding ExecutionGraphInfo has been retrieved from the ExecutionGraphCache.
protected JobExceptionsInfoWithHistory	JobExceptionsHandler.handleRequest(HandlerRequest<EmptyRequestBody> request, ExecutionGraphInfo executionGraph)
protected CompletableFuture<JobExecutionResultResponseBody>	JobExecutionResultHandler.handleRequest(HandlerRequest<EmptyRequestBody> request, RestfulGateway gateway)
protected CompletableFuture<EnvironmentInfo>	JobManagerJobEnvironmentHandler.handleRequest(HandlerRequest<EmptyRequestBody> request, RestfulGateway gateway)
protected CompletableFuture<JobIdsWithStatusOverview>	JobIdsHandler.handleRequest(HandlerRequest<EmptyRequestBody> request, RestfulGateway gateway)
protected CompletableFuture<ConfigurationInfo>	JobManagerJobConfigurationHandler.handleRequest(HandlerRequest<EmptyRequestBody> request, RestfulGateway gateway)
protected CompletableFuture<JobVertexBackPressureInfo>	JobVertexBackPressureHandler.handleRequest(HandlerRequest<EmptyRequestBody> request, RestfulGateway gateway)
protected CompletableFuture<MultipleJobsDetails>	JobsOverviewHandler.handleRequest(HandlerRequest<EmptyRequestBody> request, RestfulGateway gateway)
protected CompletableFuture<R>	AbstractExecutionGraphHandler.handleRequest(HandlerRequest<EmptyRequestBody> request, RestfulGateway gateway)
protected CompletableFuture<JobStatusInfo>	JobStatusHandler.handleRequest(HandlerRequest<EmptyRequestBody> request, RestfulGateway gateway)
CompletableFuture<EmptyResponseBody>	JobCancellationHandler.handleRequest(HandlerRequest<EmptyRequestBody> request, RestfulGateway gateway)
protected CompletableFuture<JobSubmitResponseBody>	JobSubmitHandler.handleRequest(HandlerRequest<JobSubmitRequestBody> request, DispatcherGateway gateway)

org.apache.flink.runtime.rest.handler.job.checkpoints中HandlerRequest的使用

参数类型为HandlerRequest的org.apache.flink.runtime.rest.handler.job.checkpoints中的方法

限定符和类型	方法和说明
protected TaskCheckpointStatisticsWithSubtaskDetails	TaskCheckpointStatisticDetailsHandler.handleCheckpointRequest(HandlerRequest<EmptyRequestBody> request, AbstractCheckpointStats checkpointStats)
protected CheckpointStatistics	CheckpointStatisticDetailsHandler.handleCheckpointRequest(HandlerRequest<EmptyRequestBody> ignored, AbstractCheckpointStats checkpointStats)
protected abstract R	AbstractCheckpointHandler.handleCheckpointRequest(HandlerRequest<EmptyRequestBody> request, AbstractCheckpointStats checkpointStats) Called for each request with the corresponding AbstractCheckpointStats instance.
protected CheckpointConfigInfo	CheckpointConfigHandler.handleRequest(HandlerRequest<EmptyRequestBody> request, AccessExecutionGraph executionGraph)
protected R	AbstractCheckpointHandler.handleRequest(HandlerRequest<EmptyRequestBody> request, AccessExecutionGraph executionGraph)
protected CheckpointingStatistics	CheckpointingStatisticsHandler.handleRequest(HandlerRequest<EmptyRequestBody> request, AccessExecutionGraph executionGraph)

org.apache.flink.runtime.rest.handler.job.coordination中HandlerRequest的使用

参数类型为HandlerRequest的org.apache.flink.runtime.rest.handler.job.coordination中的方法

限定符和类型	方法和说明
protected CompletableFuture<ClientCoordinationResponseBody>	ClientCoordinationHandler.handleRequest(HandlerRequest<ClientCoordinationRequestBody> request, RestfulGateway gateway)

org.apache.flink.runtime.rest.handler.job.metrics中HandlerRequest的使用

参数类型为HandlerRequest的org.apache.flink.runtime.rest.handler.job.metrics中的方法

限定符和类型	方法和说明
protected MetricStore.ComponentMetricStore	TaskManagerMetricsHandler.getComponentMetricStore(HandlerRequest<EmptyRequestBody> request, MetricStore metricStore)
protected MetricStore.ComponentMetricStore	SubtaskMetricsHandler.getComponentMetricStore(HandlerRequest<EmptyRequestBody> request, MetricStore metricStore)
protected abstract MetricStore.ComponentMetricStore	AbstractMetricsHandler.getComponentMetricStore(HandlerRequest<EmptyRequestBody> request, MetricStore metricStore) Returns the MetricStore.ComponentMetricStore that should be queried for metrics.
protected MetricStore.ComponentMetricStore	JobMetricsHandler.getComponentMetricStore(HandlerRequest<EmptyRequestBody> request, MetricStore metricStore)
protected MetricStore.ComponentMetricStore	JobManagerMetricsHandler.getComponentMetricStore(HandlerRequest<EmptyRequestBody> request, MetricStore metricStore)
protected MetricStore.ComponentMetricStore	JobVertexMetricsHandler.getComponentMetricStore(HandlerRequest<EmptyRequestBody> request, MetricStore metricStore) 已过时。
protected MetricCollectionResponseBody	JobVertexWatermarksHandler.handleRequest(HandlerRequest<EmptyRequestBody> request, AccessExecutionJobVertex jobVertex)
protected CompletableFuture<MetricCollectionResponseBody>	AbstractMetricsHandler.handleRequest(HandlerRequest<EmptyRequestBody> request, RestfulGateway gateway)
protected CompletableFuture<AggregatedMetricsResponseBody>	AbstractAggregatingMetricsHandler.handleRequest(HandlerRequest<EmptyRequestBody> request, RestfulGateway gateway)

org.apache.flink.runtime.rest.handler.job.rescaling中HandlerRequest的使用

参数类型为HandlerRequest的org.apache.flink.runtime.rest.handler.job.rescaling中的方法

限定符和类型	方法和说明
protected AsynchronousJobOperationKey	RescalingHandlers.RescalingTriggerHandler.createOperationKey(HandlerRequest<EmptyRequestBody> request)
protected AsynchronousJobOperationKey	RescalingHandlers.RescalingStatusHandler.getOperationKey(HandlerRequest<EmptyRequestBody> request)
CompletableFuture<TriggerResponse>	RescalingHandlers.RescalingTriggerHandler.handleRequest(HandlerRequest<EmptyRequestBody> request, RestfulGateway gateway)
CompletableFuture<AsynchronousOperationResult<AsynchronousOperationInfo>>	RescalingHandlers.RescalingStatusHandler.handleRequest(HandlerRequest<EmptyRequestBody> request, RestfulGateway gateway)
protected CompletableFuture<Acknowledge>	RescalingHandlers.RescalingTriggerHandler.triggerOperation(HandlerRequest<EmptyRequestBody> request, RestfulGateway gateway)

org.apache.flink.runtime.rest.handler.job.savepoints中HandlerRequest的使用

参数类型为HandlerRequest的org.apache.flink.runtime.rest.handler.job.savepoints中的方法

限定符和类型	方法和说明
protected OperationKey	SavepointDisposalHandlers.SavepointDisposalTriggerHandler.createOperationKey(HandlerRequest<SavepointDisposalRequest> request)
protected AsynchronousJobOperationKey	SavepointHandlers.SavepointStatusHandler.getOperationKey(HandlerRequest<EmptyRequestBody> request)
protected OperationKey	SavepointDisposalHandlers.SavepointDisposalStatusHandler.getOperationKey(HandlerRequest<EmptyRequestBody> request)
CompletableFuture<AsynchronousOperationResult<SavepointInfo>>	SavepointHandlers.SavepointStatusHandler.handleRequest(HandlerRequest<EmptyRequestBody> request, RestfulGateway gateway)
protected CompletableFuture<Acknowledge>	SavepointDisposalHandlers.SavepointDisposalTriggerHandler.triggerOperation(HandlerRequest<SavepointDisposalRequest> request, RestfulGateway gateway)
protected CompletableFuture<Acknowledge>	SavepointHandlers.SavepointTriggerHandler.triggerOperation(HandlerRequest<SavepointTriggerRequestBody> request, AsynchronousJobOperationKey operationKey, RestfulGateway gateway)
protected CompletableFuture<Acknowledge>	SavepointHandlers.StopWithSavepointHandler.triggerOperation(HandlerRequest<StopWithSavepointRequestBody> request, AsynchronousJobOperationKey operationKey, RestfulGateway gateway)

org.apache.flink.runtime.rest.handler.resourcemanager中HandlerRequest的使用

参数类型为HandlerRequest的org.apache.flink.runtime.rest.handler.resourcemanager中的方法

限定符和类型	方法和说明
protected abstract CompletableFuture<P>	AbstractResourceManagerHandler.handleRequest(HandlerRequest<R> request, ResourceManagerGateway gateway)
protected CompletableFuture<P>	AbstractResourceManagerHandler.handleRequest(HandlerRequest<R> request, T gateway)

org.apache.flink.runtime.rest.handler.taskmanager中HandlerRequest的使用

参数类型为HandlerRequest的org.apache.flink.runtime.rest.handler.taskmanager中的方法

限定符和类型	方法和说明
protected String	TaskManagerCustomLogHandler.getFileName(HandlerRequest<EmptyRequestBody> handlerRequest)
protected String	AbstractTaskManagerFileHandler.getFileName(HandlerRequest<EmptyRequestBody> handlerRequest)
protected CompletableFuture<TaskManagerDetailsInfo>	TaskManagerDetailsHandler.handleRequest(HandlerRequest<EmptyRequestBody> request, ResourceManagerGateway gateway)
protected CompletableFuture<ThreadDumpInfo>	TaskManagerThreadDumpHandler.handleRequest(HandlerRequest<EmptyRequestBody> request, ResourceManagerGateway gateway)
protected CompletableFuture<LogListInfo>	TaskManagerLogListHandler.handleRequest(HandlerRequest<EmptyRequestBody> request, ResourceManagerGateway gateway)
protected CompletableFuture<TaskManagersInfo>	TaskManagersHandler.handleRequest(HandlerRequest<EmptyRequestBody> request, ResourceManagerGateway gateway)
protected CompletableFuture<Void>	AbstractTaskManagerFileHandler.respondToRequest(org.apache.flink.shaded.netty4.io.netty.channel.ChannelHandlerContext ctx, org.apache.flink.shaded.netty4.io.netty.handler.codec.http.HttpRequest httpRequest, HandlerRequest<EmptyRequestBody> handlerRequest, RestfulGateway gateway)

org.apache.flink.runtime.rest.handler.util中HandlerRequest的使用

参数类型为HandlerRequest的org.apache.flink.runtime.rest.handler.util中的方法

限定符和类型	方法和说明
static <X,P extends MessageQueryParameter<X>,R extends RequestBody,M extends MessageParameters> X	HandlerRequestUtils.getQueryParameter(HandlerRequest<R> request, Class<P> queryParameterClass) Returns the value of a query parameter, or null if the query parameter is not set.
static <X,P extends MessageQueryParameter<X>,R extends RequestBody,M extends MessageParameters> X	HandlerRequestUtils.getQueryParameter(HandlerRequest<R> request, Class<P> queryParameterClass, X defaultValue)