Interface BlobEndpointBuilderFactory.BlobEndpointConsumerBuilder

All Superinterfaces:
org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver
All Known Subinterfaces:
BlobEndpointBuilderFactory.BlobEndpointBuilder
Enclosing interface:
BlobEndpointBuilderFactory

public static interface BlobEndpointBuilderFactory.BlobEndpointConsumerBuilder extends org.apache.camel.builder.EndpointConsumerBuilder
Builder for endpoint consumers for the Azure Storage Blob Service component.
  • Method Details

    • advanced

    • 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 BlobEndpointBuilderFactory.BlobEndpointConsumerBuilder 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
      Parameters:
      blobOffset - the value to set
      Returns:
      the dsl builder
    • 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
      Parameters:
      blobOffset - the value to set
      Returns:
      the dsl builder
    • blobServiceClient

      default BlobEndpointBuilderFactory.BlobEndpointConsumerBuilder 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
      Parameters:
      blobServiceClient - the value to set
      Returns:
      the dsl builder
    • blobServiceClient

      default BlobEndpointBuilderFactory.BlobEndpointConsumerBuilder 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
      Parameters:
      blobServiceClient - the value to set
      Returns:
      the dsl builder
    • blobType

      default BlobEndpointBuilderFactory.BlobEndpointConsumerBuilder 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
    • 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
      Parameters:
      blobType - the value to set
      Returns:
      the dsl builder
    • closeStreamAfterRead

      default BlobEndpointBuilderFactory.BlobEndpointConsumerBuilder 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
    • closeStreamAfterRead

      default BlobEndpointBuilderFactory.BlobEndpointConsumerBuilder 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
      Parameters:
      closeStreamAfterRead - the value to set
      Returns:
      the dsl builder
    • credentials

      default BlobEndpointBuilderFactory.BlobEndpointConsumerBuilder 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
    • 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
      Parameters:
      credentials - the value to set
      Returns:
      the dsl builder
    • credentialType

      default BlobEndpointBuilderFactory.BlobEndpointConsumerBuilder 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
    • credentialType

      default BlobEndpointBuilderFactory.BlobEndpointConsumerBuilder credentialType(String credentialType)
      Determines the credential strategy to adopt. The option will be converted to 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

      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
    • 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
      Parameters:
      dataCount - the value to set
      Returns:
      the dsl builder
    • 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
    • maxResultsPerPage

      default BlobEndpointBuilderFactory.BlobEndpointConsumerBuilder 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
    • maxResultsPerPage

      default BlobEndpointBuilderFactory.BlobEndpointConsumerBuilder 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
      Parameters:
      maxResultsPerPage - the value to set
      Returns:
      the dsl builder
    • maxRetryRequests

      default BlobEndpointBuilderFactory.BlobEndpointConsumerBuilder 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
    • maxRetryRequests

      default BlobEndpointBuilderFactory.BlobEndpointConsumerBuilder 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
      Parameters:
      maxRetryRequests - the value to set
      Returns:
      the dsl builder
    • 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

      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 BlobEndpointBuilderFactory.BlobEndpointConsumerBuilder 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
    • serviceClient

      default BlobEndpointBuilderFactory.BlobEndpointConsumerBuilder 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
      Parameters:
      serviceClient - the value to set
      Returns:
      the dsl builder
    • 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
    • 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
      Parameters:
      timeout - the value to set
      Returns:
      the dsl builder
    • sendEmptyMessageWhenIdle

      default BlobEndpointBuilderFactory.BlobEndpointConsumerBuilder sendEmptyMessageWhenIdle(boolean sendEmptyMessageWhenIdle)
      If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead. The option is a: <code>boolean</code> type. Default: false Group: consumer
      Parameters:
      sendEmptyMessageWhenIdle - the value to set
      Returns:
      the dsl builder
    • sendEmptyMessageWhenIdle

      default BlobEndpointBuilderFactory.BlobEndpointConsumerBuilder sendEmptyMessageWhenIdle(String sendEmptyMessageWhenIdle)
      If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead. The option will be converted to a <code>boolean</code> type. Default: false Group: consumer
      Parameters:
      sendEmptyMessageWhenIdle - the value to set
      Returns:
      the dsl builder
    • backoffErrorThreshold

      default BlobEndpointBuilderFactory.BlobEndpointConsumerBuilder backoffErrorThreshold(int backoffErrorThreshold)
      The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. The option is a: <code>int</code> type. Group: scheduler
      Parameters:
      backoffErrorThreshold - the value to set
      Returns:
      the dsl builder
    • backoffErrorThreshold

      default BlobEndpointBuilderFactory.BlobEndpointConsumerBuilder backoffErrorThreshold(String backoffErrorThreshold)
      The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. The option will be converted to a <code>int</code> type. Group: scheduler
      Parameters:
      backoffErrorThreshold - the value to set
      Returns:
      the dsl builder
    • backoffIdleThreshold

      default BlobEndpointBuilderFactory.BlobEndpointConsumerBuilder backoffIdleThreshold(int backoffIdleThreshold)
      The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. The option is a: <code>int</code> type. Group: scheduler
      Parameters:
      backoffIdleThreshold - the value to set
      Returns:
      the dsl builder
    • backoffIdleThreshold

      default BlobEndpointBuilderFactory.BlobEndpointConsumerBuilder backoffIdleThreshold(String backoffIdleThreshold)
      The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. The option will be converted to a <code>int</code> type. Group: scheduler
      Parameters:
      backoffIdleThreshold - the value to set
      Returns:
      the dsl builder
    • backoffMultiplier

      default BlobEndpointBuilderFactory.BlobEndpointConsumerBuilder backoffMultiplier(int backoffMultiplier)
      To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. The option is a: <code>int</code> type. Group: scheduler
      Parameters:
      backoffMultiplier - the value to set
      Returns:
      the dsl builder
    • backoffMultiplier

      default BlobEndpointBuilderFactory.BlobEndpointConsumerBuilder backoffMultiplier(String backoffMultiplier)
      To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. The option will be converted to a <code>int</code> type. Group: scheduler
      Parameters:
      backoffMultiplier - the value to set
      Returns:
      the dsl builder
    • delay

      Milliseconds before the next poll. The option is a: <code>long</code> type. Default: 500 Group: scheduler
      Parameters:
      delay - the value to set
      Returns:
      the dsl builder
    • delay

      Milliseconds before the next poll. The option will be converted to a <code>long</code> type. Default: 500 Group: scheduler
      Parameters:
      delay - the value to set
      Returns:
      the dsl builder
    • greedy

      If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages. The option is a: <code>boolean</code> type. Default: false Group: scheduler
      Parameters:
      greedy - the value to set
      Returns:
      the dsl builder
    • greedy

      If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages. The option will be converted to a <code>boolean</code> type. Default: false Group: scheduler
      Parameters:
      greedy - the value to set
      Returns:
      the dsl builder
    • initialDelay

      default BlobEndpointBuilderFactory.BlobEndpointConsumerBuilder initialDelay(long initialDelay)
      Milliseconds before the first poll starts. The option is a: <code>long</code> type. Default: 1000 Group: scheduler
      Parameters:
      initialDelay - the value to set
      Returns:
      the dsl builder
    • initialDelay

      Milliseconds before the first poll starts. The option will be converted to a <code>long</code> type. Default: 1000 Group: scheduler
      Parameters:
      initialDelay - the value to set
      Returns:
      the dsl builder
    • repeatCount

      default BlobEndpointBuilderFactory.BlobEndpointConsumerBuilder repeatCount(long repeatCount)
      Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever. The option is a: <code>long</code> type. Default: 0 Group: scheduler
      Parameters:
      repeatCount - the value to set
      Returns:
      the dsl builder
    • repeatCount

      Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever. The option will be converted to a <code>long</code> type. Default: 0 Group: scheduler
      Parameters:
      repeatCount - the value to set
      Returns:
      the dsl builder
    • runLoggingLevel

      default BlobEndpointBuilderFactory.BlobEndpointConsumerBuilder runLoggingLevel(org.apache.camel.LoggingLevel runLoggingLevel)
      The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. The option is a: <code>org.apache.camel.LoggingLevel</code> type. Default: TRACE Group: scheduler
      Parameters:
      runLoggingLevel - the value to set
      Returns:
      the dsl builder
    • runLoggingLevel

      default BlobEndpointBuilderFactory.BlobEndpointConsumerBuilder runLoggingLevel(String runLoggingLevel)
      The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. The option will be converted to a <code>org.apache.camel.LoggingLevel</code> type. Default: TRACE Group: scheduler
      Parameters:
      runLoggingLevel - the value to set
      Returns:
      the dsl builder
    • scheduledExecutorService

      default BlobEndpointBuilderFactory.BlobEndpointConsumerBuilder scheduledExecutorService(ScheduledExecutorService scheduledExecutorService)
      Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. The option is a: <code>java.util.concurrent.ScheduledExecutorService</code> type. Group: scheduler
      Parameters:
      scheduledExecutorService - the value to set
      Returns:
      the dsl builder
    • scheduledExecutorService

      default BlobEndpointBuilderFactory.BlobEndpointConsumerBuilder scheduledExecutorService(String scheduledExecutorService)
      Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. The option will be converted to a <code>java.util.concurrent.ScheduledExecutorService</code> type. Group: scheduler
      Parameters:
      scheduledExecutorService - the value to set
      Returns:
      the dsl builder
    • scheduler

      To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler. The option is a: <code>java.lang.Object</code> type. Default: none Group: scheduler
      Parameters:
      scheduler - the value to set
      Returns:
      the dsl builder
    • scheduler

      To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler. The option will be converted to a <code>java.lang.Object</code> type. Default: none Group: scheduler
      Parameters:
      scheduler - the value to set
      Returns:
      the dsl builder
    • schedulerProperties

      default BlobEndpointBuilderFactory.BlobEndpointConsumerBuilder schedulerProperties(String key, Object value)
      To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler. The option is a: <code>java.util.Map&lt;java.lang.String, java.lang.Object&gt;</code> type. The option is multivalued, and you can use the schedulerProperties(String, Object) method to add a value (call the method multiple times to set more values). Group: scheduler
      Parameters:
      key - the option key
      value - the option value
      Returns:
      the dsl builder
    • schedulerProperties

      default BlobEndpointBuilderFactory.BlobEndpointConsumerBuilder schedulerProperties(Map values)
      To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler. The option is a: <code>java.util.Map&lt;java.lang.String, java.lang.Object&gt;</code> type. The option is multivalued, and you can use the schedulerProperties(String, Object) method to add a value (call the method multiple times to set more values). Group: scheduler
      Parameters:
      values - the values
      Returns:
      the dsl builder
    • startScheduler

      default BlobEndpointBuilderFactory.BlobEndpointConsumerBuilder startScheduler(boolean startScheduler)
      Whether the scheduler should be auto started. The option is a: <code>boolean</code> type. Default: true Group: scheduler
      Parameters:
      startScheduler - the value to set
      Returns:
      the dsl builder
    • startScheduler

      default BlobEndpointBuilderFactory.BlobEndpointConsumerBuilder startScheduler(String startScheduler)
      Whether the scheduler should be auto started. The option will be converted to a <code>boolean</code> type. Default: true Group: scheduler
      Parameters:
      startScheduler - the value to set
      Returns:
      the dsl builder
    • timeUnit

      Time unit for initialDelay and delay options. The option is a: <code>java.util.concurrent.TimeUnit</code> type. Default: MILLISECONDS Group: scheduler
      Parameters:
      timeUnit - the value to set
      Returns:
      the dsl builder
    • timeUnit

      Time unit for initialDelay and delay options. The option will be converted to a <code>java.util.concurrent.TimeUnit</code> type. Default: MILLISECONDS Group: scheduler
      Parameters:
      timeUnit - the value to set
      Returns:
      the dsl builder
    • useFixedDelay

      default BlobEndpointBuilderFactory.BlobEndpointConsumerBuilder useFixedDelay(boolean useFixedDelay)
      Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. The option is a: <code>boolean</code> type. Default: true Group: scheduler
      Parameters:
      useFixedDelay - the value to set
      Returns:
      the dsl builder
    • useFixedDelay

      default BlobEndpointBuilderFactory.BlobEndpointConsumerBuilder useFixedDelay(String useFixedDelay)
      Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. The option will be converted to a <code>boolean</code> type. Default: true Group: scheduler
      Parameters:
      useFixedDelay - the value to set
      Returns:
      the dsl builder
    • 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
    • sourceBlobAccessKey

      default BlobEndpointBuilderFactory.BlobEndpointConsumerBuilder 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