schema
stringclasses
471 values
key
stringlengths
0
203
description
stringlengths
0
4.37k
object
stringlengths
2
322k
camel-yaml-dsl.json
maximum-retry-delay
Sets the upper value of retry in millis between retries, when using exponential or random backoff
{"type": "string", "default": "1000"}
camel-yaml-dsl.json
random-back-off
Enables random backoff
{"type": "boolean"}
camel-yaml-dsl.json
retry-delay
Sets the delay in millis between retries
{"type": "string", "default": "50"}
camel-yaml-dsl.json
org.apache.camel.model.OtherwiseDefinition
Route to be executed when all other choices evaluate to false
{"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.OutputTypeDefinition
Set the expected data type of the output message. If the actual message type is different at runtime, camel look for a required Transformer and apply if exists. If validate attribute is true then camel applies Validator as well. Type name consists of two parts, 'scheme' and 'name' connected with ':'. For Java type 'name' is a fully qualified class name. For example {code java:java.lang.String} , {code json:ABCOrder} . It's also possible to specify only scheme part, so that it works like a wildcard. If only 'xml' is specified, all the XML message matches. It's handy to add only one transformer/validator for all the XML-Java transformation.
{"type": "object", "properties": {"id": {"type": "string"}, "urn": {"type": "string"}, "validate": {"type": "boolean"}}, "required": ["urn"]}
camel-yaml-dsl.json
description
Sets the id of this node
{"type": "string"}
camel-yaml-dsl.json
id
Sets the id of this node
{"type": "string"}
camel-yaml-dsl.json
urn
Set output type URN.
{"type": "string"}
camel-yaml-dsl.json
validate
Whether if validation is required for this output type.
{"type": "boolean"}
camel-yaml-dsl.json
org.apache.camel.model.PackageScanDefinition
Scans for Java org.apache.camel.builder.RouteBuilder classes in java packages
{"type": "object", "properties": {"excludes": {"type": "array", "items": {"type": "string"}}, "includes": {"type": "array", "items": {"type": "string"}}, "package": {"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
includes
Include finding route builder from these java package names.
{"type": "array", "items": {"type": "string"}}
camel-yaml-dsl.json
package
Sets the java package names to use for scanning for route builder classes
{"type": "array", "items": {"type": "string"}}
camel-yaml-dsl.json
org.apache.camel.model.PausableDefinition
Pausable EIP to support resuming processing from last known offset.
{"type": "object", "properties": {"consumer-listener": {"type": "string"}, "disabled": {"type": "boolean"}, "id": {"type": "string"}, "inherit-error-handler": {"type": "boolean"}, "until-check": {"type": "string"}}, "required": ["consumer-listener", "until-check"]}
camel-yaml-dsl.json
consumer-listener
Sets the consumer listener to use
{"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
until-check
References to a java.util.function.Predicate to use for until checks. The predicate is responsible for evaluating whether the processing can resume or not. Such predicate should return true if the consumption can resume, or false otherwise. The exact point of when the predicate is called is dependent on the component, and it may be called on either one of the available events. Implementations should not assume the predicate to be called at any specific point.
{"type": "string"}
camel-yaml-dsl.json
org.apache.camel.model.PipelineDefinition
Routes the message to a sequence of processors.
{"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.PolicyDefinition
Defines a policy the route will use
{"type": "object", "properties": {"disabled": {"type": "boolean"}, "id": {"type": "string"}, "inherit-error-handler": {"type": "boolean"}, "ref": {"type": "string"}, "steps": {"type": "array", "items": {}}}, "required": ["ref"]}
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
ref
Sets a reference to use for lookup the policy in the registry.
{"type": "string"}
camel-yaml-dsl.json
org.apache.camel.model.PollEnrichDefinition
Enriches messages with data polled 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"}, "cache-size": {"type": "number"}, "disabled": {"type": "boolean"}, "expression": {}, "id": {"type": "string"}, "ignore-invalid-endpoint": {"type": "boolean"}, "inherit-error-handler": {"type": "boolean"}, "timeout": {"type": "string", "default": "-1"}}}
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 a custom message body etc.
{"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
cache-size
Sets the maximum size used by the org.apache.camel.spi.ConsumerCache which is used to cache and reuse consumers 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, which allows Camel to not cache both the producers and endpoints; they are regarded as prototype scoped and will be stopped and discarded after use. This reduces memory usage as otherwise producers/endpoints are stored in memory in the caches. However if there are a high degree of dynamic endpoints that have been used before, then it can benefit to use the cache to reuse both producers and endpoints and therefore the cache size can be set accordingly or rely on the default size (1000). If there is a mix of unique and used before dynamic endpoints, then setting a reasonable cache size can help reduce memory usage to avoid storing too many non frequent used producers.
{"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
timeout
Timeout in millis when polling from the external service. The timeout has influence about the poll enrich behavior. It basically operations in three different modes: negative value - Waits until a message is available and then returns it. Warning that this method could block indefinitely if no messages are available. 0 - Attempts to receive a message exchange immediately without waiting and returning null if a message exchange is not available yet. positive value - Attempts to receive a message exchange, waiting up to the given timeout to expire if a message is not yet available. Returns null if timed out The default value is -1 and therefore the method could block indefinitely, and therefore its recommended to use a timeout value
{"type": "string", "default": "-1"}
camel-yaml-dsl.json
org.apache.camel.model.ProcessDefinition
Calls a Camel processor
{"type": "object", "properties": {"disabled": {"type": "boolean"}, "id": {"type": "string"}, "inherit-error-handler": {"type": "boolean"}, "ref": {"type": "string"}}, "required": ["ref"]}
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
ref
Reference to the Processor to lookup in the registry to use. Can also be used for creating new beans by their class name by prefixing with #class, eg #class:com.foo.MyClassType. And it is also possible to refer to singleton beans by their type in the registry by prefixing with #type: syntax, eg #type:com.foo.MyClassType
{"type": "string"}
camel-yaml-dsl.json
org.apache.camel.model.PropertyDefinition
A key value pair where the value is a literal value
{"type": "object", "properties": {"key": {"type": "string"}, "value": {"type": "string"}}, "required": ["key", "value"]}
camel-yaml-dsl.json
key
Property key
{"type": "string"}
camel-yaml-dsl.json
value
Property value
{"type": "string"}
camel-yaml-dsl.json
org.apache.camel.model.PropertyExpressionDefinition
A key value pair where the value is an expression.
{"type": "object", "properties": {"expression": {}, "key": {"type": "string"}}, "required": ["key"]}
camel-yaml-dsl.json
expression
Property values as an expression
{}
camel-yaml-dsl.json
key
Property key
{"type": "string"}
camel-yaml-dsl.json
org.apache.camel.model.RecipientListDefinition
Route messages to a number of dynamically specified recipients
{"type": "object", "anyOf": [{}], "properties": {"aggregation-strategy": {"type": "string"}, "aggregation-strategy-method-allow-null": {"type": "boolean"}, "aggregation-strategy-method-name": {"type": "string"}, "cache-size": {"type": "number"}, "delimiter": {"type": "string", "default": ","}, "disabled": {"type": "boolean"}, "executor-service": {"type": "string"}, "expression": {}, "id": {"type": "string"}, "ignore-invalid-endpoints": {"type": "boolean"}, "inherit-error-handler": {"type": "boolean"}, "on-prepare": {"type": "string"}, "parallel-aggregate": {"type": "boolean"}, "parallel-processing": {"type": "boolean"}, "share-unit-of-work": {"type": "boolean"}, "stop-on-exception": {"type": "boolean"}, "streaming": {"type": "boolean"}, "synchronous": {"type": "boolean"}, "timeout": {"type": "string", "default": "0"}}}
camel-yaml-dsl.json
aggregation-strategy
Sets the AggregationStrategy to be used to assemble the replies from the recipients, into a single outgoing message from the RecipientList. By default Camel will use the last reply as the outgoing message. You can also use a POJO as the AggregationStrategy
{"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": "boolean"}
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
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 recipient list, 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, which allows Camel to not cache both the producers and endpoints; they are regarded as prototype scoped and will be stopped and discarded after use. This reduces memory usage as otherwise producers/endpoints are stored in memory in the caches. However if there are a high degree of dynamic endpoints that have been used before, then it can benefit to use the cache to reuse both producers and endpoints and therefore the cache size can be set accordingly or rely on the default size (1000). If there is a mix of unique and used before dynamic endpoints, then setting a reasonable cache size can help reduce memory usage to avoid storing too many non frequent used producers.
{"type": "number"}
camel-yaml-dsl.json
delimiter
Delimiter used if the Expression returned multiple endpoints. Can be turned off using the value false. The default value is ,
{"type": "string", "default": ","}
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 to be used for parallel processing. Notice if you set this option, then parallel processing is automatic implied, and you do not have to enable that option as well.
{"type": "string"}
camel-yaml-dsl.json
expression
Expression that returns which endpoints (url) to send the message to (the recipients). If the expression return an empty value then the message is not sent to any recipients.
{}
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
on-prepare
Uses the Processor when preparing the org.apache.camel.Exchange to be used send. This can be used to deep-clone messages that should be send, or any custom logic needed before the exchange is send.
{"type": "string"}
camel-yaml-dsl.json
parallel-aggregate
If enabled then the aggregate method on AggregationStrategy can be called concurrently. Notice that this would require the implementation of AggregationStrategy to be implemented as thread-safe. By default this is false meaning that Camel synchronizes the call to the aggregate method. Though in some use-cases this can be used to archive higher performance when the AggregationStrategy is implemented as thread-safe.
{"type": "boolean"}
camel-yaml-dsl.json
parallel-processing
If enabled then sending messages to the recipients occurs concurrently. Note the caller thread will still wait until all messages has been fully processed, before it continues. Its only the sending and processing the replies from the recipients which happens concurrently. When parallel processing is enabled, then the Camel routing engin will continue processing using last used thread from the parallel thread pool. However, if you want to use the original thread that called the recipient list, then make sure to enable the synchronous option as well.
{"type": "boolean"}
camel-yaml-dsl.json
share-unit-of-work
Shares the org.apache.camel.spi.UnitOfWork with the parent and each of the sub messages. Recipient List will by default not share unit of work between the parent exchange and each recipient exchange. This means each sub exchange has its own individual unit of work.
{"type": "boolean"}
camel-yaml-dsl.json
stop-on-exception
Will now stop further processing if an exception or failure occurred during processing of an org.apache.camel.Exchange and the caused exception will be thrown. Will also stop if processing the exchange failed (has a fault message) or an exception was thrown and handled by the error handler (such as using onException). In all situations the recipient list will stop further processing. This is the same behavior as in pipeline, which is used by the routing engine. The default behavior is to not stop but continue processing till the end
{"type": "boolean"}
camel-yaml-dsl.json
streaming
If enabled then Camel will process replies out-of-order, eg in the order they come back. If disabled, Camel will process replies in the same order as defined by the recipient list.
{"type": "boolean"}
camel-yaml-dsl.json
synchronous
Sets whether synchronous processing should be strictly used. When enabled then the same thread is used to continue routing after the recipient list is complete, even if parallel processing is enabled.
{"type": "boolean"}
camel-yaml-dsl.json
timeout
Sets a total timeout specified in millis, when using parallel processing. If the Recipient List hasn't been able to send and process all replies within the given timeframe, then the timeout triggers and the Recipient List breaks out and continues. Notice if you provide a TimeoutAwareAggregationStrategy then the timeout method is invoked before breaking out. If the timeout is reached with running tasks still remaining, certain tasks for which it is difficult for Camel to shut down in a graceful manner may continue to run. So use this option with a bit of care.
{"type": "string", "default": "0"}
camel-yaml-dsl.json
org.apache.camel.model.RedeliveryPolicyDefinition
To configure re-delivery for error handling
{"type": "object", "properties": {"allow-redelivery-while-stopping": {"type": "boolean"}, "async-delayed-redelivery": {"type": "boolean"}, "back-off-multiplier": {"type": "number", "default": "2.0"}, "collision-avoidance-factor": {"type": "number", "default": "0.15"}, "delay-pattern": {"type": "string"}, "disable-redelivery": {"type": "boolean"}, "exchange-formatter-ref": {"type": "string"}, "id": {"type": "string"}, "log-continued": {"type": "boolean"}, "log-exhausted": {"type": "boolean"}, "log-exhausted-message-body": {"type": "boolean"}, "log-exhausted-message-history": {"type": "boolean"}, "log-handled": {"type": "boolean"}, "log-new-exception": {"type": "boolean"}, "log-retry-attempted": {"type": "boolean"}, "log-retry-stack-trace": {"type": "boolean"}, "log-stack-trace": {"type": "boolean"}, "maximum-redeliveries": {"type": "number"}, "maximum-redelivery-delay": {"type": "string", "default": "60000"}, "redelivery-delay": {"type": "string", "default": "1000"}, "retries-exhausted-log-level": {"type": "string", "default": "ERROR"}, "retry-attempted-log-interval": {"type": "number", "default": "1"}, "retry-attempted-log-level": {"type": "string", "default": "DEBUG"}, "use-collision-avoidance": {"type": "boolean"}, "use-exponential-back-off": {"type": "boolean"}}}
camel-yaml-dsl.json
allow-redelivery-while-stopping
Controls whether to allow redelivery while stopping/shutting down a route that uses error handling.
{"type": "boolean"}
camel-yaml-dsl.json
async-delayed-redelivery
Allow asynchronous delayed redelivery. The route, in particular the consumer's component, must support the Asynchronous Routing Engine (e.g. seda).
{"type": "boolean"}
camel-yaml-dsl.json
back-off-multiplier
Sets the back off multiplier
{"type": "number", "default": "2.0"}
camel-yaml-dsl.json
collision-avoidance-factor
Sets the collision avoidance factor
{"type": "number", "default": "0.15"}
camel-yaml-dsl.json
delay-pattern
Sets the delay pattern with delay intervals.
{"type": "string"}
camel-yaml-dsl.json
disable-redelivery
Disables redelivery (same as setting maximum redeliveries to 0)
{"type": "boolean"}
camel-yaml-dsl.json
exchange-formatter-ref
Sets the reference of the instance of org.apache.camel.spi.ExchangeFormatter to generate the log message from exchange.
{"type": "string"}
camel-yaml-dsl.json
id
The id of this node
{"type": "string"}
camel-yaml-dsl.json
log-continued
Sets whether continued exceptions should be logged or not. Can be used to include or reduce verbose.
{"type": "boolean"}
camel-yaml-dsl.json
log-exhausted
Sets whether exhausted exceptions should be logged or not. Can be used to include or reduce verbose.
{"type": "boolean"}
camel-yaml-dsl.json
log-exhausted-message-body
Sets whether exhausted message body should be logged including message history or not (supports property placeholders). Can be used to include or reduce verbose. Requires logExhaustedMessageHistory to be enabled.
{"type": "boolean"}
camel-yaml-dsl.json
log-exhausted-message-history
Sets whether exhausted exceptions should be logged including message history or not (supports property placeholders). Can be used to include or reduce verbose.
{"type": "boolean"}
camel-yaml-dsl.json
log-handled
Sets whether handled exceptions should be logged or not. Can be used to include or reduce verbose.
{"type": "boolean"}
camel-yaml-dsl.json
log-new-exception
Sets whether new exceptions should be logged or not. Can be used to include or reduce verbose. A new exception is an exception that was thrown while handling a previous exception.
{"type": "boolean"}
camel-yaml-dsl.json
log-retry-attempted
Sets whether retry attempts should be logged or not. Can be used to include or reduce verbose.
{"type": "boolean"}
camel-yaml-dsl.json
log-retry-stack-trace
Sets whether stack traces should be logged when an retry attempt failed. Can be used to include or reduce verbose.
{"type": "boolean"}
camel-yaml-dsl.json
log-stack-trace
Sets whether stack traces should be logged. Can be used to include or reduce verbose.
{"type": "boolean"}
camel-yaml-dsl.json
maximum-redeliveries
Sets the maximum redeliveries x = redeliver at most x times 0 = no redeliveries -1 = redeliver forever
{"type": "number"}
camel-yaml-dsl.json
maximum-redelivery-delay
Sets the maximum delay between redelivery
{"type": "string", "default": "60000"}
camel-yaml-dsl.json
redelivery-delay
Sets the initial redelivery delay
{"type": "string", "default": "1000"}
camel-yaml-dsl.json
retries-exhausted-log-level
Sets the logging level to use when retries have been exhausted
{"type": "string", "default": "ERROR"}
camel-yaml-dsl.json
retry-attempted-log-interval
Sets the interval to use for logging retry attempts
{"type": "number", "default": "1"}
camel-yaml-dsl.json
retry-attempted-log-level
Sets the logging level to use for logging retry attempts
{"type": "string", "default": "DEBUG"}
camel-yaml-dsl.json
use-collision-avoidance
Turn on collision avoidance.
{"type": "boolean"}
camel-yaml-dsl.json
use-exponential-back-off
Turn on exponential backk off
{"type": "boolean"}