schema
stringclasses
471 values
key
stringlengths
0
203
description
stringlengths
0
4.37k
object
stringlengths
2
322k
camel-yaml-dsl.json
org.apache.camel.model.RemoveHeaderDefinition
Removes a named header from the message
{"oneOf": [{"type": "string"}, {"type": "object", "properties": {"disabled": {"type": "boolean"}, "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
id
Sets the id of this node
{"type": "string"}
camel-yaml-dsl.json
name
Name of header to remove
{"type": "string"}
camel-yaml-dsl.json
org.apache.camel.model.RemoveHeadersDefinition
Removes message headers whose name matches a specified pattern
{"oneOf": [{"type": "string"}, {"type": "object", "properties": {"disabled": {"type": "boolean"}, "exclude-pattern": {"type": "string"}, "id": {"type": "string"}, "inherit-error-handler": {"type": "boolean"}, "pattern": {"type": "string"}}}], "required": ["pattern"]}
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
exclude-pattern
Name or patter of headers to not remove. The pattern is matched in the following order: 1 = exact match 2 = wildcard (pattern ends with a and the name starts with the pattern) 3 = regular expression (all of above is case in-sensitive).
{"type": "string"}
camel-yaml-dsl.json
id
Sets the id of this node
{"type": "string"}
camel-yaml-dsl.json
pattern
Name or pattern of headers to remove. The pattern is matched in the following order: 1 = exact match 2 = wildcard (pattern ends with a and the name starts with the pattern) 3 = regular expression (all of above is case in-sensitive).
{"type": "string"}
camel-yaml-dsl.json
org.apache.camel.model.RemovePropertiesDefinition
Removes message exchange properties whose name matches a specified pattern
{"oneOf": [{"type": "string"}, {"type": "object", "properties": {"disabled": {"type": "boolean"}, "exclude-pattern": {"type": "string"}, "id": {"type": "string"}, "inherit-error-handler": {"type": "boolean"}, "pattern": {"type": "string"}}}], "required": ["pattern"]}
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
exclude-pattern
Name or pattern of properties to not remove. The pattern is matched in the following order: 1 = exact match 2 = wildcard (pattern ends with a and the name starts with the pattern) 3 = regular expression (all of above is case in-sensitive).
{"type": "string"}
camel-yaml-dsl.json
id
Sets the id of this node
{"type": "string"}
camel-yaml-dsl.json
pattern
Name or pattern of properties to remove. The pattern is matched in the following order: 1 = exact match 2 = wildcard (pattern ends with a and the name starts with the pattern) 3 = regular expression (all of above is case in-sensitive).
{"type": "string"}
camel-yaml-dsl.json
org.apache.camel.model.RemovePropertyDefinition
Removes a named property from the message exchange
{"oneOf": [{"type": "string"}, {"type": "object", "properties": {"disabled": {"type": "boolean"}, "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
id
Sets the id of this node
{"type": "string"}
camel-yaml-dsl.json
name
Name of property to remove.
{"type": "string"}
camel-yaml-dsl.json
org.apache.camel.model.ResequenceDefinition
Resequences (re-order) messages based on an expression
{"type": "object", "anyOf": [{}], "properties": {"batch-config": {}, "disabled": {"type": "boolean"}, "expression": {}, "id": {"type": "string"}, "inherit-error-handler": {"type": "boolean"}, "steps": {"type": "array", "items": {}}, "stream-config": {}}}
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 use for re-ordering the messages, such as a header with a sequence number
{}
camel-yaml-dsl.json
id
Sets the id of this node
{"type": "string"}
camel-yaml-dsl.json
org.apache.camel.model.Resilience4jConfigurationDefinition
Resilience4j Circuit Breaker EIP configuration
{"type": "object", "properties": {"automatic-transition-from-open-to-half-open-enabled": {"type": "boolean"}, "bulkhead-enabled": {"type": "boolean"}, "bulkhead-max-concurrent-calls": {"type": "number", "default": "25"}, "bulkhead-max-wait-duration": {"type": "number", "default": "0"}, "circuit-breaker": {"type": "string"}, "config": {"type": "string"}, "failure-rate-threshold": {"type": "number", "default": "50"}, "id": {"type": "string"}, "minimum-number-of-calls": {"type": "number", "default": "100"}, "permitted-number-of-calls-in-half-open-state": {"type": "number", "default": "10"}, "sliding-window-size": {"type": "number", "default": "100"}, "sliding-window-type": {"type": "string", "default": "COUNT_BASED", "enum": ["TIME_BASED", "COUNT_BASED"]}, "slow-call-duration-threshold": {"type": "number", "default": "60"}, "slow-call-rate-threshold": {"type": "number", "default": "100"}, "throw-exception-when-half-open-or-open-state": {"type": "boolean"}, "timeout-cancel-running-future": {"type": "boolean"}, "timeout-duration": {"type": "number", "default": "1000"}, "timeout-enabled": {"type": "boolean"}, "timeout-executor-service": {"type": "string"}, "wait-duration-in-open-state": {"type": "number", "default": "60"}, "writable-stack-trace-enabled": {"type": "boolean"}}}
camel-yaml-dsl.json
automatic-transition-from-open-to-half-open-enabled
Enables automatic transition from OPEN to HALF_OPEN state once the waitDurationInOpenState has passed.
{"type": "boolean"}
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-max-concurrent-calls
Configures the max amount of concurrent calls the bulkhead will support.
{"type": "number", "default": "25"}
camel-yaml-dsl.json
bulkhead-max-wait-duration
Configures a maximum amount of time which the calling thread will wait to enter the bulkhead. If bulkhead has space available, entry is guaranteed and immediate. If bulkhead is full, calling threads will contest for space, if it becomes available. maxWaitDuration can be set to 0. Note: for threads running on an event-loop or equivalent (rx computation pool, etc), setting maxWaitDuration to 0 is highly recommended. Blocking an event-loop thread will most likely have a negative effect on application throughput.
{"type": "number", "default": "0"}
camel-yaml-dsl.json
circuit-breaker
Refers to an existing io.github.resilience4j.circuitbreaker.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
config
Refers to an existing io.github.resilience4j.circuitbreaker.CircuitBreakerConfig instance to lookup and use from the registry.
{"type": "string"}
camel-yaml-dsl.json
failure-rate-threshold
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
minimum-number-of-calls
Configures the minimum number of calls which are required (per sliding window period) before the CircuitBreaker can calculate the error rate. For example, if minimumNumberOfCalls is 10, then at least 10 calls must be recorded, before the failure rate can be calculated. If only 9 calls have been recorded the CircuitBreaker will not transition to open even if all 9 calls have failed. Default minimumNumberOfCalls is 100
{"type": "number", "default": "100"}
camel-yaml-dsl.json
permitted-number-of-calls-in-half-open-state
Configures the number of permitted calls when the CircuitBreaker is half open. The size must be greater than 0. Default size is 10.
{"type": "number", "default": "10"}
camel-yaml-dsl.json
sliding-window-size
Configures the size of the sliding window which is used to record the outcome of calls when the CircuitBreaker is closed. slidingWindowSize configures the size of the sliding window. Sliding window can either be count-based or time-based. If slidingWindowType is COUNT_BASED, the last slidingWindowSize calls are recorded and aggregated. If slidingWindowType is TIME_BASED, the calls of the last slidingWindowSize seconds are recorded and aggregated. The slidingWindowSize must be greater than 0. The minimumNumberOfCalls must be greater than 0. If the slidingWindowType is COUNT_BASED, the minimumNumberOfCalls cannot be greater than slidingWindowSize . If the slidingWindowType is TIME_BASED, you can pick whatever you want. Default slidingWindowSize is 100.
{"type": "number", "default": "100"}
camel-yaml-dsl.json
sliding-window-type
Configures the type of the sliding window which is used to record the outcome of calls when the CircuitBreaker is closed. Sliding window can either be count-based or time-based. If slidingWindowType is COUNT_BASED, the last slidingWindowSize calls are recorded and aggregated. If slidingWindowType is TIME_BASED, the calls of the last slidingWindowSize seconds are recorded and aggregated. Default slidingWindowType is COUNT_BASED.
{"type": "string", "default": "COUNT_BASED", "enum": ["TIME_BASED", "COUNT_BASED"]}
camel-yaml-dsl.json
slow-call-duration-threshold
Configures the duration threshold (seconds) above which calls are considered as slow and increase the slow calls percentage. Default value is 60 seconds.
{"type": "number", "default": "60"}
camel-yaml-dsl.json
slow-call-rate-threshold
Configures a threshold in percentage. The CircuitBreaker considers a call as slow when the call duration is greater than slowCallDurationThreshold Duration. When the percentage of slow calls is equal or greater 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 100 percentage which means that all recorded calls must be slower than slowCallDurationThreshold.
{"type": "number", "default": "100"}
camel-yaml-dsl.json
throw-exception-when-half-open-or-open-state
Whether to throw io.github.resilience4j.circuitbreaker.CallNotPermittedException when the call is rejected due circuit breaker is half open or open.
{"type": "boolean"}
camel-yaml-dsl.json
timeout-cancel-running-future
Configures whether cancel is called on the running future. Defaults to true.
{"type": "boolean"}
camel-yaml-dsl.json
timeout-duration
Configures the thread execution timeout. Default value is 1 second.
{"type": "number", "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-executor-service
References to a custom thread pool to use when timeout is enabled (uses ForkJoinPool#commonPool() by default)
{"type": "string"}
camel-yaml-dsl.json
wait-duration-in-open-state
Configures the wait duration (in seconds) which specifies how long the CircuitBreaker should stay open, before it switches to half open. Default value is 60 seconds.
{"type": "number", "default": "60"}
camel-yaml-dsl.json
writable-stack-trace-enabled
Enables writable stack traces. When set to false, Exception.getStackTrace returns a zero length array. This may be used to reduce log spam when the circuit breaker is open as the cause of the exceptions is already known (the circuit breaker is short-circuiting calls).
{"type": "boolean"}
camel-yaml-dsl.json
org.apache.camel.model.RestContextRefDefinition
To refer to an XML file with rest services defined using the rest-dsl
{"oneOf": [{"type": "string"}, {"type": "object", "properties": {"ref": {"type": "string"}}}], "required": ["ref"]}
camel-yaml-dsl.json
ref
Reference to the rest-dsl
{"type": "string"}
camel-yaml-dsl.json
org.apache.camel.model.ResumableDefinition
Resume EIP to support resuming processing from last known offset.
{"type": "object", "properties": {"disabled": {"type": "boolean"}, "id": {"type": "string"}, "inherit-error-handler": {"type": "boolean"}, "intermittent": {"type": "boolean"}, "logging-level": {"type": "string", "default": "ERROR", "enum": ["TRACE", "DEBUG", "INFO", "WARN", "ERROR", "OFF"]}, "resume-strategy": {"type": "string"}}, "required": ["resume-strategy"]}
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
intermittent
Sets whether the offsets will be intermittently present or whether they must be present in every exchange
{"type": "boolean"}
camel-yaml-dsl.json
resume-strategy
Sets the resume strategy to use
{"type": "string"}
camel-yaml-dsl.json
org.apache.camel.model.RollbackDefinition
Forces a rollback by stopping routing the message
{"oneOf": [{"type": "string"}, {"type": "object", "properties": {"disabled": {"type": "boolean"}, "id": {"type": "string"}, "inherit-error-handler": {"type": "boolean"}, "mark-rollback-only": {"type": "boolean"}, "mark-rollback-only-last": {"type": "boolean"}, "message": {"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
mark-rollback-only
Mark the transaction for rollback only (cannot be overruled to commit)
{"type": "boolean"}
camel-yaml-dsl.json
mark-rollback-only-last
Mark only last sub transaction for rollback only. When using sub transactions (if the transaction manager support this)
{"type": "boolean"}
camel-yaml-dsl.json
message
Message to use in rollback exception
{"type": "string"}
camel-yaml-dsl.json
org.apache.camel.model.RouteBuilderDefinition
To refer to a Java org.apache.camel.builder.RouteBuilder instance to use.
{"oneOf": [{"type": "string"}, {"type": "object", "properties": {"id": {"type": "string"}, "ref": {"type": "string"}}}], "required": ["ref"]}
camel-yaml-dsl.json
id
The id of this node
{"type": "string"}
camel-yaml-dsl.json
ref
Reference to the route builder instance
{"type": "string"}
camel-yaml-dsl.json
org.apache.camel.model.RouteConfigurationContextRefDefinition
To refer to an XML file with route configuration defined using the xml-dsl
{"oneOf": [{"type": "string"}, {"type": "object", "properties": {"ref": {"type": "string"}}}], "required": ["ref"]}
camel-yaml-dsl.json
ref
Reference to the route templates in the xml dsl
{"type": "string"}
camel-yaml-dsl.json
org.apache.camel.model.RouteContextRefDefinition
To refer to an XML file with routes defined using the xml-dsl
{"oneOf": [{"type": "string"}, {"type": "object", "properties": {"ref": {"type": "string"}}}], "required": ["ref"]}
camel-yaml-dsl.json
ref
Reference to the routes in the xml dsl
{"type": "string"}
camel-yaml-dsl.json
org.apache.camel.model.RouteTemplateParameterDefinition
A route template parameter
{"type": "object", "properties": {"default-value": {"type": "string"}, "name": {"type": "string"}, "required": {"type": "boolean"}}, "required": ["name"]}
camel-yaml-dsl.json
default-value
Default value of the parameter. If a default value is provided then the parameter is implied not to be required.
{"type": "string"}
camel-yaml-dsl.json
description
Description of the parameter
{"type": "string"}
camel-yaml-dsl.json
name
The name of the parameter
{"type": "string"}
camel-yaml-dsl.json
required
Whether the parameter is required or not. A parameter is required unless this option is set to false or a default value has been configured.
{"type": "boolean"}
camel-yaml-dsl.json
org.apache.camel.model.RoutingSlipDefinition
Routes a message through a series of steps that are pre-determined (the slip)
{"oneOf": [{"type": "string"}, {"type": "object", "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": ","}}}], "anyOf": [{}]}
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 routing slip, 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 to define the routing slip, which defines which endpoints to route the message in a pipeline style. Notice the expression is evaluated once, if you want a more dynamic style, then the dynamic router eip is a better choice.
{}
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.SagaDefinition
Enables Sagas on the route
{"type": "object", "properties": {"compensation": {}, "completion": {}, "completion-mode": {"type": "string", "default": "AUTO", "enum": ["AUTO", "MANUAL"]}, "disabled": {"type": "boolean"}, "id": {"type": "string"}, "inherit-error-handler": {"type": "boolean"}, "option": {"type": "array", "items": {}}, "propagation": {"type": "string", "default": "REQUIRED", "enum": ["REQUIRED", "REQUIRES_NEW", "MANDATORY", "SUPPORTS", "NOT_SUPPORTED", "NEVER"]}, "saga-service": {"type": "string"}, "steps": {"type": "array", "items": {}}, "timeout": {"type": "string"}}}
camel-yaml-dsl.json
compensation
The compensation endpoint URI that must be called to compensate all changes done in the route. The route corresponding to the compensation URI must perform compensation and complete without error. If errors occur during compensation, the saga service may call again the compensation URI to retry.
{}
camel-yaml-dsl.json
completion
The completion endpoint URI that will be called when the Saga is completed successfully. The route corresponding to the completion URI must perform completion tasks and terminate without error. If errors occur during completion, the saga service may call again the completion URI to retry.
{}
camel-yaml-dsl.json
completion-mode
Determine how the saga should be considered complete. When set to AUTO, the saga is completed when the exchange that initiates the saga is processed successfully, or compensated when it completes exceptionally. When set to MANUAL, the user must complete or compensate the saga using the saga:complete or saga:compensate endpoints.
{"type": "string", "default": "AUTO", "enum": ["AUTO", "MANUAL"]}
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
option
Allows to save properties of the current exchange in order to re-use them in a compensation/completion callback route. Options are usually helpful e.g. to store and retrieve identifiers of objects that should be deleted in compensating actions. Option values will be transformed into input headers of the compensation/completion exchange.
{"type": "array", "items": {}}
camel-yaml-dsl.json
propagation
Set the Saga propagation mode (REQUIRED, REQUIRES_NEW, MANDATORY, SUPPORTS, NOT_SUPPORTED, NEVER).
{"type": "string", "default": "REQUIRED", "enum": ["REQUIRED", "REQUIRES_NEW", "MANDATORY", "SUPPORTS", "NOT_SUPPORTED", "NEVER"]}
camel-yaml-dsl.json
saga-service
Refers to the id to lookup in the registry for the specific CamelSagaService to use.
{"type": "string"}
camel-yaml-dsl.json
timeout
Set the maximum amount of time for the Saga. After the timeout is expired, the saga will be compensated automatically (unless a different decision has been taken in the meantime).
{"type": "string"}
camel-yaml-dsl.json
org.apache.camel.model.SamplingDefinition
Extract a sample of the messages passing through a route
{"oneOf": [{"type": "string"}, {"type": "object", "properties": {"disabled": {"type": "boolean"}, "id": {"type": "string"}, "inherit-error-handler": {"type": "boolean"}, "message-frequency": {"type": "number"}, "sample-period": {"type": "string", "default": "1000"}}}]}
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
message-frequency
Sets the sample message count which only a single Exchange will pass through after this many received.
{"type": "number"}