| // kafka-connector options: START |
| [[camel-azure-blob-kafka-connector-sink]] |
| = camel-azure-blob-kafka-connector sink configuration |
| |
| When using camel-azure-blob-kafka-connector as sink 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 sink connector supports 22 options, which are listed below. |
| |
| |
| |
| [width="100%",cols="2,5,^1,2",options="header"] |
| |=== |
| | Name | Description | Default | Priority |
| | *camel.sink.path.containerOr BlobUri* | Container or Blob compact Uri | null | ConfigDef.Importance.HIGH |
| | *camel.sink.endpoint.azureBlob Client* | The blob service client | null | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.blobOffset* | Set the blob offset for the upload or download operations, default is 0 | "0" | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.blobType* | Set a blob type, 'blockblob' is default One of: [blockblob] [appendblob] [pageblob] | "blockblob" | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.close StreamAfterRead* | Close the stream after read or keep it open, default is true | true | ConfigDef.Importance.MEDIUM |
| | * camel.sink.endpoint.credentials* | Set the storage credentials, required in most cases | null | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.dataLength* | Set the data length for the download or page blob upload operations | null | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.fileDir* | Set the file directory where the downloaded blobs will be saved to | null | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.publicFor Read* | 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.sink.endpoint.streamRead Size* | Set the minimum read size in bytes when reading the blob content | null | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.blob Metadata* | Set the blob meta-data | null | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.blobPrefix* | Set a prefix which can be used for listing the blobs | null | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.close StreamAfterWrite* | Close the stream after write or keep it open, default is true | true | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.lazyStart Producer* | 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. | false | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.operation* | Blob service operation hint to the producer One of: [getBlob] [deleteBlob] [listBlobs] [updateBlockBlob] [uploadBlobBlocks] [commitBlobBlockList] [getBlobBlockList] [createAppendBlob] [updateAppendBlob] [createPageBlob] [updatePageBlob] [resizePageBlob] [clearPageBlob] [getPageBlobRanges] | "listBlobs" | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.stream WriteSize* | Set the size of the buffer for writing block and page blocks | null | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.useFlat Listing* | Specify if the flat or hierarchical blob listing should be used | true | ConfigDef.Importance.MEDIUM |
| | *camel.sink.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.sink.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.lazy StartProducer* | 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. | 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 |
