Uses of Class
org.apache.flink.runtime.rest.messages.MessageParameters

Packages that use MessageParameters

Package	Description
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.job.metrics
org.apache.flink.runtime.rest.handler.job.rescaling
org.apache.flink.runtime.rest.handler.resourcemanager
org.apache.flink.runtime.rest.handler.util
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.taskmanager

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

Methods in org.apache.flink.runtime.rest with type parameters of type MessageParameters

Modifier and Type	Method	Description
<M extends MessageHeaders<R, P, U>, U extends MessageParameters, R extends RequestBody, P extends ResponseBody> CompletableFuture<P>	RestClient.sendRequest(String targetAddress, int targetPort, M messageHeaders, U messageParameters, R request)
<M extends MessageHeaders<R, P, U>, U extends MessageParameters, R extends RequestBody, P extends ResponseBody> CompletableFuture<P>	RestClient.sendRequest(String targetAddress, int targetPort, M messageHeaders, U messageParameters, R request, Collection<FileUpload> fileUploads)
<M extends MessageHeaders<R, P, U>, U extends MessageParameters, R extends RequestBody, P extends ResponseBody> CompletableFuture<P>	RestClient.sendRequest(String targetAddress, int targetPort, M messageHeaders, U messageParameters, R request, Collection<FileUpload> fileUploads, RestAPIVersion<? extends RestAPIVersion<?>> apiVersion)

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

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

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.

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

Modifier and Type	Method	Description
static <R extends RequestBody, M extends MessageParameters> HandlerRequest<R>	HandlerRequest.create(R requestBody, M messageParameters)	Short-cut for HandlerRequest.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.

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

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

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.
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 MessageParameters in org.apache.flink.runtime.rest.handler.cluster

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

Modifier and Type	Class	Description
class	AbstractJobManagerFileHandler<M extends MessageParameters>	Base class for serving files from the JobManager.

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

Classes in org.apache.flink.runtime.rest.handler.job.metrics with type parameters of type MessageParameters

Modifier and Type	Class	Description
class	AbstractMetricsHandler<M extends MessageParameters>	Request handler that returns for a given task a list of all available metrics or the values for a set of metrics.

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

Subclasses of MessageParameters in org.apache.flink.runtime.rest.handler.job.rescaling

Modifier and Type	Class	Description
class	RescalingStatusMessageParameters	MessageParameters for polling the status of a rescaling operation.
class	RescalingTriggerMessageParameters	MessageParameters for triggering the rescaling of a job.

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

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

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 MessageParameters in org.apache.flink.runtime.rest.handler.util

Methods in org.apache.flink.runtime.rest.handler.util with type parameters of type MessageParameters

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

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

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

Modifier and Type	Class	Description
class	CustomHeadersDecorator<R extends RequestBody,P extends ResponseBody,M extends MessageParameters>	Decorator class for MessageHeaders that adds the ability to include custom HTTP headers.
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.

Subclasses of MessageParameters in org.apache.flink.runtime.rest.messages

Modifier and Type	Class	Description
class	EmptyMessageParameters	MessageParameters implementation which has no parameters.
class	JobAccumulatorsMessageParameters	Request parameter for job accumulator's handler JobAccumulatorsHandler.
class	JobCancellationMessageParameters	Parameters for job related REST handlers.
class	JobClientHeartbeatParameters	The parameter when the client reports heartbeat.
class	JobMessageParameters	Message parameters which require a job path parameter.
class	JobTaskManagerMessageParameters	Message parameters which require a job path parameter and a TaskManager id path parameter.
class	JobVertexFlameGraphParameters	Message parameters for job vertex Flame Graph REST handler.
class	JobVertexMessageParameters	Message parameters for job vertex REST handlers.

Methods in org.apache.flink.runtime.rest.messages with parameters of type MessageParameters

Modifier and Type	Method	Description
static String	MessageParameters.resolveUrl(String genericUrl, MessageParameters parameters)	Resolves the given URL (e.g "jobs/:jobid") using the given path/query parameters.

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

Subclasses of MessageParameters in org.apache.flink.runtime.rest.messages.checkpoints

Modifier and Type	Class	Description
class	CheckpointMessageParameters	Message parameters for checkpoint related messages.
class	CheckpointStatusMessageParameters	The parameters for triggering a checkpoint.
class	CheckpointTriggerMessageParameters	The parameters for triggering a checkpoint.
class	TaskCheckpointMessageParameters	Message parameters for subtask related checkpoint message.

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

Subclasses of MessageParameters in org.apache.flink.runtime.rest.messages.cluster

Modifier and Type	Class	Description
class	FileMessageParameters	Parameters for JobManagerCustomLogHandler.
class	ProfilingFileMessageParameters	Parameters for JobManagerProfilingFileHandler.

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

Subclasses of MessageParameters in org.apache.flink.runtime.rest.messages.dataset

Modifier and Type	Class	Description
class	ClusterDataSetDeleteStatusMessageParameters	MessageParameters for the ClusterDataSetDeleteStatusHeaders.
class	ClusterDataSetDeleteTriggerMessageParameters	MessageParameters for the ClusterDataSetDeleteTriggerHeaders.

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

Subclasses of MessageParameters in org.apache.flink.runtime.rest.messages.job

Modifier and Type	Class	Description
class	JobExceptionsMessageParameters	MessageParameters for JobExceptionsHandler.
class	SubtaskAttemptMessageParameters	The type Subtask attempt message parameters.
class	SubtaskMessageParameters	Message parameters for subtask REST handlers.

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

Subclasses of MessageParameters in org.apache.flink.runtime.rest.messages.job.coordination

Modifier and Type	Class	Description
class	ClientCoordinationMessageParameters	MessageParameters for ClientCoordinationHandler.

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

Classes in org.apache.flink.runtime.rest.messages.job.metrics with type parameters of type MessageParameters

Modifier and Type	Class	Description
class	AbstractMetricsHeaders<M extends MessageParameters>	MessageHeaders for AbstractMetricsHandler.

Subclasses of MessageParameters in org.apache.flink.runtime.rest.messages.job.metrics

Modifier and Type	Class	Description
class	AbstractAggregatedMetricsParameters<M extends MessageQueryParameter<?>>	Base MessageParameters class for aggregating metrics.
class	AggregatedJobMetricsParameters	Parameters for aggregating job metrics.
class	AggregatedSubtaskMetricsParameters	Parameters for aggregating subtask metrics.
class	AggregateTaskManagerMetricsParameters	Parameters for aggregating task manager metrics.
class	JobManagerMetricsMessageParameters	MessageParameters for JobManagerMetricsHandler.
class	JobManagerOperatorMetricsMessageParameters	MessageParameters for JobManagerOperatorMetricsHandler.
class	JobMetricsMessageParameters	MessageParameters for JobMetricsHandler.
class	JobVertexMetricsMessageParameters	MessageParameters for JobVertexMetricsHandler.
class	SubtaskMetricsMessageParameters	MessageParameters for SubtaskMetricsHandler.
class	TaskManagerMetricsMessageParameters	MessageParameters for TaskManagerMetricsHandler.

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

Subclasses of MessageParameters in org.apache.flink.runtime.rest.messages.job.savepoints

Modifier and Type	Class	Description
class	SavepointDisposalStatusMessageParameters	MessageParameters for the SavepointDisposalHandlers.SavepointDisposalStatusHandler.
class	SavepointStatusMessageParameters	The parameters for triggering a savepoint.
class	SavepointTriggerMessageParameters	The parameters for triggering a savepoint.

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

Subclasses of MessageParameters in org.apache.flink.runtime.rest.messages.taskmanager

Modifier and Type	Class	Description
class	TaskManagerFileMessageParameters	Parameters for TaskManagerCustomLogHandler.
class	TaskManagerMessageParameters	Message parameter for a TaskManager specific handler.
class	TaskManagerProfilingFileMessageParameters	Parameters for TaskManagerProfilingFileHandler.