Package 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 Subinterfaces:
RuntimeMessageHeaders<R,P,M>
All Known Implementing Classes:
AbstractAggregatedMetricsHeaders, AbstractMetricsHeaders, AggregatedJobMetricsHeaders, AggregatedSubtaskMetricsHeaders, AggregatedTaskManagerMetricsHeaders, AsynchronousOperationStatusMessageHeaders, AsynchronousOperationTriggerMessageHeaders, CheckpointConfigHeaders, CheckpointingStatisticsHeaders, CheckpointStatisticDetailsHeaders, CheckpointStatusHeaders, CheckpointTriggerHeaders, ClientCoordinationHeaders, ClusterConfigurationInfoHeaders, ClusterDataSetDeleteStatusHeaders, ClusterDataSetDeleteTriggerHeaders, ClusterDataSetListHeaders, ClusterOverviewHeaders, CustomHeadersDecorator, DashboardConfigurationHeaders, JobAccumulatorsHeaders, JobCancellationHeaders, JobClientHeartbeatHeaders, JobConfigHeaders, JobDetailsHeaders, JobExceptionsHeaders, JobExecutionResultHeaders, JobIdsWithStatusesOverviewHeaders, JobManagerEnvironmentHeaders, JobManagerJobConfigurationHeaders, JobManagerJobEnvironmentHeaders, JobManagerLogListHeaders, JobManagerLogUrlHeaders, JobManagerMetricsHeaders, JobManagerOperatorMetricsHeaders, JobManagerProfilingHeaders, JobManagerProfilingListHeaders, JobManagerThreadDumpHeaders, JobMetricsHeaders, JobPlanHeaders, JobResourceRequirementsHeaders, JobResourcesRequirementsUpdateHeaders, JobsOverviewHeaders, JobStatusInfoHeaders, JobSubmitHeaders, JobVertexAccumulatorsHeaders, JobVertexBackPressureHeaders, JobVertexDetailsHeaders, JobVertexFlameGraphHeaders, JobVertexMetricsHeaders, JobVertexTaskManagersHeaders, JobVertexWatermarksHeaders, RescalingStatusHeaders, RescalingTriggerHeaders, SavepointDisposalStatusHeaders, SavepointDisposalTriggerHeaders, SavepointStatusHeaders, SavepointTriggerHeaders, ShutdownHeaders, StopWithSavepointTriggerHeaders, SubtaskCurrentAttemptDetailsHeaders, SubtaskExecutionAttemptAccumulatorsHeaders, SubtaskExecutionAttemptDetailsHeaders, SubtaskMetricsHeaders, SubtasksAllAccumulatorsHeaders, SubtasksTimesHeaders, TaskCheckpointStatisticsHeaders, TaskManagerDetailsHeaders, TaskManagerLogsHeaders, TaskManagerLogUrlHeaders, TaskManagerMetricsHeaders, TaskManagerProfilingHeaders, TaskManagerProfilingListHeaders, TaskManagersHeaders, TaskManagerThreadDumpHeaders
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 Details

    • 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

    • operationId

      default String operationId()
      Returns a short description for this header suitable for method code generation.
      Returns:
      short description

    • getCustomHeaders

      default Collection<HttpHeader> getCustomHeaders()
      Returns a collection of custom HTTP headers.

      This default implementation returns an empty list. Override this method to provide custom headers if needed.

      Returns:
      a collection of custom HttpHeaders, empty by default.