Package 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.
-
-
Constructor Summary
Constructors Constructor Description RestOperationResponseHeaderDefinition()
RestOperationResponseHeaderDefinition(RestOperationResponseMsgDefinition response)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description RestOperationResponseHeaderDefinition
allowableValues(String... allowableValues)
Allowed values of the parameter when its an enum typeRestOperationResponseHeaderDefinition
allowableValues(List<String> allowableValues)
Allowed values of the header when its an enum typeRestOperationResponseHeaderDefinition
arrayType(String arrayType)
The data type of the array data typeRestOperationResponseHeaderDefinition
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, booleanRestOperationResponseHeaderDefinition
description(String name)
Description of the parameter.RestOperationResponseMsgDefinition
endHeader()
Ends the configuration of this headerRestOperationResponseMsgDefinition
endResponseHeader()
Ends the configuration of this response messageRestOperationResponseHeaderDefinition
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 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
setName(String name)
-
-
-
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 parameter collection format.
-
getArrayType
public String getArrayType()
-
setArrayType
public void setArrayType(String arrayType)
Sets the 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 header data type.
-
getDataFormat
public String getDataFormat()
-
setDataFormat
public void setDataFormat(String dataFormat)
Sets the parameter data format.
-
getExample
public String getExample()
-
setExample
public void setExample(String example)
Sets the example
-
setAllowableValues
public void setAllowableValues(List<String> allowableValues)
Sets the 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
-
-