Package org.apache.flink.runtime.rest.messages

Interface Summary

Interface	Description
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.
RequestBody	Marker interface for all requests of the REST API.
ResponseBody	Marker interface for all responses of the REST API.

Class Summary

Class	Description
BlobServerPortHeaders	These headers define the protocol for querying the port of the blob server.
BlobServerPortResponseBody	Response containing the blob server port.
ClusterConfigurationInfo	Response of the ClusterConfigHandler, respresented as a list of key-value pairs of the cluster Configuration.
ClusterConfigurationInfoEntry	A single key-value pair entry in the ClusterConfigurationInfo response.
ClusterConfigurationInfoHeaders	Message headers for the ClusterConfigHandler.
ClusterOverviewHeaders	Message headers for the ClusterOverviewHandler.
CurrentJobsOverviewHandlerHeaders	Message headers for CurrentJobsOverviewHandler.
DashboardConfiguration	Response of the DashboardConfigHandler containing general configuration values such as the time zone and the refresh interval.
DashboardConfigurationHeaders	Message headers for the DashboardConfigHandler.
EmptyMessageParameters	MessageParameters implementation which has no parameters.
EmptyRequestBody	Request which do not have a request payload.
EmptyResponseBody	Empty ResponseBody implementation.
ErrorResponseBody	Generic response body for communicating errors on the server.
JobConfigHeaders	Message headers for the JobConfigHandler.
JobConfigInfo	Response type of the JobConfigHandler.
JobConfigInfo.Deserializer	Json deserializer for the JobConfigInfo.
JobConfigInfo.ExecutionConfigInfo	Nested class to encapsulate the execution configuration.
JobConfigInfo.Serializer	Json serializer for the JobConfigInfo.
JobExceptionsHeaders	Message headers for the JobExceptionsHandler.
JobExceptionsInfo	Response type of the JobExceptionsHandler.
JobExceptionsInfo.ExecutionExceptionInfo	Nested class to encapsulate the task execution exception.
JobIDPathParameter	Path parameter identifying jobs.
JobMessageParameters	Message parameters which require a job path parameter.
JobPlanHeaders	Message headers for the JobPlanHandler.
JobPlanInfo	Response type of the JobPlanHandler.
JobPlanInfo.Deserializer	Json deserializer for the JobPlanInfo.
JobPlanInfo.Serializer	Json serializer for the JobPlanInfo.
JobTerminationHeaders	Message headers for the JobCancellationHandler.
JobTerminationMessageParameters	Parameters for job related REST handlers.
JobVertexAccumulatorsHeaders	Message headers for the JobVertexAccumulatorsHandler.
JobVertexAccumulatorsInfo	Response type of the JobVertexAccumulatorsHandler.
JobVertexAccumulatorsInfo.UserAccumulator	Json serializer for the JobVertexAccumulatorsInfo.
JobVertexIdPathParameter	Path parameter specifying a JobVertexID.
JobVertexMessageParameters	Message parameters for job vertex REST handlers.
MessageParameter<X>	This class represents a single path/query parameter that can be used for a request.
MessageParameters	This class defines the path/query MessageParameters that can be used for a request.
MessagePathParameter<X>	This class represents path parameters of a request.
MessageQueryParameter<X>	This class represents query parameters of a request.
TerminationModeQueryParameter	Termination mode for the JobCancellationHandler.

Enum Summary

Enum	Description
MessageParameter.MessageParameterRequisiteness	Enum for indicating whether a parameter is mandatory or optional.
TerminationModeQueryParameter.TerminationMode	Supported termination modes.

Exception Summary

Exception	Description
ConversionException	Exception which is thrown if an input cannot converted into the requested type.