blob: e9b9df8dbcca165401d57b69315d5a47d08dfb2e [file] [log] [blame]
// kafka-connector options: START
[[camel-azure-blob-kafka-connector-source]]
= camel-azure-blob-kafka-connector source configuration
When using camel-azure-blob-kafka-connector as source make sure to use the following Maven dependency to have support for the connector:
[source,xml]
----
<dependency>
<groupId>org.apache.camel.kafkaconnector</groupId>
<artifactId>camel-azure-blob-kafka-connector</artifactId>
<version>x.x.x</version>
<!-- use the same version as your Camel Kafka connector version -->
</dependency>
----
The camel-azure-blob source connector supports 18 options, which are listed below.
[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Priority
| *camel.source.path.containerOr BlobUri* | Container or Blob compact Uri | null | ConfigDef.Importance.HIGH
| *camel.source.endpoint.azure BlobClient* | The blob service client | null | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.blob Offset* | Set the blob offset for the upload or download operations, default is 0 | "0" | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.blobType* | Set a blob type, 'blockblob' is default One of: [blockblob] [appendblob] [pageblob] | "blockblob" | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.close StreamAfterRead* | Close the stream after read or keep it open, default is true | true | ConfigDef.Importance.MEDIUM
| * camel.source.endpoint.credentials* | Set the storage credentials, required in most cases | null | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.data Length* | Set the data length for the download or page blob upload operations | null | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.fileDir* | Set the file directory where the downloaded blobs will be saved to | null | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.public ForRead* | Storage resources can be public for reading their content, if this property is enabled then the credentials do not have to be set | false | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.stream ReadSize* | Set the minimum read size in bytes when reading the blob content | null | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.bridge ErrorHandler* | 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 | ConfigDef.Importance.MEDIUM
| * camel.source.endpoint.exception Handler* | 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. | null | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.exchange Pattern* | Sets the exchange pattern when the consumer creates an exchange. One of: [InOnly] [InOut] [InOptionalOut] | null | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.basic PropertyBinding* | Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | ConfigDef.Importance.MEDIUM
| * camel.source.endpoint.synchronous* | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). | false | ConfigDef.Importance.MEDIUM
| * camel.component.azure-blob.bridge ErrorHandler* | 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 | ConfigDef.Importance.MEDIUM
| * camel.component.azure-blob.basic PropertyBinding* | Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | ConfigDef.Importance.MEDIUM
| * camel.component.azure-blob.configuration* | The Blob Service configuration | null | ConfigDef.Importance.MEDIUM
|===
// kafka-connector options: END