camel-apache-org/ibm-cos
camel-apache-org/ibm-cos
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity
d529e5f396
ibm-cos/component.json

1933 lines
68 KiB
JSON
Raw Normal View History

Add component definition: ibm-cos
2026-10-12 02:40:12 +00:00
{
"component": {
"kind": "component",
"name": "ibm-cos",
"title": "IBM Cloud Object Storage",
"description": "Store and retrieve objects from IBM Cloud Object Storage.",
"deprecated": false,
"firstVersion": "3.30.0",
"label": "cloud,file",
"javaType": "org.apache.camel.component.ibm.cos.IBMCOSComponent",
"supportLevel": "Stable",
"nativeSupported": true,
"metadata": {
"quarkusVersion": "3.36.0",
"camelArtifact": "org.apache.camel:camel-ibm-cos",
"camelVersion": "4.20.0"
},
"groupId": "org.apache.camel.quarkus",
"artifactId": "camel-quarkus-ibm-cos",
"version": "4.20.0 (CEQ 3.36.0)",
"scheme": "ibm-cos",
"extendsScheme": "",
"syntax": "ibm-cos:bucketName",
"async": false,
"api": false,
"consumerOnly": false,
"producerOnly": false,
"lenientProperties": false,
"browsable": false,
"remote": true
},
"componentProperties": {
"autoCreateBucket": {
"index": 0,
"kind": "property",
"displayName": "Auto Create Bucket",
"group": "common",
"label": "common",
"required": false,
"type": "boolean",
"javaType": "boolean",
"deprecated": false,
"autowired": false,
"secret": false,
"defaultValue": false,
"configurationClass": "org.apache.camel.component.ibm.cos.IBMCOSConfiguration",
"configurationField": "configuration",
"description": "Automatically create the bucket if it doesn't exist"
},
"configuration": {
"index": 1,
"kind": "property",
"displayName": "Configuration",
"group": "common",
"label": "",
"required": false,
"type": "object",
"javaType": "org.apache.camel.component.ibm.cos.IBMCOSConfiguration",
"deprecated": false,
"autowired": false,
"secret": false,
"description": "The component configuration"
},
"delimiter": {
"index": 2,
"kind": "property",
"displayName": "Delimiter",
"group": "common",
"label": "",
"required": false,
"type": "string",
"javaType": "java.lang.String",
"deprecated": false,
"autowired": false,
"secret": false,
"configurationClass": "org.apache.camel.component.ibm.cos.IBMCOSConfiguration",
"configurationField": "configuration",
"description": "The delimiter to use for listing objects"
},
"endpointUrl": {
"index": 3,
"kind": "property",
"displayName": "Endpoint Url",
"group": "common",
"label": "",
"required": false,
"type": "string",
"javaType": "java.lang.String",
"deprecated": false,
"autowired": false,
"secret": false,
"configurationClass": "org.apache.camel.component.ibm.cos.IBMCOSConfiguration",
"configurationField": "configuration",
"description": "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": {
"index": 4,
"kind": "property",
"displayName": "Location",
"group": "common",
"label": "",
"required": false,
"type": "string",
"javaType": "java.lang.String",
"deprecated": false,
"autowired": false,
"secret": false,
"configurationClass": "org.apache.camel.component.ibm.cos.IBMCOSConfiguration",
"configurationField": "configuration",
"description": "IBM COS Location/Region (e.g., us-south, eu-gb)"
},
"prefix": {
"index": 5,
"kind": "property",
"displayName": "Prefix",
"group": "common",
"label": "",
"required": false,
"type": "string",
"javaType": "java.lang.String",
"deprecated": false,
"autowired": false,
"secret": false,
"configurationClass": "org.apache.camel.component.ibm.cos.IBMCOSConfiguration",
"configurationField": "configuration",
"description": "The prefix to use for listing objects"
},
"bridgeErrorHandler": {
"index": 6,
"kind": "property",
"displayName": "Bridge Error Handler",
"group": "consumer",
"label": "consumer",
"required": false,
"type": "boolean",
"javaType": "boolean",
"deprecated": false,
"autowired": false,
"secret": false,
"defaultValue": false,
"description": "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."
},
"deleteAfterRead": {
"index": 7,
"kind": "property",
"displayName": "Delete After Read",
"group": "consumer",
"label": "consumer",
"required": false,
"type": "boolean",
"javaType": "boolean",
"deprecated": false,
"autowired": false,
"secret": false,
"defaultValue": true,
"configurationClass": "org.apache.camel.component.ibm.cos.IBMCOSConfiguration",
"configurationField": "configuration",
"description": "Delete the object from IBM COS after it has been retrieved"
},
"destinationBucket": {
"index": 8,
"kind": "property",
"displayName": "Destination Bucket",
"group": "consumer",
"label": "consumer",
"required": false,
"type": "string",
"javaType": "java.lang.String",
"deprecated": false,
"autowired": false,
"secret": false,
"configurationClass": "org.apache.camel.component.ibm.cos.IBMCOSConfiguration",
"configurationField": "configuration",
"description": "The destination bucket to move objects to"
},
"destinationBucketPrefix": {
"index": 9,
"kind": "property",
"displayName": "Destination Bucket Prefix",
"group": "consumer",
"label": "consumer",
"required": false,
"type": "string",
"javaType": "java.lang.String",
"deprecated": false,
"autowired": false,
"secret": false,
"configurationClass": "org.apache.camel.component.ibm.cos.IBMCOSConfiguration",
"configurationField": "configuration",
"description": "The prefix to add to objects in the destination bucket"
},
"destinationBucketSuffix": {
"index": 10,
"kind": "property",
"displayName": "Destination Bucket Suffix",
"group": "consumer",
"label": "consumer",
"required": false,
"type": "string",
"javaType": "java.lang.String",
"deprecated": false,
"autowired": false,
"secret": false,
"configurationClass": "org.apache.camel.component.ibm.cos.IBMCOSConfiguration",
"configurationField": "configuration",
"description": "The suffix to add to objects in the destination bucket"
},
"fileName": {
"index": 11,
"kind": "property",
"displayName": "File Name",
"group": "consumer",
"label": "consumer",
"required": false,
"type": "string",
"javaType": "java.lang.String",
"deprecated": false,
"autowired": false,
"secret": false,
"configurationClass": "org.apache.camel.component.ibm.cos.IBMCOSConfiguration",
"configurationField": "configuration",
"description": "To get the object from the bucket with the given file name"
},
"includeBody": {
"index": 12,
"kind": "property",
"displayName": "Include Body",
"group": "consumer",
"label": "consumer",
"required": false,
"type": "boolean",
"javaType": "boolean",
"deprecated": false,
"autowired": false,
"secret": false,
"defaultValue": true,
"configurationClass": "org.apache.camel.component.ibm.cos.IBMCOSConfiguration",
"configurationField": "configuration",
"description": "Include the object body in the exchange"
},
"includeFolders": {
"index": 13,
"kind": "property",
"displayName": "Include Folders",
"group": "consumer",
"label": "consumer",
"required": false,
"type": "boolean",
"javaType": "boolean",
"deprecated": false,
"autowired": false,
"secret": false,
"defaultValue": true,
"configurationClass": "org.apache.camel.component.ibm.cos.IBMCOSConfiguration",
"configurationField": "configuration",
"description": "Include folders/directories when listing objects"
},
"moveAfterRead": {
"index": 14,
"kind": "property",
"displayName": "Move After Read",
"group": "consumer",
"label": "consumer",
"required": false,
"type": "boolean",
"javaType": "boolean",
"deprecated": false,
"autowired": false,
"secret": false,
"defaultValue": false,
"configurationClass": "org.apache.camel.component.ibm.cos.IBMCOSConfiguration",
"configurationField": "configuration",
"description": "Move the object to a different bucket after it has been retrieved"
},
"autocloseBody": {
"index": 15,
"kind": "property",
"displayName": "Autoclose Body",
"group": "consumer (advanced)",
"label": "consumer,advanced",
"required": false,
"type": "boolean",
"javaType": "boolean",
"deprecated": false,
"autowired": false,
"secret": false,
"defaultValue": true,
"configurationClass": "org.apache.camel.component.ibm.cos.IBMCOSConfiguration",
"configurationField": "configuration",
"description": "Whether to automatically close the object input stream after processing"
},
"deleteAfterWrite": {
"index": 16,
"kind": "property",
"displayName": "Delete After Write",
"group": "producer",
"label": "producer",
"required": false,
"type": "boolean",
"javaType": "boolean",
"deprecated": false,
"autowired": false,
"secret": false,
"defaultValue": false,
"configurationClass": "org.apache.camel.component.ibm.cos.IBMCOSConfiguration",
"configurationField": "configuration",
"description": "Delete the object from the local filesystem after uploading"
},
"keyName": {
"index": 17,
"kind": "property",
"displayName": "Key Name",
"group": "producer",
"label": "producer",
"required": false,
"type": "string",
"javaType": "java.lang.String",
"deprecated": false,
"autowired": false,
"secret": false,
"configurationClass": "org.apache.camel.component.ibm.cos.IBMCOSConfiguration",
"configurationField": "configuration",
"description": "The key name for the object"
},
"lazyStartProducer": {
"index": 18,
"kind": "property",
"displayName": "Lazy Start Producer",
"group": "producer",
"label": "producer",
"required": false,
"type": "boolean",
"javaType": "boolean",
"deprecated": false,
"autowired": false,
"secret": false,
"defaultValue": false,
"description": "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."
},
"multiPartUpload": {
"index": 19,
"kind": "property",
"displayName": "Multi Part Upload",
"group": "producer",
"label": "producer",
"required": false,
"type": "boolean",
"javaType": "boolean",
"deprecated": false,
"autowired": false,
"secret": false,
"defaultValue": false,
"configurationClass": "org.apache.camel.component.ibm.cos.IBMCOSConfiguration",
"configurationField": "configuration",
"description": "Use multi-part upload for large files"
},
"operation": {
"index": 20,
"kind": "property",
"displayName": "Operation",
"group": "producer",
"label": "producer",
"required": false,
"type": "enum",
"javaType": "org.apache.camel.component.ibm.cos.IBMCOSOperations",
"enum": [
"copyObject",
"listObjects",
"deleteObject",
"deleteObjects",
"deleteBucket",
"listBuckets",
"getObject",
"getObjectRange",
"headBucket",
"createBucket",
"putObject"
],
"deprecated": false,
"autowired": false,
"secret": false,
"configurationClass": "org.apache.camel.component.ibm.cos.IBMCOSConfiguration",
"configurationField": "configuration",
"description": "The operation to perform"
},
"partSize": {
"index": 21,
"kind": "property",
"displayName": "Part Size",
"group": "producer",
"label": "producer",
"required": false,
"type": "integer",
"javaType": "long",
"deprecated": false,
"autowired": false,
"secret": false,
"defaultValue": 26214400,
"configurationClass": "org.apache.camel.component.ibm.cos.IBMCOSConfiguration",
"configurationField": "configuration",
"description": "Part size for multi-part uploads (default 25MB)"
},
"storageClass": {
"index": 22,
"kind": "property",
"displayName": "Storage Class",
"group": "producer",
"label": "producer",
"required": false,
"type": "string",
"javaType": "java.lang.String",
"deprecated": false,
"autowired": false,
"secret": false,
"configurationClass": "org.apache.camel.component.ibm.cos.IBMCOSConfiguration",
"configurationField": "configuration",
"description": "The storage class to use when storing objects (e.g., STANDARD, VAULT, COLD, FLEX)"
},
"autowiredEnabled": {
"index": 23,
"kind": "property",
"displayName": "Autowired Enabled",
"group": "advanced",
"label": "advanced",
"required": false,
"type": "boolean",
"javaType": "boolean",
"deprecated": false,
"autowired": false,
"secret": false,
"defaultValue": true,
"description": "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."
},
"cosClient": {
"index": 24,
"kind": "property",
"displayName": "Cos Client",
"group": "advanced",
"label": "advanced",
"required": false,
"type": "object",
"javaType": "com.ibm.cloud.objectstorage.services.s3.AmazonS3",
"deprecated": false,
"deprecationNote": "",
"autowired": true,
"secret": false,
"configurationClass": "org.apache.camel.component.ibm.cos.IBMCOSConfiguration",
"configurationField": "configuration",
"description": "Reference to an IBM COS Client instance in the registry"
},
"healthCheckConsumerEnabled": {
"index": 25,
"kind": "property",
"displayName": "Health Check Consumer Enabled",
"group": "health",
"label": "health",
"required": false,
"type": "boolean",
"javaType": "boolean",
"deprecated": false,
"autowired": false,
"secret": false,
"defaultValue": true,
"description": "Used for enabling or disabling all consumer based health checks from this component"
},
"healthCheckProducerEnabled": {
"index": 26,
"kind": "property",
"displayName": "Health Check Producer Enabled",
"group": "health",
"label": "health",
"required": false,
"type": "boolean",
"javaType": "boolean",
"deprecated": false,
"autowired": false,
"secret": false,
"defaultValue": true,
"description": "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."
},
"apiKey": {
"index": 27,
"kind": "property",
"displayName": "Api Key",
"group": "security",
"label": "security",
"required": false,
"type": "string",
"javaType": "java.lang.String",
"deprecated": false,
"autowired": false,
"secret": true,
"configurationClass": "org.apache.camel.component.ibm.cos.IBMCOSConfiguration",
"configurationField": "configuration",
"description": "IBM Cloud API Key for authentication"
},
"serviceInstanceId": {
"index": 28,
"kind": "property",
"displayName": "Service Instance Id",
"group": "security",
"label": "security",
"required": false,
"type": "string",
"javaType": "java.lang.String",
"deprecated": false,
"autowired": false,
"secret": true,
"configurationClass": "org.apache.camel.component.ibm.cos.IBMCOSConfiguration",
"configurationField": "configuration",
"description": "IBM COS Service Instance ID (CRN)"
}
},
"headers": {
"CamelIBMCOSBucketName": {
"index": 0,
"kind": "header",
"displayName": "",
"group": "common",
"label": "",
"required": false,
"javaType": "String",
"deprecated": false,
"deprecationNote": "",
"autowired": false,
"secret": false,
"description": "The bucket Name which this object will be stored or which will be used for the current operation",
"constantName": "org.apache.camel.component.ibm.cos.IBMCOSConstants#BUCKET_NAME"
},
"CamelIBMCOSBucketDestinationName": {
"index": 1,
"kind": "header",
"displayName": "",
"group": "producer",
"label": "producer",
"required": false,
"javaType": "String",
"deprecated": false,
"deprecationNote": "",
"autowired": false,
"secret": false,
"description": "The bucket Destination Name which will be used for the current operation",
"constantName": "org.apache.camel.component.ibm.cos.IBMCOSConstants#BUCKET_DESTINATION_NAME"
},
"CamelIBMCOSContentControl": {
"index": 2,
"kind": "header",
"displayName": "",
"group": "common",
"label": "",
"required": false,
"javaType": "String",
"deprecated": false,
"deprecationNote": "",
"autowired": false,
"secret": false,
"description": "The optional Cache-Control HTTP header which allows the user to specify caching behavior",
"constantName": "org.apache.camel.component.ibm.cos.IBMCOSConstants#CACHE_CONTROL"
},
"CamelIBMCOSContentDisposition": {
"index": 3,
"kind": "header",
"displayName": "",
"group": "common",
"label": "",
"required": false,
"javaType": "String",
"deprecated": false,
"deprecationNote": "",
"autowired": false,
"secret": false,
"description": "The optional Content-Disposition HTTP header, which specifies presentational information such as the recommended filename",
"constantName": "org.apache.camel.component.ibm.cos.IBMCOSConstants#CONTENT_DISPOSITION"
},
"CamelIBMCOSContentEncoding": {
"index": 4,
"kind": "header",
"displayName": "",
"group": "common",
"label": "",
"required": false,
"javaType": "String",
"deprecated": false,
"deprecationNote": "",
"autowired": false,
"secret": false,
"description": "The optional Content-Encoding HTTP header specifying what content encodings have been applied to the object",
"constantName": "org.apache.camel.component.ibm.cos.IBMCOSConstants#CONTENT_ENCODING"
},
"CamelIBMCOSContentLength": {
"index": 5,
"kind": "header",
"displayName": "",
"group": "common",
"label": "",
"required": false,
"javaType": "Long",
"deprecated": false,
"deprecationNote": "",
"autowired": false,
"secret": false,
"description": "The Content-Length HTTP header indicating the size of the associated object in bytes",
"constantName": "org.apache.camel.component.ibm.cos.IBMCOSConstants#CONTENT_LENGTH"
},
"CamelIBMCOSContentMD5": {
"index": 6,
"kind": "header",
"displayName": "",
"group": "common",
"label": "",
"required": false,
"javaType": "String",
"deprecated": false,
"deprecationNote": "",
"autowired": false,
"secret": false,
"description": "The base64 encoded 128-bit MD5 digest of the associated object",
"constantName": "org.apache.camel.component.ibm.cos.IBMCOSConstants#CONTENT_MD5"
},
"CamelIBMCOSContentType": {
"index": 7,
"kind": "header",
"displayName": "",
"group": "common",
"label": "",
"required": false,
"javaType": "String",
"deprecated": false,
"deprecationNote": "",
"autowired": false,
"secret": false,
"description": "The Content-Type HTTP header, which indicates the type of content stored in the associated object",
"constantName": "org.apache.camel.component.ibm.cos.IBMCOSConstants#CONTENT_TYPE"
},
"CamelIBMCOSETag": {
"index": 8,
"kind": "header",
"displayName": "",
"group": "common",
"label": "",
"required": false,
"javaType": "String",
"deprecated": false,
"deprecationNote": "",
"autowired": false,
"secret": false,
"description": "The ETag value for the object",
"constantName": "org.apache.camel.component.ibm.cos.IBMCOSConstants#E_TAG"
},
"CamelIBMCOSKey": {
"index": 9,
"kind": "header",
"displayName": "",
"group": "common",
"label": "",
"required": false,
"javaType": "String",
"deprecated": false,
"deprecationNote": "",
"autowired": false,
"secret": false,
"description": "The key under which this object is stored or will be stored",
"constantName": "org.apache.camel.component.ibm.cos.IBMCOSConstants#KEY"
},
"CamelIBMCOSDestinationKey": {
"index": 10,
"kind": "header",
"displayName": "",
"group": "producer",
"label": "producer",
"required": false,
"javaType": "String",
"deprecated": false,
"deprecationNote": "",
"autowired": false,
"secret": false,
"description": "The Destination key which will be used for the current operation",
"constantName": "org.apache.camel.component.ibm.cos.IBMCOSConstants#DESTINATION_KEY"
},
"CamelIBMCOSLastModified": {
"index": 11,
"kind": "header",
"displayName": "",
"group": "common",
"label": "",
"required": false,
"javaType": "java.util.Date",
"deprecated": false,
"deprecationNote": "",
"autowired": false,
"secret": false,
"description": "The value of the Last-Modified header, indicating the date and time at which IBM COS last recorded a modification to the object",
"constantName": "org.apache.camel.component.ibm.cos.IBMCOSConstants#LAST_MODIFIED"
},
"CamelIBMCOSVersionId": {
"index": 12,
"kind": "header",
"displayName": "",
"group": "common",
"label": "",
"required": false,
"javaType": "String",
"deprecated": false,
"deprecationNote": "",
"autowired": false,
"secret": false,
"description": "The version ID of the associated IBM COS object if available",
"constantName": "org.apache.camel.component.ibm.cos.IBMCOSConstants#VERSION_ID"
},
"CamelIBMCOSOperation": {
"index": 13,
"kind": "header",
"displayName": "",
"group": "common",
"label": "",
"required": false,
"javaType": "String",
"deprecated": false,
"deprecationNote": "",
"autowired": false,
"secret": false,
"description": "The operation to perform",
"constantName": "org.apache.camel.component.ibm.cos.IBMCOSConstants#COS_OPERATION"
},
"CamelIBMCOSPrefix": {
"index": 14,
"kind": "header",
"displayName": "",
"group": "common",
"label": "",
"required": false,
"javaType": "String",
"deprecated": false,
"deprecationNote": "",
"autowired": false,
"secret": false,
"description": "The prefix which is used to filter objects",
"constantName": "org.apache.camel.component.ibm.cos.IBMCOSConstants#PREFIX"
},
"CamelIBMCOSDelimiter": {
"index": 15,
"kind": "header",
"displayName": "",
"group": "common",
"label": "",
"required": false,
"javaType": "String",
"deprecated": false,
"deprecationNote": "",
"autowired": false,
"secret": false,
"description": "The delimiter which is used to filter objects",
"constantName": "org.apache.camel.component.ibm.cos.IBMCOSConstants#DELIMITER"
},
"CamelIBMCOSKeysToDelete": {
"index": 16,
"kind": "header",
"displayName": "",
"group": "producer",
"label": "producer",
"required": false,
"javaType": "java.util.List<String>",
"deprecated": false,
"deprecationNote": "",
"autowired": false,
"secret": false,
"description": "A list of keys to delete when using deleteObjects operation",
"constantName": "org.apache.camel.component.ibm.cos.IBMCOSConstants#KEYS_TO_DELETE"
},
"CamelIBMCOSMetadata": {
"index": 17,
"kind": "header",
"displayName": "",
"group": "common",
"label": "",
"required": false,
"javaType": "java.util.Map<String, String>",
"deprecated": false,
"deprecationNote": "",
"autowired": false,
"secret": false,
"description": "A map of metadata to be stored with the object in IBM COS",
"constantName": "org.apache.camel.component.ibm.cos.IBMCOSConstants#METADATA"
},
"CamelIBMCOSRangeStart": {
"index": 18,
"kind": "header",
"displayName": "",
"group": "producer",
"label": "producer",
"required": false,
"javaType": "Long",
"deprecated": false,
"deprecationNote": "",
"autowired": false,
"secret": false,
"description": "The range start position for partial object retrieval",
"constantName": "org.apache.camel.component.ibm.cos.IBMCOSConstants#RANGE_START"
},
"CamelIBMCOSRangeEnd": {
"index": 19,
"kind": "header",
"displayName": "",
"group": "producer",
"label": "producer",
"required": false,
"javaType": "Long",
"deprecated": false,
"deprecationNote": "",
"autowired": false,
"secret": false,
"description": "The range end position for partial object retrieval",
"constantName": "org.apache.camel.component.ibm.cos.IBMCOSConstants#RANGE_END"
},
"CamelIBMCOSBucketExists": {
"index": 20,
"kind": "header",
"displayName": "",
"group": "producer",
"label": "producer",
"required": false,
"javaType": "Boolean",
"deprecated": false,
"deprecationNote": "",
"autowired": false,
"secret": false,
"description": "Whether the bucket exists or not",
"constantName": "org.apache.camel.component.ibm.cos.IBMCOSConstants#BUCKET_EXISTS"
}
},
"properties": {
"bucketName": {
"index": 0,
"kind": "path",
"displayName": "Bucket Name",
"group": "common",
"label": "",
"required": true,
"type": "string",
"javaType": "java.lang.String",
"deprecated": false,
"deprecationNote": "",
"autowired": false,
"secret": false,
"description": "Bucket name"
},
"autoCreateBucket": {
"index": 1,
"kind": "parameter",
"displayName": "Auto Create Bucket",
"group": "common",
"label": "common",
"required": false,
"type": "boolean",
"javaType": "boolean",
"deprecated": false,
"autowired": false,
"secret": false,
"defaultValue": false,
"configurationClass": "org.apache.camel.component.ibm.cos.IBMCOSConfiguration",
"configurationField": "configuration",
"description": "Automatically create the bucket if it doesn't exist"
},
"delimiter": {
"index": 2,
"kind": "parameter",
"displayName": "Delimiter",
"group": "common",
"label": "",
"required": false,
"type": "string",
"javaType": "java.lang.String",
"deprecated": false,
"autowired": false,
"secret": false,
"configurationClass": "org.apache.camel.component.ibm.cos.IBMCOSConfiguration",
"configurationField": "configuration",
"description": "The delimiter to use for listing objects"
},
"endpointUrl": {
"index": 3,
"kind": "parameter",
"displayName": "Endpoint Url",
"group": "common",
"label": "",
"required": false,
"type": "string",
"javaType": "java.lang.String",
"deprecated": false,
"autowired": false,
"secret": false,
"configurationClass": "org.apache.camel.component.ibm.cos.IBMCOSConfiguration",
"configurationField": "configuration",
"description": "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": {
"index": 4,
"kind": "parameter",
"displayName": "Location",
"group": "common",
"label": "",
"required": false,
"type": "string",
"javaType": "java.lang.String",
"deprecated": false,
"autowired": false,
"secret": false,
"configurationClass": "org.apache.camel.component.ibm.cos.IBMCOSConfiguration",
"configurationField": "configuration",
"description": "IBM COS Location/Region (e.g., us-south, eu-gb)"
},
"prefix": {
"index": 5,
"kind": "parameter",
"displayName": "Prefix",
"group": "common",
"label": "",
"required": false,
"type": "string",
"javaType": "java.lang.String",
"deprecated": false,
"autowired": false,
"secret": false,
"configurationClass": "org.apache.camel.component.ibm.cos.IBMCOSConfiguration",
"configurationField": "configuration",
"description": "The prefix to use for listing objects"
},
"deleteAfterRead": {
"index": 6,
"kind": "parameter",
"displayName": "Delete After Read",
"group": "consumer",
"label": "consumer",
"required": false,
"type": "boolean",
"javaType": "boolean",
"deprecated": false,
"autowired": false,
"secret": false,
"defaultValue": true,
"configurationClass": "org.apache.camel.component.ibm.cos.IBMCOSConfiguration",
"configurationField": "configuration",
"description": "Delete the object from IBM COS after it has been retrieved"
},
"destinationBucket": {
"index": 7,
"kind": "parameter",
"displayName": "Destination Bucket",
"group": "consumer",
"label": "consumer",
"required": false,
"type": "string",
"javaType": "java.lang.String",
"deprecated": false,
"autowired": false,
"secret": false,
"configurationClass": "org.apache.camel.component.ibm.cos.IBMCOSConfiguration",
"configurationField": "configuration",
"description": "The destination bucket to move objects to"
},
"destinationBucketPrefix": {
"index": 8,
"kind": "parameter",
"displayName": "Destination Bucket Prefix",
"group": "consumer",
"label": "consumer",
"required": false,
"type": "string",
"javaType": "java.lang.String",
"deprecated": false,
"autowired": false,
"secret": false,
"configurationClass": "org.apache.camel.component.ibm.cos.IBMCOSConfiguration",
"configurationField": "configuration",
"description": "The prefix to add to objects in the destination bucket"
},
"destinationBucketSuffix": {
"index": 9,
"kind": "parameter",
"displayName": "Destination Bucket Suffix",
"group": "consumer",
"label": "consumer",
"required": false,
"type": "string",
"javaType": "java.lang.String",
"deprecated": false,
"autowired": false,
"secret": false,
"configurationClass": "org.apache.camel.component.ibm.cos.IBMCOSConfiguration",
"configurationField": "configuration",
"description": "The suffix to add to objects in the destination bucket"
},
"fileName": {
"index": 10,
"kind": "parameter",
"displayName": "File Name",
"group": "consumer",
"label": "consumer",
"required": false,
"type": "string",
"javaType": "java.lang.String",
"deprecated": false,
"autowired": false,
"secret": false,
"configurationClass": "org.apache.camel.component.ibm.cos.IBMCOSConfiguration",
"configurationField": "configuration",
"description": "To get the object from the bucket with the given file name"
},
"includeBody": {
"index": 11,
"kind": "parameter",
"displayName": "Include Body",
"group": "consumer",
"label": "consumer",
"required": false,
"type": "boolean",
"javaType": "boolean",
"deprecated": false,
"autowired": false,
"secret": false,
"defaultValue": true,
"configurationClass": "org.apache.camel.component.ibm.cos.IBMCOSConfiguration",
"configurationField": "configuration",
"description": "Include the object body in the exchange"
},
"includeFolders": {
"index": 12,
"kind": "parameter",
"displayName": "Include Folders",
"group": "consumer",
"label": "consumer",
"required": false,
"type": "boolean",
"javaType": "boolean",
"deprecated": false,
"autowired": false,
"secret": false,
"defaultValue": true,
"configurationClass": "org.apache.camel.component.ibm.cos.IBMCOSConfiguration",
"configurationField": "configuration",
"description": "Include folders/directories when listing objects"
},
"maxMessagesPerPoll": {
"index": 13,
"kind": "parameter",
"displayName": "Max Messages Per Poll",
"group": "consumer",
"label": "consumer",
"required": false,
"type": "integer",
"javaType": "int",
"deprecated": false,
"autowired": false,
"secret": false,
"defaultValue": 10,
"description": "Gets the maximum number of messages as a limit to poll at each polling."
},
"moveAfterRead": {
"index": 14,
"kind": "parameter",
"displayName": "Move After Read",
"group": "consumer",
"label": "consumer",
"required": false,
"type": "boolean",
"javaType": "boolean",
"deprecated": false,
"autowired": false,
"secret": false,
"defaultValue": false,
"configurationClass": "org.apache.camel.component.ibm.cos.IBMCOSConfiguration",
"configurationField": "configuration",
"description": "Move the object to a different bucket after it has been retrieved"
},
"sendEmptyMessageWhenIdle": {
"index": 15,
"kind": "parameter",
"displayName": "Send Empty Message When Idle",
"group": "consumer",
"label": "consumer",
"required": false,
"type": "boolean",
"javaType": "boolean",
"deprecated": false,
"autowired": false,
"secret": false,
"defaultValue": false,
"description": "If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead."
},
"autocloseBody": {
"index": 16,
"kind": "parameter",
"displayName": "Autoclose Body",
"group": "consumer (advanced)",
"label": "consumer,advanced",
"required": false,
"type": "boolean",
"javaType": "boolean",
"deprecated": false,
"autowired": false,
"secret": false,
"defaultValue": true,
"configurationClass": "org.apache.camel.component.ibm.cos.IBMCOSConfiguration",
"configurationField": "configuration",
"description": "Whether to automatically close the object input stream after processing"
},
"bridgeErrorHandler": {
"index": 17,
"kind": "parameter",
"displayName": "Bridge Error Handler",
"group": "consumer (advanced)",
"label": "consumer,advanced",
"required": false,
"type": "boolean",
"javaType": "boolean",
"deprecated": false,
"autowired": false,
"secret": false,
"defaultValue": false,
"description": "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": {
"index": 18,
"kind": "parameter",
"displayName": "Exception Handler",
"group": "consumer (advanced)",
"label": "consumer,advanced",
"required": false,
"type": "object",
"javaType": "org.apache.camel.spi.ExceptionHandler",
"optionalPrefix": "consumer.",
"deprecated": false,
"autowired": false,
"secret": false,
"description": "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": {
"index": 19,
"kind": "parameter",
"displayName": "Exchange Pattern",
"group": "consumer (advanced)",
"label": "consumer,advanced",
"required": false,
"type": "enum",
"javaType": "org.apache.camel.ExchangePattern",
"enum": [
"InOnly",
"InOut"
],
"deprecated": false,
"autowired": false,
"secret": false,
"description": "Sets the exchange pattern when the consumer creates an exchange."
},
"inProgressRepository": {
"index": 20,
"kind": "parameter",
"displayName": "In Progress Repository",
"group": "consumer (advanced)",
"label": "consumer,advanced",
"required": false,
"type": "object",
"javaType": "org.apache.camel.spi.IdempotentRepository",
"deprecated": false,
"autowired": false,
"secret": false,
"description": "A pluggable in-progress repository to track objects being consumed"
},
"pollStrategy": {
"index": 21,
"kind": "parameter",
"displayName": "Poll Strategy",
"group": "consumer (advanced)",
"label": "consumer,advanced",
"required": false,
"type": "object",
"javaType": "org.apache.camel.spi.PollingConsumerPollStrategy",
"deprecated": false,
"autowired": false,
"secret": false,
"description": "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": {
"index": 22,
"kind": "parameter",
"displayName": "Delete After Write",
"group": "producer",
"label": "producer",
"required": false,
"type": "boolean",
"javaType": "boolean",
"deprecated": false,
"autowired": false,
"secret": false,
"defaultValue": false,
"configurationClass": "org.apache.camel.component.ibm.cos.IBMCOSConfiguration",
"configurationField": "configuration",
"description": "Delete the object from the local filesystem after uploading"
},
"keyName": {
"index": 23,
"kind": "parameter",
"displayName": "Key Name",
"group": "producer",
"label": "producer",
"required": false,
"type": "string",
"javaType": "java.lang.String",
"deprecated": false,
"autowired": false,
"secret": false,
"configurationClass": "org.apache.camel.component.ibm.cos.IBMCOSConfiguration",
"configurationField": "configuration",
"description": "The key name for the object"
},
"multiPartUpload": {
"index": 24,
"kind": "parameter",
"displayName": "Multi Part Upload",
"group": "producer",
"label": "producer",
"required": false,
"type": "boolean",
"javaType": "boolean",
"deprecated": false,
"autowired": false,
"secret": false,
"defaultValue": false,
"configurationClass": "org.apache.camel.component.ibm.cos.IBMCOSConfiguration",
"configurationField": "configuration",
"description": "Use multi-part upload for large files"
},
"operation": {
"index": 25,
"kind": "parameter",
"displayName": "Operation",
"group": "producer",
"label": "producer",
"required": false,
"type": "enum",
"javaType": "org.apache.camel.component.ibm.cos.IBMCOSOperations",
"enum": [
"copyObject",
"listObjects",
"deleteObject",
"deleteObjects",
"deleteBucket",
"listBuckets",
"getObject",
"getObjectRange",
"headBucket",
"createBucket",
"putObject"
],
"deprecated": false,
"autowired": false,
"secret": false,
"configurationClass": "org.apache.camel.component.ibm.cos.IBMCOSConfiguration",
"configurationField": "configuration",
"description": "The operation to perform"
},
"partSize": {
"index": 26,
"kind": "parameter",
"displayName": "Part Size",
"group": "producer",
"label": "producer",
"required": false,
"type": "integer",
"javaType": "long",
"deprecated": false,
"autowired": false,
"secret": false,
"defaultValue": 26214400,
"configurationClass": "org.apache.camel.component.ibm.cos.IBMCOSConfiguration",
"configurationField": "configuration",
"description": "Part size for multi-part uploads (default 25MB)"
},
"storageClass": {
"index": 27,
"kind": "parameter",
"displayName": "Storage Class",
"group": "producer",
"label": "producer",
"required": false,
"type": "string",
"javaType": "java.lang.String",
"deprecated": false,
"autowired": false,
"secret": false,
"configurationClass": "org.apache.camel.component.ibm.cos.IBMCOSConfiguration",
"configurationField": "configuration",
"description": "The storage class to use when storing objects (e.g., STANDARD, VAULT, COLD, FLEX)"
},
"lazyStartProducer": {
"index": 28,
"kind": "parameter",
"displayName": "Lazy Start Producer",
"group": "producer (advanced)",
"label": "producer,advanced",
"required": false,
"type": "boolean",
"javaType": "boolean",
"deprecated": false,
"autowired": false,
"secret": false,
"defaultValue": false,
"description": "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": {
"index": 29,
"kind": "parameter",
"displayName": "Cos Client",
"group": "advanced",
"label": "advanced",
"required": false,
"type": "object",
"javaType": "com.ibm.cloud.objectstorage.services.s3.AmazonS3",
"deprecated": false,
"deprecationNote": "",
"autowired": true,
"secret": false,
"configurationClass": "org.apache.camel.component.ibm.cos.IBMCOSConfiguration",
"configurationField": "configuration",
"description": "Reference to an IBM COS Client instance in the registry"
},
"backoffErrorThreshold": {
"index": 30,
"kind": "parameter",
"displayName": "Backoff Error Threshold",
"group": "scheduler",
"label": "consumer,scheduler",
"required": false,
"type": "integer",
"javaType": "int",
"deprecated": false,
"autowired": false,
"secret": false,
"description": "The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in."
},
"backoffIdleThreshold": {
"index": 31,
"kind": "parameter",
"displayName": "Backoff Idle Threshold",
"group": "scheduler",
"label": "consumer,scheduler",
"required": false,
"type": "integer",
"javaType": "int",
"deprecated": false,
"autowired": false,
"secret": false,
"description": "The number of subsequent idle polls that should happen before the backoffMultipler should kick-in."
},
"backoffMultiplier": {
"index": 32,
"kind": "parameter",
"displayName": "Backoff Multiplier",
"group": "scheduler",
"label": "consumer,scheduler",
"required": false,
"type": "integer",
"javaType": "int",
"deprecated": false,
"autowired": false,
"secret": false,
"description": "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": {
"index": 33,
"kind": "parameter",
"displayName": "Delay",
"group": "scheduler",
"label": "consumer,scheduler",
"required": false,
"type": "integer",
"javaType": "long",
"deprecated": false,
"autowired": false,
"secret": false,
"defaultValue": 500,
"description": "Milliseconds before the next poll."
},
"greedy": {
"index": 34,
"kind": "parameter",
"displayName": "Greedy",
"group": "scheduler",
"label": "consumer,scheduler",
"required": false,
"type": "boolean",
"javaType": "boolean",
"deprecated": false,
"autowired": false,
"secret": false,
"defaultValue": false,
"description": "If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages."
},
"initialDelay": {
"index": 35,
"kind": "parameter",
"displayName": "Initial Delay",
"group": "scheduler",
"label": "consumer,scheduler",
"required": false,
"type": "integer",
"javaType": "long",
"deprecated": false,
"autowired": false,
"secret": false,
"defaultValue": 1000,
"description": "Milliseconds before the first poll starts."
},
"repeatCount": {
"index": 36,
"kind": "parameter",
"displayName": "Repeat Count",
"group": "scheduler",
"label": "consumer,scheduler",
"required": false,
"type": "integer",
"javaType": "long",
"deprecated": false,
"autowired": false,
"secret": false,
"defaultValue": 0,
"description": "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": {
"index": 37,
"kind": "parameter",
"displayName": "Run Logging Level",
"group": "scheduler",
"label": "consumer,scheduler",
"required": false,
"type": "enum",
"javaType": "org.apache.camel.LoggingLevel",
"enum": [
"TRACE",
"DEBUG",
"INFO",
"WARN",
"ERROR",
"OFF"
],
"deprecated": false,
"autowired": false,
"secret": false,
"defaultValue": "TRACE",
"description": "The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that."
},
"scheduledExecutorService": {
"index": 38,
"kind": "parameter",
"displayName": "Scheduled Executor Service",
"group": "scheduler",
"label": "consumer,scheduler",
"required": false,
"type": "object",
"javaType": "java.util.concurrent.ScheduledExecutorService",
"deprecated": false,
"autowired": false,
"secret": false,
"description": "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": {
"index": 39,
"kind": "parameter",
"displayName": "Scheduler",
"group": "scheduler",
"label": "consumer,scheduler",
"required": false,
"type": "object",
"javaType": "java.lang.Object",
"deprecated": false,
"autowired": false,
"secret": false,
"defaultValue": "none",
"description": "To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler"
},
"schedulerProperties": {
"index": 40,
"kind": "parameter",
"displayName": "Scheduler Properties",
"group": "scheduler",
"label": "consumer,scheduler",
"required": false,
"type": "object",
"javaType": "java.util.Map<java.lang.String, java.lang.Object>",
"prefix": "scheduler.",
"multiValue": true,
"deprecated": false,
"autowired": false,
"secret": false,
"description": "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": {
"index": 41,
"kind": "parameter",
"displayName": "Start Scheduler",
"group": "scheduler",
"label": "consumer,scheduler",
"required": false,
"type": "boolean",
"javaType": "boolean",
"deprecated": false,
"autowired": false,
"secret": false,
"defaultValue": true,
"description": "Whether the scheduler should be auto started."
},
"timeUnit": {
"index": 42,
"kind": "parameter",
"displayName": "Time Unit",
"group": "scheduler",
"label": "consumer,scheduler",
"required": false,
"type": "enum",
"javaType": "java.util.concurrent.TimeUnit",
"enum": [
"NANOSECONDS",
"MICROSECONDS",
"MILLISECONDS",
"SECONDS",
"MINUTES",
"HOURS",
"DAYS"
],
"deprecated": false,
"autowired": false,
"secret": false,
"defaultValue": "MILLISECONDS",
"description": "Time unit for initialDelay and delay options."
},
"useFixedDelay": {
"index": 43,
"kind": "parameter",
"displayName": "Use Fixed Delay",
"group": "scheduler",
"label": "consumer,scheduler",
"required": false,
"type": "boolean",
"javaType": "boolean",
"deprecated": false,
"autowired": false,
"secret": false,
"defaultValue": true,
"description": "Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details."
},
"apiKey": {
"index": 44,
"kind": "parameter",
"displayName": "Api Key",
"group": "security",
"label": "security",
"required": false,
"type": "string",
"javaType": "java.lang.String",
"deprecated": false,
"autowired": false,
"secret": true,
"configurationClass": "org.apache.camel.component.ibm.cos.IBMCOSConfiguration",
"configurationField": "configuration",
"description": "IBM Cloud API Key for authentication"
},
"serviceInstanceId": {
"index": 45,
"kind": "parameter",
"displayName": "Service Instance Id",
"group": "security",
"label": "security",
"required": false,
"type": "string",
"javaType": "java.lang.String",
"deprecated": false,
"autowired": false,
"secret": true,
"configurationClass": "org.apache.camel.component.ibm.cos.IBMCOSConfiguration",
"configurationField": "configuration",
"description": "IBM COS Service Instance ID (CRN)"
}
},
"propertiesSchema": {
"properties": {
"bucketName": {
"title": "Bucket Name",
"description": "Bucket name",
"type": "string",
"$comment": "group:common"
},
"autoCreateBucket": {
"title": "Auto Create Bucket",
"description": "Automatically create the bucket if it doesn't exist",
"type": "boolean",
"$comment": "group:common",
"default": false
},
"delimiter": {
"title": "Delimiter",
"description": "The delimiter to use for listing objects",
"type": "string",
"$comment": "group:common"
},
"endpointUrl": {
"title": "Endpoint Url",
"description": "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.",
"type": "string",
"$comment": "group:common"
},
"location": {
"title": "Location",
"description": "IBM COS Location/Region (e.g., us-south, eu-gb)",
"type": "string",
"$comment": "group:common"
},
"prefix": {
"title": "Prefix",
"description": "The prefix to use for listing objects",
"type": "string",
"$comment": "group:common"
},
"deleteAfterRead": {
"title": "Delete After Read",
"description": "Delete the object from IBM COS after it has been retrieved",
"type": "boolean",
"$comment": "group:consumer",
"default": true
},
"destinationBucket": {
"title": "Destination Bucket",
"description": "The destination bucket to move objects to",
"type": "string",
"$comment": "group:consumer"
},
"destinationBucketPrefix": {
"title": "Destination Bucket Prefix",
"description": "The prefix to add to objects in the destination bucket",
"type": "string",
"$comment": "group:consumer"
},
"destinationBucketSuffix": {
"title": "Destination Bucket Suffix",
"description": "The suffix to add to objects in the destination bucket",
"type": "string",
"$comment": "group:consumer"
},
"fileName": {
"title": "File Name",
"description": "To get the object from the bucket with the given file name",
"type": "string",
"$comment": "group:consumer"
},
"includeBody": {
"title": "Include Body",
"description": "Include the object body in the exchange",
"type": "boolean",
"$comment": "group:consumer",
"default": true
},
"includeFolders": {
"title": "Include Folders",
"description": "Include folders/directories when listing objects",
"type": "boolean",
"$comment": "group:consumer",
"default": true
},
"maxMessagesPerPoll": {
"title": "Max Messages Per Poll",
"description": "Gets the maximum number of messages as a limit to poll at each polling.",
"type": "integer",
"$comment": "group:consumer",
"default": 10
},
"moveAfterRead": {
"title": "Move After Read",
"description": "Move the object to a different bucket after it has been retrieved",
"type": "boolean",
"$comment": "group:consumer",
"default": false
},
"sendEmptyMessageWhenIdle": {
"title": "Send Empty Message When Idle",
"description": "If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead.",
"type": "boolean",
"$comment": "group:consumer",
"default": false
},
"autocloseBody": {
"title": "Autoclose Body",
"description": "Whether to automatically close the object input stream after processing",
"type": "boolean",
"$comment": "group:consumer (advanced)",
"default": true
},
"bridgeErrorHandler": {
"title": "Bridge Error Handler",
"description": "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.",
"type": "boolean",
"$comment": "group:consumer (advanced)",
"default": false
},
"exceptionHandler": {
"title": "Exception Handler",
"description": "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.",
"type": "string",
"$comment": "group:consumer (advanced)",
"format": "bean:org.apache.camel.spi.ExceptionHandler"
},
"exchangePattern": {
"title": "Exchange Pattern",
"description": "Sets the exchange pattern when the consumer creates an exchange.",
"type": "string",
"enum": [
"InOnly",
"InOut"
],
"$comment": "group:consumer (advanced)"
},
"inProgressRepository": {
"title": "In Progress Repository",
"description": "A pluggable in-progress repository to track objects being consumed",
"type": "string",
"$comment": "group:consumer (advanced)",
"format": "bean:org.apache.camel.spi.IdempotentRepository"
},
"pollStrategy": {
"title": "Poll Strategy",
"description": "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.",
"type": "string",
"$comment": "group:consumer (advanced)",
"format": "bean:org.apache.camel.spi.PollingConsumerPollStrategy"
},
"deleteAfterWrite": {
"title": "Delete After Write",
"description": "Delete the object from the local filesystem after uploading",
"type": "boolean",
"$comment": "group:producer",
"default": false
},
"keyName": {
"title": "Key Name",
"description": "The key name for the object",
"type": "string",
"$comment": "group:producer"
},
"multiPartUpload": {
"title": "Multi Part Upload",
"description": "Use multi-part upload for large files",
"type": "boolean",
"$comment": "group:producer",
"default": false
},
"operation": {
"title": "Operation",
"description": "The operation to perform",
"type": "string",
"enum": [
"copyObject",
"listObjects",
"deleteObject",
"deleteObjects",
"deleteBucket",
"listBuckets",
"getObject",
"getObjectRange",
"headBucket",
"createBucket",
"putObject"
],
"$comment": "group:producer"
},
"partSize": {
"title": "Part Size",
"description": "Part size for multi-part uploads (default 25MB)",
"type": "integer",
"$comment": "group:producer",
"default": 26214400
},
"storageClass": {
"title": "Storage Class",
"description": "The storage class to use when storing objects (e.g., STANDARD, VAULT, COLD, FLEX)",
"type": "string",
"$comment": "group:producer"
},
"lazyStartProducer": {
"title": "Lazy Start Producer",
"description": "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.",
"type": "boolean",
"$comment": "group:producer (advanced)",
"default": false
},
"cosClient": {
"title": "Cos Client",
"description": "Reference to an IBM COS Client instance in the registry",
"type": "string",
"$comment": "group:advanced",
"format": "bean:com.ibm.cloud.objectstorage.services.s3.AmazonS3"
},
"backoffErrorThreshold": {
"title": "Backoff Error Threshold",
"description": "The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.",
"type": "integer",
"$comment": "group:scheduler"
},
"backoffIdleThreshold": {
"title": "Backoff Idle Threshold",
"description": "The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.",
"type": "integer",
"$comment": "group:scheduler"
},
"backoffMultiplier": {
"title": "Backoff Multiplier",
"description": "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.",
"type": "integer",
"$comment": "group:scheduler"
},
"delay": {
"title": "Delay",
"description": "Milliseconds before the next poll.",
"type": "integer",
"$comment": "group:scheduler",
"default": 500
},
"greedy": {
"title": "Greedy",
"description": "If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages.",
"type": "boolean",
"$comment": "group:scheduler",
"default": false
},
"initialDelay": {
"title": "Initial Delay",
"description": "Milliseconds before the first poll starts.",
"type": "integer",
"$comment": "group:scheduler",
"default": 1000
},
"repeatCount": {
"title": "Repeat Count",
"description": "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.",
"type": "integer",
"$comment": "group:scheduler",
"default": 0
},
"runLoggingLevel": {
"title": "Run Logging Level",
"description": "The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that.",
"type": "string",
"enum": [
"TRACE",
"DEBUG",
"INFO",
"WARN",
"ERROR",
"OFF"
],
"$comment": "group:scheduler",
"default": "TRACE"
},
"scheduledExecutorService": {
"title": "Scheduled Executor Service",
"description": "Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool.",
"type": "string",
"$comment": "group:scheduler",
"format": "bean:java.util.concurrent.ScheduledExecutorService"
},
"scheduler": {
"title": "Scheduler",
"description": "To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler",
"type": "string",
"$comment": "group:scheduler",
"format": "bean:java.lang.Object",
"default": "none"
},
"schedulerProperties": {
"title": "Scheduler Properties",
"description": "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.",
"type": "object",
"$comment": "group:scheduler"
},
"startScheduler": {
"title": "Start Scheduler",
"description": "Whether the scheduler should be auto started.",
"type": "boolean",
"$comment": "group:scheduler",
"default": true
},
"timeUnit": {
"title": "Time Unit",
"description": "Time unit for initialDelay and delay options.",
"type": "string",
"enum": [
"NANOSECONDS",
"MICROSECONDS",
"MILLISECONDS",
"SECONDS",
"MINUTES",
"HOURS",
"DAYS"
],
"$comment": "group:scheduler",
"default": "MILLISECONDS"
},
"useFixedDelay": {
"title": "Use Fixed Delay",
"description": "Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details.",
"type": "boolean",
"$comment": "group:scheduler",
"default": true
},
"apiKey": {
"title": "Api Key",
"description": "IBM Cloud API Key for authentication",
"type": "string",
"$comment": "group:security",
"format": "password"
},
"serviceInstanceId": {
"title": "Service Instance Id",
"description": "IBM COS Service Instance ID (CRN)",
"type": "string",
"$comment": "group:security",
"format": "password"
}
},
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"required": [
"bucketName"
]
}
}
Reference in New Issue Copy Permalink