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

Class AbstractOperationHeaders

java.lang.Object

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

All Implemented Interfaces:

RestHandlerSpecification, MessageHeaders<EmptyRequestBody,OperationStatusResponseBody,OperationMessageParameters>, UntypedResponseMessageHeaders<EmptyRequestBody,OperationMessageParameters>, SqlGatewayMessageHeaders<EmptyRequestBody,OperationStatusResponseBody,OperationMessageParameters>

Direct Known Subclasses:

CancelOperationHeaders, CloseOperationHeaders, GetOperationStatusHeaders

public abstract class AbstractOperationHeaders
extends Object
implements SqlGatewayMessageHeaders<EmptyRequestBody,OperationStatusResponseBody,OperationMessageParameters>

Abstract operation related message headers.

Constructor Summary

Constructors

Constructor	Description
AbstractOperationHeaders()

Method Summary

Modifier and Type	Method	Description
Class<EmptyRequestBody>	getRequestClass()	Returns the class of the request message.
Class<OperationStatusResponseBody>	getResponseClass()	Returns the class of the response message.
org.apache.flink.shaded.netty4.io.netty.handler.codec.http.HttpResponseStatus	getResponseStatusCode()	Returns the http status code for the response.
OperationMessageParameters	getUnresolvedMessageParameters()	Returns a new MessageParameters object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

getCustomHeaders, getDescription, getResponseTypeParameters, operationId

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

getHttpMethod, getTargetRestEndpointURL

Methods inherited from interface org.apache.flink.table.gateway.rest.header.SqlGatewayMessageHeaders

getSupportedAPIVersions

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

acceptsFileUploads

Constructor Detail

AbstractOperationHeaders

public AbstractOperationHeaders()

Method Detail

getResponseClass

public Class<OperationStatusResponseBody> getResponseClass()

Description copied from interface: MessageHeaders

Returns the class of the response message.

Specified by:

getResponseClass in interface MessageHeaders<EmptyRequestBody,OperationStatusResponseBody,OperationMessageParameters>

Returns:

class of the response message

getResponseStatusCode

public org.apache.flink.shaded.netty4.io.netty.handler.codec.http.HttpResponseStatus getResponseStatusCode()

Description copied from interface: MessageHeaders

Returns the http status code for the response.

Specified by:

getResponseStatusCode in interface MessageHeaders<EmptyRequestBody,OperationStatusResponseBody,OperationMessageParameters>

Returns:

http status code of the response

getRequestClass

public Class<EmptyRequestBody> getRequestClass()

Description copied from interface: UntypedResponseMessageHeaders

Returns the class of the request message.

Specified by:

getRequestClass in interface UntypedResponseMessageHeaders<EmptyRequestBody,OperationMessageParameters>

Returns:

class of the request message

getUnresolvedMessageParameters

public OperationMessageParameters getUnresolvedMessageParameters()

Description copied from interface: UntypedResponseMessageHeaders

Returns a new MessageParameters object.

Specified by:

getUnresolvedMessageParameters in interface UntypedResponseMessageHeaders<EmptyRequestBody,OperationMessageParameters>

Returns:

new message parameters object