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

Interface SqlGatewayMessageHeaders<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:

MessageHeaders<R,P,M>, RestHandlerSpecification, UntypedResponseMessageHeaders<R,M>

All Known Implementing Classes:

AbstractEmbeddedSchedulerWorkflowHeaders, AbstractOperationHeaders, CancelOperationHeaders, CloseOperationHeaders, CloseSessionHeaders, CompleteStatementHeaders, ConfigureSessionHeaders, CreateEmbeddedSchedulerWorkflowHeaders, DeleteEmbeddedSchedulerWorkflowHeaders, ExecuteStatementHeaders, FetchResultsHeaders, GetApiVersionHeaders, GetInfoHeaders, GetOperationStatusHeaders, GetSessionConfigHeaders, OpenSessionHeaders, RefreshMaterializedTableHeaders, ResumeEmbeddedSchedulerWorkflowHeaders, SuspendEmbeddedSchedulerWorkflowHeaders, TriggerSessionHeartbeatHeaders

public interface SqlGatewayMessageHeaders<R extends RequestBody,P extends ResponseBody,M extends MessageParameters>
extends 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 and Description
default Collection<? extends RestAPIVersion<?>>	getSupportedAPIVersions() Returns the supported API versions that this request supports.

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.messages.UntypedResponseMessageHeaders

acceptsFileUploads, getRequestClass, getUnresolvedMessageParameters

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

getHttpMethod, getTargetRestEndpointURL

Method Detail

getSupportedAPIVersions

default Collection<? extends RestAPIVersion<?>> getSupportedAPIVersions()

Description copied from interface: RestHandlerSpecification

Returns the supported API versions that this request supports.

Specified by:

getSupportedAPIVersions in interface RestHandlerSpecification

Returns:

Collection of supported API versions