Uses of Interface
org.apache.flink.runtime.rest.handler.RestHandlerSpecification

Packages that use RestHandlerSpecification

Package	Description
org.apache.flink.runtime.dispatcher
org.apache.flink.runtime.rest
org.apache.flink.runtime.rest.handler.async
org.apache.flink.runtime.rest.handler.job.rescaling
org.apache.flink.runtime.rest.handler.legacy.files
org.apache.flink.runtime.rest.messages
org.apache.flink.runtime.rest.messages.checkpoints
org.apache.flink.runtime.rest.messages.cluster
org.apache.flink.runtime.rest.messages.dataset
org.apache.flink.runtime.rest.messages.job
org.apache.flink.runtime.rest.messages.job.coordination
org.apache.flink.runtime.rest.messages.job.metrics
org.apache.flink.runtime.rest.messages.job.savepoints
org.apache.flink.runtime.rest.messages.job.savepoints.stop
org.apache.flink.runtime.rest.messages.taskmanager
org.apache.flink.runtime.webmonitor

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

Methods in org.apache.flink.runtime.dispatcher that return types with arguments of type RestHandlerSpecification

Modifier and Type	Method	Description
protected List<org.apache.flink.api.java.tuple.Tuple2<RestHandlerSpecification,org.apache.flink.shaded.netty4.io.netty.channel.ChannelInboundHandler>>	DispatcherRestEndpoint.initializeHandlers(CompletableFuture<String> localAddressFuture)
protected Collection<org.apache.flink.api.java.tuple.Tuple2<RestHandlerSpecification,org.apache.flink.shaded.netty4.io.netty.channel.ChannelInboundHandler>>	DispatcherRestEndpoint.initializeWebSubmissionHandlers(CompletableFuture<String> localAddressFuture)

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

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

Modifier and Type	Method	Description
protected abstract List<org.apache.flink.api.java.tuple.Tuple2<RestHandlerSpecification,org.apache.flink.shaded.netty4.io.netty.channel.ChannelInboundHandler>>	RestServerEndpoint.initializeHandlers(CompletableFuture<String> localAddressFuture)	This method is called at the beginning of RestServerEndpoint.start() to setup all handlers that the REST server endpoint implementation requires.

Method parameters in org.apache.flink.runtime.rest with type arguments of type RestHandlerSpecification

Modifier and Type	Method	Description
int	RestServerEndpoint.RestHandlerUrlComparator.compare(org.apache.flink.api.java.tuple.Tuple2<RestHandlerSpecification,org.apache.flink.shaded.netty4.io.netty.channel.ChannelInboundHandler> o1, org.apache.flink.api.java.tuple.Tuple2<RestHandlerSpecification,org.apache.flink.shaded.netty4.io.netty.channel.ChannelInboundHandler> o2)

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

Classes in org.apache.flink.runtime.rest.handler.async that implement RestHandlerSpecification

Modifier and Type	Class	Description
class	AsynchronousOperationStatusMessageHeaders<V,M extends MessageParameters>	Message headers for the status polling of an asynchronous operation.
class	AsynchronousOperationTriggerMessageHeaders<R extends RequestBody,M extends MessageParameters>	Message headers for the triggering of an asynchronous operation.

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

Classes in org.apache.flink.runtime.rest.handler.job.rescaling that implement RestHandlerSpecification

Modifier and Type	Class	Description
class	RescalingStatusHeaders	Message headers for polling the status of an ongoing rescaling operation.
class	RescalingTriggerHeaders	Message headers for triggering the rescaling of a job.

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

Classes in org.apache.flink.runtime.rest.handler.legacy.files that implement RestHandlerSpecification

Modifier and Type	Class	Description
class	WebContentHandlerSpecification	Rest handler specification for the web content handler.

Uses of RestHandlerSpecification in org.apache.flink.runtime.rest.messages

Subinterfaces of RestHandlerSpecification in org.apache.flink.runtime.rest.messages

Modifier and Type	Interface	Description
interface	MessageHeaders<R extends RequestBody,P extends ResponseBody,M extends MessageParameters>	This class links RequestBodys to ResponseBodys types and contains meta-data required for their http headers.
interface	RuntimeMessageHeaders<R extends RequestBody,P extends ResponseBody,M extends MessageParameters>	This class links RequestBodys to ResponseBodys types and contains meta-data required for their http headers in runtime module.
interface	RuntimeUntypedResponseMessageHeaders<R extends RequestBody,M extends MessageParameters>	Message headers for a web handler request that belongs to runtime module.
interface	UntypedResponseMessageHeaders<R extends RequestBody,M extends MessageParameters>	Message headers for a web handler request.

Classes in org.apache.flink.runtime.rest.messages that implement RestHandlerSpecification

Modifier and Type	Class	Description
class	ClusterConfigurationInfoHeaders	Message headers for the ClusterConfigHandler.
class	ClusterOverviewHeaders	Message headers for the ClusterOverviewHandler.
class	CustomHeadersDecorator<R extends RequestBody,P extends ResponseBody,M extends MessageParameters>	Decorator class for MessageHeaders that adds the ability to include custom HTTP headers.
class	DashboardConfigurationHeaders	Message headers for the DashboardConfigHandler.
class	JobAccumulatorsHeaders	Message headers for the JobAccumulatorsHandler.
class	JobCancellationHeaders	Message headers for the JobCancellationHandler.
class	JobClientHeartbeatHeaders	Message headers for the JobClientHeartbeatHandler.
class	JobConfigHeaders	Message headers for the JobConfigHandler.
class	JobExceptionsHeaders	Message headers for the JobExceptionsHandler.
class	JobIdsWithStatusesOverviewHeaders	Message headers for the JobIdsWithStatusOverview.
class	JobManagerEnvironmentHeaders	Message headers for the JobManagerEnvironmentHandler.
class	JobManagerLogUrlHeaders	Headers for the log url retriever of JobManager.
class	JobPlanHeaders	Message headers for the JobPlanHandler.
class	JobsOverviewHeaders	Message headers for JobsOverviewHandler.
class	JobVertexAccumulatorsHeaders	Message headers for the JobVertexAccumulatorsHandler.
class	JobVertexBackPressureHeaders	Message headers for the JobVertexBackPressureHandler.
class	JobVertexDetailsHeaders	Message headers for the JobVertexDetailsHandler.
class	JobVertexFlameGraphHeaders	Message headers for the JobVertexFlameGraphHandler.
class	JobVertexTaskManagersHeaders	Message headers for the JobVertexTaskManagersHandler.
class	SubtasksAllAccumulatorsHeaders	Message headers for the SubtasksAllAccumulatorsHandler.
class	SubtasksTimesHeaders	Message headers for the SubtasksTimesHandler.
class	TaskManagerLogUrlHeaders	Headers for the log url retriever of TaskManager.
class	YarnCancelJobTerminationHeaders	Deprecated. This should be removed once we can send arbitrary REST calls via the Yarn proxy.
class	YarnStopJobTerminationHeaders	Deprecated. This should be removed once we can send arbitrary REST calls via the Yarn proxy.

Uses of RestHandlerSpecification in org.apache.flink.runtime.rest.messages.checkpoints

Classes in org.apache.flink.runtime.rest.messages.checkpoints that implement RestHandlerSpecification

Modifier and Type	Class	Description
class	CheckpointConfigHeaders	Message headers for the CheckpointConfigHandler.
class	CheckpointingStatisticsHeaders	Message headers for the CheckpointingStatisticsHandler.
class	CheckpointStatisticDetailsHeaders	Headers for the CheckpointStatisticDetailsHandler.
class	CheckpointStatusHeaders	These headers define the protocol for querying the status of a checkpoint operation.
class	CheckpointTriggerHeaders	These headers define the protocol for triggering a checkpoint.
class	TaskCheckpointStatisticsHeaders	Headers for the TaskCheckpointStatisticDetailsHandler.

Uses of RestHandlerSpecification in org.apache.flink.runtime.rest.messages.cluster

Classes in org.apache.flink.runtime.rest.messages.cluster that implement RestHandlerSpecification

Modifier and Type	Class	Description
class	JobManagerCustomLogHeaders	Headers for the JobManagerCustomLogHandler.
class	JobManagerLogFileHeader	Headers for the JobManagerLogFileHandler.
class	JobManagerLogListHeaders	Headers for the JobManagerLogListHandler.
class	JobManagerProfilingFileHeaders	Headers for the JobManagerProfilingFileHandler.
class	JobManagerProfilingHeaders	Headers for the JobManagerProfilingHandler.
class	JobManagerProfilingListHeaders	Headers for the JobManagerProfilingHandler.
class	JobManagerStdoutFileHeader	Headers for the JobManagerStdoutFileHandler.
class	JobManagerThreadDumpHeaders	Headers for the JobManagerThreadDumpHandler.
class	ShutdownHeaders	Message headers for ShutdownHandler.

Uses of RestHandlerSpecification in org.apache.flink.runtime.rest.messages.dataset

Classes in org.apache.flink.runtime.rest.messages.dataset that implement RestHandlerSpecification

Modifier and Type	Class	Description
class	ClusterDataSetDeleteStatusHeaders	Specification for retrieving the status for the delete operation of a cluster data set.
class	ClusterDataSetDeleteTriggerHeaders	Specification for triggering the deletion of a cluster data set.
class	ClusterDataSetListHeaders	Specification for retrieving an overview over all available cluster partitions.

Uses of RestHandlerSpecification in org.apache.flink.runtime.rest.messages.job

Classes in org.apache.flink.runtime.rest.messages.job that implement RestHandlerSpecification

Modifier and Type	Class	Description
class	JobDetailsHeaders	Message headers for the JobDetailsHandler.
class	JobExecutionResultHeaders	MessageHeaders for JobExecutionResultHeaders.
class	JobManagerJobConfigurationHeaders	Message headers for the JobManagerJobConfigurationHandler.
class	JobManagerJobEnvironmentHeaders	Message headers for the JobManagerJobEnvironmentHandler.
class	JobResourceRequirementsHeaders	Headers for REST request to get details on job's resources.
class	JobResourcesRequirementsUpdateHeaders	Headers for REST request to patch a job.
class	JobStatusInfoHeaders	MessageHeaders for JobStatusHandler.
class	JobSubmitHeaders	These headers define the protocol for submitting a job to a flink cluster.
class	SubtaskCurrentAttemptDetailsHeaders	Message headers for the SubtaskCurrentAttemptDetailsHandler.
class	SubtaskExecutionAttemptAccumulatorsHeaders	Message headers for the SubtaskExecutionAttemptAccumulatorsHandler.
class	SubtaskExecutionAttemptDetailsHeaders	Message headers for the SubtaskExecutionAttemptDetailsHandler.

Uses of RestHandlerSpecification in org.apache.flink.runtime.rest.messages.job.coordination

Classes in org.apache.flink.runtime.rest.messages.job.coordination that implement RestHandlerSpecification

Modifier and Type	Class	Description
class	ClientCoordinationHeaders	Message headers for the ClientCoordinationHandler.

Uses of RestHandlerSpecification in org.apache.flink.runtime.rest.messages.job.metrics

Classes in org.apache.flink.runtime.rest.messages.job.metrics that implement RestHandlerSpecification

Modifier and Type	Class	Description
class	AbstractAggregatedMetricsHeaders<P extends AbstractAggregatedMetricsParameters<?>>	Based MessageHeaders class for aggregating metrics.
class	AbstractMetricsHeaders<M extends MessageParameters>	MessageHeaders for AbstractMetricsHandler.
class	AggregatedJobMetricsHeaders	Headers for aggregating job metrics.
class	AggregatedSubtaskMetricsHeaders	Headers for aggregating subtask metrics.
class	AggregatedTaskManagerMetricsHeaders	Headers for aggregating task manager metrics.
class	JobManagerMetricsHeaders	MessageHeaders for JobManagerMetricsHandler.
class	JobManagerOperatorMetricsHeaders	MessageHeaders for JobManagerOperatorMetricsHandler.
class	JobMetricsHeaders	MessageHeaders for JobMetricsHandler.
class	JobVertexMetricsHeaders	MessageHeaders for JobVertexMetricsHandler.
class	JobVertexWatermarksHeaders	MessageHeaders for retrieving watermarks.
class	SubtaskMetricsHeaders	MessageHeaders for SubtaskMetricsHandler.
class	TaskManagerMetricsHeaders	MessageHeaders for TaskManagerMetricsHandler.

Uses of RestHandlerSpecification in org.apache.flink.runtime.rest.messages.job.savepoints

Classes in org.apache.flink.runtime.rest.messages.job.savepoints that implement RestHandlerSpecification

Modifier and Type	Class	Description
class	SavepointDisposalStatusHeaders	AsynchronousOperationTriggerMessageHeaders implementation for the SavepointDisposalHandlers.SavepointDisposalStatusHandler.
class	SavepointDisposalTriggerHeaders	AsynchronousOperationTriggerMessageHeaders for the SavepointDisposalHandlers.SavepointDisposalTriggerHandler.
class	SavepointStatusHeaders	These headers define the protocol for triggering a savepoint.
class	SavepointTriggerHeaders	These headers define the protocol for triggering a savepoint.

Uses of RestHandlerSpecification in org.apache.flink.runtime.rest.messages.job.savepoints.stop

Classes in org.apache.flink.runtime.rest.messages.job.savepoints.stop that implement RestHandlerSpecification

Modifier and Type	Class	Description
class	StopWithSavepointTriggerHeaders	These headers define the protocol for triggering a "stop" action.

Uses of RestHandlerSpecification in org.apache.flink.runtime.rest.messages.taskmanager

Classes in org.apache.flink.runtime.rest.messages.taskmanager that implement RestHandlerSpecification

Modifier and Type	Class	Description
class	TaskManagerCustomLogHeaders	Headers for the TaskManagerCustomLogHandler.
class	TaskManagerDetailsHeaders	Headers for the TaskManagerDetailsHandler which serves the TaskManager details.
class	TaskManagerLogFileHeaders	Headers for the TaskManagerLogFileHandler.
class	TaskManagerLogsHeaders	Headers for the TaskManagerLogListHandler.
class	TaskManagerProfilingFileHeaders	Headers for the TaskManagerProfilingFileHandler.
class	TaskManagerProfilingHeaders	Headers for the TaskManagerProfilingHandler.
class	TaskManagerProfilingListHeaders	Headers for the TaskManagerProfilingListHandler.
class	TaskManagersHeaders	Message headers for the TaskManagersHandler.
class	TaskManagerStdoutFileHeaders	Headers for the TaskManagerStdoutFileHandler.
class	TaskManagerThreadDumpHeaders	Headers for the TaskManagerThreadDumpHandler.

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

Methods in org.apache.flink.runtime.webmonitor that return types with arguments of type RestHandlerSpecification

Modifier and Type	Method	Description
Collection<org.apache.flink.api.java.tuple.Tuple2<RestHandlerSpecification,org.apache.flink.shaded.netty4.io.netty.channel.ChannelInboundHandler>>	WebMonitorExtension.EmptyWebMonitorExtension.getHandlers()
Collection<org.apache.flink.api.java.tuple.Tuple2<RestHandlerSpecification,org.apache.flink.shaded.netty4.io.netty.channel.ChannelInboundHandler>>	WebMonitorExtension.getHandlers()	Gets the collection of extension handlers to register at the WebMonitorEndpoint.
protected List<org.apache.flink.api.java.tuple.Tuple2<RestHandlerSpecification,org.apache.flink.shaded.netty4.io.netty.channel.ChannelInboundHandler>>	WebMonitorEndpoint.initializeHandlers(CompletableFuture<String> localAddressFuture)
protected Collection<org.apache.flink.api.java.tuple.Tuple2<RestHandlerSpecification,org.apache.flink.shaded.netty4.io.netty.channel.ChannelInboundHandler>>	WebMonitorEndpoint.initializeWebSubmissionHandlers(CompletableFuture<String> localAddressFuture)