Interface BlobEndpointBuilderFactory.BlobEndpointBuilder
-
- All Superinterfaces:
BlobEndpointBuilderFactory.BlobEndpointConsumerBuilder
,BlobEndpointBuilderFactory.BlobEndpointProducerBuilder
,org.apache.camel.builder.EndpointConsumerBuilder
,org.apache.camel.EndpointConsumerResolver
,org.apache.camel.builder.EndpointProducerBuilder
,org.apache.camel.EndpointProducerResolver
- Enclosing interface:
- BlobEndpointBuilderFactory
public static interface BlobEndpointBuilderFactory.BlobEndpointBuilder extends BlobEndpointBuilderFactory.BlobEndpointConsumerBuilder, BlobEndpointBuilderFactory.BlobEndpointProducerBuilder
Builder for endpoint for the Azure Storage Blob Service component.
-
-
Method Summary
All Methods Instance Methods Default Methods Modifier and Type Method Description default BlobEndpointBuilderFactory.BlobEndpointBuilder
accessKey(String accessKey)
Access key for the associated azure account name to be used for authentication with azure blob services.default BlobEndpointBuilderFactory.AdvancedBlobEndpointBuilder
advanced()
default BlobEndpointBuilderFactory.BlobEndpointBuilder
blobName(String blobName)
The blob name, to consume specific blob from a container.default BlobEndpointBuilderFactory.BlobEndpointBuilder
blobOffset(long blobOffset)
Set the blob offset for the upload or download operations, default is 0.default BlobEndpointBuilderFactory.BlobEndpointBuilder
blobOffset(String blobOffset)
Set the blob offset for the upload or download operations, default is 0.default BlobEndpointBuilderFactory.BlobEndpointBuilder
blobServiceClient(com.azure.storage.blob.BlobServiceClient blobServiceClient)
Client to a storage account.default BlobEndpointBuilderFactory.BlobEndpointBuilder
blobServiceClient(String blobServiceClient)
Client to a storage account.default BlobEndpointBuilderFactory.BlobEndpointBuilder
blobType(String blobType)
The blob type in order to initiate the appropriate settings for each blob type.default BlobEndpointBuilderFactory.BlobEndpointBuilder
blobType(org.apache.camel.component.azure.storage.blob.BlobType blobType)
The blob type in order to initiate the appropriate settings for each blob type.default BlobEndpointBuilderFactory.BlobEndpointBuilder
closeStreamAfterRead(boolean closeStreamAfterRead)
Close the stream after read or keep it open, default is true.default BlobEndpointBuilderFactory.BlobEndpointBuilder
closeStreamAfterRead(String closeStreamAfterRead)
Close the stream after read or keep it open, default is true.default BlobEndpointBuilderFactory.BlobEndpointBuilder
credentials(com.azure.storage.common.StorageSharedKeyCredential credentials)
StorageSharedKeyCredential can be injected to create the azure client, this holds the important authentication information.default BlobEndpointBuilderFactory.BlobEndpointBuilder
credentials(String credentials)
StorageSharedKeyCredential can be injected to create the azure client, this holds the important authentication information.default BlobEndpointBuilderFactory.BlobEndpointBuilder
dataCount(Long dataCount)
How many bytes to include in the range.default BlobEndpointBuilderFactory.BlobEndpointBuilder
dataCount(String dataCount)
How many bytes to include in the range.default BlobEndpointBuilderFactory.BlobEndpointBuilder
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.BlobEndpointBuilder
maxResultsPerPage(Integer maxResultsPerPage)
Specifies the maximum number of blobs to return, including all BlobPrefix elements.default BlobEndpointBuilderFactory.BlobEndpointBuilder
maxResultsPerPage(String maxResultsPerPage)
Specifies the maximum number of blobs to return, including all BlobPrefix elements.default BlobEndpointBuilderFactory.BlobEndpointBuilder
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.BlobEndpointBuilder
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.BlobEndpointBuilder
prefix(String prefix)
Filters the results to return only blobs whose names begin with the specified prefix.default BlobEndpointBuilderFactory.BlobEndpointBuilder
regex(String regex)
Filters the results to return only blobs whose names match the specified regular expression.default BlobEndpointBuilderFactory.BlobEndpointBuilder
serviceClient(com.azure.storage.blob.BlobServiceClient serviceClient)
Client to a storage account.default BlobEndpointBuilderFactory.BlobEndpointBuilder
serviceClient(String serviceClient)
Client to a storage account.default BlobEndpointBuilderFactory.BlobEndpointBuilder
sourceBlobAccessKey(String sourceBlobAccessKey)
Source Blob Access Key: for copyblob operation, sadly, we need to have an accessKey for the source blob we want to copy Passing an accessKey as header, it's unsafe so we could set as key.default BlobEndpointBuilderFactory.BlobEndpointBuilder
timeout(String timeout)
An optional timeout value beyond which a RuntimeException will be raised.default BlobEndpointBuilderFactory.BlobEndpointBuilder
timeout(Duration timeout)
An optional timeout value beyond which a RuntimeException will be raised.-
Methods inherited from interface org.apache.camel.builder.endpoint.dsl.BlobEndpointBuilderFactory.BlobEndpointConsumerBuilder
backoffErrorThreshold, backoffErrorThreshold, backoffIdleThreshold, backoffIdleThreshold, backoffMultiplier, backoffMultiplier, bridgeErrorHandler, bridgeErrorHandler, delay, delay, greedy, greedy, initialDelay, initialDelay, repeatCount, repeatCount, runLoggingLevel, runLoggingLevel, scheduledExecutorService, scheduledExecutorService, scheduler, scheduler, schedulerProperties, schedulerProperties, sendEmptyMessageWhenIdle, sendEmptyMessageWhenIdle, startScheduler, startScheduler, timeUnit, timeUnit, useFixedDelay, useFixedDelay
-
Methods inherited from interface org.apache.camel.builder.endpoint.dsl.BlobEndpointBuilderFactory.BlobEndpointProducerBuilder
blobSequenceNumber, blobSequenceNumber, blockListType, blockListType, changeFeedContext, changeFeedContext, changeFeedEndTime, changeFeedEndTime, changeFeedStartTime, changeFeedStartTime, closeStreamAfterWrite, closeStreamAfterWrite, commitBlockListLater, commitBlockListLater, createAppendBlob, createAppendBlob, createPageBlob, createPageBlob, downloadLinkExpiration, downloadLinkExpiration, lazyStartProducer, lazyStartProducer, operation, operation, pageBlobSize, pageBlobSize
-
Methods inherited from interface org.apache.camel.builder.EndpointConsumerBuilder
doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getUri
-
-
-
-
Method Detail
-
advanced
default BlobEndpointBuilderFactory.AdvancedBlobEndpointBuilder advanced()
- Specified by:
advanced
in interfaceBlobEndpointBuilderFactory.BlobEndpointConsumerBuilder
- Specified by:
advanced
in interfaceBlobEndpointBuilderFactory.BlobEndpointProducerBuilder
-
blobName
default BlobEndpointBuilderFactory.BlobEndpointBuilder 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: <code>java.lang.String</code> type. Group: common- Specified by:
blobName
in interfaceBlobEndpointBuilderFactory.BlobEndpointConsumerBuilder
- Specified by:
blobName
in interfaceBlobEndpointBuilderFactory.BlobEndpointProducerBuilder
- Parameters:
blobName
- the value to set- Returns:
- the dsl builder
-
blobOffset
default BlobEndpointBuilderFactory.BlobEndpointBuilder blobOffset(long blobOffset)
Set the blob offset for the upload or download operations, default is 0. The option is a: <code>long</code> type. Default: 0 Group: common- Specified by:
blobOffset
in interfaceBlobEndpointBuilderFactory.BlobEndpointConsumerBuilder
- Specified by:
blobOffset
in interfaceBlobEndpointBuilderFactory.BlobEndpointProducerBuilder
- Parameters:
blobOffset
- the value to set- Returns:
- the dsl builder
-
blobOffset
default BlobEndpointBuilderFactory.BlobEndpointBuilder blobOffset(String blobOffset)
Set the blob offset for the upload or download operations, default is 0. The option will be converted to a <code>long</code> type. Default: 0 Group: common- Specified by:
blobOffset
in interfaceBlobEndpointBuilderFactory.BlobEndpointConsumerBuilder
- Specified by:
blobOffset
in interfaceBlobEndpointBuilderFactory.BlobEndpointProducerBuilder
- Parameters:
blobOffset
- the value to set- Returns:
- the dsl builder
-
blobServiceClient
default BlobEndpointBuilderFactory.BlobEndpointBuilder blobServiceClient(com.azure.storage.blob.BlobServiceClient 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: <code>com.azure.storage.blob.BlobServiceClient</code> type. Group: common- Specified by:
blobServiceClient
in interfaceBlobEndpointBuilderFactory.BlobEndpointConsumerBuilder
- Specified by:
blobServiceClient
in interfaceBlobEndpointBuilderFactory.BlobEndpointProducerBuilder
- Parameters:
blobServiceClient
- the value to set- Returns:
- the dsl builder
-
blobServiceClient
default BlobEndpointBuilderFactory.BlobEndpointBuilder 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 <code>com.azure.storage.blob.BlobServiceClient</code> type. Group: common- Specified by:
blobServiceClient
in interfaceBlobEndpointBuilderFactory.BlobEndpointConsumerBuilder
- Specified by:
blobServiceClient
in interfaceBlobEndpointBuilderFactory.BlobEndpointProducerBuilder
- Parameters:
blobServiceClient
- the value to set- Returns:
- the dsl builder
-
blobType
default BlobEndpointBuilderFactory.BlobEndpointBuilder blobType(org.apache.camel.component.azure.storage.blob.BlobType blobType)
The blob type in order to initiate the appropriate settings for each blob type. The option is a: <code>org.apache.camel.component.azure.storage.blob.BlobType</code> type. Default: blockblob Group: common- Specified by:
blobType
in interfaceBlobEndpointBuilderFactory.BlobEndpointConsumerBuilder
- Specified by:
blobType
in interfaceBlobEndpointBuilderFactory.BlobEndpointProducerBuilder
- Parameters:
blobType
- the value to set- Returns:
- the dsl builder
-
blobType
default BlobEndpointBuilderFactory.BlobEndpointBuilder blobType(String blobType)
The blob type in order to initiate the appropriate settings for each blob type. The option will be converted to a <code>org.apache.camel.component.azure.storage.blob.BlobType</code> type. Default: blockblob Group: common- Specified by:
blobType
in interfaceBlobEndpointBuilderFactory.BlobEndpointConsumerBuilder
- Specified by:
blobType
in interfaceBlobEndpointBuilderFactory.BlobEndpointProducerBuilder
- Parameters:
blobType
- the value to set- Returns:
- the dsl builder
-
closeStreamAfterRead
default BlobEndpointBuilderFactory.BlobEndpointBuilder closeStreamAfterRead(boolean closeStreamAfterRead)
Close the stream after read or keep it open, default is true. The option is a: <code>boolean</code> type. Default: true Group: common- Specified by:
closeStreamAfterRead
in interfaceBlobEndpointBuilderFactory.BlobEndpointConsumerBuilder
- Specified by:
closeStreamAfterRead
in interfaceBlobEndpointBuilderFactory.BlobEndpointProducerBuilder
- Parameters:
closeStreamAfterRead
- the value to set- Returns:
- the dsl builder
-
closeStreamAfterRead
default BlobEndpointBuilderFactory.BlobEndpointBuilder closeStreamAfterRead(String closeStreamAfterRead)
Close the stream after read or keep it open, default is true. The option will be converted to a <code>boolean</code> type. Default: true Group: common- Specified by:
closeStreamAfterRead
in interfaceBlobEndpointBuilderFactory.BlobEndpointConsumerBuilder
- Specified by:
closeStreamAfterRead
in interfaceBlobEndpointBuilderFactory.BlobEndpointProducerBuilder
- Parameters:
closeStreamAfterRead
- the value to set- Returns:
- the dsl builder
-
credentials
default BlobEndpointBuilderFactory.BlobEndpointBuilder credentials(com.azure.storage.common.StorageSharedKeyCredential credentials)
StorageSharedKeyCredential can be injected to create the azure client, this holds the important authentication information. The option is a: <code>com.azure.storage.common.StorageSharedKeyCredential</code> type. Group: common- Specified by:
credentials
in interfaceBlobEndpointBuilderFactory.BlobEndpointConsumerBuilder
- Specified by:
credentials
in interfaceBlobEndpointBuilderFactory.BlobEndpointProducerBuilder
- Parameters:
credentials
- the value to set- Returns:
- the dsl builder
-
credentials
default BlobEndpointBuilderFactory.BlobEndpointBuilder 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 <code>com.azure.storage.common.StorageSharedKeyCredential</code> type. Group: common- Specified by:
credentials
in interfaceBlobEndpointBuilderFactory.BlobEndpointConsumerBuilder
- Specified by:
credentials
in interfaceBlobEndpointBuilderFactory.BlobEndpointProducerBuilder
- Parameters:
credentials
- the value to set- Returns:
- the dsl builder
-
dataCount
default BlobEndpointBuilderFactory.BlobEndpointBuilder 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: <code>java.lang.Long</code> type. Group: common- Specified by:
dataCount
in interfaceBlobEndpointBuilderFactory.BlobEndpointConsumerBuilder
- Specified by:
dataCount
in interfaceBlobEndpointBuilderFactory.BlobEndpointProducerBuilder
- Parameters:
dataCount
- the value to set- Returns:
- the dsl builder
-
dataCount
default BlobEndpointBuilderFactory.BlobEndpointBuilder 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 <code>java.lang.Long</code> type. Group: common- Specified by:
dataCount
in interfaceBlobEndpointBuilderFactory.BlobEndpointConsumerBuilder
- Specified by:
dataCount
in interfaceBlobEndpointBuilderFactory.BlobEndpointProducerBuilder
- Parameters:
dataCount
- the value to set- Returns:
- the dsl builder
-
fileDir
default BlobEndpointBuilderFactory.BlobEndpointBuilder 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: <code>java.lang.String</code> type. Group: common- Specified by:
fileDir
in interfaceBlobEndpointBuilderFactory.BlobEndpointConsumerBuilder
- Specified by:
fileDir
in interfaceBlobEndpointBuilderFactory.BlobEndpointProducerBuilder
- Parameters:
fileDir
- the value to set- Returns:
- the dsl builder
-
maxResultsPerPage
default BlobEndpointBuilderFactory.BlobEndpointBuilder 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: <code>java.lang.Integer</code> type. Group: common- Specified by:
maxResultsPerPage
in interfaceBlobEndpointBuilderFactory.BlobEndpointConsumerBuilder
- Specified by:
maxResultsPerPage
in interfaceBlobEndpointBuilderFactory.BlobEndpointProducerBuilder
- Parameters:
maxResultsPerPage
- the value to set- Returns:
- the dsl builder
-
maxResultsPerPage
default BlobEndpointBuilderFactory.BlobEndpointBuilder 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 a <code>java.lang.Integer</code> type. Group: common- Specified by:
maxResultsPerPage
in interfaceBlobEndpointBuilderFactory.BlobEndpointConsumerBuilder
- Specified by:
maxResultsPerPage
in interfaceBlobEndpointBuilderFactory.BlobEndpointProducerBuilder
- Parameters:
maxResultsPerPage
- the value to set- Returns:
- the dsl builder
-
maxRetryRequests
default BlobEndpointBuilderFactory.BlobEndpointBuilder 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: <code>int</code> type. Default: 0 Group: common- Specified by:
maxRetryRequests
in interfaceBlobEndpointBuilderFactory.BlobEndpointConsumerBuilder
- Specified by:
maxRetryRequests
in interfaceBlobEndpointBuilderFactory.BlobEndpointProducerBuilder
- Parameters:
maxRetryRequests
- the value to set- Returns:
- the dsl builder
-
maxRetryRequests
default BlobEndpointBuilderFactory.BlobEndpointBuilder 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 <code>int</code> type. Default: 0 Group: common- Specified by:
maxRetryRequests
in interfaceBlobEndpointBuilderFactory.BlobEndpointConsumerBuilder
- Specified by:
maxRetryRequests
in interfaceBlobEndpointBuilderFactory.BlobEndpointProducerBuilder
- Parameters:
maxRetryRequests
- the value to set- Returns:
- the dsl builder
-
prefix
default BlobEndpointBuilderFactory.BlobEndpointBuilder 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: <code>java.lang.String</code> type. Group: common- Specified by:
prefix
in interfaceBlobEndpointBuilderFactory.BlobEndpointConsumerBuilder
- Specified by:
prefix
in interfaceBlobEndpointBuilderFactory.BlobEndpointProducerBuilder
- Parameters:
prefix
- the value to set- Returns:
- the dsl builder
-
regex
default BlobEndpointBuilderFactory.BlobEndpointBuilder 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: <code>java.lang.String</code> type. Group: common- Specified by:
regex
in interfaceBlobEndpointBuilderFactory.BlobEndpointConsumerBuilder
- Specified by:
regex
in interfaceBlobEndpointBuilderFactory.BlobEndpointProducerBuilder
- Parameters:
regex
- the value to set- Returns:
- the dsl builder
-
serviceClient
default BlobEndpointBuilderFactory.BlobEndpointBuilder serviceClient(com.azure.storage.blob.BlobServiceClient 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: <code>com.azure.storage.blob.BlobServiceClient</code> type. Group: common- Specified by:
serviceClient
in interfaceBlobEndpointBuilderFactory.BlobEndpointConsumerBuilder
- Specified by:
serviceClient
in interfaceBlobEndpointBuilderFactory.BlobEndpointProducerBuilder
- Parameters:
serviceClient
- the value to set- Returns:
- the dsl builder
-
serviceClient
default BlobEndpointBuilderFactory.BlobEndpointBuilder 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 a <code>com.azure.storage.blob.BlobServiceClient</code> type. Group: common- Specified by:
serviceClient
in interfaceBlobEndpointBuilderFactory.BlobEndpointConsumerBuilder
- Specified by:
serviceClient
in interfaceBlobEndpointBuilderFactory.BlobEndpointProducerBuilder
- Parameters:
serviceClient
- the value to set- Returns:
- the dsl builder
-
timeout
default BlobEndpointBuilderFactory.BlobEndpointBuilder timeout(Duration timeout)
An optional timeout value beyond which a RuntimeException will be raised. The option is a: <code>java.time.Duration</code> type. Group: common- Specified by:
timeout
in interfaceBlobEndpointBuilderFactory.BlobEndpointConsumerBuilder
- Specified by:
timeout
in interfaceBlobEndpointBuilderFactory.BlobEndpointProducerBuilder
- Parameters:
timeout
- the value to set- Returns:
- the dsl builder
-
timeout
default BlobEndpointBuilderFactory.BlobEndpointBuilder timeout(String timeout)
An optional timeout value beyond which a RuntimeException will be raised. The option will be converted to a <code>java.time.Duration</code> type. Group: common- Specified by:
timeout
in interfaceBlobEndpointBuilderFactory.BlobEndpointConsumerBuilder
- Specified by:
timeout
in interfaceBlobEndpointBuilderFactory.BlobEndpointProducerBuilder
- Parameters:
timeout
- the value to set- Returns:
- the dsl builder
-
accessKey
default BlobEndpointBuilderFactory.BlobEndpointBuilder accessKey(String accessKey)
Access key for the associated azure account name to be used for authentication with azure blob services. The option is a: <code>java.lang.String</code> type. Group: security- Specified by:
accessKey
in interfaceBlobEndpointBuilderFactory.BlobEndpointConsumerBuilder
- Specified by:
accessKey
in interfaceBlobEndpointBuilderFactory.BlobEndpointProducerBuilder
- Parameters:
accessKey
- the value to set- Returns:
- the dsl builder
-
sourceBlobAccessKey
default BlobEndpointBuilderFactory.BlobEndpointBuilder sourceBlobAccessKey(String sourceBlobAccessKey)
Source Blob Access Key: for copyblob operation, sadly, we need to have an accessKey for the source blob we want to copy Passing an accessKey as header, it's unsafe so we could set as key. The option is a: <code>java.lang.String</code> type. Group: security- Specified by:
sourceBlobAccessKey
in interfaceBlobEndpointBuilderFactory.BlobEndpointConsumerBuilder
- Specified by:
sourceBlobAccessKey
in interfaceBlobEndpointBuilderFactory.BlobEndpointProducerBuilder
- Parameters:
sourceBlobAccessKey
- the value to set- Returns:
- the dsl builder
-
-