schema
stringclasses
471 values
key
stringlengths
0
203
description
stringlengths
0
4.37k
object
stringlengths
2
322k
camel-yaml-dsl.json
sample-period
Sets the sample period during which only a single Exchange will pass through.
{"type": "string", "default": "1000"}
camel-yaml-dsl.json
org.apache.camel.model.ScriptDefinition
Executes a script from a language which does not change the message body.
{"type": "object", "anyOf": [{}], "properties": {"disabled": {"type": "boolean"}, "expression": {}, "id": {"type": "string"}, "inherit-error-handler": {"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
expression
Expression to return the transformed message body (the new message body to use)
{}
camel-yaml-dsl.json
id
Sets the id of this node
{"type": "string"}
camel-yaml-dsl.json
org.apache.camel.model.SetBodyDefinition
Sets the contents of the message body
{"type": "object", "anyOf": [{}], "properties": {"disabled": {"type": "boolean"}, "expression": {}, "id": {"type": "string"}, "inherit-error-handler": {"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
expression
Expression that returns the new body to use
{}
camel-yaml-dsl.json
id
Sets the id of this node
{"type": "string"}
camel-yaml-dsl.json
org.apache.camel.model.SetExchangePatternDefinition
Sets the exchange pattern on the message exchange
{"oneOf": [{"type": "string"}, {"type": "object", "properties": {"disabled": {"type": "boolean"}, "id": {"type": "string"}, "inherit-error-handler": {"type": "boolean"}, "pattern": {"type": "string", "enum": ["InOnly", "InOut"]}}}]}
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
pattern
Sets the new exchange pattern of the Exchange to be used from this point forward
{"type": "string", "enum": ["InOnly", "InOut"]}
camel-yaml-dsl.json
org.apache.camel.model.SetHeaderDefinition
Sets the value of a message header
{"type": "object", "anyOf": [{}], "properties": {"disabled": {"type": "boolean"}, "expression": {}, "id": {"type": "string"}, "inherit-error-handler": {"type": "boolean"}, "name": {"type": "string"}}, "required": ["name"]}
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 return the value of the header
{}
camel-yaml-dsl.json
id
Sets the id of this node
{"type": "string"}
camel-yaml-dsl.json
name
Name of message header to set a new value The simple language can be used to define a dynamic evaluated header name to be used. Otherwise a constant name will be used.
{"type": "string"}
camel-yaml-dsl.json
org.apache.camel.model.SetPropertyDefinition
Sets a named property on the message exchange
{"type": "object", "anyOf": [{}], "properties": {"disabled": {"type": "boolean"}, "expression": {}, "id": {"type": "string"}, "inherit-error-handler": {"type": "boolean"}, "name": {"type": "string"}}, "required": ["name"]}
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 return the value of the message exchange property
{}
camel-yaml-dsl.json
id
Sets the id of this node
{"type": "string"}
camel-yaml-dsl.json
name
Name of exchange property to set a new value. The simple language can be used to define a dynamic evaluated exchange property name to be used. Otherwise a constant name will be used.
{"type": "string"}
camel-yaml-dsl.json
org.apache.camel.model.SortDefinition
Sorts the contents of the message
{"type": "object", "anyOf": [{}], "properties": {"comparator": {"type": "string"}, "disabled": {"type": "boolean"}, "expression": {}, "id": {"type": "string"}, "inherit-error-handler": {"type": "boolean"}}}
camel-yaml-dsl.json
comparator
Sets the comparator to use for sorting
{"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
expression
Optional expression to sort by something else than the message body
{}
camel-yaml-dsl.json
id
Sets the id of this node
{"type": "string"}
camel-yaml-dsl.json
org.apache.camel.model.SplitDefinition
Splits a single message into many sub-messages.
{"type": "object", "anyOf": [{}], "properties": {"aggregation-strategy": {"type": "string"}, "aggregation-strategy-method-allow-null": {"type": "boolean"}, "aggregation-strategy-method-name": {"type": "string"}, "delimiter": {"type": "string", "default": ","}, "disabled": {"type": "boolean"}, "executor-service": {"type": "string"}, "expression": {}, "id": {"type": "string"}, "inherit-error-handler": {"type": "boolean"}, "on-prepare": {"type": "string"}, "parallel-aggregate": {"type": "boolean"}, "parallel-processing": {"type": "boolean"}, "share-unit-of-work": {"type": "boolean"}, "steps": {"type": "array", "items": {}}, "stop-on-exception": {"type": "boolean"}, "streaming": {"type": "boolean"}, "synchronous": {"type": "boolean"}, "timeout": {"type": "string", "default": "0"}}}
camel-yaml-dsl.json
aggregation-strategy
Sets a reference to the AggregationStrategy to be used to assemble the replies from the split messages, into a single outgoing message from the Splitter. By default Camel will use the original incoming message to the splitter (leave it unchanged). 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
delimiter
Delimiter used in splitting messages. 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 automatically implied, and you do not have to enable that option as well.
{"type": "string"}
camel-yaml-dsl.json
expression
Expression of how to split the message body, such as as-is, using a tokenizer, or using a xpath.
{}
camel-yaml-dsl.json
id
Sets the id of this node
{"type": "string"}
camel-yaml-dsl.json
on-prepare
Uses the Processor when preparing the org.apache.camel.Exchange to be sent. This can be used to deep-clone messages that should be sent, or any custom logic needed before the exchange is sent.
{"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 processing each split messages occurs concurrently. Note the caller thread will still wait until all messages has been fully processed, before it continues. It's only processing the sub messages from the splitter 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 splitter, 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. Splitter will by default not share unit of work between the parent exchange and each split exchange. This means each split 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 splitter 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
When in streaming mode, then the splitter splits the original message on-demand, and each split message is processed one by one. This reduces memory usage as the splitter do not split all the messages first, but then we do not know the total size, and therefore the org.apache.camel.Exchange#SPLIT_SIZE is empty. In non-streaming mode (default) the splitter will split each message first, to know the total size, and then process each message one by one. This requires to keep all the split messages in memory and therefore requires more memory. The total size is provided in the org.apache.camel.Exchange#SPLIT_SIZE header. The streaming mode also affects the aggregation behavior. If enabled then Camel will process replies out-of-order, e.g. in the order they come back. If disabled, Camel will process replies in the same order as the messages was split.
{"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 split 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 Splitter hasn't been able to split and process all the sub messages within the given timeframe, then the timeout triggers and the Splitter 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.StepDefinition
Routes the message to a sequence of processors which is grouped together as one logical name
{"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.StopDefinition
Stops the processing of the current message
{"type": "object", "properties": {"disabled": {"type": "boolean"}, "id": {"type": "string"}, "inherit-error-handler": {"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
id
Sets the id of this node
{"type": "string"}
camel-yaml-dsl.json
org.apache.camel.model.TemplatedRouteParameterDefinition
An input parameter of a route template.
{"type": "object", "properties": {"name": {"type": "string"}, "value": {"type": "string"}}, "required": ["name", "value"]}
camel-yaml-dsl.json
name
The name of the parameter
{"type": "string"}
camel-yaml-dsl.json
value
The value of the parameter.
{"type": "string"}
camel-yaml-dsl.json
org.apache.camel.model.ThreadPoolProfileDefinition
To configure thread pools
{"type": "object", "properties": {"allow-core-thread-time-out": {"type": "boolean"}, "default-profile": {"type": "boolean"}, "id": {"type": "string"}, "keep-alive-time": {"type": "number"}, "max-pool-size": {"type": "number"}, "max-queue-size": {"type": "number"}, "pool-size": {"type": "number"}, "rejected-policy": {"type": "string", "enum": ["Abort", "CallerRuns"]}, "time-unit": {"type": "string", "enum": ["NANOSECONDS", "MICROSECONDS", "MILLISECONDS", "SECONDS", "MINUTES", "HOURS", "DAYS"]}}}
camel-yaml-dsl.json
allow-core-thread-time-out
Whether idle core threads is allowed to timeout and therefore can shrink the pool size below the core pool size Is by default true
{"type": "boolean"}
camel-yaml-dsl.json
default-profile
Whether this profile is the default thread pool profile
{"type": "boolean"}
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
keep-alive-time
Sets the keep alive time for idle threads in the pool
{"type": "number"}
camel-yaml-dsl.json
max-pool-size
Sets the maximum pool size
{"type": "number"}
camel-yaml-dsl.json
max-queue-size
Sets the maximum number of tasks in the work queue. Use -1 or Integer.MAX_VALUE for an unbounded queue
{"type": "number"}
camel-yaml-dsl.json
pool-size
Sets the core pool size
{"type": "number"}
camel-yaml-dsl.json
rejected-policy
Sets the handler for tasks which cannot be executed by the thread pool.
{"type": "string", "enum": ["Abort", "CallerRuns"]}
camel-yaml-dsl.json
time-unit
Sets the time unit to use for keep alive time By default SECONDS is used.
{"type": "string", "enum": ["NANOSECONDS", "MICROSECONDS", "MILLISECONDS", "SECONDS", "MINUTES", "HOURS", "DAYS"]}
camel-yaml-dsl.json
org.apache.camel.model.ThreadsDefinition
Specifies that all steps after this node are processed asynchronously
{"type": "object", "properties": {"allow-core-thread-time-out": {"type": "boolean"}, "caller-runs-when-rejected": {"type": "string", "default": "true"}, "disabled": {"type": "boolean"}, "executor-service": {"type": "string"}, "id": {"type": "string"}, "inherit-error-handler": {"type": "boolean"}, "keep-alive-time": {"type": "number"}, "max-pool-size": {"type": "number"}, "max-queue-size": {"type": "number"}, "pool-size": {"type": "number"}, "rejected-policy": {"type": "string", "enum": ["Abort", "CallerRuns"]}, "thread-name": {"type": "string", "default": "Threads"}, "time-unit": {"type": "string", "enum": ["NANOSECONDS", "MICROSECONDS", "MILLISECONDS", "SECONDS", "MINUTES", "HOURS", "DAYS"]}}}
camel-yaml-dsl.json
allow-core-thread-time-out
Whether idle core threads are allowed to timeout and therefore can shrink the pool size below the core pool size Is by default false
{"type": "boolean"}
camel-yaml-dsl.json
caller-runs-when-rejected
Whether or not to use as caller runs as fallback when a task is rejected being added to the thread pool (when its full). This is only used as fallback if no rejectedPolicy has been configured, or the thread pool has no configured rejection handler. Is by default true
{"type": "string", "default": "true"}
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
{"type": "string"}
camel-yaml-dsl.json
id
Sets the id of this node
{"type": "string"}
camel-yaml-dsl.json
keep-alive-time
Sets the keep alive time for idle threads
{"type": "number"}
camel-yaml-dsl.json
max-pool-size
Sets the maximum pool size
{"type": "number"}
camel-yaml-dsl.json
max-queue-size
Sets the maximum number of tasks in the work queue. Use -1 or Integer.MAX_VALUE for an unbounded queue
{"type": "number"}
camel-yaml-dsl.json
pool-size
Sets the core pool size
{"type": "number"}
camel-yaml-dsl.json
rejected-policy
Sets the handler for tasks which cannot be executed by the thread pool.
{"type": "string", "enum": ["Abort", "CallerRuns"]}
camel-yaml-dsl.json
thread-name
Sets the thread name to use.
{"type": "string", "default": "Threads"}
camel-yaml-dsl.json
time-unit
Sets the keep alive time unit. By default SECONDS is used.
{"type": "string", "enum": ["NANOSECONDS", "MICROSECONDS", "MILLISECONDS", "SECONDS", "MINUTES", "HOURS", "DAYS"]}
camel-yaml-dsl.json
org.apache.camel.model.ThrottleDefinition
Controls the rate at which messages are passed to the next node in the route
{"type": "object", "anyOf": [{}], "properties": {"async-delayed": {"type": "boolean"}, "caller-runs-when-rejected": {"type": "boolean"}, "correlation-expression": {}, "disabled": {"type": "boolean"}, "executor-service": {"type": "string"}, "expression": {}, "id": {"type": "string"}, "inherit-error-handler": {"type": "boolean"}, "reject-execution": {"type": "boolean"}, "time-period-millis": {"type": "string", "default": "1000"}}}
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
correlation-expression
The expression used to calculate the correlation key to use for throttle grouping. The Exchange which has the same correlation key is throttled together.
{}
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 (ScheduledExecutorService) by the throttler.
{"type": "string"}
camel-yaml-dsl.json
expression
Expression to configure the maximum number of messages to throttle per request
{}
camel-yaml-dsl.json
id
Sets the id of this node
{"type": "string"}
camel-yaml-dsl.json
reject-execution
Whether or not throttler throws the ThrottlerRejectedExecutionException when the exchange exceeds the request limit Is by default false
{"type": "boolean"}
camel-yaml-dsl.json
time-period-millis
Sets the time period during which the maximum request count is valid for
{"type": "string", "default": "1000"}
camel-yaml-dsl.json
org.apache.camel.model.ThrowExceptionDefinition
Throws an exception
{"type": "object", "properties": {"disabled": {"type": "boolean"}, "exception-type": {"type": "string"}, "id": {"type": "string"}, "inherit-error-handler": {"type": "boolean"}, "message": {"type": "string"}, "ref": {"type": "string"}}}