camel-hwcloud-obs-kafka-connector source configuration

Connector Description: To provide stable, secure, efficient, and easy-to-use cloud storage service on Huawei Cloud

When using camel-hwcloud-obs-kafka-connector as source make sure to use the following Maven dependency to have support for the connector:

<dependency>
  <groupId>org.apache.camel.kafkaconnector</groupId>
  <artifactId>camel-hwcloud-obs-kafka-connector</artifactId>
  <version>x.x.x</version>
  <!-- use the same version as your Camel Kafka connector version -->
</dependency>

To use this source connector in Kafka connect you’ll need to set the following connector.class

connector.class=org.apache.camel.kafkaconnector.hwcloudobs.CamelHwcloudobsSourceConnector

The camel-hwcloud-obs source connector supports 40 options, which are listed below.

Name Description Default Priority

camel.source.endpoint.bucketName

Name of bucket to perform operation on.

MEDIUM

camel.source.endpoint.endpoint

OBS url. Carries higher precedence than region parameter based client initialization.

MEDIUM

camel.source.endpoint.region

Required OBS service region. This is lower precedence than endpoint based configuration.

HIGH

camel.source.endpoint.bridgeErrorHandler

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.

false

MEDIUM

camel.source.endpoint.deleteAfterRead

Determines if objects should be deleted after it has been retrieved.

false

MEDIUM

camel.source.endpoint.delimiter

The character used for grouping object names.

MEDIUM

camel.source.endpoint.destinationBucket

Name of destination bucket where objects will be moved when moveAfterRead is set to true.

MEDIUM

camel.source.endpoint.fileName

Get the object from the bucket with the given file name.

MEDIUM

camel.source.endpoint.includeFolders

If true, objects in folders will be consumed. Otherwise, they will be ignored and no Exchanges will be created for them.

true

MEDIUM

camel.source.endpoint.maxMessagesPerPoll

The maximum number of messages to poll at each polling.

10

MEDIUM

camel.source.endpoint.moveAfterRead

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.

false

MEDIUM

camel.source.endpoint.prefix

The object name prefix used for filtering objects to be listed.

MEDIUM

camel.source.endpoint.sendEmptyMessageWhenIdle

If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead.

false

MEDIUM

camel.source.endpoint.exceptionHandler

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.

MEDIUM

camel.source.endpoint.exchangePattern

Sets the exchange pattern when the consumer creates an exchange. One of: [InOnly] [InOut] [InOptionalOut].

Enum values:

  • InOnly

  • InOut

  • InOptionalOut

MEDIUM

camel.source.endpoint.pollStrategy

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.

MEDIUM

camel.source.endpoint.proxyHost

Proxy server ip/hostname.

MEDIUM

camel.source.endpoint.proxyPassword

Proxy authentication password.

MEDIUM

camel.source.endpoint.proxyPort

Proxy server port.

MEDIUM

camel.source.endpoint.proxyUser

Proxy authentication user.

MEDIUM

camel.source.endpoint.backoffErrorThreshold

The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.

MEDIUM

camel.source.endpoint.backoffIdleThreshold

The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.

MEDIUM

camel.source.endpoint.backoffMultiplier

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.

MEDIUM

camel.source.endpoint.delay

Milliseconds before the next poll.

500L

MEDIUM

camel.source.endpoint.greedy

If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages.

false

MEDIUM

camel.source.endpoint.initialDelay

Milliseconds before the first poll starts.

1000L

MEDIUM

camel.source.endpoint.repeatCount

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.

0L

MEDIUM

camel.source.endpoint.runLoggingLevel

The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. One of: [TRACE] [DEBUG] [INFO] [WARN] [ERROR] [OFF].

Enum values:

  • TRACE

  • DEBUG

  • INFO

  • WARN

  • ERROR

  • OFF

"TRACE"

MEDIUM

camel.source.endpoint.scheduledExecutorService

Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool.

MEDIUM

camel.source.endpoint.scheduler

To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler.

"none"

MEDIUM

camel.source.endpoint.schedulerProperties

To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler.

MEDIUM

camel.source.endpoint.startScheduler

Whether the scheduler should be auto started.

true

MEDIUM

camel.source.endpoint.timeUnit

Time unit for initialDelay and delay options. One of: [NANOSECONDS] [MICROSECONDS] [MILLISECONDS] [SECONDS] [MINUTES] [HOURS] [DAYS].

Enum values:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

"MILLISECONDS"

MEDIUM

camel.source.endpoint.useFixedDelay

Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details.

true

MEDIUM

camel.source.endpoint.accessKey

Required Access key for the cloud user.

HIGH

camel.source.endpoint.ignoreSslVerification

Ignore SSL verification.

false

MEDIUM

camel.source.endpoint.secretKey

Required Secret key for the cloud user.

HIGH

camel.source.endpoint.serviceKeys

Configuration object for cloud service authentication.

MEDIUM

camel.component.hwcloud-obs.bridgeErrorHandler

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.

false

MEDIUM

camel.component.hwcloud-obs.autowiredEnabled

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

MEDIUM

The camel-hwcloud-obs source connector has no converters out of the box.

The camel-hwcloud-obs source connector has no transforms out of the box.

The camel-hwcloud-obs source connector has no aggregation strategies out of the box.