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

Class FetchResultsHeaders

java.lang.Object

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

All Implemented Interfaces:

RestHandlerSpecification, MessageHeaders<EmptyRequestBody,FetchResultsResponseBody,FetchResultsMessageParameters>, UntypedResponseMessageHeaders<EmptyRequestBody,FetchResultsMessageParameters>, SqlGatewayMessageHeaders<EmptyRequestBody,FetchResultsResponseBody,FetchResultsMessageParameters>

public class FetchResultsHeaders
extends Object
implements SqlGatewayMessageHeaders<EmptyRequestBody,FetchResultsResponseBody,FetchResultsMessageParameters>

Message headers for fetching results.

Field Summary

Fields

Modifier and Type	Field	Description
static String	URL

Method Summary

Modifier and Type	Method	Description
static String	buildNextUri(SqlGatewayRestAPIVersion version, String sessionId, String operationId, Long nextToken, RowFormat rowFormat)
static FetchResultsHeaders	getDefaultInstance()
String	getDescription()	Returns the description for this header.
HttpMethodWrapper	getHttpMethod()	Returns the HttpMethodWrapper to be used for the request.
static FetchResultsHeaders	getInstanceV1()
Class<EmptyRequestBody>	getRequestClass()	Returns the class of the request message.
Class<FetchResultsResponseBody>	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.
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.
FetchResultsMessageParameters	getUnresolvedMessageParameters()	Returns a new MessageParameters object.
String	operationId()	Returns a short description for this header suitable for method code generation.

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, getResponseTypeParameters

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

acceptsFileUploads

Field Detail

URL

public static final String URL

See Also:

Constant Field Values

Method Detail

getInstanceV1

public static FetchResultsHeaders getInstanceV1()

getDefaultInstance

public static FetchResultsHeaders getDefaultInstance()

buildNextUri

@Nullable
public static String buildNextUri(SqlGatewayRestAPIVersion version,
                                  String sessionId,
                                  String operationId,
                                  Long nextToken,
                                  RowFormat rowFormat)

getResponseClass

public Class<FetchResultsResponseBody> getResponseClass()

Description copied from interface: MessageHeaders

Returns the class of the response message.

Specified by:

getResponseClass in interface MessageHeaders<EmptyRequestBody,FetchResultsResponseBody,FetchResultsMessageParameters>

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,FetchResultsResponseBody,FetchResultsMessageParameters>

Returns:

http status code of the response

getDescription

public String getDescription()

Description copied from interface: MessageHeaders

Returns the description for this header.

Specified by:

getDescription in interface MessageHeaders<EmptyRequestBody,FetchResultsResponseBody,FetchResultsMessageParameters>

Returns:

description for the header

getHttpMethod

public HttpMethodWrapper getHttpMethod()

Description copied from interface: RestHandlerSpecification

Returns the HttpMethodWrapper to be used for the request.

Specified by:

getHttpMethod in interface RestHandlerSpecification

Returns:

http method to be used for the request

getTargetRestEndpointURL

public String getTargetRestEndpointURL()

Description copied from interface: RestHandlerSpecification

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

Specified by:

getTargetRestEndpointURL in interface RestHandlerSpecification

Returns:

endpoint url that this request should be sent to

getSupportedAPIVersions

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

Description copied from interface: RestHandlerSpecification

Returns the supported API versions that this request supports.

Specified by:

getSupportedAPIVersions in interface RestHandlerSpecification

Specified by:

getSupportedAPIVersions in interface SqlGatewayMessageHeaders<EmptyRequestBody,FetchResultsResponseBody,FetchResultsMessageParameters>

Returns:

Collection of supported API versions

getRequestClass

public Class<EmptyRequestBody> getRequestClass()

Description copied from interface: UntypedResponseMessageHeaders

Returns the class of the request message.

Specified by:

getRequestClass in interface UntypedResponseMessageHeaders<EmptyRequestBody,FetchResultsMessageParameters>

Returns:

class of the request message

getUnresolvedMessageParameters

public FetchResultsMessageParameters getUnresolvedMessageParameters()

Description copied from interface: UntypedResponseMessageHeaders

Returns a new MessageParameters object.

Specified by:

getUnresolvedMessageParameters in interface UntypedResponseMessageHeaders<EmptyRequestBody,FetchResultsMessageParameters>

Returns:

new message parameters object

operationId

public String operationId()

Description copied from interface: MessageHeaders

Returns a short description for this header suitable for method code generation.

Specified by:

operationId in interface MessageHeaders<EmptyRequestBody,FetchResultsResponseBody,FetchResultsMessageParameters>

Returns:

short description