@Metadata(label="rest") public class VerbDefinition extends OptionalIdentifiedDefinition<VerbDefinition>
Constructor and Description |
---|
VerbDefinition() |
Modifier and Type | Method and Description |
---|---|
String |
asVerb() |
RestDefinition |
delete() |
RestDefinition |
delete(String uri) |
RestDefinition |
get() |
RestDefinition |
get(String uri) |
Boolean |
getApiDocs() |
RestBindingMode |
getBindingMode() |
Boolean |
getClientRequestValidation() |
String |
getConsumes() |
Boolean |
getEnableCORS() |
String |
getLabel() |
String |
getMethod() |
String |
getOutType() |
List<RestOperationParamDefinition> |
getParams() |
String |
getProduces() |
List<RestOperationResponseMsgDefinition> |
getResponseMsgs() |
RestDefinition |
getRest() |
RouteDefinition |
getRoute() |
String |
getRouteId() |
List<SecurityDefinition> |
getSecurity() |
String |
getShortName() |
Boolean |
getSkipBindingOnErrorCode() |
ToDefinition |
getTo() |
ToDynamicDefinition |
getToD() |
OptionalIdentifiedDefinition<?> |
getToOrRoute() |
String |
getType() |
String |
getUri() |
Boolean |
getUsedForGeneratingNodeId() |
RestDefinition |
head() |
RestDefinition |
head(String uri) |
RestDefinition |
post() |
RestDefinition |
post(String uri) |
RestDefinition |
put() |
RestDefinition |
put(String uri) |
void |
setApiDocs(Boolean apiDocs)
Whether to include or exclude the VerbDefinition in API documentation.
|
void |
setBindingMode(RestBindingMode bindingMode)
Sets the binding mode to use.
|
void |
setClientRequestValidation(Boolean clientRequestValidation)
Whether to enable validation of the client request to check whether the
Content-Type and Accept headers from the client is supported by the
Rest-DSL configuration of its consumes/produces settings.
|
void |
setConsumes(String consumes)
To define the content type what the REST service consumes (accept as
input), such as application/xml or application/json.
|
void |
setEnableCORS(Boolean enableCORS)
Whether to enable CORS headers in the HTTP response.
|
void |
setMethod(String method)
The HTTP verb such as GET, POST, DELETE, etc.
|
void |
setOutType(String outType)
Sets the class name to use for binding from POJO to output for the
outgoing data This option will override what may be configured on a
parent level
The canonical name of the class of the input data.
|
void |
setParams(List<RestOperationParamDefinition> params)
To specify the REST operation parameters using Swagger.
|
void |
setProduces(String produces)
To define the content type what the REST service produces (uses for
output), such as application/xml or application/json This option will
override what may be configured on a parent level
|
void |
setResponseMsgs(List<RestOperationResponseMsgDefinition> responseMsgs)
Sets swagger operation response messages.
|
void |
setRest(RestDefinition rest) |
void |
setRoute(RouteDefinition route) |
void |
setRouteId(String routeId)
The route id this rest-dsl is using (read-only)
|
void |
setSecurity(List<SecurityDefinition> security)
Sets the swagger security settings for this verb.
|
void |
setSkipBindingOnErrorCode(Boolean skipBindingOnErrorCode)
Whether to skip binding on output if there is a custom HTTP error code
header.
|
void |
setTo(ToDefinition to) |
void |
setToD(ToDynamicDefinition to) |
void |
setToOrRoute(OptionalIdentifiedDefinition<?> toOrRoute)
To route from this REST service to a Camel endpoint, or an inlined route
|
void |
setType(String type)
Sets the class name to use for binding from input to POJO for the
incoming data This option will override what may be configured on a
parent level.
|
void |
setUri(String uri)
Uri template of this REST service such as /{id}.
|
void |
setUsedForGeneratingNodeId(Boolean usedForGeneratingNodeId) |
RestDefinition |
verb(String verb) |
RestDefinition |
verb(String verb,
String uri) |
description, description, getCustomId, getDescription, getDescriptionText, getId, getParent, hasCustomIdAssigned, id, idOrCreate, setCustomId, setDescription, setId
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getReadPropertyPlaceholderOptions, getWritePropertyPlaceholderOptions
public VerbDefinition()
public String getShortName()
public List<RestOperationParamDefinition> getParams()
public void setParams(List<RestOperationParamDefinition> params)
public List<RestOperationResponseMsgDefinition> getResponseMsgs()
public void setResponseMsgs(List<RestOperationResponseMsgDefinition> responseMsgs)
public List<SecurityDefinition> getSecurity()
public void setSecurity(List<SecurityDefinition> security)
public String getConsumes()
public void setConsumes(String consumes)
public String getProduces()
public void setProduces(String produces)
public RestBindingMode getBindingMode()
public void setBindingMode(RestBindingMode bindingMode)
public Boolean getSkipBindingOnErrorCode()
public void setSkipBindingOnErrorCode(Boolean skipBindingOnErrorCode)
public Boolean getClientRequestValidation()
public void setClientRequestValidation(Boolean clientRequestValidation)
public Boolean getEnableCORS()
public void setEnableCORS(Boolean enableCORS)
public void setType(String type)
public String getOutType()
public void setOutType(String outType)
public String getRouteId()
public void setRouteId(String routeId)
public Boolean getApiDocs()
public void setApiDocs(Boolean apiDocs)
public RestDefinition getRest()
public void setRest(RestDefinition rest)
public RouteDefinition getRoute()
public void setRoute(RouteDefinition route)
public ToDefinition getTo()
public ToDynamicDefinition getToD()
public void setTo(ToDefinition to)
public void setToD(ToDynamicDefinition to)
public OptionalIdentifiedDefinition<?> getToOrRoute()
public void setToOrRoute(OptionalIdentifiedDefinition<?> toOrRoute)
public RestDefinition get()
public RestDefinition get(String uri)
public RestDefinition post()
public RestDefinition post(String uri)
public RestDefinition put()
public RestDefinition put(String uri)
public RestDefinition delete()
public RestDefinition delete(String uri)
public RestDefinition head()
public RestDefinition head(String uri)
public RestDefinition verb(String verb)
public RestDefinition verb(String verb, String uri)
public Boolean getUsedForGeneratingNodeId()
public void setUsedForGeneratingNodeId(Boolean usedForGeneratingNodeId)
Apache Camel