{"component":{"kind":"component","name":"hwcloud-obs","title":"Huawei Object Storage Service (OBS)","description":"To provide stable, secure, efficient, and easy-to-use cloud storage service on Huawei Cloud","deprecated":false,"firstVersion":"3.12.0","label":"cloud","javaType":"org.apache.camel.component.huaweicloud.obs.OBSComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-huaweicloud-obs","version":"3.18.0","scheme":"hwcloud-obs","extendsScheme":"","syntax":"hwcloud-obs:operation","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false},"headers":{"CamelHwCloudObsBucketName":{"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of the bucket where object is contained","constantName":"org.apache.camel.component.huaweicloud.obs.constants.OBSHeaders#BUCKET_NAME"},"CamelHwCloudObsObjectKey":{"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The key that the object is stored under","constantName":"org.apache.camel.component.huaweicloud.obs.constants.OBSHeaders#OBJECT_KEY"},"CamelHwCloudObsLastModified":{"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Date","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The date and time that the object was last modified","constantName":"org.apache.camel.component.huaweicloud.obs.constants.OBSHeaders#LAST_MODIFIED"},"CamelHwCloudObsETag":{"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The 128-bit MD5 digest of the Base64 code of the object. This data is the unique identifier of the object content","constantName":"org.apache.camel.component.huaweicloud.obs.constants.OBSHeaders#ETAG"},"CamelHwCloudObsContentMD5":{"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The 128-bit Base64-encoded digest used to decrypt the object","constantName":"org.apache.camel.component.huaweicloud.obs.constants.OBSHeaders#CONTENT_MD5"},"CamelHwCloudObsObjectType":{"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Shows whether the object is a file or a folder","constantName":"org.apache.camel.component.huaweicloud.obs.constants.OBSHeaders#OBJECT_TYPE"},"Content-Length":{"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The size of the object body in bytes","constantName":"org.apache.camel.component.huaweicloud.obs.constants.OBSHeaders#CONTENT_LENGTH"},"Content-Type":{"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The type of content stored in the object","constantName":"org.apache.camel.component.huaweicloud.obs.constants.OBSHeaders#CONTENT_TYPE"},"CamelFileName":{"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of the object with which the operation is to be performed","constantName":"org.apache.camel.component.huaweicloud.obs.constants.OBSHeaders#FILE_NAME"}},"properties":{"operation":{"kind":"path","displayName":"Operation","group":"producer","label":"producer","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Operation to be performed"},"bucketName":{"kind":"parameter","displayName":"Bucket Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of bucket to perform operation on"},"endpoint":{"kind":"parameter","displayName":"Endpoint url","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"OBS url. Carries higher precedence than region parameter based client initialization"},"objectName":{"kind":"parameter","displayName":"Object Name","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of object to perform operation with"},"region":{"kind":"parameter","displayName":"Service region","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"OBS service region. This is lower precedence than endpoint based configuration"},"deleteAfterRead":{"kind":"parameter","displayName":"Delete after read","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":false,"description":"Determines if objects should be deleted after it has been retrieved"},"delimiter":{"kind":"parameter","displayName":"Delimiter","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The character used for grouping object names"},"destinationBucket":{"kind":"parameter","displayName":"Destination Bucket","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of destination bucket where objects will be moved when moveAfterRead is set to true"},"fileName":{"kind":"parameter","displayName":"File Name","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Get the object from the bucket with the given file name"},"includeFolders":{"kind":"parameter","displayName":"Include Folders","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":true,"description":"If true, objects in folders will be consumed. Otherwise, they will be ignored and no Exchanges will be created for them"},"maxMessagesPerPoll":{"kind":"parameter","displayName":"Maximum messages per poll","group":"consumer","label":"consumer","required":false,"type":"integer","javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":10,"description":"The maximum number of messages to poll at each polling"},"moveAfterRead":{"kind":"parameter","displayName":"Move After Read","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":false,"description":"Determines whether objects should be moved to a different bucket after they have been retrieved. The destinationBucket option must also be set for this option to work."},"prefix":{"kind":"parameter","displayName":"Prefix","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The object name prefix used for filtering objects to be listed"},"sendEmptyMessageWhenIdle":{"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."},"bridgeErrorHandler":{"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 occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. 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":{"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":{"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut","InOptionalOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"pollStrategy":{"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."},"bucketLocation":{"kind":"parameter","displayName":"Bucket Location","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Location of bucket when creating a new bucket"},"lazyStartProducer":{"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."},"proxyHost":{"kind":"parameter","displayName":"Proxy server host","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Proxy server ip/hostname"},"proxyPassword":{"kind":"parameter","displayName":"Proxy password","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"Proxy authentication password"},"proxyPort":{"kind":"parameter","displayName":"Proxy server port","group":"proxy","label":"proxy","required":false,"type":"integer","javaType":"int","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Proxy server port"},"proxyUser":{"kind":"parameter","displayName":"Proxy user","group":"proxy","label":"proxy","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"Proxy authentication user"},"backoffErrorThreshold":{"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":{"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":{"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":{"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":{"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":{"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":{"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":{"kind":"parameter","displayName":"Run Logging Level","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","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":{"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":{"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":{"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."},"startScheduler":{"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":{"kind":"parameter","displayName":"Time Unit","group":"scheduler","label":"consumer,scheduler","required":false,"type":"object","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":{"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."},"accessKey":{"kind":"parameter","displayName":"API access key (AK)","group":"security","label":"security","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"Access key for the cloud user"},"ignoreSslVerification":{"kind":"parameter","displayName":"SSL Verification Ignored","group":"security","label":"security","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":false,"description":"Ignore SSL verification"},"secretKey":{"kind":"parameter","displayName":"API secret key (SK)","group":"security","label":"security","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"Secret key for the cloud user"},"serviceKeys":{"kind":"parameter","displayName":"Service Configuration","group":"security","label":"security","required":false,"type":"object","javaType":"org.apache.camel.component.huaweicloud.common.models.ServiceKeys","deprecated":false,"deprecationNote":"","autowired":false,"secret":true,"description":"Configuration object for cloud service authentication"}}}