Uses of Interface
org.apache.flink.runtime.webmonitor.RestfulGateway

Packages that use RestfulGateway

Package	Description
org.apache.flink.runtime.dispatcher
org.apache.flink.runtime.jobmaster
org.apache.flink.runtime.rest
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.legacy
org.apache.flink.runtime.rest.handler.legacy.files
org.apache.flink.runtime.rest.handler.legacy.metrics
org.apache.flink.runtime.rest.handler.resourcemanager
org.apache.flink.runtime.rest.handler.taskmanager
org.apache.flink.runtime.webmonitor

Uses of RestfulGateway in org.apache.flink.runtime.dispatcher

Subinterfaces of RestfulGateway in org.apache.flink.runtime.dispatcher

Modifier and Type	Interface	Description
interface	DispatcherGateway	Gateway for the Dispatcher component.

Classes in org.apache.flink.runtime.dispatcher that implement RestfulGateway

Modifier and Type	Class	Description
class	Dispatcher	Base class for the Dispatcher component.
class	StandaloneDispatcher	Dispatcher implementation which spawns a JobMaster for each submitted JobGraph within in the same process.

Uses of RestfulGateway in org.apache.flink.runtime.jobmaster

Constructor parameters in org.apache.flink.runtime.jobmaster with type arguments of type RestfulGateway

Constructor

Description

MiniDispatcherRestEndpoint(GatewayRetriever<? extends RestfulGateway> leaderRetriever, org.apache.flink.configuration.Configuration clusterConfiguration, RestHandlerConfiguration restConfiguration, GatewayRetriever<ResourceManagerGateway> resourceManagerRetriever, TransientBlobService transientBlobService, ScheduledExecutorService executor, MetricFetcher metricFetcher, LeaderElection leaderElection, ExecutionGraphCache executionGraphCache, org.apache.flink.runtime.rpc.FatalErrorHandler fatalErrorHandler)

Uses of RestfulGateway in org.apache.flink.runtime.rest

Classes in org.apache.flink.runtime.rest with type parameters of type RestfulGateway

Modifier and Type	Interface	Description
interface	RestEndpointFactory<T extends RestfulGateway>	WebMonitorEndpoint factory.

Methods in org.apache.flink.runtime.rest that return types with arguments of type RestfulGateway

Modifier and Type	Method	Description
WebMonitorEndpoint<RestfulGateway>	ApplicationRestEndpointFactory.createRestEndpoint(org.apache.flink.configuration.Configuration configuration, LeaderGatewayRetriever<DispatcherGateway> dispatcherGatewayRetriever, LeaderGatewayRetriever<ResourceManagerGateway> resourceManagerGatewayRetriever, TransientBlobService transientBlobService, ScheduledExecutorService executor, MetricFetcher metricFetcher, LeaderElection leaderElection, org.apache.flink.runtime.rpc.FatalErrorHandler fatalErrorHandler)

Uses of RestfulGateway in org.apache.flink.runtime.rest.handler

Classes in org.apache.flink.runtime.rest.handler with type parameters of type RestfulGateway

Modifier and Type	Class	Description
class	AbstractHandler<T extends RestfulGateway,R extends RequestBody,M extends MessageParameters>	Super class for netty-based handlers that work with RequestBody.
class	AbstractRestHandler<T extends RestfulGateway,R extends RequestBody,P extends ResponseBody,M extends MessageParameters>	Super class for netty-based handlers that work with RequestBodys and ResponseBodys.
class	LeaderRetrievalHandler<T extends RestfulGateway>	SimpleChannelInboundHandler which encapsulates the leader retrieval logic for the REST endpoints.

Uses of RestfulGateway in org.apache.flink.runtime.rest.handler.async

Classes in org.apache.flink.runtime.rest.handler.async with type parameters of type RestfulGateway

Modifier and Type	Class	Description
protected class	AbstractAsynchronousOperationHandlers.StatusHandler<T extends RestfulGateway,V,M extends MessageParameters>	Handler which will be polled to retrieve the asynchronous operation's result.
protected class	AbstractAsynchronousOperationHandlers.TriggerHandler<T extends RestfulGateway,B extends RequestBody,M extends MessageParameters>	Handler which is responsible for triggering an asynchronous operation.

Uses of RestfulGateway in org.apache.flink.runtime.rest.handler.cluster

Methods in org.apache.flink.runtime.rest.handler.cluster with parameters of type RestfulGateway

Modifier and Type	Method	Description
protected CompletableFuture<ConfigurationInfo>	ClusterConfigHandler.handleRequest(HandlerRequest<EmptyRequestBody> request, RestfulGateway gateway)
CompletableFuture<ClusterOverviewWithVersion>	ClusterOverviewHandler.handleRequest(HandlerRequest<EmptyRequestBody> request, RestfulGateway gateway)
CompletableFuture<DashboardConfiguration>	DashboardConfigHandler.handleRequest(HandlerRequest<EmptyRequestBody> request, RestfulGateway gateway)
protected CompletableFuture<EnvironmentInfo>	JobManagerEnvironmentHandler.handleRequest(HandlerRequest<EmptyRequestBody> request, RestfulGateway gateway)
protected CompletableFuture<LogListInfo>	JobManagerLogListHandler.handleRequest(HandlerRequest<EmptyRequestBody> request, RestfulGateway gateway)
protected CompletableFuture<ProfilingInfo>	JobManagerProfilingHandler.handleRequest(HandlerRequest<ProfilingRequestBody> request, RestfulGateway gateway)
protected CompletableFuture<ProfilingInfoList>	JobManagerProfilingListHandler.handleRequest(HandlerRequest<EmptyRequestBody> request, RestfulGateway gateway)
protected CompletableFuture<ThreadDumpInfo>	JobManagerThreadDumpHandler.handleRequest(HandlerRequest<EmptyRequestBody> request, RestfulGateway gateway)
protected CompletableFuture<EmptyResponseBody>	ShutdownHandler.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)

Constructor parameters in org.apache.flink.runtime.rest.handler.cluster with type arguments of type RestfulGateway

Constructor	Description
AbstractJobManagerFileHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever, Duration timeout, Map<String,String> responseHeaders, UntypedResponseMessageHeaders<EmptyRequestBody,M> messageHeaders)
ClusterConfigHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever, Duration timeout, Map<String,String> responseHeaders, MessageHeaders<EmptyRequestBody,ConfigurationInfo,EmptyMessageParameters> messageHeaders, org.apache.flink.configuration.Configuration configuration)
ClusterOverviewHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever, Duration timeout, Map<String,String> responseHeaders, MessageHeaders<EmptyRequestBody,ClusterOverviewWithVersion,EmptyMessageParameters> messageHeaders)
DashboardConfigHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever, Duration timeout, Map<String,String> responseHeaders, MessageHeaders<EmptyRequestBody,DashboardConfiguration,EmptyMessageParameters> messageHeaders, long refreshInterval, boolean webSubmitEnabled, boolean webCancelEnabled, boolean webRescaleEnabled)
JobManagerCustomLogHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever, Duration timeout, Map<String,String> responseHeaders, UntypedResponseMessageHeaders<EmptyRequestBody,FileMessageParameters> messageHeaders, File logDir)
JobManagerEnvironmentHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever, Duration timeout, Map<String,String> responseHeaders, MessageHeaders<EmptyRequestBody,EnvironmentInfo,EmptyMessageParameters> messageHeaders)
JobManagerLogFileHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever, Duration timeout, Map<String,String> responseHeaders, UntypedResponseMessageHeaders<EmptyRequestBody,EmptyMessageParameters> messageHeaders, File file)
JobManagerLogListHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever, Duration timeout, Map<String,String> responseHeaders, MessageHeaders<EmptyRequestBody,LogListInfo,EmptyMessageParameters> messageHeaders, File logDir)
JobManagerProfilingFileHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever, Duration timeout, Map<String,String> responseHeaders, UntypedResponseMessageHeaders<EmptyRequestBody,ProfilingFileMessageParameters> messageHeaders, org.apache.flink.configuration.Configuration configs)
JobManagerProfilingHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever, Duration timeout, Map<String,String> responseHeaders, MessageHeaders<ProfilingRequestBody,ProfilingInfo,EmptyMessageParameters> messageHeaders, org.apache.flink.configuration.Configuration configuration)
JobManagerProfilingListHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever, Duration timeout, Map<String,String> responseHeaders, MessageHeaders<EmptyRequestBody,ProfilingInfoList,EmptyMessageParameters> messageHeaders, org.apache.flink.configuration.Configuration configuration)
JobManagerThreadDumpHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever, Duration timeout, Map<String,String> responseHeaders, MessageHeaders<EmptyRequestBody,ThreadDumpInfo,EmptyMessageParameters> messageHeaders)
ShutdownHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever, Duration timeout, Map<String,String> responseHeaders, MessageHeaders<EmptyRequestBody,EmptyResponseBody,EmptyMessageParameters> messageHeaders)

Uses of RestfulGateway in org.apache.flink.runtime.rest.handler.dataset

Methods in org.apache.flink.runtime.rest.handler.dataset with parameters of type RestfulGateway

Modifier and Type	Method	Description
protected CompletableFuture<ClusterDataSetDeleteHandlers.SerializableVoid>	ClusterDataSetDeleteHandlers.ClusterDataSetDeleteTriggerHandler.triggerOperation(HandlerRequest<EmptyRequestBody> request, RestfulGateway gateway)

Constructor parameters in org.apache.flink.runtime.rest.handler.dataset with type arguments of type RestfulGateway

Constructor	Description
ClusterDataSetDeleteStatusHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever, Duration timeout, Map<String,String> responseHeaders)
ClusterDataSetDeleteTriggerHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever, Duration timeout, Map<String,String> responseHeaders, GatewayRetriever<ResourceManagerGateway> resourceManagerGatewayRetriever)
ClusterDataSetListHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever, Duration timeout, Map<String,String> responseHeaders, GatewayRetriever<ResourceManagerGateway> resourceManagerGatewayRetriever)

Uses of RestfulGateway in org.apache.flink.runtime.rest.handler.job

Methods in org.apache.flink.runtime.rest.handler.job with parameters of type RestfulGateway

Modifier and Type	Method	Description
protected CompletableFuture<R>	AbstractExecutionGraphHandler.handleRequest(HandlerRequest<EmptyRequestBody> request, RestfulGateway gateway)
CompletableFuture<EmptyResponseBody>	JobCancellationHandler.handleRequest(HandlerRequest<EmptyRequestBody> request, RestfulGateway gateway)
CompletableFuture<EmptyResponseBody>	JobClientHeartbeatHandler.handleRequest(HandlerRequest<JobClientHeartbeatRequestBody> request, RestfulGateway gateway)
protected CompletableFuture<JobExecutionResultResponseBody>	JobExecutionResultHandler.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<EnvironmentInfo>	JobManagerJobEnvironmentHandler.handleRequest(HandlerRequest<EmptyRequestBody> request, RestfulGateway gateway)
protected CompletableFuture<JobResourceRequirementsBody>	JobResourceRequirementsHandler.handleRequest(HandlerRequest<EmptyRequestBody> request, RestfulGateway gateway)
protected CompletableFuture<EmptyResponseBody>	JobResourceRequirementsUpdateHandler.handleRequest(HandlerRequest<JobResourceRequirementsBody> request, RestfulGateway gateway)
protected CompletableFuture<MultipleJobsDetails>	JobsOverviewHandler.handleRequest(HandlerRequest<EmptyRequestBody> request, RestfulGateway gateway)
protected CompletableFuture<JobStatusInfo>	JobStatusHandler.handleRequest(HandlerRequest<EmptyRequestBody> request, RestfulGateway gateway)
protected CompletableFuture<JobVertexBackPressureInfo>	JobVertexBackPressureHandler.handleRequest(HandlerRequest<EmptyRequestBody> request, RestfulGateway gateway)

Method parameters in org.apache.flink.runtime.rest.handler.job with type arguments of type RestfulGateway

Modifier and Type	Method	Description
static AbstractRestHandler<?,?,?,?>	JobVertexFlameGraphHandler.disabledHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever, Duration timeout, Map<String,String> responseHeaders)

Constructor parameters in org.apache.flink.runtime.rest.handler.job with type arguments of type RestfulGateway

Constructor	Description
AbstractAccessExecutionGraphHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever, Duration timeout, Map<String,String> responseHeaders, MessageHeaders<EmptyRequestBody,R,M> messageHeaders, ExecutionGraphCache executionGraphCache, Executor executor)
AbstractExecutionGraphHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever, Duration timeout, Map<String,String> responseHeaders, MessageHeaders<EmptyRequestBody,R,M> messageHeaders, ExecutionGraphCache executionGraphCache, Executor executor)
AbstractJobVertexHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever, Duration timeout, Map<String,String> responseHeaders, MessageHeaders<EmptyRequestBody,R,M> messageHeaders, ExecutionGraphCache executionGraphCache, Executor executor)	Instantiates a new Abstract job vertex handler.
AbstractSubtaskAttemptHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever, Duration timeout, Map<String,String> responseHeaders, MessageHeaders<EmptyRequestBody,R,M> messageHeaders, ExecutionGraphCache executionGraphCache, Executor executor)	Instantiates a new Abstract job vertex handler.
AbstractSubtaskHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever, Duration timeout, Map<String,String> responseHeaders, MessageHeaders<EmptyRequestBody,R,M> messageHeaders, ExecutionGraphCache executionGraphCache, Executor executor)	Instantiates a new Abstract job vertex handler.
JobAccumulatorsHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever, Duration timeout, Map<String,String> responseHeaders, MessageHeaders<EmptyRequestBody,JobAccumulatorsInfo,JobAccumulatorsMessageParameters> messageHeaders, ExecutionGraphCache executionGraphCache, Executor executor)
JobCancellationHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever, Duration timeout, Map<String,String> headers, MessageHeaders<EmptyRequestBody,EmptyResponseBody,JobCancellationMessageParameters> messageHeaders, TerminationModeQueryParameter.TerminationMode defaultTerminationMode)
JobClientHeartbeatHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever, Duration timeout, Map<String,String> headers, MessageHeaders<JobClientHeartbeatRequestBody,EmptyResponseBody,JobClientHeartbeatParameters> messageHeaders)
JobConfigHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever, Duration timeout, Map<String,String> responseHeaders, MessageHeaders<EmptyRequestBody,JobConfigInfo,JobMessageParameters> messageHeaders, ExecutionGraphCache executionGraphCache, Executor executor)
JobDetailsHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever, Duration timeout, Map<String,String> responseHeaders, MessageHeaders<EmptyRequestBody,JobDetailsInfo,JobMessageParameters> messageHeaders, ExecutionGraphCache executionGraphCache, Executor executor, MetricFetcher metricFetcher)
JobExceptionsHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever, Duration timeout, Map<String,String> responseHeaders, MessageHeaders<EmptyRequestBody,JobExceptionsInfoWithHistory,JobExceptionsMessageParameters> messageHeaders, ExecutionGraphCache executionGraphCache, Executor executor)
JobExecutionResultHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever, Duration timeout, Map<String,String> responseHeaders)
JobIdsHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever, Duration timeout, Map<String,String> responseHeaders, MessageHeaders<EmptyRequestBody,JobIdsWithStatusOverview,EmptyMessageParameters> messageHeaders)
JobManagerJobConfigurationHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever, Duration timeout, Map<String,String> responseHeaders, MessageHeaders<EmptyRequestBody,ConfigurationInfo,JobMessageParameters> messageHeaders, org.apache.flink.configuration.Configuration configuration)
JobManagerJobEnvironmentHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever, Duration timeout, Map<String,String> responseHeaders, MessageHeaders<EmptyRequestBody,EnvironmentInfo,JobMessageParameters> messageHeaders)
JobPlanHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever, Duration timeout, Map<String,String> headers, MessageHeaders<EmptyRequestBody,JobPlanInfo,JobMessageParameters> messageHeaders, ExecutionGraphCache executionGraphCache, Executor executor)
JobResourceRequirementsHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever, Duration timeout, Map<String,String> responseHeaders)
JobResourceRequirementsUpdateHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever, Duration timeout, Map<String,String> responseHeaders)
JobsOverviewHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever, Duration timeout, Map<String,String> responseHeaders, MessageHeaders<EmptyRequestBody,MultipleJobsDetails,EmptyMessageParameters> messageHeaders)
JobStatusHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever, Duration timeout, Map<String,String> responseHeaders, MessageHeaders<EmptyRequestBody,JobStatusInfo,JobMessageParameters> messageHeaders)
JobVertexAccumulatorsHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever, Duration timeout, Map<String,String> responseHeaders, MessageHeaders<EmptyRequestBody,JobVertexAccumulatorsInfo,JobVertexMessageParameters> messageHeaders, ExecutionGraphCache executionGraphCache, Executor executor)
JobVertexBackPressureHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever, Duration timeout, Map<String,String> responseHeaders, MessageHeaders<EmptyRequestBody,JobVertexBackPressureInfo,JobVertexMessageParameters> messageHeaders, MetricFetcher metricFetcher)
JobVertexDetailsHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever, Duration timeout, Map<String,String> responseHeaders, MessageHeaders<EmptyRequestBody,JobVertexDetailsInfo,JobVertexMessageParameters> messageHeaders, ExecutionGraphCache executionGraphCache, Executor executor, MetricFetcher metricFetcher)
JobVertexFlameGraphHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever, Duration timeout, Map<String,String> responseHeaders, ExecutionGraphCache executionGraphCache, Executor executor, VertexStatsTracker<VertexThreadInfoStats> threadInfoOperatorTracker)
JobVertexTaskManagersHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever, Duration timeout, Map<String,String> responseHeaders, MessageHeaders<EmptyRequestBody,JobVertexTaskManagersInfo,JobVertexMessageParameters> messageHeaders, ExecutionGraphCache executionGraphCache, Executor executor, MetricFetcher metricFetcher)
SubtaskCurrentAttemptDetailsHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever, Duration timeout, Map<String,String> responseHeaders, MessageHeaders<EmptyRequestBody,SubtaskExecutionAttemptDetailsInfo,SubtaskMessageParameters> messageHeaders, ExecutionGraphCache executionGraphCache, Executor executor, MetricFetcher metricFetcher)
SubtaskExecutionAttemptAccumulatorsHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever, Duration timeout, Map<String,String> responseHeaders, MessageHeaders<EmptyRequestBody,SubtaskExecutionAttemptAccumulatorsInfo,SubtaskAttemptMessageParameters> messageHeaders, ExecutionGraphCache executionGraphCache, Executor executor)	Instantiates a new Abstract job vertex handler.
SubtaskExecutionAttemptDetailsHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever, Duration timeout, Map<String,String> responseHeaders, MessageHeaders<EmptyRequestBody,SubtaskExecutionAttemptDetailsInfo,SubtaskAttemptMessageParameters> messageHeaders, ExecutionGraphCache executionGraphCache, Executor executor, MetricFetcher metricFetcher)	Instantiates a new subtask execution attempt details handler.
SubtasksAllAccumulatorsHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever, Duration timeout, Map<String,String> responseHeaders, MessageHeaders<EmptyRequestBody,SubtasksAllAccumulatorsInfo,JobVertexMessageParameters> messageHeaders, ExecutionGraphCache executionGraphCache, Executor executor)
SubtasksTimesHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever, Duration timeout, Map<String,String> responseHeaders, MessageHeaders<EmptyRequestBody,SubtasksTimesInfo,JobVertexMessageParameters> messageHeaders, ExecutionGraphCache executionGraphCache, Executor executor)

Uses of RestfulGateway in org.apache.flink.runtime.rest.handler.job.checkpoints

Methods in org.apache.flink.runtime.rest.handler.job.checkpoints with parameters of type RestfulGateway

Modifier and Type	Method	Description
protected CompletableFuture<R>	AbstractCheckpointStatsHandler.handleRequest(HandlerRequest<EmptyRequestBody> request, RestfulGateway gateway)
CompletableFuture<AsynchronousOperationResult<CheckpointInfo>>	CheckpointHandlers.CheckpointStatusHandler.handleRequest(HandlerRequest<EmptyRequestBody> request, RestfulGateway gateway)
protected CompletableFuture<TriggerResponse>	CheckpointHandlers.CheckpointTriggerHandler.handleRequest(HandlerRequest<CheckpointTriggerRequestBody> request, RestfulGateway gateway)

Constructor parameters in org.apache.flink.runtime.rest.handler.job.checkpoints with type arguments of type RestfulGateway

Constructor	Description
AbstractCheckpointHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever, Duration timeout, Map<String,String> responseHeaders, MessageHeaders<EmptyRequestBody,R,M> messageHeaders, Executor executor, org.apache.flink.shaded.guava33.com.google.common.cache.Cache<org.apache.flink.api.common.JobID,CompletableFuture<CheckpointStatsSnapshot>> checkpointStatsSnapshotCache, CheckpointStatsCache checkpointStatsCache)
AbstractCheckpointStatsHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever, Duration timeout, Map<String,String> responseHeaders, MessageHeaders<EmptyRequestBody,R,M> messageHeaders, org.apache.flink.shaded.guava33.com.google.common.cache.Cache<org.apache.flink.api.common.JobID,CompletableFuture<CheckpointStatsSnapshot>> checkpointStatsSnapshotCache, Executor executor)
CheckpointConfigHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever, Duration timeout, Map<String,String> responseHeaders, MessageHeaders<EmptyRequestBody,CheckpointConfigInfo,JobMessageParameters> messageHeaders, ExecutionGraphCache executionGraphCache, Executor executor)
CheckpointingStatisticsHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever, Duration timeout, Map<String,String> responseHeaders, MessageHeaders<EmptyRequestBody,CheckpointingStatistics,JobMessageParameters> messageHeaders, org.apache.flink.shaded.guava33.com.google.common.cache.Cache<org.apache.flink.api.common.JobID,CompletableFuture<CheckpointStatsSnapshot>> checkpointStatsSnapshotCache, Executor executor)
CheckpointStatisticDetailsHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever, Duration timeout, Map<String,String> responseHeaders, MessageHeaders<EmptyRequestBody,CheckpointStatistics,CheckpointMessageParameters> messageHeaders, Executor executor, org.apache.flink.shaded.guava33.com.google.common.cache.Cache<org.apache.flink.api.common.JobID,CompletableFuture<CheckpointStatsSnapshot>> checkpointStatsSnapshotCache, CheckpointStatsCache checkpointStatsCache)
CheckpointStatusHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever, Duration timeout, Map<String,String> responseHeaders)
CheckpointTriggerHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever, Duration timeout, Map<String,String> responseHeaders)
TaskCheckpointStatisticDetailsHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever, Duration timeout, Map<String,String> responseHeaders, MessageHeaders<EmptyRequestBody,TaskCheckpointStatisticsWithSubtaskDetails,TaskCheckpointMessageParameters> messageHeaders, Executor executor, org.apache.flink.shaded.guava33.com.google.common.cache.Cache<org.apache.flink.api.common.JobID,CompletableFuture<CheckpointStatsSnapshot>> checkpointStatsSnapshotCache, CheckpointStatsCache checkpointStatsCache)

Uses of RestfulGateway in org.apache.flink.runtime.rest.handler.job.coordination

Methods in org.apache.flink.runtime.rest.handler.job.coordination with parameters of type RestfulGateway

Modifier and Type	Method	Description
protected CompletableFuture<ClientCoordinationResponseBody>	ClientCoordinationHandler.handleRequest(HandlerRequest<ClientCoordinationRequestBody> request, RestfulGateway gateway)

Constructor parameters in org.apache.flink.runtime.rest.handler.job.coordination with type arguments of type RestfulGateway

Constructor	Description
ClientCoordinationHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever, Duration timeout, Map<String,String> responseHeaders, MessageHeaders<ClientCoordinationRequestBody,ClientCoordinationResponseBody,ClientCoordinationMessageParameters> messageHeaders)

Uses of RestfulGateway in org.apache.flink.runtime.rest.handler.job.metrics

Methods in org.apache.flink.runtime.rest.handler.job.metrics with parameters of type RestfulGateway

Modifier and Type	Method	Description
protected CompletableFuture<AggregatedMetricsResponseBody>	AbstractAggregatingMetricsHandler.handleRequest(HandlerRequest<EmptyRequestBody> request, RestfulGateway gateway)
protected CompletableFuture<MetricCollectionResponseBody>	AbstractMetricsHandler.handleRequest(HandlerRequest<EmptyRequestBody> request, RestfulGateway gateway)

Constructor parameters in org.apache.flink.runtime.rest.handler.job.metrics with type arguments of type RestfulGateway

Constructor	Description
AbstractAggregatingMetricsHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever, Duration timeout, Map<String,String> responseHeaders, AbstractAggregatedMetricsHeaders<P> messageHeaders, Executor executor, MetricFetcher fetcher)
AbstractMetricsHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever, Duration timeout, Map<String,String> headers, MessageHeaders<EmptyRequestBody,MetricCollectionResponseBody,M> messageHeaders, MetricFetcher metricFetcher)
AggregatingJobsMetricsHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever, Duration timeout, Map<String,String> responseHeaders, Executor executor, MetricFetcher fetcher)
AggregatingSubtasksMetricsHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever, Duration timeout, Map<String,String> responseHeaders, Executor executor, MetricFetcher fetcher)
AggregatingTaskManagersMetricsHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever, Duration timeout, Map<String,String> responseHeaders, Executor executor, MetricFetcher fetcher)
JobManagerMetricsHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever, Duration timeout, Map<String,String> headers, MetricFetcher metricFetcher)
JobManagerOperatorMetricsHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever, Duration timeout, Map<String,String> headers, MetricFetcher metricFetcher)
JobMetricsHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever, Duration timeout, Map<String,String> headers, MetricFetcher metricFetcher)
JobVertexMetricsHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever, Duration timeout, Map<String,String> headers, MetricFetcher metricFetcher)	Deprecated.
JobVertexWatermarksHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever, Duration timeout, Map<String,String> responseHeaders, MetricFetcher metricFetcher, ExecutionGraphCache executionGraphCache, Executor executor)
SubtaskMetricsHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever, Duration timeout, Map<String,String> headers, MetricFetcher metricFetcher)
TaskManagerMetricsHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever, Duration timeout, Map<String,String> headers, MetricFetcher metricFetcher)

Uses of RestfulGateway in org.apache.flink.runtime.rest.handler.job.rescaling

Methods in org.apache.flink.runtime.rest.handler.job.rescaling with parameters of type RestfulGateway

Modifier and Type	Method	Description
CompletableFuture<AsynchronousOperationResult<AsynchronousOperationInfo>>	RescalingHandlers.RescalingStatusHandler.handleRequest(HandlerRequest<EmptyRequestBody> request, RestfulGateway gateway)
CompletableFuture<TriggerResponse>	RescalingHandlers.RescalingTriggerHandler.handleRequest(HandlerRequest<EmptyRequestBody> request, RestfulGateway gateway)
protected CompletableFuture<Acknowledge>	RescalingHandlers.RescalingTriggerHandler.triggerOperation(HandlerRequest<EmptyRequestBody> request, RestfulGateway gateway)

Constructor parameters in org.apache.flink.runtime.rest.handler.job.rescaling with type arguments of type RestfulGateway

Constructor	Description
RescalingStatusHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever, Duration timeout, Map<String,String> responseHeaders)
RescalingTriggerHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever, Duration timeout, Map<String,String> responseHeaders)

Uses of RestfulGateway in org.apache.flink.runtime.rest.handler.job.savepoints

Methods in org.apache.flink.runtime.rest.handler.job.savepoints with parameters of type RestfulGateway

Modifier and Type	Method	Description
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)

Constructor parameters in org.apache.flink.runtime.rest.handler.job.savepoints with type arguments of type RestfulGateway

Constructor	Description
SavepointDisposalStatusHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever, Duration timeout, Map<String,String> responseHeaders)
SavepointDisposalTriggerHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever, Duration timeout, Map<String,String> responseHeaders)
SavepointStatusHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever, Duration timeout, Map<String,String> responseHeaders)
SavepointTriggerHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever, Duration timeout, Map<String,String> responseHeaders)
StopWithSavepointHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever, Duration timeout, Map<String,String> responseHeaders)

Uses of RestfulGateway in org.apache.flink.runtime.rest.handler.legacy

Methods in org.apache.flink.runtime.rest.handler.legacy with parameters of type RestfulGateway

Modifier and Type	Method	Description
CompletableFuture<ExecutionGraphInfo>	DefaultExecutionGraphCache.getExecutionGraphInfo(org.apache.flink.api.common.JobID jobId, RestfulGateway restfulGateway)
CompletableFuture<ExecutionGraphInfo>	ExecutionGraphCache.getExecutionGraphInfo(org.apache.flink.api.common.JobID jobId, RestfulGateway restfulGateway)	Gets the ExecutionGraphInfo for the given JobID and caches it.

Uses of RestfulGateway in org.apache.flink.runtime.rest.handler.legacy.files

Classes in org.apache.flink.runtime.rest.handler.legacy.files with type parameters of type RestfulGateway

Modifier and Type	Class	Description
class	StaticFileServerHandler<T extends RestfulGateway>	Simple file server handler that serves requests to web frontend's static files, such as HTML, CSS, or JS files.

Uses of RestfulGateway in org.apache.flink.runtime.rest.handler.legacy.metrics

Classes in org.apache.flink.runtime.rest.handler.legacy.metrics with type parameters of type RestfulGateway

Modifier and Type	Class	Description
class	MetricFetcherImpl<T extends RestfulGateway>	Implementation of MetricFetcher which fetches metrics from the MetricQueryServiceGateway.

Methods in org.apache.flink.runtime.rest.handler.legacy.metrics with type parameters of type RestfulGateway

Modifier and Type	Method	Description
static <T extends RestfulGateway> MetricFetcherImpl<T>	MetricFetcherImpl.fromConfiguration(org.apache.flink.configuration.Configuration configuration, MetricQueryServiceRetriever metricQueryServiceGatewayRetriever, GatewayRetriever<T> dispatcherGatewayRetriever, ExecutorService executor)

Uses of RestfulGateway in org.apache.flink.runtime.rest.handler.resourcemanager

Classes in org.apache.flink.runtime.rest.handler.resourcemanager with type parameters of type RestfulGateway

Modifier and Type	Class	Description
class	AbstractResourceManagerHandler<T extends RestfulGateway,R extends RequestBody,P extends ResponseBody,M extends MessageParameters>	Base class for REST handlers which need access to the ResourceManager.

Uses of RestfulGateway in org.apache.flink.runtime.rest.handler.taskmanager

Methods in org.apache.flink.runtime.rest.handler.taskmanager with parameters of type RestfulGateway

Modifier and Type	Method	Description
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)

Constructor parameters in org.apache.flink.runtime.rest.handler.taskmanager with type arguments of type RestfulGateway

Constructor	Description
AbstractTaskManagerFileHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever, Duration timeout, Map<String,String> responseHeaders, UntypedResponseMessageHeaders<EmptyRequestBody,M> untypedResponseMessageHeaders, GatewayRetriever<ResourceManagerGateway> resourceManagerGatewayRetriever, TransientBlobService transientBlobService, Duration cacheEntryDuration)
TaskManagerCustomLogHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever, Duration timeout, Map<String,String> responseHeaders, UntypedResponseMessageHeaders<EmptyRequestBody,TaskManagerFileMessageParameters> untypedResponseMessageHeaders, GatewayRetriever<ResourceManagerGateway> resourceManagerGatewayRetriever, TransientBlobService transientBlobService, Duration cacheEntryDuration)
TaskManagerDetailsHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever, Duration timeout, Map<String,String> responseHeaders, MessageHeaders<EmptyRequestBody,TaskManagerDetailsInfo,TaskManagerMessageParameters> messageHeaders, GatewayRetriever<ResourceManagerGateway> resourceManagerGatewayRetriever, MetricFetcher metricFetcher)
TaskManagerLogFileHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever, Duration timeout, Map<String,String> responseHeaders, UntypedResponseMessageHeaders<EmptyRequestBody,TaskManagerMessageParameters> untypedResponseMessageHeaders, GatewayRetriever<ResourceManagerGateway> resourceManagerGatewayRetriever, TransientBlobService transientBlobService, Duration cacheEntryDuration)
TaskManagerLogListHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever, Duration timeout, Map<String,String> responseHeaders, MessageHeaders<EmptyRequestBody,LogListInfo,TaskManagerMessageParameters> messageHeaders, GatewayRetriever<ResourceManagerGateway> resourceManagerGatewayRetriever)
TaskManagerProfilingFileHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever, Duration timeout, Map<String,String> responseHeaders, UntypedResponseMessageHeaders<EmptyRequestBody,TaskManagerProfilingFileMessageParameters> untypedResponseMessageHeaders, GatewayRetriever<ResourceManagerGateway> resourceManagerGatewayRetriever, TransientBlobService transientBlobService, Duration cacheEntryDuration)
TaskManagerProfilingHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever, Duration timeout, Map<String,String> responseHeaders, MessageHeaders<ProfilingRequestBody,ProfilingInfo,TaskManagerMessageParameters> messageHeaders, GatewayRetriever<ResourceManagerGateway> resourceManagerGatewayRetriever, org.apache.flink.configuration.Configuration configuration)
TaskManagerProfilingListHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever, Duration timeout, Map<String,String> responseHeaders, MessageHeaders<EmptyRequestBody,ProfilingInfoList,TaskManagerMessageParameters> messageHeaders, GatewayRetriever<ResourceManagerGateway> resourceManagerGatewayRetriever)
TaskManagersHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever, Duration timeout, Map<String,String> responseHeaders, MessageHeaders<EmptyRequestBody,TaskManagersInfo,EmptyMessageParameters> messageHeaders, GatewayRetriever<ResourceManagerGateway> resourceManagerGatewayRetriever)
TaskManagerStdoutFileHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever, Duration timeout, Map<String,String> responseHeaders, UntypedResponseMessageHeaders<EmptyRequestBody,TaskManagerMessageParameters> untypedResponseMessageHeaders, GatewayRetriever<ResourceManagerGateway> resourceManagerGatewayRetriever, TransientBlobService transientBlobService, Duration cacheEntryDuration)
TaskManagerThreadDumpHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever, Duration timeout, Map<String,String> responseHeaders, MessageHeaders<EmptyRequestBody,ThreadDumpInfo,TaskManagerMessageParameters> messageHeaders, GatewayRetriever<ResourceManagerGateway> resourceManagerGatewayRetriever)

Uses of RestfulGateway in org.apache.flink.runtime.webmonitor

Classes in org.apache.flink.runtime.webmonitor with type parameters of type RestfulGateway

Modifier and Type	Class	Description
class	WebMonitorEndpoint<T extends RestfulGateway>	Rest endpoint which serves the web frontend REST calls.

Classes in org.apache.flink.runtime.webmonitor that implement RestfulGateway

Modifier and Type	Class	Description
class	NonLeaderRetrievalRestfulGateway	* Gateway for restful endpoints without leader retrieval logic. * *

Methods in org.apache.flink.runtime.webmonitor with type parameters of type RestfulGateway

Modifier and Type	Method	Description
static <T extends RestfulGateway> Optional<StaticFileServerHandler<T>>	WebMonitorUtils.tryLoadWebContent(GatewayRetriever<? extends T> leaderRetriever, Duration timeout, File tmpDir)	Checks whether the flink-runtime-web dependency is available and if so returns a StaticFileServerHandler which can serve the static file contents.