R
- request message typeP
- response message typeM
- message parameters typepublic interface MessageHeaders<R extends RequestBody,P extends ResponseBody,M extends MessageParameters> extends UntypedResponseMessageHeaders<R,M>
RequestBody
s to ResponseBody
s types and contains meta-data
required for their http headers.
Implementations must be state-less.
Modifier and Type | Method and Description |
---|---|
default Collection<HttpHeader> |
getCustomHeaders()
Returns a collection of custom HTTP headers.
|
String |
getDescription()
Returns the description for this header.
|
Class<P> |
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.
|
default Collection<Class<?>> |
getResponseTypeParameters()
Returns the collection of type parameters for the response type.
|
default String |
operationId()
Returns a short description for this header suitable for method code generation.
|
acceptsFileUploads, getRequestClass, getUnresolvedMessageParameters
getHttpMethod, getSupportedAPIVersions, getTargetRestEndpointURL
Class<P> getResponseClass()
org.apache.flink.shaded.netty4.io.netty.handler.codec.http.HttpResponseStatus getResponseStatusCode()
default Collection<Class<?>> getResponseTypeParameters()
String getDescription()
default String operationId()
default Collection<HttpHeader> getCustomHeaders()
This default implementation returns an empty list. Override this method to provide custom headers if needed.
HttpHeaders
, empty by default.Copyright © 2014–2024 The Apache Software Foundation. All rights reserved.