Package org.apache.camel.builder.component.dsl

Interface AzureStorageBlobComponentBuilderFactory.AzureStorageBlobComponentBuilder

All Superinterfaces:
ComponentBuilder<org.apache.camel.component.azure.storage.blob.BlobComponent>
All Known Implementing Classes:
AzureStorageBlobComponentBuilderFactory.AzureStorageBlobComponentBuilderImpl
Enclosing interface:
AzureStorageBlobComponentBuilderFactory
public static interface AzureStorageBlobComponentBuilderFactory.AzureStorageBlobComponentBuilder extends ComponentBuilder<org.apache.camel.component.azure.storage.blob.BlobComponent>
Builder for the Azure Storage Blob Service component.

  • Method Details

    • blobName

      default AzureStorageBlobComponentBuilderFactory.AzureStorageBlobComponentBuilder blobName(String blobName)
      The blob name, to consume specific blob from a container. However, on producer it is only required for the operations on the blob level. The option is a: <code>java.lang.String</code> type. Group: common
      Parameters:
      blobName - the value to set
      Returns:
      the dsl builder

    • blobOffset

      default AzureStorageBlobComponentBuilderFactory.AzureStorageBlobComponentBuilder blobOffset(long blobOffset)
      Set the blob offset for the upload or download operations, default is 0. The option is a: <code>long</code> type. Group: common
      Parameters:
      blobOffset - the value to set
      Returns:
      the dsl builder

    • blobType

      default AzureStorageBlobComponentBuilderFactory.AzureStorageBlobComponentBuilder 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
      Parameters:
      blobType - the value to set
      Returns:
      the dsl builder

    • closeStreamAfterRead

      default AzureStorageBlobComponentBuilderFactory.AzureStorageBlobComponentBuilder 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
      Parameters:
      closeStreamAfterRead - the value to set
      Returns:
      the dsl builder

    • configuration

      default AzureStorageBlobComponentBuilderFactory.AzureStorageBlobComponentBuilder configuration(org.apache.camel.component.azure.storage.blob.BlobConfiguration configuration)
      The component configurations. The option is a: <code>org.apache.camel.component.azure.storage.blob.BlobConfiguration</code> type. Group: common
      Parameters:
      configuration - the value to set
      Returns:
      the dsl builder

    • credentials

      default AzureStorageBlobComponentBuilderFactory.AzureStorageBlobComponentBuilder 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
      Parameters:
      credentials - the value to set
      Returns:
      the dsl builder

    • credentialType

      default AzureStorageBlobComponentBuilderFactory.AzureStorageBlobComponentBuilder credentialType(org.apache.camel.component.azure.storage.blob.CredentialType credentialType)
      Determines the credential strategy to adopt. The option is a: <code>org.apache.camel.component.azure.storage.blob.CredentialType</code> type. Default: AZURE_IDENTITY Group: common
      Parameters:
      credentialType - the value to set
      Returns:
      the dsl builder

    • dataCount

      default AzureStorageBlobComponentBuilderFactory.AzureStorageBlobComponentBuilder 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
      Parameters:
      dataCount - the value to set
      Returns:
      the dsl builder

    • fileDir

      default AzureStorageBlobComponentBuilderFactory.AzureStorageBlobComponentBuilder 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
      Parameters:
      fileDir - the value to set
      Returns:
      the dsl builder

    • leaseBlob

      default AzureStorageBlobComponentBuilderFactory.AzureStorageBlobComponentBuilder leaseBlob(boolean leaseBlob)
      Sets whether a lease should be acquired when accessing the blob. When set to true, the component will acquire a lease before performing blob operations that require exclusive access. The option is a: <code>boolean</code> type. Default: false Group: common
      Parameters:
      leaseBlob - the value to set
      Returns:
      the dsl builder

    • leaseDurationInSeconds

      default AzureStorageBlobComponentBuilderFactory.AzureStorageBlobComponentBuilder leaseDurationInSeconds(Integer leaseDurationInSeconds)
      Sets the lease duration in seconds. Use -1 for infinite or a value between 15 and 60 for fixed leases. The option is a: <code>java.lang.Integer</code> type. Default: 60 Group: common
      Parameters:
      leaseDurationInSeconds - the value to set
      Returns:
      the dsl builder

    • maxResultsPerPage

      default AzureStorageBlobComponentBuilderFactory.AzureStorageBlobComponentBuilder 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
      Parameters:
      maxResultsPerPage - the value to set
      Returns:
      the dsl builder

    • maxRetryRequests

      default AzureStorageBlobComponentBuilderFactory.AzureStorageBlobComponentBuilder 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. Group: common
      Parameters:
      maxRetryRequests - the value to set
      Returns:
      the dsl builder

    • prefix

      default AzureStorageBlobComponentBuilderFactory.AzureStorageBlobComponentBuilder 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
      Parameters:
      prefix - the value to set
      Returns:
      the dsl builder

    • regex

      default AzureStorageBlobComponentBuilderFactory.AzureStorageBlobComponentBuilder 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
      Parameters:
      regex - the value to set
      Returns:
      the dsl builder

    • sasToken

      default AzureStorageBlobComponentBuilderFactory.AzureStorageBlobComponentBuilder sasToken(String sasToken)
      In case of usage of Shared Access Signature we'll need to set a SAS Token. The option is a: <code>java.lang.String</code> type. Group: common
      Parameters:
      sasToken - the value to set
      Returns:
      the dsl builder

    • serviceClient

      default AzureStorageBlobComponentBuilderFactory.AzureStorageBlobComponentBuilder 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
      Parameters:
      serviceClient - the value to set
      Returns:
      the dsl builder

    • timeout

      default AzureStorageBlobComponentBuilderFactory.AzureStorageBlobComponentBuilder 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
      Parameters:
      timeout - the value to set
      Returns:
      the dsl builder

    • bridgeErrorHandler

      default AzureStorageBlobComponentBuilderFactory.AzureStorageBlobComponentBuilder bridgeErrorHandler(boolean bridgeErrorHandler)
      Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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: <code>boolean</code> type. Default: false Group: consumer
      Parameters:
      bridgeErrorHandler - the value to set
      Returns:
      the dsl builder

    • deleteAfterRead

      default AzureStorageBlobComponentBuilderFactory.AzureStorageBlobComponentBuilder deleteAfterRead(boolean deleteAfterRead)
      Delete blobs from Azure after they have been retrieved. The delete is only performed if the Exchange is committed. If a rollback occurs, the blob is not deleted. If this option is false, then the same blobs will be retrieved over and over again in the polls. Therefore, you need to use the Idempotent Consumer EIP in the route to filter out duplicates. You can filter using the BlobConstants#BLOB_NAME header, or only the blob name. The option is a: <code>boolean</code> type. Default: false Group: consumer
      Parameters:
      deleteAfterRead - the value to set
      Returns:
      the dsl builder

    • destinationBlobPrefix

      default AzureStorageBlobComponentBuilderFactory.AzureStorageBlobComponentBuilder destinationBlobPrefix(String destinationBlobPrefix)
      Define the destination blob prefix to use when a blob must be moved, and moveAfterRead is set to true. The option is a: <code>java.lang.String</code> type. Group: consumer
      Parameters:
      destinationBlobPrefix - the value to set
      Returns:
      the dsl builder

    • destinationBlobSuffix

      default AzureStorageBlobComponentBuilderFactory.AzureStorageBlobComponentBuilder destinationBlobSuffix(String destinationBlobSuffix)
      Define the destination blob suffix to use when a blob must be moved, and moveAfterRead is set to true. The option is a: <code>java.lang.String</code> type. Group: consumer
      Parameters:
      destinationBlobSuffix - the value to set
      Returns:
      the dsl builder

    • destinationContainer

      default AzureStorageBlobComponentBuilderFactory.AzureStorageBlobComponentBuilder destinationContainer(String destinationContainer)
      Define the destination container where a blob must be moved when moveAfterRead is set to true. The option is a: <code>java.lang.String</code> type. Group: consumer
      Parameters:
      destinationContainer - the value to set
      Returns:
      the dsl builder

    • moveAfterRead

      default AzureStorageBlobComponentBuilderFactory.AzureStorageBlobComponentBuilder moveAfterRead(boolean moveAfterRead)
      Move blobs from the container to a different container after they have been retrieved. To accomplish the operation, the destinationContainer option must be set. The copy blob operation is only performed if the Exchange is committed. If a rollback occurs, the blob is not moved. The option is a: <code>boolean</code> type. Default: false Group: consumer
      Parameters:
      moveAfterRead - the value to set
      Returns:
      the dsl builder

    • removePrefixOnMove

      default AzureStorageBlobComponentBuilderFactory.AzureStorageBlobComponentBuilder removePrefixOnMove(boolean removePrefixOnMove)
      Remove the contents of the prefix configuration string from the new blob name before moving. For example, if prefix is set to 'notify/' and the destinationBlobPrefix is set to 'archive/', a blob with a name of 'notify/example.txt' will be moved to 'archive/example.txt', rather than the default behavior where the new name is 'archive/notify/example.txt'. Only applicable when moveAfterRead is true. The option is a: <code>boolean</code> type. Default: false Group: consumer
      Parameters:
      removePrefixOnMove - the value to set
      Returns:
      the dsl builder

    • blobSequenceNumber

      default AzureStorageBlobComponentBuilderFactory.AzureStorageBlobComponentBuilder blobSequenceNumber(Long blobSequenceNumber)
      A user-controlled value that you can use to track requests. The value of the sequence number must be between 0 and 263 - 1.The default value is 0. The option is a: <code>java.lang.Long</code> type. Group: producer
      Parameters:
      blobSequenceNumber - the value to set
      Returns:
      the dsl builder

    • blockListType

      default AzureStorageBlobComponentBuilderFactory.AzureStorageBlobComponentBuilder blockListType(com.azure.storage.blob.models.BlockListType blockListType)
      Specifies which type of blocks to return. The option is a: <code>com.azure.storage.blob.models.BlockListType</code> type. Default: COMMITTED Group: producer
      Parameters:
      blockListType - the value to set
      Returns:
      the dsl builder

    • blockSize

      default AzureStorageBlobComponentBuilderFactory.AzureStorageBlobComponentBuilder blockSize(Long blockSize)
      The block size in bytes to use for chunked uploads with uploadBlockBlobChunked operation. Default is 4MB (4194304). Maximum is 4000MB. Must be greater than 0. The option is a: <code>java.lang.Long</code> type. Group: producer
      Parameters:
      blockSize - the value to set
      Returns:
      the dsl builder

    • changeFeedContext

      default AzureStorageBlobComponentBuilderFactory.AzureStorageBlobComponentBuilder changeFeedContext(com.azure.core.util.Context changeFeedContext)
      When using getChangeFeed producer operation, this gives additional context that is passed through the Http pipeline during the service call. The option is a: <code>com.azure.core.util.Context</code> type. Group: producer
      Parameters:
      changeFeedContext - the value to set
      Returns:
      the dsl builder

    • changeFeedEndTime

      default AzureStorageBlobComponentBuilderFactory.AzureStorageBlobComponentBuilder changeFeedEndTime(OffsetDateTime changeFeedEndTime)
      When using getChangeFeed producer operation, this filters the results to return events approximately before the end time. Note: A few events belonging to the next hour can also be returned. A few events belonging to this hour can be missing; to ensure all events from the hour are returned, round the end time up by an hour. The option is a: <code>java.time.OffsetDateTime</code> type. Group: producer
      Parameters:
      changeFeedEndTime - the value to set
      Returns:
      the dsl builder

    • changeFeedStartTime

      default AzureStorageBlobComponentBuilderFactory.AzureStorageBlobComponentBuilder changeFeedStartTime(OffsetDateTime changeFeedStartTime)
      When using getChangeFeed producer operation, this filters the results to return events approximately after the start time. Note: A few events belonging to the previous hour can also be returned. A few events belonging to this hour can be missing; to ensure all events from the hour are returned, round the start time down by an hour. The option is a: <code>java.time.OffsetDateTime</code> type. Group: producer
      Parameters:
      changeFeedStartTime - the value to set
      Returns:
      the dsl builder

    • closeStreamAfterWrite

      default AzureStorageBlobComponentBuilderFactory.AzureStorageBlobComponentBuilder closeStreamAfterWrite(boolean closeStreamAfterWrite)
      Close the stream after write or keep it open, default is true. The option is a: <code>boolean</code> type. Default: true Group: producer
      Parameters:
      closeStreamAfterWrite - the value to set
      Returns:
      the dsl builder

    • commitBlockListLater

      default AzureStorageBlobComponentBuilderFactory.AzureStorageBlobComponentBuilder commitBlockListLater(boolean commitBlockListLater)
      When is set to true, the staged blocks will not be committed directly. The option is a: <code>boolean</code> type. Default: true Group: producer
      Parameters:
      commitBlockListLater - the value to set
      Returns:
      the dsl builder

    • createAppendBlob

      default AzureStorageBlobComponentBuilderFactory.AzureStorageBlobComponentBuilder createAppendBlob(boolean createAppendBlob)
      When is set to true, the append blocks will be created when committing append blocks. The option is a: <code>boolean</code> type. Default: true Group: producer
      Parameters:
      createAppendBlob - the value to set
      Returns:
      the dsl builder

    • createPageBlob

      default AzureStorageBlobComponentBuilderFactory.AzureStorageBlobComponentBuilder createPageBlob(boolean createPageBlob)
      When is set to true, the page blob will be created when uploading page blob. The option is a: <code>boolean</code> type. Default: true Group: producer
      Parameters:
      createPageBlob - the value to set
      Returns:
      the dsl builder

    • downloadLinkExpiration

      default AzureStorageBlobComponentBuilderFactory.AzureStorageBlobComponentBuilder downloadLinkExpiration(Long downloadLinkExpiration)
      Override the default expiration (millis) of URL download link. The option is a: <code>java.lang.Long</code> type. Group: producer
      Parameters:
      downloadLinkExpiration - the value to set
      Returns:
      the dsl builder

    • lazyStartProducer

      default AzureStorageBlobComponentBuilderFactory.AzureStorageBlobComponentBuilder 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: <code>boolean</code> type. Default: false Group: producer
      Parameters:
      lazyStartProducer - the value to set
      Returns:
      the dsl builder

    • maxConcurrency

      default AzureStorageBlobComponentBuilderFactory.AzureStorageBlobComponentBuilder maxConcurrency(Integer maxConcurrency)
      The maximum number of parallel requests to use during upload with uploadBlockBlobChunked operation. Default is determined by the Azure SDK based on available processors. The option is a: <code>java.lang.Integer</code> type. Group: producer
      Parameters:
      maxConcurrency - the value to set
      Returns:
      the dsl builder

    • maxSingleUploadSize

      default AzureStorageBlobComponentBuilderFactory.AzureStorageBlobComponentBuilder maxSingleUploadSize(Long maxSingleUploadSize)
      The maximum size in bytes for a single upload request with uploadBlockBlobChunked operation. Files smaller than this will be uploaded in a single request. Files larger will use chunked upload with blocks of size blockSize. Default is 256MB. The option is a: <code>java.lang.Long</code> type. Group: producer
      Parameters:
      maxSingleUploadSize - the value to set
      Returns:
      the dsl builder

    • operation

      default AzureStorageBlobComponentBuilderFactory.AzureStorageBlobComponentBuilder operation(org.apache.camel.component.azure.storage.blob.BlobOperationsDefinition operation)
      The blob operation that can be used with this component on the producer. The option is a: <code>org.apache.camel.component.azure.storage.blob.BlobOperationsDefinition</code> type. Default: listBlobContainers Group: producer
      Parameters:
      operation - the value to set
      Returns:
      the dsl builder

    • pageBlobSize

      default AzureStorageBlobComponentBuilderFactory.AzureStorageBlobComponentBuilder pageBlobSize(Long pageBlobSize)
      Specifies the maximum size for the page blob, up to 8 TB. The page blob size must be aligned to a 512-byte boundary. The option is a: <code>java.lang.Long</code> type. Default: 512 Group: producer
      Parameters:
      pageBlobSize - the value to set
      Returns:
      the dsl builder

    • autowiredEnabled

      default AzureStorageBlobComponentBuilderFactory.AzureStorageBlobComponentBuilder autowiredEnabled(boolean autowiredEnabled)
      Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. The option is a: <code>boolean</code> type. Default: true Group: advanced
      Parameters:
      autowiredEnabled - the value to set
      Returns:
      the dsl builder

    • healthCheckConsumerEnabled

      default AzureStorageBlobComponentBuilderFactory.AzureStorageBlobComponentBuilder healthCheckConsumerEnabled(boolean healthCheckConsumerEnabled)
      Used for enabling or disabling all consumer based health checks from this component. The option is a: <code>boolean</code> type. Default: true Group: health
      Parameters:
      healthCheckConsumerEnabled - the value to set
      Returns:
      the dsl builder

    • healthCheckProducerEnabled

      default AzureStorageBlobComponentBuilderFactory.AzureStorageBlobComponentBuilder healthCheckProducerEnabled(boolean healthCheckProducerEnabled)
      Used for enabling or disabling all producer based health checks from this component. Notice: Camel has by default disabled all producer based health-checks. You can turn on producer checks globally by setting camel.health.producersEnabled=true. The option is a: <code>boolean</code> type. Default: true Group: health
      Parameters:
      healthCheckProducerEnabled - the value to set
      Returns:
      the dsl builder

    • accessKey

      default AzureStorageBlobComponentBuilderFactory.AzureStorageBlobComponentBuilder 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
      Parameters:
      accessKey - the value to set
      Returns:
      the dsl builder

    • azureClientId

      default AzureStorageBlobComponentBuilderFactory.AzureStorageBlobComponentBuilder azureClientId(String azureClientId)
      Azure Client ID for authentication with Azure Identity. The option is a: <code>java.lang.String</code> type. Group: security
      Parameters:
      azureClientId - the value to set
      Returns:
      the dsl builder

    • azureClientSecret

      default AzureStorageBlobComponentBuilderFactory.AzureStorageBlobComponentBuilder azureClientSecret(String azureClientSecret)
      Azure Client Secret for authentication with Azure Identity. The option is a: <code>java.lang.String</code> type. Group: security
      Parameters:
      azureClientSecret - the value to set
      Returns:
      the dsl builder

    • azureTenantId

      default AzureStorageBlobComponentBuilderFactory.AzureStorageBlobComponentBuilder azureTenantId(String azureTenantId)
      Azure Tenant ID for authentication with Azure Identity. The option is a: <code>java.lang.String</code> type. Group: security
      Parameters:
      azureTenantId - the value to set
      Returns:
      the dsl builder

    • sourceBlobAccessKey

      default AzureStorageBlobComponentBuilderFactory.AzureStorageBlobComponentBuilder 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
      Parameters:
      sourceBlobAccessKey - the value to set
      Returns:
      the dsl builder