Package org.apache.flink.table.gateway.rest.header

Interface SqlGatewayMessageHeaders<R extends org.apache.flink.runtime.rest.messages.RequestBody,P extends org.apache.flink.runtime.rest.messages.ResponseBody,M extends org.apache.flink.runtime.rest.messages.MessageParameters>

Type Parameters:
R - request message type
P - response message type
M - message parameters type
All Superinterfaces:
org.apache.flink.runtime.rest.messages.MessageHeaders<R,P,M>, org.apache.flink.runtime.rest.handler.RestHandlerSpecification, org.apache.flink.runtime.rest.messages.UntypedResponseMessageHeaders<R,M>
All Known Implementing Classes:
AbstractEmbeddedSchedulerWorkflowHeaders, AbstractOperationHeaders, CancelOperationHeaders, CloseOperationHeaders, CloseSessionHeaders, CompleteStatementHeaders, ConfigureSessionHeaders, CreateEmbeddedSchedulerWorkflowHeaders, DeleteEmbeddedSchedulerWorkflowHeaders, DeployScriptHeaders, ExecuteStatementHeaders, FetchResultsHeaders, GetApiVersionHeaders, GetInfoHeaders, GetOperationStatusHeaders, GetSessionConfigHeaders, OpenSessionHeaders, RefreshMaterializedTableHeaders, ResumeEmbeddedSchedulerWorkflowHeaders, SuspendEmbeddedSchedulerWorkflowHeaders, TriggerSessionHeartbeatHeaders
public interface SqlGatewayMessageHeaders<R extends org.apache.flink.runtime.rest.messages.RequestBody,P extends org.apache.flink.runtime.rest.messages.ResponseBody,M extends org.apache.flink.runtime.rest.messages.MessageParameters> extends org.apache.flink.runtime.rest.messages.MessageHeaders<R,P,M>
This class links RequestBodys to ResponseBodys types and contains meta-data required for their http headers in runtime module.

Implementations must be state-less.

  • Method Summary

    Modifier and Type
    Method
    Description
    default Collection<? extends org.apache.flink.runtime.rest.versioning.RestAPIVersion<?>>
    getSupportedAPIVersions()
     

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

    getCustomHeaders, getDescription, getResponseClass, getResponseStatusCode, getResponseTypeParameters, operationId

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

    getHttpMethod, getTargetRestEndpointURL

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

    acceptsFileUploads, getRequestClass, getUnresolvedMessageParameters

  • Method Details

    • getSupportedAPIVersions

      default Collection<? extends org.apache.flink.runtime.rest.versioning.RestAPIVersion<?>> getSupportedAPIVersions()
      Specified by:
      getSupportedAPIVersions in interface org.apache.flink.runtime.rest.handler.RestHandlerSpecification