IBM Cloud Object Storage
Store and retrieve objects from IBM Cloud Object Storage.
What’s inside
-
IBM Cloud Object Storage component, URI syntax:
ibm-cos:bucketName
Please refer to the above links for usage and configuration details.
Maven coordinates
<dependency>
<groupId>org.apache.camel.springboot</groupId>
<artifactId>camel-ibm-cos-starter</artifactId>
</dependency>Spring Boot Auto-Configuration
The starter supports 30 options, which are listed below.
| Name | Description | Default | Type |
|---|---|---|---|
camel.component.ibm-cos.api-key | IBM Cloud API Key for authentication | String | |
camel.component.ibm-cos.auto-create-bucket | Automatically create the bucket if it doesn’t exist | false | Boolean |
camel.component.ibm-cos.autoclose-body | Whether to automatically close the object input stream after processing | true | Boolean |
camel.component.ibm-cos.autowired-enabled | Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. | true | Boolean |
camel.component.ibm-cos.bridge-error-handler | 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. | false | Boolean |
camel.component.ibm-cos.configuration | The component configuration. The option is a org.apache.camel.component.ibm.cos.IBMCOSConfiguration type. | IBMCOSConfiguration | |
camel.component.ibm-cos.cos-client | Reference to an IBM COS Client instance in the registry. The option is a com.ibm.cloud.objectstorage.services.s3.AmazonS3 type. | AmazonS3 | |
camel.component.ibm-cos.delete-after-read | Delete the object from IBM COS after it has been retrieved | true | Boolean |
camel.component.ibm-cos.delete-after-write | Delete the object from the local filesystem after uploading | false | Boolean |
camel.component.ibm-cos.delimiter | The delimiter to use for listing objects | String | |
camel.component.ibm-cos.destination-bucket | The destination bucket to move objects to | String | |
camel.component.ibm-cos.destination-bucket-prefix | The prefix to add to objects in the destination bucket | String | |
camel.component.ibm-cos.destination-bucket-suffix | The suffix to add to objects in the destination bucket | String | |
camel.component.ibm-cos.enabled | Whether to enable auto configuration of the ibm-cos component. This is enabled by default. | Boolean | |
camel.component.ibm-cos.endpoint-url | IBM COS Endpoint URL (e.g., https://s3.us-south.cloud-object-storage.appdomain.cloud) Note that some operations requires to use a regional endpoint URL instead of a cross-region one. | String | |
camel.component.ibm-cos.file-name | To get the object from the bucket with the given file name | String | |
camel.component.ibm-cos.health-check-consumer-enabled | Used for enabling or disabling all consumer based health checks from this component | true | Boolean |
camel.component.ibm-cos.health-check-producer-enabled | Used for enabling or disabling all producer based health checks from this component. Notice: Camel has by default disabled all producer based health-checks. You can turn on producer checks globally by setting camel.health.producersEnabled=true. | true | Boolean |
camel.component.ibm-cos.include-body | Include the object body in the exchange | true | Boolean |
camel.component.ibm-cos.include-folders | Include folders/directories when listing objects | true | Boolean |
camel.component.ibm-cos.key-name | The key name for the object | String | |
camel.component.ibm-cos.lazy-start-producer | 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. | false | Boolean |
camel.component.ibm-cos.location | IBM COS Location/Region (e.g., us-south, eu-gb) | String | |
camel.component.ibm-cos.move-after-read | Move the object to a different bucket after it has been retrieved | false | Boolean |
camel.component.ibm-cos.multi-part-upload | Use multi-part upload for large files | false | Boolean |
camel.component.ibm-cos.operation | The operation to perform | IBMCOSOperations | |
camel.component.ibm-cos.part-size | Part size for multi-part uploads (default 25MB) | 26214400 | Long |
camel.component.ibm-cos.prefix | The prefix to use for listing objects | String | |
camel.component.ibm-cos.service-instance-id | IBM COS Service Instance ID (CRN) | String | |
camel.component.ibm-cos.storage-class | The storage class to use when storing objects (e.g., STANDARD, VAULT, COLD, FLEX) | String |