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:

org.apache.flink.runtime.rest.handler.RestHandlerSpecification, org.apache.flink.runtime.rest.messages.MessageHeaders<org.apache.flink.runtime.rest.messages.EmptyRequestBody,FetchResultsResponseBody,FetchResultsMessageParameters>, org.apache.flink.runtime.rest.messages.UntypedResponseMessageHeaders<org.apache.flink.runtime.rest.messages.EmptyRequestBody,FetchResultsMessageParameters>, SqlGatewayMessageHeaders<org.apache.flink.runtime.rest.messages.EmptyRequestBody,FetchResultsResponseBody,FetchResultsMessageParameters>

public class FetchResultsHeaders
extends Object
implements SqlGatewayMessageHeaders<org.apache.flink.runtime.rest.messages.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()
org.apache.flink.runtime.rest.HttpMethodWrapper	getHttpMethod()
static FetchResultsHeaders	getInstanceV1()
Class<org.apache.flink.runtime.rest.messages.EmptyRequestBody>	getRequestClass()
Class<FetchResultsResponseBody>	getResponseClass()
org.apache.flink.shaded.netty4.io.netty.handler.codec.http.HttpResponseStatus	getResponseStatusCode()
Collection<? extends org.apache.flink.runtime.rest.versioning.RestAPIVersion<?>>	getSupportedAPIVersions()
String	getTargetRestEndpointURL()
FetchResultsMessageParameters	getUnresolvedMessageParameters()
String	operationId()

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()

Specified by:

getResponseClass in interface org.apache.flink.runtime.rest.messages.MessageHeaders<org.apache.flink.runtime.rest.messages.EmptyRequestBody,FetchResultsResponseBody,FetchResultsMessageParameters>

getResponseStatusCode

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

Specified by:

getResponseStatusCode in interface org.apache.flink.runtime.rest.messages.MessageHeaders<org.apache.flink.runtime.rest.messages.EmptyRequestBody,FetchResultsResponseBody,FetchResultsMessageParameters>

getDescription

public String getDescription()

Specified by:

getDescription in interface org.apache.flink.runtime.rest.messages.MessageHeaders<org.apache.flink.runtime.rest.messages.EmptyRequestBody,FetchResultsResponseBody,FetchResultsMessageParameters>

getHttpMethod

public org.apache.flink.runtime.rest.HttpMethodWrapper getHttpMethod()

Specified by:

getHttpMethod in interface org.apache.flink.runtime.rest.handler.RestHandlerSpecification

getTargetRestEndpointURL

public String getTargetRestEndpointURL()

Specified by:

getTargetRestEndpointURL in interface org.apache.flink.runtime.rest.handler.RestHandlerSpecification

getSupportedAPIVersions

public Collection<? extends org.apache.flink.runtime.rest.versioning.RestAPIVersion<?>> getSupportedAPIVersions()

Specified by:

getSupportedAPIVersions in interface org.apache.flink.runtime.rest.handler.RestHandlerSpecification

Specified by:

getSupportedAPIVersions in interface SqlGatewayMessageHeaders<org.apache.flink.runtime.rest.messages.EmptyRequestBody,FetchResultsResponseBody,FetchResultsMessageParameters>

getRequestClass

public Class<org.apache.flink.runtime.rest.messages.EmptyRequestBody> getRequestClass()

Specified by:

getRequestClass in interface org.apache.flink.runtime.rest.messages.UntypedResponseMessageHeaders<org.apache.flink.runtime.rest.messages.EmptyRequestBody,FetchResultsMessageParameters>

getUnresolvedMessageParameters

public FetchResultsMessageParameters getUnresolvedMessageParameters()

Specified by:

getUnresolvedMessageParameters in interface org.apache.flink.runtime.rest.messages.UntypedResponseMessageHeaders<org.apache.flink.runtime.rest.messages.EmptyRequestBody,FetchResultsMessageParameters>

operationId

public String operationId()

Specified by:

operationId in interface org.apache.flink.runtime.rest.messages.MessageHeaders<org.apache.flink.runtime.rest.messages.EmptyRequestBody,FetchResultsResponseBody,FetchResultsMessageParameters>