diff --git a/Home.md b/Home.md index 93a012c..38aedd9 100644 --- a/Home.md +++ b/Home.md @@ -1,21 +1,36 @@ -# Deploy the Project on CamelX Platform +# Once -Deploy on CamelX Platform in three steps +Trigger a single message only once at startup (useful for development and testing purposes). -## Step 1: Create a release -From the project space, click on **"Create a release"** +## Metadata -The new version is automatically available in the list +| Property | Value | +|----------|-------| +| Scheme | `once` | +| Support Level | Stable | +| Labels | core,scheduling | +| Version | 4.20.0 (CEQ 3.36.0) | -## Step 2: Deploy -Click on **"Deploy"** +## Maven Dependency -- **Version:** Select the desired release -- **Environment:** Choose `Development`, `Staging`, or `Production` -- **Configuration:** Select the configuration source -- **Resources:** Set CPU and Memory +```xml + + org.apache.camel.quarkus + camel-quarkus-once + 4.20.0 (CEQ 3.36.0) + +``` -## Step 3: Expose -Enable **"Expose"** +## Endpoint Properties -Choose an **API Gateway** (Internal, Public, etc.) +| Name | Type | Required | Default | Description | +|------|------|----------|---------|-------------| +| `name` | string | ✓ | | The logical name | +| `body` | string | | | The data to use as message body. You can externalize the data by using file: or classpath: as prefix and specify the location of the file. | +| `headers` | object | | | The data to use as message headers as key=value pairs. You can externalize the data by using file: or classpath: as prefix and specify the location of the file. This is a multi-value option with prefix: header. | +| `bridgeErrorHandler` | boolean | | `false` | Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. | +| `exceptionHandler` | object | | | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored. | +| `exchangePattern` | enum | | | Sets the exchange pattern when the consumer creates an exchange. | +| `delay` | integer | | `1000` | The number of milliseconds to wait before triggering. The default value is 1000. | +| `exchangeProperties` | object | | | The data to use as exchange properties as key=value pairs. You can externalize the data by using file: or classpath: as prefix and specify the location of the file. This is a multi-value option with prefix: exchangeProperty. | +| `variables` | object | | | The data to use as exchange variables as key=value pairs. You can externalize the data by using file: or classpath: as prefix and specify the location of the file. This is a multi-value option with prefix: variable. |