Interface BlobEndpointBuilderFactory.BlobEndpointConsumerBuilder
-
- All Superinterfaces:
org.apache.camel.builder.EndpointConsumerBuilder
,org.apache.camel.EndpointConsumerResolver
- All Known Subinterfaces:
BlobEndpointBuilderFactory.BlobEndpointBuilder
- Enclosing interface:
- BlobEndpointBuilderFactory
public static interface BlobEndpointBuilderFactory.BlobEndpointConsumerBuilder extends org.apache.camel.builder.EndpointConsumerBuilder
Builder for endpoint consumers for the Azure Storage Blob Service component.
-
-
Method Summary
All Methods Instance Methods Default Methods Modifier and Type Method Description default BlobEndpointBuilderFactory.BlobEndpointConsumerBuilder
accessKey(String accessKey)
Access key for the associated azure account name to be used for authentication with azure blob services.default BlobEndpointBuilderFactory.AdvancedBlobEndpointConsumerBuilder
advanced()
default BlobEndpointBuilderFactory.BlobEndpointConsumerBuilder
autoDiscoverClient(boolean autoDiscoverClient)
Setting the autoDiscoverClient mechanism, if true, the component will look for a client instance in the registry automatically otherwise it will skip that checking.default BlobEndpointBuilderFactory.BlobEndpointConsumerBuilder
autoDiscoverClient(String autoDiscoverClient)
Setting the autoDiscoverClient mechanism, if true, the component will look for a client instance in the registry automatically otherwise it will skip that checking.default BlobEndpointBuilderFactory.BlobEndpointConsumerBuilder
blobName(String blobName)
The blob name, to consume specific blob from a container.default BlobEndpointBuilderFactory.BlobEndpointConsumerBuilder
blobOffset(long blobOffset)
Set the blob offset for the upload or download operations, default is 0.default BlobEndpointBuilderFactory.BlobEndpointConsumerBuilder
blobOffset(String blobOffset)
Set the blob offset for the upload or download operations, default is 0.default BlobEndpointBuilderFactory.BlobEndpointConsumerBuilder
blobServiceClient(Object blobServiceClient)
Client to a storage account.default BlobEndpointBuilderFactory.BlobEndpointConsumerBuilder
blobServiceClient(String blobServiceClient)
Client to a storage account.default BlobEndpointBuilderFactory.BlobEndpointConsumerBuilder
blobType(String blobType)
The blob type in order to initiate the appropriate settings for each blob type.default BlobEndpointBuilderFactory.BlobEndpointConsumerBuilder
blobType(BlobEndpointBuilderFactory.BlobType blobType)
The blob type in order to initiate the appropriate settings for each blob type.default BlobEndpointBuilderFactory.BlobEndpointConsumerBuilder
bridgeErrorHandler(boolean 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.default BlobEndpointBuilderFactory.BlobEndpointConsumerBuilder
bridgeErrorHandler(String 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.default BlobEndpointBuilderFactory.BlobEndpointConsumerBuilder
closeStreamAfterRead(boolean closeStreamAfterRead)
Close the stream after read or keep it open, default is true.default BlobEndpointBuilderFactory.BlobEndpointConsumerBuilder
closeStreamAfterRead(String closeStreamAfterRead)
Close the stream after read or keep it open, default is true.default BlobEndpointBuilderFactory.BlobEndpointConsumerBuilder
credentials(Object credentials)
StorageSharedKeyCredential can be injected to create the azure client, this holds the important authentication information.default BlobEndpointBuilderFactory.BlobEndpointConsumerBuilder
credentials(String credentials)
StorageSharedKeyCredential can be injected to create the azure client, this holds the important authentication information.default BlobEndpointBuilderFactory.BlobEndpointConsumerBuilder
dataCount(Long dataCount)
How many bytes to include in the range.default BlobEndpointBuilderFactory.BlobEndpointConsumerBuilder
dataCount(String dataCount)
How many bytes to include in the range.default BlobEndpointBuilderFactory.BlobEndpointConsumerBuilder
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.BlobEndpointConsumerBuilder
maxResultsPerPage(Integer maxResultsPerPage)
Specifies the maximum number of blobs to return, including all BlobPrefix elements.default BlobEndpointBuilderFactory.BlobEndpointConsumerBuilder
maxResultsPerPage(String maxResultsPerPage)
Specifies the maximum number of blobs to return, including all BlobPrefix elements.default BlobEndpointBuilderFactory.BlobEndpointConsumerBuilder
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.BlobEndpointConsumerBuilder
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.BlobEndpointConsumerBuilder
prefix(String prefix)
Filters the results to return only blobs whose names begin with the specified prefix.default BlobEndpointBuilderFactory.BlobEndpointConsumerBuilder
regex(String regex)
Filters the results to return only blobs whose names match the specified regular expression.default BlobEndpointBuilderFactory.BlobEndpointConsumerBuilder
serviceClient(Object serviceClient)
Client to a storage account.default BlobEndpointBuilderFactory.BlobEndpointConsumerBuilder
serviceClient(String serviceClient)
Client to a storage account.default BlobEndpointBuilderFactory.BlobEndpointConsumerBuilder
timeout(String timeout)
An optional timeout value beyond which a RuntimeException will be raised.default BlobEndpointBuilderFactory.BlobEndpointConsumerBuilder
timeout(Duration timeout)
An optional timeout value beyond which a RuntimeException will be raised.
-
-
-
Method Detail
-
advanced
default BlobEndpointBuilderFactory.AdvancedBlobEndpointConsumerBuilder advanced()
-
autoDiscoverClient
default BlobEndpointBuilderFactory.BlobEndpointConsumerBuilder autoDiscoverClient(boolean autoDiscoverClient)
Setting the autoDiscoverClient mechanism, if true, the component will look for a client instance in the registry automatically otherwise it will skip that checking. The option is a:boolean
type. Default: true Group: common
-
autoDiscoverClient
default BlobEndpointBuilderFactory.BlobEndpointConsumerBuilder autoDiscoverClient(String autoDiscoverClient)
Setting the autoDiscoverClient mechanism, if true, the component will look for a client instance in the registry automatically otherwise it will skip that checking. The option will be converted to aboolean
type. Default: true Group: common
-
blobName
default BlobEndpointBuilderFactory.BlobEndpointConsumerBuilder blobName(String blobName)
The blob name, to consume specific blob from a container. 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.BlobEndpointConsumerBuilder 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.BlobEndpointConsumerBuilder blobOffset(String blobOffset)
Set the blob offset for the upload or download operations, default is 0. The option will be converted to along
type. Default: 0 Group: common
-
blobServiceClient
default BlobEndpointBuilderFactory.BlobEndpointConsumerBuilder 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.BlobEndpointConsumerBuilder 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 acom.azure.storage.blob.BlobServiceClient
type. Group: common
-
blobType
default BlobEndpointBuilderFactory.BlobEndpointConsumerBuilder 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.BlobEndpointConsumerBuilder blobType(String blobType)
The blob type in order to initiate the appropriate settings for each blob type. The option will be converted to aorg.apache.camel.component.azure.storage.blob.BlobType
type. Default: blockblob Group: common
-
closeStreamAfterRead
default BlobEndpointBuilderFactory.BlobEndpointConsumerBuilder 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.BlobEndpointConsumerBuilder closeStreamAfterRead(String closeStreamAfterRead)
Close the stream after read or keep it open, default is true. The option will be converted to aboolean
type. Default: true Group: common
-
credentials
default BlobEndpointBuilderFactory.BlobEndpointConsumerBuilder 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.BlobEndpointConsumerBuilder credentials(String credentials)
StorageSharedKeyCredential can be injected to create the azure client, this holds the important authentication information. The option will be converted to acom.azure.storage.common.StorageSharedKeyCredential
type. Group: common
-
dataCount
default BlobEndpointBuilderFactory.BlobEndpointConsumerBuilder 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.BlobEndpointConsumerBuilder 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 ajava.lang.Long
type. Group: common
-
fileDir
default BlobEndpointBuilderFactory.BlobEndpointConsumerBuilder 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
-
maxResultsPerPage
default BlobEndpointBuilderFactory.BlobEndpointConsumerBuilder maxResultsPerPage(Integer maxResultsPerPage)
Specifies the maximum number of blobs to return, including all BlobPrefix elements. If the request does not specify maxResultsPerPage or specifies a value greater than 5,000, the server will return up to 5,000 items. The option is a:java.lang.Integer
type. Group: common
-
maxResultsPerPage
default BlobEndpointBuilderFactory.BlobEndpointConsumerBuilder maxResultsPerPage(String maxResultsPerPage)
Specifies the maximum number of blobs to return, including all BlobPrefix elements. If the request does not specify maxResultsPerPage or specifies a value greater than 5,000, the server will return up to 5,000 items. The option will be converted to ajava.lang.Integer
type. Group: common
-
maxRetryRequests
default BlobEndpointBuilderFactory.BlobEndpointConsumerBuilder 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.BlobEndpointConsumerBuilder 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 aint
type. Default: 0 Group: common
-
prefix
default BlobEndpointBuilderFactory.BlobEndpointConsumerBuilder prefix(String prefix)
Filters the results to return only blobs whose names begin with the specified prefix. May be null to return all blobs. The option is a:java.lang.String
type. Group: common
-
regex
default BlobEndpointBuilderFactory.BlobEndpointConsumerBuilder regex(String regex)
Filters the results to return only blobs whose names match the specified regular expression. May be null to return all if both prefix and regex are set, regex takes the priority and prefix is ignored. The option is a:java.lang.String
type. Group: common
-
serviceClient
default BlobEndpointBuilderFactory.BlobEndpointConsumerBuilder 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 BlobServiceClient#getBlobContainerClient(String), and operations on a blob are available on BlobClient through BlobContainerClient#getBlobClient(String). The option is a:com.azure.storage.blob.BlobServiceClient
type. Group: common
-
serviceClient
default BlobEndpointBuilderFactory.BlobEndpointConsumerBuilder 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 BlobServiceClient#getBlobContainerClient(String), and operations on a blob are available on BlobClient through BlobContainerClient#getBlobClient(String). The option will be converted to acom.azure.storage.blob.BlobServiceClient
type. Group: common
-
timeout
default BlobEndpointBuilderFactory.BlobEndpointConsumerBuilder timeout(Duration timeout)
An optional timeout value beyond which a RuntimeException will be raised. The option is a:java.time.Duration
type. Group: common
-
timeout
default BlobEndpointBuilderFactory.BlobEndpointConsumerBuilder timeout(String timeout)
An optional timeout value beyond which a RuntimeException will be raised. The option will be converted to ajava.time.Duration
type. Group: common
-
bridgeErrorHandler
default BlobEndpointBuilderFactory.BlobEndpointConsumerBuilder bridgeErrorHandler(boolean 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. The option is a:boolean
type. Default: false Group: consumer
-
bridgeErrorHandler
default BlobEndpointBuilderFactory.BlobEndpointConsumerBuilder bridgeErrorHandler(String 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. The option will be converted to aboolean
type. Default: false Group: consumer
-
accessKey
default BlobEndpointBuilderFactory.BlobEndpointConsumerBuilder 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
-
-