Package org.apache.camel.model.rest
Class ResponseMessageDefinition
java.lang.Object
org.apache.camel.model.rest.ResponseMessageDefinition
To specify the rest operation response messages.
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptioncode
(int code) The response code such as a HTTP status codeThe response code such as a HTTP status code.Ends the configuration of this response messageAdds an examplegetCode()
Adds a response headerThe response message (description)responseModel
(Class<?> type) The response modelvoid
void
setExamples
(List<RestPropertyDefinition> examples) Examples of response messagesvoid
setHeaders
(List<ResponseHeaderDefinition> headers) void
setMessage
(String message) void
setResponseModel
(String responseModel)
-
Constructor Details
-
ResponseMessageDefinition
-
ResponseMessageDefinition
public ResponseMessageDefinition()
-
-
Method Details
-
getCode
-
setCode
-
getResponseModel
-
setResponseModel
-
getMessage
-
setMessage
-
getHeaders
-
setHeaders
-
getExamples
-
setExamples
Examples of response messages -
code
The response code such as a HTTP status code -
code
The response code such as a HTTP status code. Can use general, or other words to indicate general error responses that do not map to a specific HTTP status code -
message
The response message (description) -
responseModel
The response model -
example
Adds an example -
header
Adds a response header -
endResponseMessage
Ends the configuration of this response message
-