org.apache.camel.model.rest

Class RestOperationResponseMsgDefinition

java.lang.Object

org.apache.camel.model.rest.RestOperationResponseMsgDefinition

@Metadata(label="rest")
public class RestOperationResponseMsgDefinition
extends Object

To specify the rest operation response messages using Swagger.

This maps to the Swagger Response Message Object. see com.wordnik.swagger.model.ResponseMessage and https://github.com/swagger-api/swagger-spec/blob/master/versions/1.2.md#525-response-message-object.

Constructor Summary

Constructors

Constructor and Description
RestOperationResponseMsgDefinition()
RestOperationResponseMsgDefinition(VerbDefinition verb)

Method Summary

Methods

Modifier and Type	Method and Description
RestOperationResponseMsgDefinition	code(int code) The return code
RestDefinition	endResponseMessage() Ends the configuration of this response message
int	getCode()
String	getMessage()
String	getResponseModel()
RestOperationResponseMsgDefinition	message(String msg) The return message
RestOperationResponseMsgDefinition	responseModel(Class<?> type) The response model
void	setCode(int code) Sets the Swagger Operation's ResponseMessage code
void	setMessage(String message) Sets the Swagger Operation's ResponseMessage message
void	setResponseModel(String responseModel) Sets the Swagger Operation's ResponseMessage responseModel

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RestOperationResponseMsgDefinition

public RestOperationResponseMsgDefinition(VerbDefinition verb)

RestOperationResponseMsgDefinition

public RestOperationResponseMsgDefinition()

Method Detail

getCode

public int getCode()

setCode

public void setCode(int code)

Sets the Swagger Operation's ResponseMessage code

getResponseModel

public String getResponseModel()

setResponseModel

public void setResponseModel(String responseModel)

Sets the Swagger Operation's ResponseMessage responseModel

getMessage

public String getMessage()

setMessage

public void setMessage(String message)

Sets the Swagger Operation's ResponseMessage message

code

public RestOperationResponseMsgDefinition code(int code)

The return code

message

public RestOperationResponseMsgDefinition message(String msg)

The return message

responseModel

public RestOperationResponseMsgDefinition responseModel(Class<?> type)

The response model

endResponseMessage

public RestDefinition endResponseMessage()

Ends the configuration of this response message