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

Interface AzureStorageBlobComponentBuilderFactory.AzureStorageBlobComponentBuilder

    • Method Detail

      • 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

      • 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. Default: 0 Group: common
        Parameters:
        maxRetryRequests - 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

      • 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

      • bridgeErrorHandler

        default AzureStorageBlobComponentBuilderFactory.AzureStorageBlobComponentBuilder 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: <code>boolean</code> type. Default: false Group: consumer
        Parameters:
        bridgeErrorHandler - 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. Default: 0 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

      • 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

      • 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

      • 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

      • 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