org.apache.camel.builder.endpoint.dsl

Interface BlobServiceEndpointBuilderFactory.BlobServiceEndpointBuilder

All Superinterfaces:

BlobServiceEndpointBuilderFactory.BlobServiceEndpointConsumerBuilder, BlobServiceEndpointBuilderFactory.BlobServiceEndpointProducerBuilder, org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver, org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver

Enclosing interface:

BlobServiceEndpointBuilderFactory

public static interface BlobServiceEndpointBuilderFactory.BlobServiceEndpointBuilder
extends BlobServiceEndpointBuilderFactory.BlobServiceEndpointConsumerBuilder, BlobServiceEndpointBuilderFactory.BlobServiceEndpointProducerBuilder

Builder for endpoint for the Azure Storage Blob Service (Deprecated) component.

Method Summary

Modifier and Type	Method and Description
default BlobServiceEndpointBuilderFactory.AdvancedBlobServiceEndpointBuilder	advanced()
default BlobServiceEndpointBuilderFactory.BlobServiceEndpointBuilder	azureBlobClient(Object azureBlobClient) The blob service client.
default BlobServiceEndpointBuilderFactory.BlobServiceEndpointBuilder	azureBlobClient(String azureBlobClient) The blob service client.
default BlobServiceEndpointBuilderFactory.BlobServiceEndpointBuilder	blobOffset(Long blobOffset) Set the blob offset for the upload or download operations, default is 0.
default BlobServiceEndpointBuilderFactory.BlobServiceEndpointBuilder	blobOffset(String blobOffset) Set the blob offset for the upload or download operations, default is 0.
default BlobServiceEndpointBuilderFactory.BlobServiceEndpointBuilder	blobType(BlobServiceEndpointBuilderFactory.BlobType blobType) Set a blob type, 'blockblob' is default.
default BlobServiceEndpointBuilderFactory.BlobServiceEndpointBuilder	blobType(String blobType) Set a blob type, 'blockblob' is default.
default BlobServiceEndpointBuilderFactory.BlobServiceEndpointBuilder	closeStreamAfterRead(boolean closeStreamAfterRead) Close the stream after read or keep it open, default is true.
default BlobServiceEndpointBuilderFactory.BlobServiceEndpointBuilder	closeStreamAfterRead(String closeStreamAfterRead) Close the stream after read or keep it open, default is true.
default BlobServiceEndpointBuilderFactory.BlobServiceEndpointBuilder	credentials(Object credentials) Set the storage credentials, required in most cases.
default BlobServiceEndpointBuilderFactory.BlobServiceEndpointBuilder	credentials(String credentials) Set the storage credentials, required in most cases.
default BlobServiceEndpointBuilderFactory.BlobServiceEndpointBuilder	credentialsAccountKey(String credentialsAccountKey) Set the storage account key used during authentication phase.
default BlobServiceEndpointBuilderFactory.BlobServiceEndpointBuilder	credentialsAccountName(String credentialsAccountName) Set the storage account name used during authentication phase.
default BlobServiceEndpointBuilderFactory.BlobServiceEndpointBuilder	dataLength(Long dataLength) Set the data length for the download or page blob upload operations.
default BlobServiceEndpointBuilderFactory.BlobServiceEndpointBuilder	dataLength(String dataLength) Set the data length for the download or page blob upload operations.
default BlobServiceEndpointBuilderFactory.BlobServiceEndpointBuilder	fileDir(String fileDir) Set the file directory where the downloaded blobs will be saved to.
default BlobServiceEndpointBuilderFactory.BlobServiceEndpointBuilder	publicForRead(boolean publicForRead) Storage resources can be public for reading their content, if this property is enabled then the credentials do not have to be set.
default BlobServiceEndpointBuilderFactory.BlobServiceEndpointBuilder	publicForRead(String publicForRead) Storage resources can be public for reading their content, if this property is enabled then the credentials do not have to be set.
default BlobServiceEndpointBuilderFactory.BlobServiceEndpointBuilder	streamReadSize(int streamReadSize) Set the minimum read size in bytes when reading the blob content.
default BlobServiceEndpointBuilderFactory.BlobServiceEndpointBuilder	streamReadSize(String streamReadSize) Set the minimum read size in bytes when reading the blob content.
default BlobServiceEndpointBuilderFactory.BlobServiceEndpointBuilder	validateClientURI(boolean validateClientURI) Whether to validate the Azure client URI.
default BlobServiceEndpointBuilderFactory.BlobServiceEndpointBuilder	validateClientURI(String validateClientURI) Whether to validate the Azure client URI.

Methods inherited from interface org.apache.camel.builder.endpoint.dsl.BlobServiceEndpointBuilderFactory.BlobServiceEndpointConsumerBuilder

bridgeErrorHandler, bridgeErrorHandler

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

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, getUri

Methods inherited from interface org.apache.camel.EndpointConsumerResolver

resolve, resolve

Methods inherited from interface org.apache.camel.builder.endpoint.dsl.BlobServiceEndpointBuilderFactory.BlobServiceEndpointProducerBuilder

blobMetadata, blobMetadata, blobPrefix, closeStreamAfterWrite, closeStreamAfterWrite, lazyStartProducer, lazyStartProducer, operation, operation, streamWriteSize, streamWriteSize, useFlatListing, useFlatListing

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 BlobServiceEndpointBuilderFactory.AdvancedBlobServiceEndpointBuilder advanced()

Specified by:

advanced in interface BlobServiceEndpointBuilderFactory.BlobServiceEndpointConsumerBuilder

Specified by:

advanced in interface BlobServiceEndpointBuilderFactory.BlobServiceEndpointProducerBuilder

azureBlobClient

default BlobServiceEndpointBuilderFactory.BlobServiceEndpointBuilder azureBlobClient(Object azureBlobClient)

The blob service client. The option is a: <code>com.microsoft.azure.storage.blob.CloudBlob</code> type. Group: common

Specified by:

azureBlobClient in interface BlobServiceEndpointBuilderFactory.BlobServiceEndpointConsumerBuilder

Specified by:

azureBlobClient in interface BlobServiceEndpointBuilderFactory.BlobServiceEndpointProducerBuilder

Parameters:

azureBlobClient - the value to set

Returns:

the dsl builder

azureBlobClient

default BlobServiceEndpointBuilderFactory.BlobServiceEndpointBuilder azureBlobClient(String azureBlobClient)

The blob service client. The option will be converted to a <code>com.microsoft.azure.storage.blob.CloudBlob</code> type. Group: common

Specified by:

azureBlobClient in interface BlobServiceEndpointBuilderFactory.BlobServiceEndpointConsumerBuilder

Specified by:

azureBlobClient in interface BlobServiceEndpointBuilderFactory.BlobServiceEndpointProducerBuilder

Parameters:

azureBlobClient - the value to set

Returns:

the dsl builder

blobOffset

default BlobServiceEndpointBuilderFactory.BlobServiceEndpointBuilder blobOffset(Long blobOffset)

Set the blob offset for the upload or download operations, default is 0. The option is a: <code>java.lang.Long</code> type. Default: 0 Group: common

Specified by:

blobOffset in interface BlobServiceEndpointBuilderFactory.BlobServiceEndpointConsumerBuilder

Specified by:

blobOffset in interface BlobServiceEndpointBuilderFactory.BlobServiceEndpointProducerBuilder

Parameters:

blobOffset - the value to set

Returns:

the dsl builder

blobOffset

default BlobServiceEndpointBuilderFactory.BlobServiceEndpointBuilder blobOffset(String blobOffset)

Set the blob offset for the upload or download operations, default is 0. The option will be converted to a <code>java.lang.Long</code> type. Default: 0 Group: common

Specified by:

blobOffset in interface BlobServiceEndpointBuilderFactory.BlobServiceEndpointConsumerBuilder

Specified by:

blobOffset in interface BlobServiceEndpointBuilderFactory.BlobServiceEndpointProducerBuilder

Parameters:

blobOffset - the value to set

Returns:

the dsl builder

blobType

default BlobServiceEndpointBuilderFactory.BlobServiceEndpointBuilder blobType(BlobServiceEndpointBuilderFactory.BlobType blobType)

Set a blob type, 'blockblob' is default. The option is a: <code>org.apache.camel.component.azure.blob.BlobType</code> type. Default: blockblob Group: common

Specified by:

blobType in interface BlobServiceEndpointBuilderFactory.BlobServiceEndpointConsumerBuilder

Specified by:

blobType in interface BlobServiceEndpointBuilderFactory.BlobServiceEndpointProducerBuilder

Parameters:

blobType - the value to set

Returns:

the dsl builder

blobType

default BlobServiceEndpointBuilderFactory.BlobServiceEndpointBuilder blobType(String blobType)

Set a blob type, 'blockblob' is default. The option will be converted to a <code>org.apache.camel.component.azure.blob.BlobType</code> type. Default: blockblob Group: common

Specified by:

blobType in interface BlobServiceEndpointBuilderFactory.BlobServiceEndpointConsumerBuilder

Specified by:

blobType in interface BlobServiceEndpointBuilderFactory.BlobServiceEndpointProducerBuilder

Parameters:

blobType - the value to set

Returns:

the dsl builder

closeStreamAfterRead

default BlobServiceEndpointBuilderFactory.BlobServiceEndpointBuilder 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 interface BlobServiceEndpointBuilderFactory.BlobServiceEndpointConsumerBuilder

Specified by:

closeStreamAfterRead in interface BlobServiceEndpointBuilderFactory.BlobServiceEndpointProducerBuilder

Parameters:

closeStreamAfterRead - the value to set

Returns:

the dsl builder

closeStreamAfterRead

default BlobServiceEndpointBuilderFactory.BlobServiceEndpointBuilder 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 interface BlobServiceEndpointBuilderFactory.BlobServiceEndpointConsumerBuilder

Specified by:

closeStreamAfterRead in interface BlobServiceEndpointBuilderFactory.BlobServiceEndpointProducerBuilder

Parameters:

closeStreamAfterRead - the value to set

Returns:

the dsl builder

credentials

default BlobServiceEndpointBuilderFactory.BlobServiceEndpointBuilder credentials(Object credentials)

Set the storage credentials, required in most cases. The option is a: <code>com.microsoft.azure.storage.StorageCredentials</code> type. Group: common

Specified by:

credentials in interface BlobServiceEndpointBuilderFactory.BlobServiceEndpointConsumerBuilder

Specified by:

credentials in interface BlobServiceEndpointBuilderFactory.BlobServiceEndpointProducerBuilder

Parameters:

credentials - the value to set

Returns:

the dsl builder

credentials

default BlobServiceEndpointBuilderFactory.BlobServiceEndpointBuilder credentials(String credentials)

Set the storage credentials, required in most cases. The option will be converted to a <code>com.microsoft.azure.storage.StorageCredentials</code> type. Group: common

Specified by:

credentials in interface BlobServiceEndpointBuilderFactory.BlobServiceEndpointConsumerBuilder

Specified by:

credentials in interface BlobServiceEndpointBuilderFactory.BlobServiceEndpointProducerBuilder

Parameters:

credentials - the value to set

Returns:

the dsl builder

dataLength

default BlobServiceEndpointBuilderFactory.BlobServiceEndpointBuilder dataLength(Long dataLength)

Set the data length for the download or page blob upload operations. The option is a: <code>java.lang.Long</code> type. Group: common

Specified by:

dataLength in interface BlobServiceEndpointBuilderFactory.BlobServiceEndpointConsumerBuilder

Specified by:

dataLength in interface BlobServiceEndpointBuilderFactory.BlobServiceEndpointProducerBuilder

Parameters:

dataLength - the value to set

Returns:

the dsl builder

dataLength

default BlobServiceEndpointBuilderFactory.BlobServiceEndpointBuilder dataLength(String dataLength)

Set the data length for the download or page blob upload operations. The option will be converted to a <code>java.lang.Long</code> type. Group: common

Specified by:

dataLength in interface BlobServiceEndpointBuilderFactory.BlobServiceEndpointConsumerBuilder

Specified by:

dataLength in interface BlobServiceEndpointBuilderFactory.BlobServiceEndpointProducerBuilder

Parameters:

dataLength - the value to set

Returns:

the dsl builder

fileDir

default BlobServiceEndpointBuilderFactory.BlobServiceEndpointBuilder fileDir(String fileDir)

Set the file directory where the downloaded blobs will be saved to. The option is a: <code>java.lang.String</code> type. Group: common

Specified by:

fileDir in interface BlobServiceEndpointBuilderFactory.BlobServiceEndpointConsumerBuilder

Specified by:

fileDir in interface BlobServiceEndpointBuilderFactory.BlobServiceEndpointProducerBuilder

Parameters:

fileDir - the value to set

Returns:

the dsl builder

publicForRead

default BlobServiceEndpointBuilderFactory.BlobServiceEndpointBuilder publicForRead(boolean publicForRead)

Storage resources can be public for reading their content, if this property is enabled then the credentials do not have to be set. The option is a: <code>boolean</code> type. Default: false Group: common

Specified by:

publicForRead in interface BlobServiceEndpointBuilderFactory.BlobServiceEndpointConsumerBuilder

Specified by:

publicForRead in interface BlobServiceEndpointBuilderFactory.BlobServiceEndpointProducerBuilder

Parameters:

publicForRead - the value to set

Returns:

the dsl builder

publicForRead

default BlobServiceEndpointBuilderFactory.BlobServiceEndpointBuilder publicForRead(String publicForRead)

Storage resources can be public for reading their content, if this property is enabled then the credentials do not have to be set. The option will be converted to a <code>boolean</code> type. Default: false Group: common

Specified by:

publicForRead in interface BlobServiceEndpointBuilderFactory.BlobServiceEndpointConsumerBuilder

Specified by:

publicForRead in interface BlobServiceEndpointBuilderFactory.BlobServiceEndpointProducerBuilder

Parameters:

publicForRead - the value to set

Returns:

the dsl builder

streamReadSize

default BlobServiceEndpointBuilderFactory.BlobServiceEndpointBuilder streamReadSize(int streamReadSize)

Set the minimum read size in bytes when reading the blob content. The option is a: <code>int</code> type. Group: common

Specified by:

streamReadSize in interface BlobServiceEndpointBuilderFactory.BlobServiceEndpointConsumerBuilder

Specified by:

streamReadSize in interface BlobServiceEndpointBuilderFactory.BlobServiceEndpointProducerBuilder

Parameters:

streamReadSize - the value to set

Returns:

the dsl builder

streamReadSize

default BlobServiceEndpointBuilderFactory.BlobServiceEndpointBuilder streamReadSize(String streamReadSize)

Set the minimum read size in bytes when reading the blob content. The option will be converted to a <code>int</code> type. Group: common

Specified by:

streamReadSize in interface BlobServiceEndpointBuilderFactory.BlobServiceEndpointConsumerBuilder

Specified by:

streamReadSize in interface BlobServiceEndpointBuilderFactory.BlobServiceEndpointProducerBuilder

Parameters:

streamReadSize - the value to set

Returns:

the dsl builder

validateClientURI

default BlobServiceEndpointBuilderFactory.BlobServiceEndpointBuilder validateClientURI(boolean validateClientURI)

Whether to validate the Azure client URI. The option is a: <code>boolean</code> type. Default: true Group: common

Specified by:

validateClientURI in interface BlobServiceEndpointBuilderFactory.BlobServiceEndpointConsumerBuilder

Specified by:

validateClientURI in interface BlobServiceEndpointBuilderFactory.BlobServiceEndpointProducerBuilder

Parameters:

validateClientURI - the value to set

Returns:

the dsl builder

validateClientURI

default BlobServiceEndpointBuilderFactory.BlobServiceEndpointBuilder validateClientURI(String validateClientURI)

Whether to validate the Azure client URI. The option will be converted to a <code>boolean</code> type. Default: true Group: common

Specified by:

validateClientURI in interface BlobServiceEndpointBuilderFactory.BlobServiceEndpointConsumerBuilder

Specified by:

validateClientURI in interface BlobServiceEndpointBuilderFactory.BlobServiceEndpointProducerBuilder

Parameters:

validateClientURI - the value to set

Returns:

the dsl builder

credentialsAccountKey

default BlobServiceEndpointBuilderFactory.BlobServiceEndpointBuilder credentialsAccountKey(String credentialsAccountKey)

Set the storage account key used during authentication phase. The option is a: <code>java.lang.String</code> type. Group: security

Specified by:

credentialsAccountKey in interface BlobServiceEndpointBuilderFactory.BlobServiceEndpointConsumerBuilder

Specified by:

credentialsAccountKey in interface BlobServiceEndpointBuilderFactory.BlobServiceEndpointProducerBuilder

Parameters:

credentialsAccountKey - the value to set

Returns:

the dsl builder

credentialsAccountName

default BlobServiceEndpointBuilderFactory.BlobServiceEndpointBuilder credentialsAccountName(String credentialsAccountName)

Set the storage account name used during authentication phase. The option is a: <code>java.lang.String</code> type. Group: security

Specified by:

credentialsAccountName in interface BlobServiceEndpointBuilderFactory.BlobServiceEndpointConsumerBuilder

Specified by:

credentialsAccountName in interface BlobServiceEndpointBuilderFactory.BlobServiceEndpointProducerBuilder

Parameters:

credentialsAccountName - the value to set

Returns:

the dsl builder