@Metadata(label="rest") public class RestOperationParamDefinition extends Object
Constructor and Description |
---|
RestOperationParamDefinition() |
RestOperationParamDefinition(VerbDefinition verb) |
Modifier and Type | Method and Description |
---|---|
RestOperationParamDefinition |
access(String paramAccess)
Parameter access.
|
RestOperationParamDefinition |
allowableValues(List<String> allowableValues)
Allowed values of the parameter when its an enum type
|
RestOperationParamDefinition |
allowableValues(String... allowableValues)
Allowed values of the parameter when its an enum type
|
RestOperationParamDefinition |
allowMultiple(Boolean allowMultiple)
Whether the parameter can be used multiple times
|
RestOperationParamDefinition |
dataType(String type)
The data type of the parameter such as string, long, int, boolean
|
RestOperationParamDefinition |
defaultValue(String name)
The default value of the parameter.
|
RestOperationParamDefinition |
description(String name)
Description of the parameter.
|
RestDefinition |
endParam()
Ends the configuration of this parameter
|
String |
getAccess() |
List<String> |
getAllowableValues() |
Boolean |
getAllowMultiple() |
String |
getDataType() |
String |
getDefaultValue()
Sets the Swagger Parameter default value.
|
String |
getDescription() |
String |
getName() |
Boolean |
getRequired() |
RestParamType |
getType() |
RestOperationParamDefinition |
name(String name)
Name of the parameter.
|
RestOperationParamDefinition |
required(Boolean required)
Whether the parameter is required
|
void |
setAccess(String access)
Sets the Swagger Parameter paramAccess flag.
|
void |
setAllowableValues(List<String> allowableValues)
Sets the Swagger Parameter list of allowable values.
|
void |
setAllowMultiple(Boolean allowMultiple)
Sets the Swagger Parameter allowMultiple flag.
|
void |
setDataType(String dataType)
Sets the Swagger Parameter data type.
|
void |
setDefaultValue(String defaultValue) |
void |
setDescription(String description)
Sets the Swagger Parameter description.
|
void |
setName(String name)
Sets the Swagger Parameter name.
|
void |
setRequired(Boolean required)
Sets the Swagger Parameter required flag.
|
void |
setType(RestParamType type)
Sets the Swagger Parameter type.
|
RestOperationParamDefinition |
type(RestParamType type)
The parameter type such as body, form, header, path, query
|
public RestOperationParamDefinition()
public RestOperationParamDefinition(VerbDefinition verb)
public RestParamType getType()
public void setType(RestParamType type)
public String getDescription()
public void setDescription(String description)
public String getDefaultValue()
public void setDefaultValue(String defaultValue)
public Boolean getRequired()
public void setRequired(Boolean required)
public Boolean getAllowMultiple()
public void setAllowMultiple(Boolean allowMultiple)
public String getDataType()
public void setDataType(String dataType)
public List<String> getAllowableValues()
public void setAllowableValues(List<String> allowableValues)
public RestOperationParamDefinition name(String name)
public RestOperationParamDefinition description(String name)
public RestOperationParamDefinition defaultValue(String name)
public RestOperationParamDefinition required(Boolean required)
public RestOperationParamDefinition allowMultiple(Boolean allowMultiple)
public RestOperationParamDefinition dataType(String type)
public RestOperationParamDefinition allowableValues(List<String> allowableValues)
public RestOperationParamDefinition allowableValues(String... allowableValues)
public RestOperationParamDefinition type(RestParamType type)
public RestOperationParamDefinition access(String paramAccess)
public RestDefinition endParam()
Apache Camel