Package org.apache.flink.runtime.rest.handler

Interface RestHandlerSpecification

All Known Subinterfaces:
MessageHeaders<R,P,M>, RuntimeMessageHeaders<R,P,M>, RuntimeUntypedResponseMessageHeaders<R,M>, UntypedResponseMessageHeaders<R,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, JobManagerCustomLogHeaders, JobManagerEnvironmentHeaders, JobManagerJobConfigurationHeaders, JobManagerJobEnvironmentHeaders, JobManagerLogFileHeader, JobManagerLogListHeaders, JobManagerLogUrlHeaders, JobManagerMetricsHeaders, JobManagerOperatorMetricsHeaders, JobManagerProfilingFileHeaders, JobManagerProfilingHeaders, JobManagerProfilingListHeaders, JobManagerStdoutFileHeader, 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, TaskManagerCustomLogHeaders, TaskManagerDetailsHeaders, TaskManagerLogFileHeaders, TaskManagerLogsHeaders, TaskManagerLogUrlHeaders, TaskManagerMetricsHeaders, TaskManagerProfilingFileHeaders, TaskManagerProfilingHeaders, TaskManagerProfilingListHeaders, TaskManagersHeaders, TaskManagerStdoutFileHeaders, TaskManagerThreadDumpHeaders, WebContentHandlerSpecification, YarnCancelJobTerminationHeaders, YarnStopJobTerminationHeaders
public interface RestHandlerSpecification
Rest handler interface which all rest handler implementation have to implement.

  • Method Details

    • getHttpMethod

      HttpMethodWrapper getHttpMethod()
      Returns the HttpMethodWrapper to be used for the request.
      Returns:
      http method to be used for the request

    • getTargetRestEndpointURL

      String getTargetRestEndpointURL()
      Returns the generalized endpoint url that this request should be sent to, for example /job/:jobid.
      Returns:
      endpoint url that this request should be sent to

    • getSupportedAPIVersions

      Collection<? extends RestAPIVersion<?>> getSupportedAPIVersions()
      Returns the supported API versions that this request supports.
      Returns:
      Collection of supported API versions