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

Interface AzureStorageQueueComponentBuilderFactory.AzureStorageQueueComponentBuilder

All Superinterfaces:
ComponentBuilder<org.apache.camel.component.azure.storage.queue.QueueComponent>
All Known Implementing Classes:
AzureStorageQueueComponentBuilderFactory.AzureStorageQueueComponentBuilderImpl
Enclosing interface:
AzureStorageQueueComponentBuilderFactory
public static interface AzureStorageQueueComponentBuilderFactory.AzureStorageQueueComponentBuilder extends ComponentBuilder<org.apache.camel.component.azure.storage.queue.QueueComponent>
Builder for the Azure Storage Queue Service component.

  • Method Details

    • configuration

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

    • serviceClient

      default AzureStorageQueueComponentBuilderFactory.AzureStorageQueueComponentBuilder serviceClient(com.azure.storage.queue.QueueServiceClient serviceClient)
      Service client to a storage account to interact with the queue service. 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. This client contains all the operations for interacting with a queue account in Azure Storage. Operations allowed by the client are creating, listing, and deleting queues, retrieving and updating properties of the account, and retrieving statistics of the account. The option is a: <code>com.azure.storage.queue.QueueServiceClient</code> type. Group: common
      Parameters:
      serviceClient - the value to set
      Returns:
      the dsl builder

    • bridgeErrorHandler

      default AzureStorageQueueComponentBuilderFactory.AzureStorageQueueComponentBuilder 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

    • createQueue

      default AzureStorageQueueComponentBuilderFactory.AzureStorageQueueComponentBuilder createQueue(boolean createQueue)
      When is set to true, the queue will be automatically created when sending messages to the queue. The option is a: <code>boolean</code> type. Default: false Group: producer
      Parameters:
      createQueue - the value to set
      Returns:
      the dsl builder

    • lazyStartProducer

      default AzureStorageQueueComponentBuilderFactory.AzureStorageQueueComponentBuilder 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 AzureStorageQueueComponentBuilderFactory.AzureStorageQueueComponentBuilder operation(org.apache.camel.component.azure.storage.queue.QueueOperationDefinition operation)
      Queue service operation hint to the producer. The option is a: <code>org.apache.camel.component.azure.storage.queue.QueueOperationDefinition</code> type. Group: producer
      Parameters:
      operation - the value to set
      Returns:
      the dsl builder

    • autowiredEnabled

      default AzureStorageQueueComponentBuilderFactory.AzureStorageQueueComponentBuilder 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 AzureStorageQueueComponentBuilderFactory.AzureStorageQueueComponentBuilder 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 AzureStorageQueueComponentBuilderFactory.AzureStorageQueueComponentBuilder 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

    • maxMessages

      default AzureStorageQueueComponentBuilderFactory.AzureStorageQueueComponentBuilder maxMessages(Integer maxMessages)
      Maximum number of messages to get, if there are less messages exist in the queue than requested all the messages will be returned. If left empty only 1 message will be retrieved, the allowed range is 1 to 32 messages. The option is a: <code>java.lang.Integer</code> type. Default: 1 Group: queue
      Parameters:
      maxMessages - the value to set
      Returns:
      the dsl builder

    • messageId

      default AzureStorageQueueComponentBuilderFactory.AzureStorageQueueComponentBuilder messageId(String messageId)
      The ID of the message to be deleted or updated. The option is a: <code>java.lang.String</code> type. Group: queue
      Parameters:
      messageId - the value to set
      Returns:
      the dsl builder

    • popReceipt

      default AzureStorageQueueComponentBuilderFactory.AzureStorageQueueComponentBuilder popReceipt(String popReceipt)
      Unique identifier that must match for the message to be deleted or updated. The option is a: <code>java.lang.String</code> type. Group: queue
      Parameters:
      popReceipt - the value to set
      Returns:
      the dsl builder

    • timeout

      default AzureStorageQueueComponentBuilderFactory.AzureStorageQueueComponentBuilder timeout(Duration timeout)
      An optional timeout applied to the operation. If a response is not returned before the timeout concludes a RuntimeException will be thrown. The option is a: <code>java.time.Duration</code> type. Group: queue
      Parameters:
      timeout - the value to set
      Returns:
      the dsl builder

    • timeToLive

      default AzureStorageQueueComponentBuilderFactory.AzureStorageQueueComponentBuilder timeToLive(Duration timeToLive)
      How long the message will stay alive in the queue. If unset the value will default to 7 days, if -1 is passed the message will not expire. The time to live must be -1 or any positive number. The format should be in this form: PnDTnHnMn.nS., e.g: PT20.345S -- parses as 20.345 seconds, P2D -- parses as 2 days However, in case you are using EndpointDsl/ComponentDsl, you can do something like Duration.ofSeconds() since these Java APIs are typesafe. The option is a: <code>java.time.Duration</code> type. Group: queue
      Parameters:
      timeToLive - the value to set
      Returns:
      the dsl builder

    • visibilityTimeout

      default AzureStorageQueueComponentBuilderFactory.AzureStorageQueueComponentBuilder visibilityTimeout(Duration visibilityTimeout)
      The timeout period for how long the message is invisible in the queue. The timeout must be between 1 seconds and 7 days. The format should be in this form: PnDTnHnMn.nS., e.g: PT20.345S -- parses as 20.345 seconds, P2D -- parses as 2 days However, in case you are using EndpointDsl/ComponentDsl, you can do something like Duration.ofSeconds() since these Java APIs are typesafe. The option is a: <code>java.time.Duration</code> type. Group: queue
      Parameters:
      visibilityTimeout - the value to set
      Returns:
      the dsl builder

    • accessKey

      default AzureStorageQueueComponentBuilderFactory.AzureStorageQueueComponentBuilder accessKey(String accessKey)
      Access key for the associated azure account name to be used for authentication with azure queue services. The option is a: <code>java.lang.String</code> type. Group: security
      Parameters:
      accessKey - the value to set
      Returns:
      the dsl builder

    • credentials

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