org.apache.camel.model.rest

Class RestOperationResponseHeaderDefinition

java.lang.Object

org.apache.camel.model.rest.RestOperationResponseHeaderDefinition

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

To specify the rest operation response headers using Swagger.

This maps to the Swagger Response Header Object.

Constructor Summary

Constructors

Constructor and Description
RestOperationResponseHeaderDefinition()
RestOperationResponseHeaderDefinition(RestOperationResponseMsgDefinition response)

Method Summary

Modifier and Type	Method and Description
RestOperationResponseHeaderDefinition	allowableValues(List<String> allowableValues) Allowed values of the header when its an enum type
RestOperationResponseHeaderDefinition	allowableValues(String... allowableValues) Allowed values of the parameter when its an enum type
RestOperationResponseHeaderDefinition	arrayType(String arrayType) The data type of the array data type
RestOperationResponseHeaderDefinition	collectionFormat(CollectionFormat collectionFormat) Sets the collection format.
RestOperationResponseHeaderDefinition	dataFormat(String type) The data format of the parameter such as binary, date, date-time, password.
RestOperationResponseHeaderDefinition	dataType(String type) The data type of the header such as string, integer, boolean
RestOperationResponseHeaderDefinition	description(String name) Description of the parameter.
RestOperationResponseMsgDefinition	endHeader() Ends the configuration of this header
RestOperationResponseMsgDefinition	endResponseHeader() Ends the configuration of this response message
RestOperationResponseHeaderDefinition	example(String example) Sets an example of this header.
List<String>	getAllowableValues()
String	getArrayType()
CollectionFormat	getCollectionFormat()
String	getDataFormat()
String	getDataType()
String	getDescription()
String	getExample()
String	getName()
RestOperationResponseHeaderDefinition	name(String name) Name of the parameter.
void	setAllowableValues(List<String> allowableValues) Sets the Swagger Parameter list of allowable values.
void	setArrayType(String arrayType) Sets the Swagger Parameter array type.
void	setCollectionFormat(CollectionFormat collectionFormat) Sets the Swagger Parameter collection format.
void	setDataFormat(String dataFormat) Sets the Swagger Parameter data format.
void	setDataType(String dataType) Sets the Swagger header data type.
void	setDescription(String description)
void	setExample(String example) Sets the Swagger example
void	setName(String name)

Methods inherited from class java.lang.Object

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

Constructor Detail

RestOperationResponseHeaderDefinition

public RestOperationResponseHeaderDefinition(RestOperationResponseMsgDefinition response)

RestOperationResponseHeaderDefinition

public RestOperationResponseHeaderDefinition()

Method Detail

endResponseHeader

public RestOperationResponseMsgDefinition endResponseHeader()

Ends the configuration of this response message

getName

public String getName()

setName

public void setName(String name)

getDescription

public String getDescription()

setDescription

public void setDescription(String description)

getCollectionFormat

public CollectionFormat getCollectionFormat()

setCollectionFormat

public void setCollectionFormat(CollectionFormat collectionFormat)

Sets the Swagger Parameter collection format.

getArrayType

public String getArrayType()

setArrayType

public void setArrayType(String arrayType)

Sets the Swagger Parameter array type. Required if data type is "array". Describes the type of items in the array.

getDataType

public String getDataType()

setDataType

public void setDataType(String dataType)

Sets the Swagger header data type.

getDataFormat

public String getDataFormat()

setDataFormat

public void setDataFormat(String dataFormat)

Sets the Swagger Parameter data format.

getAllowableValues

public List<String> getAllowableValues()

getExample

public String getExample()

setExample

public void setExample(String example)

Sets the Swagger example

setAllowableValues

public void setAllowableValues(List<String> allowableValues)

Sets the Swagger Parameter list of allowable values.

name

public RestOperationResponseHeaderDefinition name(String name)

Name of the parameter.

This option is mandatory.

description

public RestOperationResponseHeaderDefinition description(String name)

Description of the parameter.

collectionFormat

public RestOperationResponseHeaderDefinition collectionFormat(CollectionFormat collectionFormat)

Sets the collection format.

arrayType

public RestOperationResponseHeaderDefinition arrayType(String arrayType)

The data type of the array data type

dataType

public RestOperationResponseHeaderDefinition dataType(String type)

The data type of the header such as string, integer, boolean

dataFormat

public RestOperationResponseHeaderDefinition dataFormat(String type)

The data format of the parameter such as binary, date, date-time, password. The format is usually derived from the dataType alone. However you can set this option for more fine grained control of the format in use.

allowableValues

public RestOperationResponseHeaderDefinition allowableValues(List<String> allowableValues)

Allowed values of the header when its an enum type

allowableValues

public RestOperationResponseHeaderDefinition allowableValues(String... allowableValues)

Allowed values of the parameter when its an enum type

example

public RestOperationResponseHeaderDefinition example(String example)

Sets an example of this header.

endHeader

public RestOperationResponseMsgDefinition endHeader()

Ends the configuration of this header