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

Interface RestHandlerSpecification

All Known Subinterfaces:

MessageHeaders<R,P,M>, RuntimeMessageHeaders<R,P,M>, RuntimeUntypedResponseMessageHeaders<R,M>, SqlGatewayMessageHeaders<R,P,M>, UntypedResponseMessageHeaders<R,M>

All Known Implementing Classes:

AbstractAggregatedMetricsHeaders, AbstractEmbeddedSchedulerWorkflowHeaders, AbstractJarPlanHeaders, AbstractMetricsHeaders, AbstractOperationHeaders, AggregatedJobMetricsHeaders, AggregatedSubtaskMetricsHeaders, AggregatedTaskManagerMetricsHeaders, AsynchronousOperationStatusMessageHeaders, AsynchronousOperationTriggerMessageHeaders, CancelOperationHeaders, CheckpointConfigHeaders, CheckpointingStatisticsHeaders, CheckpointStatisticDetailsHeaders, CheckpointStatusHeaders, CheckpointTriggerHeaders, ClientCoordinationHeaders, CloseOperationHeaders, CloseSessionHeaders, ClusterConfigurationInfoHeaders, ClusterDataSetDeleteStatusHeaders, ClusterDataSetDeleteTriggerHeaders, ClusterDataSetListHeaders, ClusterOverviewHeaders, CompleteStatementHeaders, ConfigureSessionHeaders, CreateEmbeddedSchedulerWorkflowHeaders, CustomHeadersDecorator, DashboardConfigurationHeaders, DeleteEmbeddedSchedulerWorkflowHeaders, ExecuteStatementHeaders, FetchResultsHeaders, GetApiVersionHeaders, GetInfoHeaders, GetOperationStatusHeaders, GetSessionConfigHeaders, JarDeleteHeaders, JarListHeaders, JarPlanGetHeaders, JarPlanPostHeaders, JarRunHeaders, JarUploadHeaders, 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, OpenSessionHeaders, RefreshMaterializedTableHeaders, RescalingStatusHeaders, RescalingTriggerHeaders, ResumeEmbeddedSchedulerWorkflowHeaders, SavepointDisposalStatusHeaders, SavepointDisposalTriggerHeaders, SavepointStatusHeaders, SavepointTriggerHeaders, ShutdownHeaders, StopWithSavepointTriggerHeaders, SubtaskCurrentAttemptDetailsHeaders, SubtaskExecutionAttemptAccumulatorsHeaders, SubtaskExecutionAttemptDetailsHeaders, SubtaskMetricsHeaders, SubtasksAllAccumulatorsHeaders, SubtasksTimesHeaders, SuspendEmbeddedSchedulerWorkflowHeaders, TaskCheckpointStatisticsHeaders, TaskManagerCustomLogHeaders, TaskManagerDetailsHeaders, TaskManagerLogFileHeaders, TaskManagerLogsHeaders, TaskManagerLogUrlHeaders, TaskManagerMetricsHeaders, TaskManagerProfilingFileHeaders, TaskManagerProfilingHeaders, TaskManagerProfilingListHeaders, TaskManagersHeaders, TaskManagerStdoutFileHeaders, TaskManagerThreadDumpHeaders, TriggerSessionHeartbeatHeaders, UrlPrefixDecorator, WebContentHandlerSpecification, YarnCancelJobTerminationHeaders, YarnStopJobTerminationHeaders

public interface RestHandlerSpecification

Rest handler interface which all rest handler implementation have to implement.

Method Summary

Modifier and Type	Method	Description
HttpMethodWrapper	getHttpMethod()	Returns the HttpMethodWrapper to be used for the request.
Collection<? extends RestAPIVersion<?>>	getSupportedAPIVersions()	Returns the supported API versions that this request supports.
String	getTargetRestEndpointURL()	Returns the generalized endpoint url that this request should be sent to, for example /job/:jobid.

Method Detail

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