Package org.apache.camel.model.rest
Class ResponseHeaderDefinition
java.lang.Object
org.apache.camel.model.rest.ResponseHeaderDefinition
To specify the rest operation response headers.
-
Constructor Summary
ConstructorDescription -
Method Summary
Modifier and TypeMethodDescriptionallowableValues
(String allowableValues) Allowed values of the parameter when its an enum typeallowableValues
(String... allowableValues) Allowed values of the parameter when its an enum typeallowableValues
(List<String> allowableValues) Allowed values of the header when its an enum typeThe data type of the array data typecollectionFormat
(CollectionFormat collectionFormat) Sets the collection format.dataFormat
(String type) The data format of the parameter such as binary, date, date-time, password.The data type of the header such as string, integer, booleandescription
(String name) Description of the parameter.Ends the configuration of this headerEnds the configuration of this response messageSets an example of this header.getName()
Name of the parameter.void
setAllowableValues
(List<ValueDefinition> allowableValues) Sets the parameter list of allowable values.void
setArrayType
(String arrayType) Sets the parameter array type.void
setCollectionFormat
(CollectionFormat collectionFormat) Sets the parameter collection format.void
setDataFormat
(String dataFormat) Sets the parameter data format.void
setDataType
(String dataType) Sets the header data type.void
setDescription
(String description) void
setExample
(String example) Sets the examplevoid
-
Constructor Details
-
ResponseHeaderDefinition
-
ResponseHeaderDefinition
public ResponseHeaderDefinition()
-
-
Method Details
-
endResponseHeader
Ends the configuration of this response message -
getName
-
setName
-
getDescription
-
setDescription
-
getCollectionFormat
-
setCollectionFormat
Sets the parameter collection format. -
getArrayType
-
setArrayType
Sets the parameter array type. Required if data type is "array". Describes the type of items in the array. -
getDataType
-
setDataType
Sets the header data type. -
getDataFormat
-
setDataFormat
Sets the parameter data format. -
getAllowableValues
-
getExample
-
setExample
Sets the example -
setAllowableValues
Sets the parameter list of allowable values. -
name
Name of the parameter.This option is mandatory.
-
description
Description of the parameter. -
collectionFormat
Sets the collection format. -
arrayType
The data type of the array data type -
dataType
The data type of the header such as string, integer, boolean -
dataFormat
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
Allowed values of the header when its an enum type -
allowableValues
Allowed values of the parameter when its an enum type -
allowableValues
Allowed values of the parameter when its an enum type -
example
Sets an example of this header. -
endHeader
Ends the configuration of this header -
getAllowableValuesAsStringList
-