schema
stringclasses
471 values
key
stringlengths
0
203
description
stringlengths
0
4.37k
object
stringlengths
2
322k
camel-yaml-dsl.json
id
Sets the id of this node
{"type": "string"}
camel-yaml-dsl.json
otherwise
Sets the otherwise node
{}
camel-yaml-dsl.json
precondition
Indicates whether this Choice EIP is in precondition mode or not. If so its branches (when/otherwise) are evaluated during startup to keep at runtime only the branch that matched.
{"type": "boolean"}
camel-yaml-dsl.json
when
Sets the when nodes
{"type": "array", "items": {}}
camel-yaml-dsl.json
org.apache.camel.model.CircuitBreakerDefinition
Route messages in a fault tolerance way using Circuit Breaker
{"type": "object", "properties": {"configuration": {"type": "string"}, "disabled": {"type": "boolean"}, "fault-tolerance-configuration": {}, "id": {"type": "string"}, "inherit-error-handler": {"type": "boolean"}, "on-fallback": {}, "resilience4j-configuration": {}, "steps": {"type": "array", "items": {}}}}
camel-yaml-dsl.json
configuration
Refers to a circuit breaker configuration (such as resillience4j, or microprofile-fault-tolerance) to use for configuring the circuit breaker EIP.
{"type": "string"}
camel-yaml-dsl.json
description
Sets the id of this node
{"type": "string"}
camel-yaml-dsl.json
disabled
Whether to disable this EIP from the route during build time. Once an EIP has been disabled then it cannot be enabled later at runtime.
{"type": "boolean"}
camel-yaml-dsl.json
fault-tolerance-configuration
Configures the circuit breaker to use MicroProfile Fault Tolerance with the given configuration.
{}
camel-yaml-dsl.json
id
Sets the id of this node
{"type": "string"}
camel-yaml-dsl.json
on-fallback
The fallback route path to execute that does not go over the network. This should be a static or cached result that can immediately be returned upon failure. If the fallback requires network connection then use onFallbackViaNetwork() .
{}
camel-yaml-dsl.json
resilience4j-configuration
Configures the circuit breaker to use Resilience4j with the given configuration.
{}
camel-yaml-dsl.json
org.apache.camel.model.ClaimCheckDefinition
The Claim Check EIP allows you to replace message content with a claim check (a unique key), which can be used to retrieve the message content at a later time.
{"type": "object", "properties": {"aggregation-strategy": {"type": "string"}, "aggregation-strategy-method-name": {"type": "string"}, "disabled": {"type": "boolean"}, "filter": {"type": "string"}, "id": {"type": "string"}, "inherit-error-handler": {"type": "boolean"}, "key": {"type": "string"}, "operation": {"type": "s...
camel-yaml-dsl.json
aggregation-strategy
To use a custom AggregationStrategy instead of the default implementation. Notice you cannot use both custom aggregation strategy and configure data at the same time.
{"type": "string"}
camel-yaml-dsl.json
aggregation-strategy-method-name
This option can be used to explicit declare the method name to use, when using POJOs as the AggregationStrategy.
{"type": "string"}
camel-yaml-dsl.json
description
Sets the id of this node
{"type": "string"}
camel-yaml-dsl.json
disabled
Whether to disable this EIP from the route during build time. Once an EIP has been disabled then it cannot be enabled later at runtime.
{"type": "boolean"}
camel-yaml-dsl.json
filter
Specify a filter to control what data gets merged data back from the claim check repository. The following syntax is supported: body - to aggregate the message body attachments - to aggregate all the message attachments headers - to aggregate all the message headers header:pattern - to aggregate all the message headers...
{"type": "string"}
camel-yaml-dsl.json
id
Sets the id of this node
{"type": "string"}
camel-yaml-dsl.json
key
To use a specific key for claim check id (for dynamic keys use simple language syntax as the key).
{"type": "string"}
camel-yaml-dsl.json
operation
The claim check operation to use. The following operations are supported: Get - Gets (does not remove) the claim check by the given key. GetAndRemove - Gets and removes the claim check by the given key. Set - Sets a new (will override if key already exists) claim check with the given key. Push - Sets a new claim check ...
{"type": "string", "enum": ["Get", "GetAndRemove", "Set", "Push", "Pop"]}
camel-yaml-dsl.json
org.apache.camel.model.ContextScanDefinition
Scans for Java org.apache.camel.builder.RouteBuilder instances in the context org.apache.camel.spi.Registry .
{"type": "object", "properties": {"excludes": {"type": "array", "items": {"type": "string"}}, "include-non-singletons": {"type": "boolean"}, "includes": {"type": "array", "items": {"type": "string"}}}}
camel-yaml-dsl.json
excludes
Exclude finding route builder from these java package names.
{"type": "array", "items": {"type": "string"}}
camel-yaml-dsl.json
include-non-singletons
Whether to include non-singleton beans (prototypes) By default only singleton beans is included in the context scan
{"type": "boolean"}
camel-yaml-dsl.json
includes
Include finding route builder from these java package names.
{"type": "array", "items": {"type": "string"}}
camel-yaml-dsl.json
org.apache.camel.model.ConvertBodyDefinition
Converts the message body to another type
{"oneOf": [{"type": "string"}, {"type": "object", "properties": {"charset": {"type": "string"}, "disabled": {"type": "boolean"}, "id": {"type": "string"}, "inherit-error-handler": {"type": "boolean"}, "mandatory": {"type": "boolean"}, "type": {"type": "string"}}}], "required": ["type"]}
camel-yaml-dsl.json
charset
To use a specific charset when converting
{"type": "string"}
camel-yaml-dsl.json
description
Sets the id of this node
{"type": "string"}
camel-yaml-dsl.json
disabled
Whether to disable this EIP from the route during build time. Once an EIP has been disabled then it cannot be enabled later at runtime.
{"type": "boolean"}
camel-yaml-dsl.json
id
Sets the id of this node
{"type": "string"}
camel-yaml-dsl.json
mandatory
When mandatory then the conversion must return a value (cannot be null), if this is not possible then NoTypeConversionAvailableException is thrown. Setting this to false could mean conversion is not possible and the value is null.
{"type": "boolean"}
camel-yaml-dsl.json
type
The java type to convert to
{"type": "string"}
camel-yaml-dsl.json
org.apache.camel.model.DelayDefinition
Delays processing for a specified length of time
{"type": "object", "anyOf": [{}], "properties": {"async-delayed": {"type": "boolean"}, "caller-runs-when-rejected": {"type": "boolean"}, "disabled": {"type": "boolean"}, "executor-service": {"type": "string"}, "expression": {}, "id": {"type": "string"}, "inherit-error-handler": {"type": "boolean"}}}
camel-yaml-dsl.json
async-delayed
Enables asynchronous delay which means the thread will not block while delaying.
{"type": "boolean"}
camel-yaml-dsl.json
caller-runs-when-rejected
Whether or not the caller should run the task when it was rejected by the thread pool. Is by default true
{"type": "boolean"}
camel-yaml-dsl.json
description
Sets the id of this node
{"type": "string"}
camel-yaml-dsl.json
disabled
Whether to disable this EIP from the route during build time. Once an EIP has been disabled then it cannot be enabled later at runtime.
{"type": "boolean"}
camel-yaml-dsl.json
executor-service
To use a custom Thread Pool if asyncDelay has been enabled.
{"type": "string"}
camel-yaml-dsl.json
expression
Expression to define how long time to wait (in millis)
{}
camel-yaml-dsl.json
id
Sets the id of this node
{"type": "string"}
camel-yaml-dsl.json
org.apache.camel.model.DynamicRouterDefinition
Route messages based on dynamic rules
{"type": "object", "anyOf": [{}], "properties": {"cache-size": {"type": "number"}, "disabled": {"type": "boolean"}, "expression": {}, "id": {"type": "string"}, "ignore-invalid-endpoints": {"type": "boolean"}, "inherit-error-handler": {"type": "boolean"}, "uri-delimiter": {"type": "string", "default": ","}}}
camel-yaml-dsl.json
cache-size
Sets the maximum size used by the org.apache.camel.spi.ProducerCache which is used to cache and reuse producers when using this dynamic router, when uris are reused. Beware that when using dynamic endpoints then it affects how well the cache can be utilized. If each dynamic endpoint is unique then its best to turn off ...
{"type": "number"}
camel-yaml-dsl.json
description
Sets the id of this node
{"type": "string"}
camel-yaml-dsl.json
disabled
Whether to disable this EIP from the route during build time. Once an EIP has been disabled then it cannot be enabled later at runtime.
{"type": "boolean"}
camel-yaml-dsl.json
expression
Expression to call that returns the endpoint(s) to route to in the dynamic routing. Important: The expression will be called in a while loop fashion, until the expression returns null which means the dynamic router is finished.
{}
camel-yaml-dsl.json
id
Sets the id of this node
{"type": "string"}
camel-yaml-dsl.json
ignore-invalid-endpoints
Ignore the invalidate endpoint exception when try to create a producer with that endpoint
{"type": "boolean"}
camel-yaml-dsl.json
uri-delimiter
Sets the uri delimiter to use
{"type": "string", "default": ","}
camel-yaml-dsl.json
org.apache.camel.model.EnrichDefinition
Enriches a message with data from a secondary resource
{"type": "object", "anyOf": [{}], "properties": {"aggregate-on-exception": {"type": "boolean"}, "aggregation-strategy": {"type": "string"}, "aggregation-strategy-method-allow-null": {"type": "string"}, "aggregation-strategy-method-name": {"type": "string"}, "allow-optimised-components": {"type": "boolean"}, "cache-size...
camel-yaml-dsl.json
aggregate-on-exception
If this option is false then the aggregate method is not used if there was an exception thrown while trying to retrieve the data to enrich from the resource. Setting this option to true allows end users to control what to do if there was an exception in the aggregate method. For example to suppress the exception or set...
{"type": "boolean"}
camel-yaml-dsl.json
aggregation-strategy
Sets the AggregationStrategy to be used to merge the reply from the external service, into a single outgoing message. By default Camel will use the reply from the external service as outgoing message.
{"type": "string"}
camel-yaml-dsl.json
aggregation-strategy-method-allow-null
If this option is false then the aggregate method is not used if there was no data to enrich. If this option is true then null values is used as the oldExchange (when no data to enrich), when using POJOs as the AggregationStrategy.
{"type": "string"}
camel-yaml-dsl.json
aggregation-strategy-method-name
This option can be used to explicit declare the method name to use, when using POJOs as the AggregationStrategy.
{"type": "string"}
camel-yaml-dsl.json
allow-optimised-components
Whether to allow components to optimise enricher if they are org.apache.camel.spi.SendDynamicAware .
{"type": "boolean"}
camel-yaml-dsl.json
cache-size
Sets the maximum size used by the org.apache.camel.spi.ProducerCache which is used to cache and reuse producer when uris are reused. Beware that when using dynamic endpoints then it affects how well the cache can be utilized. If each dynamic endpoint is unique then its best to turn off caching by setting this to -1, wh...
{"type": "number"}
camel-yaml-dsl.json
description
Sets the id of this node
{"type": "string"}
camel-yaml-dsl.json
disabled
Whether to disable this EIP from the route during build time. Once an EIP has been disabled then it cannot be enabled later at runtime.
{"type": "boolean"}
camel-yaml-dsl.json
expression
Expression that computes the endpoint uri to use as the resource endpoint to enrich from
{}
camel-yaml-dsl.json
id
Sets the id of this node
{"type": "string"}
camel-yaml-dsl.json
ignore-invalid-endpoint
Ignore the invalidate endpoint exception when try to create a producer with that endpoint
{"type": "boolean"}
camel-yaml-dsl.json
share-unit-of-work
Shares the org.apache.camel.spi.UnitOfWork with the parent and the resource exchange. Enrich will by default not share unit of work between the parent exchange and the resource exchange. This means the resource exchange has its own individual unit of work.
{"type": "boolean"}
camel-yaml-dsl.json
org.apache.camel.model.ErrorHandlerDefinition
Camel error handling.
{"type": "object", "properties": {"dead-letter-channel": {}, "default-error-handler": {}, "id": {"type": "string"}, "jta-transaction-error-handler": {}, "no-error-handler": {}, "spring-transaction-error-handler": {}}}
camel-yaml-dsl.json
id
The id of this node
{"type": "string"}
camel-yaml-dsl.json
org.apache.camel.model.FaultToleranceConfigurationDefinition
MicroProfile Fault Tolerance Circuit Breaker EIP configuration
{"type": "object", "properties": {"bulkhead-enabled": {"type": "boolean"}, "bulkhead-executor-service": {"type": "string"}, "bulkhead-max-concurrent-calls": {"type": "number", "default": "10"}, "bulkhead-waiting-task-queue": {"type": "number", "default": "10"}, "circuit-breaker": {"type": "string"}, "delay": {"type": "...
camel-yaml-dsl.json
bulkhead-enabled
Whether bulkhead is enabled or not on the circuit breaker. Default is false.
{"type": "boolean"}
camel-yaml-dsl.json
bulkhead-executor-service
References to a custom thread pool to use when bulkhead is enabled.
{"type": "string"}
camel-yaml-dsl.json
bulkhead-max-concurrent-calls
Configures the max amount of concurrent calls the bulkhead will support.
{"type": "number", "default": "10"}
camel-yaml-dsl.json
bulkhead-waiting-task-queue
Configures the task queue size for holding waiting tasks to be processed by the bulkhead.
{"type": "number", "default": "10"}
camel-yaml-dsl.json
circuit-breaker
Refers to an existing io.smallrye.faulttolerance.core.circuit.breaker.CircuitBreaker instance to lookup and use from the registry. When using this, then any other circuit breaker options are not in use.
{"type": "string"}
camel-yaml-dsl.json
delay
Control how long the circuit breaker stays open. The default is 5 seconds.
{"type": "string", "default": "5000"}
camel-yaml-dsl.json
failure-ratio
Configures the failure rate threshold in percentage. If the failure rate is equal or greater than the threshold the CircuitBreaker transitions to open and starts short-circuiting calls. The threshold must be greater than 0 and not greater than 100. Default value is 50 percentage.
{"type": "number", "default": "50"}
camel-yaml-dsl.json
id
The id of this node
{"type": "string"}
camel-yaml-dsl.json
request-volume-threshold
Controls the size of the rolling window used when the circuit breaker is closed
{"type": "number", "default": "20"}
camel-yaml-dsl.json
success-threshold
Controls the number of trial calls which are allowed when the circuit breaker is half-open
{"type": "number", "default": "1"}
camel-yaml-dsl.json
timeout-duration
Configures the thread execution timeout. Default value is 1 second.
{"type": "string", "default": "1000"}
camel-yaml-dsl.json
timeout-enabled
Whether timeout is enabled or not on the circuit breaker. Default is false.
{"type": "boolean"}
camel-yaml-dsl.json
timeout-pool-size
Configures the pool size of the thread pool when timeout is enabled. Default value is 10.
{"type": "number", "default": "10"}
camel-yaml-dsl.json
timeout-scheduled-executor-service
References to a custom thread pool to use when timeout is enabled
{"type": "string"}
camel-yaml-dsl.json
org.apache.camel.model.FilterDefinition
Filter out messages based using a predicate
{"type": "object", "anyOf": [{}], "properties": {"disabled": {"type": "boolean"}, "expression": {}, "id": {"type": "string"}, "inherit-error-handler": {"type": "boolean"}, "status-property-name": {"type": "string"}, "steps": {"type": "array", "items": {}}}}
camel-yaml-dsl.json
description
Sets the id of this node
{"type": "string"}
camel-yaml-dsl.json
disabled
Whether to disable this EIP from the route during build time. Once an EIP has been disabled then it cannot be enabled later at runtime.
{"type": "boolean"}
camel-yaml-dsl.json
expression
Expression to determine if the message should be filtered or not. If the expression returns an empty value or false then the message is filtered (dropped), otherwise the message is continued being routed.
{}
camel-yaml-dsl.json
id
Sets the id of this node
{"type": "string"}
camel-yaml-dsl.json
status-property-name
Name of exchange property to use for storing the status of the filtering. Setting this allows to know if the filter predicate evaluated as true or false.
{"type": "string"}
camel-yaml-dsl.json
org.apache.camel.model.FinallyDefinition
Path traversed when a try, catch, finally block exits
{"type": "object", "properties": {"disabled": {"type": "boolean"}, "id": {"type": "string"}, "inherit-error-handler": {"type": "boolean"}, "steps": {"type": "array", "items": {}}}}
camel-yaml-dsl.json
description
Sets the id of this node
{"type": "string"}
camel-yaml-dsl.json
disabled
Whether to disable this EIP from the route during build time. Once an EIP has been disabled then it cannot be enabled later at runtime.
{"type": "boolean"}
camel-yaml-dsl.json
id
Sets the id of this node
{"type": "string"}
camel-yaml-dsl.json
org.apache.camel.model.GlobalOptionDefinition
Models a string key/value pair for configuring some global options on a Camel context such as max debug log length.
{"type": "object", "properties": {"key": {"type": "string"}, "value": {"type": "string"}}, "required": ["key", "value"]}
camel-yaml-dsl.json
key
Global option key
{"type": "string"}
camel-yaml-dsl.json
value
Global option value
{"type": "string"}
camel-yaml-dsl.json
org.apache.camel.model.GlobalOptionsDefinition
Models a series of string key/value pairs for configuring some global options on a Camel context such as max debug log length.
{"type": "object", "properties": {"global-option": {"type": "array", "items": {}}}}
camel-yaml-dsl.json
global-option
A series of global options as key value pairs
{"type": "array", "items": {}}
camel-yaml-dsl.json
org.apache.camel.model.IdempotentConsumerDefinition
Filters out duplicate messages
{"type": "object", "anyOf": [{}], "properties": {"completion-eager": {"type": "boolean"}, "disabled": {"type": "boolean"}, "eager": {"type": "boolean"}, "expression": {}, "id": {"type": "string"}, "idempotent-repository": {"type": "string"}, "inherit-error-handler": {"type": "boolean"}, "remove-on-failure": {"type": "b...
camel-yaml-dsl.json
completion-eager
Sets whether to complete the idempotent consumer eager or when the exchange is done. If this option is true to complete eager, then the idempotent consumer will trigger its completion when the exchange reached the end of the block of the idempotent consumer pattern. So if the exchange is continued routed after the bloc...
{"type": "boolean"}
camel-yaml-dsl.json
description
Sets the id of this node
{"type": "string"}
camel-yaml-dsl.json
disabled
Whether to disable this EIP from the route during build time. Once an EIP has been disabled then it cannot be enabled later at runtime.
{"type": "boolean"}
camel-yaml-dsl.json
eager
Sets whether to eagerly add the key to the idempotent repository or wait until the exchange is complete. Eager is default enabled.
{"type": "boolean"}
camel-yaml-dsl.json
expression
Expression used to calculate the correlation key to use for duplicate check. The Exchange which has the same correlation key is regarded as a duplicate and will be rejected.
{}
camel-yaml-dsl.json
id
Sets the id of this node
{"type": "string"}