Interface BlobEndpointBuilderFactory.BlobEndpointProducerBuilder

  • All Superinterfaces:
    org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver
    All Known Subinterfaces:
    BlobEndpointBuilderFactory.BlobEndpointBuilder
    Enclosing interface:
    BlobEndpointBuilderFactory

    public static interface BlobEndpointBuilderFactory.BlobEndpointProducerBuilder
    extends org.apache.camel.builder.EndpointProducerBuilder
    Builder for endpoint producers for the Azure Storage Blob Service component.
    • Method Detail

      • autoDiscoverClient

        default BlobEndpointBuilderFactory.BlobEndpointProducerBuilder 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.BlobEndpointProducerBuilder 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 a boolean type. Default: true Group: common
      • blobServiceClient

        default BlobEndpointBuilderFactory.BlobEndpointProducerBuilder 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.BlobEndpointProducerBuilder 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 com.azure.storage.blob.BlobServiceClient type. Group: common
      • blobType

        default BlobEndpointBuilderFactory.BlobEndpointProducerBuilder blobType​(String blobType)
        The blob type in order to initiate the appropriate settings for each blob type. The option will be converted to a org.apache.camel.component.azure.storage.blob.BlobType type. Default: blockblob Group: common
      • credentials

        default BlobEndpointBuilderFactory.BlobEndpointProducerBuilder 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.BlobEndpointProducerBuilder 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 com.azure.storage.common.StorageSharedKeyCredential type. Group: common
      • maxResultsPerPage

        default BlobEndpointBuilderFactory.BlobEndpointProducerBuilder 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.BlobEndpointProducerBuilder 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 java.lang.Integer type. Group: common
      • maxRetryRequests

        default BlobEndpointBuilderFactory.BlobEndpointProducerBuilder 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.BlobEndpointProducerBuilder 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 int type. Default: 0 Group: common
      • regex

        default BlobEndpointBuilderFactory.BlobEndpointProducerBuilder 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.BlobEndpointProducerBuilder 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.BlobEndpointProducerBuilder 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 com.azure.storage.blob.BlobServiceClient type. Group: common
      • blobSequenceNumber

        default BlobEndpointBuilderFactory.BlobEndpointProducerBuilder 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: java.lang.Long type. Default: 0 Group: producer
      • blobSequenceNumber

        default BlobEndpointBuilderFactory.BlobEndpointProducerBuilder blobSequenceNumber​(String 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 will be converted to a java.lang.Long type. Default: 0 Group: producer
      • commitBlockListLater

        default BlobEndpointBuilderFactory.BlobEndpointProducerBuilder commitBlockListLater​(boolean commitBlockListLater)
        When is set to true, the staged blocks will not be committed directly. The option is a: boolean type. Default: true Group: producer
      • createAppendBlob

        default BlobEndpointBuilderFactory.BlobEndpointProducerBuilder createAppendBlob​(boolean createAppendBlob)
        When is set to true, the append blocks will be created when committing append blocks. The option is a: boolean type. Default: true Group: producer
      • lazyStartProducer

        default BlobEndpointBuilderFactory.BlobEndpointProducerBuilder 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: boolean type. Default: false Group: producer
      • lazyStartProducer

        default BlobEndpointBuilderFactory.BlobEndpointProducerBuilder lazyStartProducer​(String 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 will be converted to a boolean type. Default: false Group: producer
      • operation

        default BlobEndpointBuilderFactory.BlobEndpointProducerBuilder operation​(String operation)
        The blob operation that can be used with this component on the producer. The option will be converted to a org.apache.camel.component.azure.storage.blob.BlobOperationsDefinition type. Default: listBlobContainers Group: producer
      • pageBlobSize

        default BlobEndpointBuilderFactory.BlobEndpointProducerBuilder 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: java.lang.Long type. Default: 512 Group: producer
      • pageBlobSize

        default BlobEndpointBuilderFactory.BlobEndpointProducerBuilder pageBlobSize​(String 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 will be converted to a java.lang.Long type. Default: 512 Group: producer