2 Home

gitea_admin edited this page 2026-10-12 05:31:45 +00:00

Table of Contents

• IBM Cloud Object Storage Source
• Metadata
• Properties
• Dependencies

IBM Cloud Object Storage Source

Receive data from an IBM Cloud Object Storage Bucket.

Metadata

Property	Value
Type	source
Group	IBM Cloud Object Storage
Namespace	IBM
Support Level	Preview
Provider	Apache Software Foundation

Properties

Name	Type	Required	Default	Description
bucketName	string	✓		The IBM COS Bucket name.
apiKey	string	✓		IBM Cloud API Key for authentication.
serviceInstanceId	string	✓		IBM COS Service Instance ID (CRN).
endpointUrl	string	✓		IBM COS Endpoint URL (e.g., https://s3.us-south.cloud-object-storage.appdomain.cloud).
location	string			IBM COS Location/Region (e.g., us-south, eu-gb).
deleteAfterRead	boolean		true	Specifies to delete objects after consuming them.
moveAfterRead	boolean		false	Move objects from IBM COS bucket to a different bucket after they have been retrieved.
destinationBucket	string			Define the destination bucket where an object must be moved when moveAfterRead is set to true.
destinationBucketPrefix	string			Define the destination bucket prefix to use when an object must be moved, and moveAfterRead is set to true.
destinationBucketSuffix	string			Define the destination bucket suffix to use when an object must be moved, and moveAfterRead is set to true.
autoCreateBucket	boolean		false	Specifies to automatically create the IBM COS bucket.
prefix	string			The IBM COS bucket prefix to consider while searching.
delimiter	string			The delimiter to use for listing objects.
includeBody	boolean		true	If true, the object body is included in the exchange. If false, only headers are set.
includeFolders	boolean		true	Include folders/directories when listing objects.
delay	integer		500	The number of milliseconds before the next poll of the selected bucket.
maxMessagesPerPoll	integer		10	Gets the maximum number of messages as a limit to poll at each polling. The default value is 10. Use 0 or a negative number to set it as unlimited.

Dependencies

• camel:core
• camel:ibm-cos
• camel:kamelet