org.apache.flink.runtime.rest.messages

Interface MessageHeaders<R extends RequestBody,P extends ResponseBody,M extends MessageParameters>

Type Parameters:

R - request message type

P - response message type

M - message parameters type

All Superinterfaces:

RestHandlerSpecification, UntypedResponseMessageHeaders<R,M>

All Known Implementing Classes:

AbstractAggregatedMetricsHeaders, AbstractMetricsHeaders, AggregatedJobMetricsHeaders, AggregatedSubtaskMetricsHeaders, AggregatedTaskManagerMetricsHeaders, AsynchronousOperationStatusMessageHeaders, AsynchronousOperationTriggerMessageHeaders, CheckpointConfigHeaders, CheckpointingStatisticsHeaders, CheckpointStatisticDetailsHeaders, ClusterConfigurationInfoHeaders, ClusterOverviewHeaders, DashboardConfigurationHeaders, JarDeleteHeaders, JarListHeaders, JarPlanHeaders, JarRunHeaders, JarUploadHeaders, JobAccumulatorsHeaders, JobConfigHeaders, JobDetailsHeaders, JobExceptionsHeaders, JobExecutionResultHeaders, JobIdsWithStatusesOverviewHeaders, JobManagerMetricsHeaders, JobMetricsHeaders, JobPlanHeaders, JobsOverviewHeaders, JobSubmitHeaders, JobTerminationHeaders, JobVertexAccumulatorsHeaders, JobVertexBackPressureHeaders, JobVertexDetailsHeaders, JobVertexMetricsHeaders, JobVertexTaskManagersHeaders, RescalingStatusHeaders, RescalingTriggerHeaders, SavepointDisposalStatusHeaders, SavepointDisposalTriggerHeaders, SavepointStatusHeaders, SavepointTriggerHeaders, ShutdownHeaders, SubtaskCurrentAttemptDetailsHeaders, SubtaskExecutionAttemptAccumulatorsHeaders, SubtaskExecutionAttemptDetailsHeaders, SubtaskMetricsHeaders, SubtasksAllAccumulatorsHeaders, SubtasksTimesHeaders, TaskCheckpointStatisticsHeaders, TaskManagerDetailsHeaders, TaskManagerMetricsHeaders, TaskManagersHeaders

public interface MessageHeaders<R extends RequestBody,P extends ResponseBody,M extends MessageParameters>
extends UntypedResponseMessageHeaders<R,M>

This class links RequestBodys to ResponseBodys types and contains meta-data required for their http headers.

Implementations must be state-less.

Method Summary

Modifier and Type	Method and Description
String	getDescription() Returns the description for this header.
Class<P>	getResponseClass() Returns the class of the response message.
org.apache.flink.shaded.netty4.io.netty.handler.codec.http.HttpResponseStatus	getResponseStatusCode() Returns the http status code for the response.
default Collection<Class<?>>	getResponseTypeParameters() Returns the collection of type parameters for the response type.

Methods inherited from interface org.apache.flink.runtime.rest.messages.UntypedResponseMessageHeaders

acceptsFileUploads, getRequestClass, getUnresolvedMessageParameters

Methods inherited from interface org.apache.flink.runtime.rest.handler.RestHandlerSpecification

getHttpMethod, getTargetRestEndpointURL

Method Detail

getResponseClass

Class<P> getResponseClass()

Returns the class of the response message.

Returns:

class of the response message

getResponseStatusCode

org.apache.flink.shaded.netty4.io.netty.handler.codec.http.HttpResponseStatus getResponseStatusCode()

Returns the http status code for the response.

Returns:

http status code of the response

getResponseTypeParameters

default Collection<Class<?>> getResponseTypeParameters()

Returns the collection of type parameters for the response type.

Returns:

Collection of type parameters for the response type

getDescription

String getDescription()

Returns the description for this header.

Returns:

description for the header