camel.apache.org/google-storage
1
0
Fork 0
generated from camel.apache.org/component
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update wiki Home page for google-storage

gitea_admin 2026-03-11 14:38:31 +00:00
parent 000e6aa3e2
commit af411104ca
1 changed files with 56 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

70
Home.md

@ -1,21 +1,63 @@
# Deploy the Project on CamelX Platform
# Google Storage
Deploy on CamelX Platform in three steps
Store and retrieve objects from Google Cloud Storage Service using the google-cloud-storage library.
## 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 | `google-storage` |
| Support Level | Stable |
| Labels | cloud |
| Version | 4.10.2 |
## 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
<dependency>
<groupId>org.apache.camel</groupId>
<artifactId>camel-google-storage</artifactId>
<version>4.10.2</version>
</dependency>
```
## Step 3: Expose
Enable **"Expose"**
## Endpoint Properties
Choose an **API Gateway** (Internal, Public, etc.)
| Name | Type | Required | Default | Description |
|------|------|----------|---------|-------------|
| `bucketName` | string | ✓ | | Bucket name or ARN |
| `autoCreateBucket` | boolean | | `true` | Setting the autocreation of the bucket bucketName. |
| `serviceAccountKey` | string | | | The Service account key that can be used as credentials for the Storage client. It can be loaded by default from classpath, but you can prefix with classpath:, file:, or http: to load the resource from different systems. |
| `storageClass` | object | | `STANDARD` | The Cloud Storage class to use when creating the new buckets |
| `storageClient` | object | | | The storage client |
| `storageLocation` | string | | `US-EAST1` | The Cloud Storage location to use when creating the new buckets |
| `deleteAfterRead` | boolean | | `true` | Delete objects from the bucket after they have been retrieved. The delete is only performed if the Exchange is committed. If a rollback occurs, the object is not deleted. If this option is false, then the same objects will be retrieve over and over again on the polls. |
| `destinationBucket` | string | | | Define the destination bucket where an object must be moved when moveAfterRead is set to true. |
| `downloadFileName` | string | | | The folder or filename to use when downloading the blob. By default, this specifies the folder name, and the name of the file is the blob name. For example, setting this to mydownload will be the same as setting mydownload/${file:name}. You can use dynamic expressions for fine-grained control. For example, you can specify ${date:now:yyyyMMdd}/${file:name} to store the blob in sub folders based on today's day. Only ${file:name} and ${file:name.noext} is supported as dynamic tokens for the blob name. |
| `filter` | string | | | A regular expression to include only blobs with name matching it. |
| `includeBody` | boolean | | `true` | If it is true, the Object exchange will be consumed and put into the body. If false the Object stream will be put raw into the body and the headers will be set with the object metadata. |
| `includeFolders` | boolean | | `true` | If it is true, the folders/directories will be consumed. If it is false, they will be ignored, and Exchanges will not be created for those |
| `moveAfterRead` | boolean | | `false` | Move objects from the origin bucket to a different bucket after they have been retrieved. To accomplish the operation the destinationBucket option must be set. The copy bucket operation is only performed if the Exchange is committed. If a rollback occurs, the object is not moved. |
| `prefix` | string | | | The prefix which is used in the BlobListOptions to only consume objects we are interested in |
| `sendEmptyMessageWhenIdle` | boolean | | `false` | If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead. |
| `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` | object | | | Sets the exchange pattern when the consumer creates an exchange. |
| `pollStrategy` | object | | | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. |
| `objectName` | string | | | The Object name inside the bucket |
| `operation` | object | | | Set the operation for the producer |
| `lazyStartProducer` | boolean | | `false` | Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. |
| `backoffErrorThreshold` | integer | | | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. |
| `backoffIdleThreshold` | integer | | | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. |
| `backoffMultiplier` | integer | | | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. |
| `delay` | integer | | `500` | Milliseconds before the next poll. |
| `greedy` | boolean | | `false` | If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages. |
| `initialDelay` | integer | | `1000` | Milliseconds before the first poll starts. |
| `repeatCount` | integer | | `0` | Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever. |
| `runLoggingLevel` | object | | `TRACE` | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. |
| `scheduledExecutorService` | object | | | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. |
| `scheduler` | object | | `none` | To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler |
| `schedulerProperties` | object | | | To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler. |
| `startScheduler` | boolean | | `true` | Whether the scheduler should be auto started. |
| `timeUnit` | object | | `MILLISECONDS` | Time unit for initialDelay and delay options. |
| `useFixedDelay` | boolean | | `true` | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. |