Interface RestOpenApiEndpointBuilderFactory.RestOpenApiEndpointBuilder
- All Superinterfaces:
org.apache.camel.builder.EndpointProducerBuilder
,org.apache.camel.EndpointProducerResolver
- Enclosing interface:
- RestOpenApiEndpointBuilderFactory
public static interface RestOpenApiEndpointBuilderFactory.RestOpenApiEndpointBuilder
extends org.apache.camel.builder.EndpointProducerBuilder
Builder for endpoint for the REST OpenApi component.
-
Method Summary
Modifier and TypeMethodDescriptionadvanced()
API basePath, for example /v2.componentName
(String componentName) Name of the Camel component that will perform the requests.What payload type this component capable of consuming.Scheme hostname and port to direct the HTTP requests to in the form of https://hostname:port.What payload type this component is producing.Methods inherited from interface org.apache.camel.builder.EndpointProducerBuilder
doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getRawUri, getUri
Methods inherited from interface org.apache.camel.EndpointProducerResolver
resolve, resolve
-
Method Details
-
advanced
-
basePath
API basePath, for example /v2. Default is unset, if set overrides the value present in OpenApi specification and in the component configuration. The option is a: <code>java.lang.String</code> type. Group: producer- Parameters:
basePath
- the value to set- Returns:
- the dsl builder
-
componentName
default RestOpenApiEndpointBuilderFactory.RestOpenApiEndpointBuilder componentName(String componentName) Name of the Camel component that will perform the requests. The component must be present in Camel registry and it must implement RestProducerFactory service provider interface. If not set CLASSPATH is searched for single component that implements RestProducerFactory SPI. Overrides component configuration. The option is a: <code>java.lang.String</code> type. Group: producer- Parameters:
componentName
- the value to set- Returns:
- the dsl builder
-
consumes
What payload type this component capable of consuming. Could be one type, like application/json or multiple types as application/json, application/xml; q=0.5 according to the RFC7231. This equates to the value of Accept HTTP header. If set overrides any value found in the OpenApi specification and. in the component configuration. The option is a: <code>java.lang.String</code> type. Group: producer- Parameters:
consumes
- the value to set- Returns:
- the dsl builder
-
host
Scheme hostname and port to direct the HTTP requests to in the form of https://hostname:port. Can be configured at the endpoint, component or in the corresponding REST configuration in the Camel Context. If you give this component a name (e.g. petstore) that REST configuration is consulted first, rest-openapi next, and global configuration last. If set overrides any value found in the OpenApi specification, RestConfiguration. Overrides all other configuration. The option is a: <code>java.lang.String</code> type. Group: producer- Parameters:
host
- the value to set- Returns:
- the dsl builder
-
produces
What payload type this component is producing. For example application/json according to the RFC7231. This equates to the value of Content-Type HTTP header. If set overrides any value present in the OpenApi specification. Overrides all other configuration. The option is a: <code>java.lang.String</code> type. Group: producer- Parameters:
produces
- the value to set- Returns:
- the dsl builder
-