IBM Cloud Object Storage

Store and retrieve objects from IBM Cloud Object Storage.

Metadata

Property	Value
Scheme	`ibm-cos`
Support Level	Stable
Labels	cloud,file
Version	4.20.0 (CEQ 3.36.0)

Maven Dependency

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-ibm-cos</artifactId>
    <version>4.20.0 (CEQ 3.36.0)</version>
</dependency>

Endpoint Properties

Name	Type	Required	Default	Description
`bucketName`	string	✓		Bucket name
`autoCreateBucket`	boolean		`false`	Automatically create the bucket if it doesn't exist
`delimiter`	string			The delimiter to use for listing objects
`endpointUrl`	string			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.
`location`	string			IBM COS Location/Region (e.g., us-south, eu-gb)
`prefix`	string			The prefix to use for listing objects
`deleteAfterRead`	boolean		`true`	Delete the object from IBM COS after it has been retrieved
`destinationBucket`	string			The destination bucket to move objects to
`destinationBucketPrefix`	string			The prefix to add to objects in the destination bucket
`destinationBucketSuffix`	string			The suffix to add to objects in the destination bucket
`fileName`	string			To get the object from the bucket with the given file name
`includeBody`	boolean		`true`	Include the object body in the exchange
`includeFolders`	boolean		`true`	Include folders/directories when listing objects
`maxMessagesPerPoll`	integer		`10`	Gets the maximum number of messages as a limit to poll at each polling.
`moveAfterRead`	boolean		`false`	Move the object to a different bucket after it has been retrieved
`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.
`autocloseBody`	boolean		`true`	Whether to automatically close the object input stream after processing
`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.
`inProgressRepository`	object			A pluggable in-progress repository to track objects being consumed
`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.
`deleteAfterWrite`	boolean		`false`	Delete the object from the local filesystem after uploading
`keyName`	string			The key name for the object
`multiPartUpload`	boolean		`false`	Use multi-part upload for large files
`operation`	enum			The operation to perform
`partSize`	integer		`26214400`	Part size for multi-part uploads (default 25MB)
`storageClass`	string			The storage class to use when storing objects (e.g., STANDARD, VAULT, COLD, FLEX)
`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.
`cosClient`	object			Reference to an IBM COS Client instance in the registry
`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`	enum		`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. This is a multi-value option with prefix: scheduler.
`startScheduler`	boolean		`true`	Whether the scheduler should be auto started.
`timeUnit`	enum		`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.
`apiKey`	string			IBM Cloud API Key for authentication
`serviceInstanceId`	string			IBM COS Service Instance ID (CRN)