Class RefreshMaterializedTableHeaders
- java.lang.Object
-
- org.apache.flink.table.gateway.rest.header.materializedtable.RefreshMaterializedTableHeaders
-
- All Implemented Interfaces:
RestHandlerSpecification
,MessageHeaders<RefreshMaterializedTableRequestBody,RefreshMaterializedTableResponseBody,RefreshMaterializedTableParameters>
,UntypedResponseMessageHeaders<RefreshMaterializedTableRequestBody,RefreshMaterializedTableParameters>
,SqlGatewayMessageHeaders<RefreshMaterializedTableRequestBody,RefreshMaterializedTableResponseBody,RefreshMaterializedTableParameters>
public class RefreshMaterializedTableHeaders extends Object implements SqlGatewayMessageHeaders<RefreshMaterializedTableRequestBody,RefreshMaterializedTableResponseBody,RefreshMaterializedTableParameters>
Message headers for executing a materialized table refresh operation.
-
-
Constructor Summary
Constructors Constructor Description RefreshMaterializedTableHeaders()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description String
getDescription()
Returns the description for this header.HttpMethodWrapper
getHttpMethod()
Returns theHttpMethodWrapper
to be used for the request.static RefreshMaterializedTableHeaders
getInstance()
Class<RefreshMaterializedTableRequestBody>
getRequestClass()
Returns the class of the request message.Class<RefreshMaterializedTableResponseBody>
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
.RefreshMaterializedTableParameters
getUnresolvedMessageParameters()
Returns a newMessageParameters
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
-
-
-
-
Method Detail
-
getHttpMethod
public HttpMethodWrapper getHttpMethod()
Description copied from interface:RestHandlerSpecification
Returns theHttpMethodWrapper
to be used for the request.- Specified by:
getHttpMethod
in interfaceRestHandlerSpecification
- 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 interfaceRestHandlerSpecification
- Returns:
- endpoint url that this request should be sent to
-
getResponseClass
public Class<RefreshMaterializedTableResponseBody> getResponseClass()
Description copied from interface:MessageHeaders
Returns the class of the response message.- Specified by:
getResponseClass
in interfaceMessageHeaders<RefreshMaterializedTableRequestBody,RefreshMaterializedTableResponseBody,RefreshMaterializedTableParameters>
- 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 interfaceMessageHeaders<RefreshMaterializedTableRequestBody,RefreshMaterializedTableResponseBody,RefreshMaterializedTableParameters>
- 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 interfaceMessageHeaders<RefreshMaterializedTableRequestBody,RefreshMaterializedTableResponseBody,RefreshMaterializedTableParameters>
- Returns:
- description for the header
-
getRequestClass
public Class<RefreshMaterializedTableRequestBody> getRequestClass()
Description copied from interface:UntypedResponseMessageHeaders
Returns the class of the request message.- Specified by:
getRequestClass
in interfaceUntypedResponseMessageHeaders<RefreshMaterializedTableRequestBody,RefreshMaterializedTableParameters>
- Returns:
- class of the request message
-
getUnresolvedMessageParameters
public RefreshMaterializedTableParameters getUnresolvedMessageParameters()
Description copied from interface:UntypedResponseMessageHeaders
Returns a newMessageParameters
object.- Specified by:
getUnresolvedMessageParameters
in interfaceUntypedResponseMessageHeaders<RefreshMaterializedTableRequestBody,RefreshMaterializedTableParameters>
- Returns:
- new message parameters object
-
getSupportedAPIVersions
public Collection<? extends RestAPIVersion<?>> getSupportedAPIVersions()
Description copied from interface:RestHandlerSpecification
Returns the supported API versions that this request supports.- Specified by:
getSupportedAPIVersions
in interfaceRestHandlerSpecification
- Specified by:
getSupportedAPIVersions
in interfaceSqlGatewayMessageHeaders<RefreshMaterializedTableRequestBody,RefreshMaterializedTableResponseBody,RefreshMaterializedTableParameters>
- Returns:
- Collection of supported API versions
-
getInstance
public static RefreshMaterializedTableHeaders getInstance()
-
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 interfaceMessageHeaders<RefreshMaterializedTableRequestBody,RefreshMaterializedTableResponseBody,RefreshMaterializedTableParameters>
- Returns:
- short description
-
-