org.apache.camel.builder.endpoint.dsl

Interface BlobEndpointBuilderFactory.BlobEndpointProducerBuilder

All Superinterfaces:

org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver

All Known Subinterfaces:

BlobEndpointBuilderFactory.BlobEndpointBuilder

Enclosing interface:

BlobEndpointBuilderFactory

public static interface BlobEndpointBuilderFactory.BlobEndpointProducerBuilder
extends org.apache.camel.builder.EndpointProducerBuilder

Builder for endpoint producers for the Azure Storage Blob Service component.

Method Summary

Modifier and Type	Method and Description
default BlobEndpointBuilderFactory.BlobEndpointProducerBuilder	accessKey(String accessKey) Access key for the associated azure account name to be used for authentication with azure blob services.
default BlobEndpointBuilderFactory.AdvancedBlobEndpointProducerBuilder	advanced()
default BlobEndpointBuilderFactory.BlobEndpointProducerBuilder	blobName(String blobName) The blob name, required for consumer.
default BlobEndpointBuilderFactory.BlobEndpointProducerBuilder	blobOffset(long blobOffset) Set the blob offset for the upload or download operations, default is 0.
default BlobEndpointBuilderFactory.BlobEndpointProducerBuilder	blobOffset(String blobOffset) Set the blob offset for the upload or download operations, default is 0.
default BlobEndpointBuilderFactory.BlobEndpointProducerBuilder	blobServiceClient(Object blobServiceClient) Client to a storage account.
default BlobEndpointBuilderFactory.BlobEndpointProducerBuilder	blobServiceClient(String blobServiceClient) Client to a storage account.
default BlobEndpointBuilderFactory.BlobEndpointProducerBuilder	blobType(BlobEndpointBuilderFactory.BlobType blobType) The blob type in order to initiate the appropriate settings for each blob type.
default BlobEndpointBuilderFactory.BlobEndpointProducerBuilder	blobType(String blobType) The blob type in order to initiate the appropriate settings for each blob type.
default BlobEndpointBuilderFactory.BlobEndpointProducerBuilder	closeStreamAfterRead(boolean closeStreamAfterRead) Close the stream after read or keep it open, default is true.
default BlobEndpointBuilderFactory.BlobEndpointProducerBuilder	closeStreamAfterRead(String closeStreamAfterRead) Close the stream after read or keep it open, default is true.
default BlobEndpointBuilderFactory.BlobEndpointProducerBuilder	closeStreamAfterWrite(boolean closeStreamAfterWrite) Close the stream after write or keep it open, default is true.
default BlobEndpointBuilderFactory.BlobEndpointProducerBuilder	closeStreamAfterWrite(String closeStreamAfterWrite) Close the stream after write or keep it open, default is true.
default BlobEndpointBuilderFactory.BlobEndpointProducerBuilder	credentials(Object credentials) StorageSharedKeyCredential can be injected to create the azure client, this holds the important authentication information.
default BlobEndpointBuilderFactory.BlobEndpointProducerBuilder	credentials(String credentials) StorageSharedKeyCredential can be injected to create the azure client, this holds the important authentication information.
default BlobEndpointBuilderFactory.BlobEndpointProducerBuilder	dataCount(Long dataCount) How many bytes to include in the range.
default BlobEndpointBuilderFactory.BlobEndpointProducerBuilder	dataCount(String dataCount) How many bytes to include in the range.
default BlobEndpointBuilderFactory.BlobEndpointProducerBuilder	fileDir(String fileDir) The file directory where the downloaded blobs will be saved to, this can be used in both, producer and consumer.
default BlobEndpointBuilderFactory.BlobEndpointProducerBuilder	lazyStartProducer(boolean lazyStartProducer) Whether the producer should be started lazy (on the first message).
default BlobEndpointBuilderFactory.BlobEndpointProducerBuilder	lazyStartProducer(String lazyStartProducer) Whether the producer should be started lazy (on the first message).
default BlobEndpointBuilderFactory.BlobEndpointProducerBuilder	maxRetryRequests(int maxRetryRequests) Specifies the maximum number of additional HTTP Get requests that will be made while reading the data from a response body.
default BlobEndpointBuilderFactory.BlobEndpointProducerBuilder	maxRetryRequests(String maxRetryRequests) Specifies the maximum number of additional HTTP Get requests that will be made while reading the data from a response body.
default BlobEndpointBuilderFactory.BlobEndpointProducerBuilder	operation(BlobEndpointBuilderFactory.BlobOperationsDefinition operation) The blob operation that can be used with this component on the producer.
default BlobEndpointBuilderFactory.BlobEndpointProducerBuilder	operation(String operation) The blob operation that can be used with this component on the producer.
default BlobEndpointBuilderFactory.BlobEndpointProducerBuilder	serviceClient(Object serviceClient) Client to a storage account.
default BlobEndpointBuilderFactory.BlobEndpointProducerBuilder	serviceClient(String serviceClient) Client to a storage account.

Methods inherited from interface org.apache.camel.builder.EndpointProducerBuilder

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, expr, getUri

Methods inherited from interface org.apache.camel.EndpointProducerResolver

resolve, resolve

Method Detail

advanced

default BlobEndpointBuilderFactory.AdvancedBlobEndpointProducerBuilder advanced()

blobName

default BlobEndpointBuilderFactory.BlobEndpointProducerBuilder blobName(String blobName)

The blob name, required for consumer. However on producer, is only required for the operations on the blob level. The option is a: java.lang.String type. Group: common

blobOffset

default BlobEndpointBuilderFactory.BlobEndpointProducerBuilder blobOffset(long blobOffset)

Set the blob offset for the upload or download operations, default is 0. The option is a: long type. Default: 0 Group: common

blobOffset

default BlobEndpointBuilderFactory.BlobEndpointProducerBuilder blobOffset(String blobOffset)

Set the blob offset for the upload or download operations, default is 0. The option will be converted to a long type. Default: 0 Group: common

blobServiceClient

default BlobEndpointBuilderFactory.BlobEndpointProducerBuilder blobServiceClient(Object blobServiceClient)

Client to a storage account. This client does not hold any state about a particular storage account but is instead a convenient way of sending off appropriate requests to the resource on the service. It may also be used to construct URLs to blobs and containers. This client contains operations on a service account. Operations on a container are available on BlobContainerClient through getBlobContainerClient(String), and operations on a blob are available on BlobClient through getBlobContainerClient(String).getBlobClient(String). The option is a: com.azure.storage.blob.BlobServiceClient type. Group: common

blobServiceClient

default BlobEndpointBuilderFactory.BlobEndpointProducerBuilder blobServiceClient(String blobServiceClient)

Client to a storage account. This client does not hold any state about a particular storage account but is instead a convenient way of sending off appropriate requests to the resource on the service. It may also be used to construct URLs to blobs and containers. This client contains operations on a service account. Operations on a container are available on BlobContainerClient through getBlobContainerClient(String), and operations on a blob are available on BlobClient through getBlobContainerClient(String).getBlobClient(String). The option will be converted to a com.azure.storage.blob.BlobServiceClient type. Group: common

blobType

default BlobEndpointBuilderFactory.BlobEndpointProducerBuilder blobType(BlobEndpointBuilderFactory.BlobType blobType)

The blob type in order to initiate the appropriate settings for each blob type. The option is a: org.apache.camel.component.azure.storage.blob.BlobType type. Default: blockblob Group: common

blobType

default BlobEndpointBuilderFactory.BlobEndpointProducerBuilder blobType(String blobType)

The blob type in order to initiate the appropriate settings for each blob type. The option will be converted to a org.apache.camel.component.azure.storage.blob.BlobType type. Default: blockblob Group: common

closeStreamAfterRead

default BlobEndpointBuilderFactory.BlobEndpointProducerBuilder closeStreamAfterRead(boolean closeStreamAfterRead)

Close the stream after read or keep it open, default is true. The option is a: boolean type. Default: true Group: common

closeStreamAfterRead

default BlobEndpointBuilderFactory.BlobEndpointProducerBuilder closeStreamAfterRead(String closeStreamAfterRead)

Close the stream after read or keep it open, default is true. The option will be converted to a boolean type. Default: true Group: common

credentials

default BlobEndpointBuilderFactory.BlobEndpointProducerBuilder credentials(Object credentials)

StorageSharedKeyCredential can be injected to create the azure client, this holds the important authentication information. The option is a: com.azure.storage.common.StorageSharedKeyCredential type. Group: common

credentials

default BlobEndpointBuilderFactory.BlobEndpointProducerBuilder credentials(String credentials)

StorageSharedKeyCredential can be injected to create the azure client, this holds the important authentication information. The option will be converted to a com.azure.storage.common.StorageSharedKeyCredential type. Group: common

dataCount

default BlobEndpointBuilderFactory.BlobEndpointProducerBuilder dataCount(Long dataCount)

How many bytes to include in the range. Must be greater than or equal to 0 if specified. The option is a: java.lang.Long type. Group: common

dataCount

default BlobEndpointBuilderFactory.BlobEndpointProducerBuilder dataCount(String dataCount)

How many bytes to include in the range. Must be greater than or equal to 0 if specified. The option will be converted to a java.lang.Long type. Group: common

fileDir

default BlobEndpointBuilderFactory.BlobEndpointProducerBuilder fileDir(String fileDir)

The file directory where the downloaded blobs will be saved to, this can be used in both, producer and consumer. The option is a: java.lang.String type. Group: common

maxRetryRequests

default BlobEndpointBuilderFactory.BlobEndpointProducerBuilder maxRetryRequests(int maxRetryRequests)

Specifies the maximum number of additional HTTP Get requests that will be made while reading the data from a response body. The option is a: int type. Default: 0 Group: common

maxRetryRequests

default BlobEndpointBuilderFactory.BlobEndpointProducerBuilder maxRetryRequests(String maxRetryRequests)

Specifies the maximum number of additional HTTP Get requests that will be made while reading the data from a response body. The option will be converted to a int type. Default: 0 Group: common

serviceClient

default BlobEndpointBuilderFactory.BlobEndpointProducerBuilder serviceClient(Object serviceClient)

Client to a storage account. This client does not hold any state about a particular storage account but is instead a convenient way of sending off appropriate requests to the resource on the service. It may also be used to construct URLs to blobs and containers. This client contains operations on a service account. Operations on a container are available on BlobContainerClient through getBlobContainerClient(String), and operations on a blob are available on BlobClient through getBlobContainerClient(String).getBlobClient(String). The option is a: com.azure.storage.blob.BlobServiceClient type. Group: common

serviceClient

default BlobEndpointBuilderFactory.BlobEndpointProducerBuilder serviceClient(String serviceClient)

Client to a storage account. This client does not hold any state about a particular storage account but is instead a convenient way of sending off appropriate requests to the resource on the service. It may also be used to construct URLs to blobs and containers. This client contains operations on a service account. Operations on a container are available on BlobContainerClient through getBlobContainerClient(String), and operations on a blob are available on BlobClient through getBlobContainerClient(String).getBlobClient(String). The option will be converted to a com.azure.storage.blob.BlobServiceClient type. Group: common

closeStreamAfterWrite

default BlobEndpointBuilderFactory.BlobEndpointProducerBuilder closeStreamAfterWrite(boolean closeStreamAfterWrite)

Close the stream after write or keep it open, default is true. The option is a: boolean type. Default: true Group: producer

closeStreamAfterWrite

default BlobEndpointBuilderFactory.BlobEndpointProducerBuilder closeStreamAfterWrite(String closeStreamAfterWrite)

Close the stream after write or keep it open, default is true. The option will be converted to a boolean type. Default: true Group: producer

lazyStartProducer

default BlobEndpointBuilderFactory.BlobEndpointProducerBuilder lazyStartProducer(boolean lazyStartProducer)

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. The option is a: boolean type. Default: false Group: producer

lazyStartProducer

default BlobEndpointBuilderFactory.BlobEndpointProducerBuilder lazyStartProducer(String lazyStartProducer)

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. The option will be converted to a boolean type. Default: false Group: producer

operation

default BlobEndpointBuilderFactory.BlobEndpointProducerBuilder operation(BlobEndpointBuilderFactory.BlobOperationsDefinition operation)

The blob operation that can be used with this component on the producer. The option is a: org.apache.camel.component.azure.storage.blob.BlobOperationsDefinition type. Default: listBlobContainers Group: producer

operation

default BlobEndpointBuilderFactory.BlobEndpointProducerBuilder operation(String operation)

The blob operation that can be used with this component on the producer. The option will be converted to a org.apache.camel.component.azure.storage.blob.BlobOperationsDefinition type. Default: listBlobContainers Group: producer

accessKey

default BlobEndpointBuilderFactory.BlobEndpointProducerBuilder accessKey(String accessKey)

Access key for the associated azure account name to be used for authentication with azure blob services. The option is a: java.lang.String type. Group: security