QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder (Camel

All Superinterfaces:

org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver

All Known Subinterfaces:

QueueEndpointBuilderFactory.QueueEndpointBuilder

Enclosing interface:

QueueEndpointBuilderFactory
```
public static interface QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder
extends org.apache.camel.builder.EndpointConsumerBuilder
```
Builder for endpoint consumers for the Azure Storage Queue Service component.

Method Summary

All Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`default QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder`	`accessKey(String accessKey)` Access key for the associated azure account name to be used for authentication with azure queue services.
`default QueueEndpointBuilderFactory.AdvancedQueueEndpointConsumerBuilder`	`advanced()`
`default QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder`	`backoffErrorThreshold(int backoffErrorThreshold)` The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.
`default QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder`	`backoffErrorThreshold(String backoffErrorThreshold)` The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.
`default QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder`	`backoffIdleThreshold(int backoffIdleThreshold)` The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.
`default QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder`	`backoffIdleThreshold(String backoffIdleThreshold)` The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.
`default QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder`	`backoffMultiplier(int backoffMultiplier)` To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row.
`default QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder`	`backoffMultiplier(String backoffMultiplier)` To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row.
`default QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder`	`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.
`default QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder`	`bridgeErrorHandler(String 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.
`default QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder`	`credentials(Object credentials)` StorageSharedKeyCredential can be injected to create the azure client, this holds the important authentication information.
`default QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder`	`credentials(String credentials)` StorageSharedKeyCredential can be injected to create the azure client, this holds the important authentication information.
`default QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder`	`delay(long delay)` Milliseconds before the next poll.
`default QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder`	`delay(String delay)` Milliseconds before the next poll.
`default QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder`	`greedy(boolean greedy)` If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages.
`default QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder`	`greedy(String greedy)` If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages.
`default QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder`	`initialDelay(long initialDelay)` Milliseconds before the first poll starts.
`default QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder`	`initialDelay(String initialDelay)` Milliseconds before the first poll starts.
`default QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder`	`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.
`default QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder`	`maxMessages(String maxMessages)` Maximum number of messages to get, if there are less messages exist in the queue than requested all the messages will be returned.
`default QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder`	`messageId(String messageId)` The ID of the message to be deleted or updated.
`default QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder`	`popReceipt(String popReceipt)` Unique identifier that must match for the message to be deleted or updated.
`default QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder`	`repeatCount(long repeatCount)` Specifies a maximum limit of number of fires.
`default QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder`	`repeatCount(String repeatCount)` Specifies a maximum limit of number of fires.
`default QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder`	`runLoggingLevel(org.apache.camel.LoggingLevel runLoggingLevel)` The consumer logs a start/complete log line when it polls.
`default QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder`	`runLoggingLevel(String runLoggingLevel)` The consumer logs a start/complete log line when it polls.
`default QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder`	`scheduledExecutorService(ScheduledExecutorService scheduledExecutorService)` Allows for configuring a custom/shared thread pool to use for the consumer.
`default QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder`	`scheduledExecutorService(String scheduledExecutorService)` Allows for configuring a custom/shared thread pool to use for the consumer.
`default QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder`	`scheduler(Object scheduler)` To use a cron scheduler from either camel-spring or camel-quartz component.
`default QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder`	`scheduler(String scheduler)` To use a cron scheduler from either camel-spring or camel-quartz component.
`default QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder`	`schedulerProperties(Map values)` To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler.
`default QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder`	`schedulerProperties(String key, Object value)` To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler.
`default QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder`	`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.
`default QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder`	`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.
`default QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder`	`serviceClient(Object serviceClient)` Service client to a storage account to interact with the queue service.
`default QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder`	`serviceClient(String serviceClient)` Service client to a storage account to interact with the queue service.
`default QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder`	`startScheduler(boolean startScheduler)` Whether the scheduler should be auto started.
`default QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder`	`startScheduler(String startScheduler)` Whether the scheduler should be auto started.
`default QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder`	`timeout(Duration timeout)` An optional timeout applied to the operation.
`default QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder`	`timeout(String timeout)` An optional timeout applied to the operation.
`default QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder`	`timeToLive(Duration timeToLive)` How long the message will stay alive in the queue.
`default QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder`	`timeToLive(String timeToLive)` How long the message will stay alive in the queue.
`default QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder`	`timeUnit(String timeUnit)` Time unit for initialDelay and delay options.
`default QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder`	`timeUnit(TimeUnit timeUnit)` Time unit for initialDelay and delay options.
`default QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder`	`useFixedDelay(boolean useFixedDelay)` Controls if fixed delay or fixed rate is used.
`default QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder`	`useFixedDelay(String useFixedDelay)` Controls if fixed delay or fixed rate is used.
`default QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder`	`visibilityTimeout(Duration visibilityTimeout)` The timeout period for how long the message is invisible in the queue.
`default QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder`	`visibilityTimeout(String visibilityTimeout)` The timeout period for how long the message is invisible in the queue.

Methods inherited from interface org.apache.camel.builder.EndpointConsumerBuilder
doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getUri

Methods inherited from interface org.apache.camel.EndpointConsumerResolver
resolve, resolve

- Method Detail
  - advanced
```
default QueueEndpointBuilderFactory.AdvancedQueueEndpointConsumerBuilder advanced()
```
  - serviceClient
```
default QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder serviceClient(Object 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
  - serviceClient
```
default QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder serviceClient(String 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 will be converted to a <code>com.azure.storage.queue.QueueServiceClient</code> type. Group: common
    
    Parameters:
    
    serviceClient - the value to set
    
    Returns:
    
    the dsl builder
  - bridgeErrorHandler
```
default QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder 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
  - bridgeErrorHandler
```
default QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder bridgeErrorHandler(String 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 will be converted to a <code>boolean</code> type. Default: false Group: consumer
    
    Parameters:
    
    bridgeErrorHandler - the value to set
    
    Returns:
    
    the dsl builder
  - sendEmptyMessageWhenIdle
```
default QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder 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 QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder 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
  - maxMessages
```
default QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder 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
  - maxMessages
```
default QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder maxMessages(String 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 will be converted to a <code>java.lang.Integer</code> type. Default: 1 Group: queue
    
    Parameters:
    
    maxMessages - the value to set
    
    Returns:
    
    the dsl builder
  - messageId
```
default QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder 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 QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder 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 QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder 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
  - timeout
```
default QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder timeout(String 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 will be converted to a <code>java.time.Duration</code> type. Group: queue
    
    Parameters:
    
    timeout - the value to set
    
    Returns:
    
    the dsl builder
  - timeToLive
```
default QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder 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
  - timeToLive
```
default QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder timeToLive(String 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 will be converted to a <code>java.time.Duration</code> type. Group: queue
    
    Parameters:
    
    timeToLive - the value to set
    
    Returns:
    
    the dsl builder
  - visibilityTimeout
```
default QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder 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
  - visibilityTimeout
```
default QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder visibilityTimeout(String 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 will be converted to a <code>java.time.Duration</code> type. Group: queue
    
    Parameters:
    
    visibilityTimeout - the value to set
    
    Returns:
    
    the dsl builder
  - backoffErrorThreshold
```
default QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder 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 QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder 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 QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder 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 QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder 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 QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder 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 QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder 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
```
default QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder delay(long 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
```
default QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder delay(String 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
```
default QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder greedy(boolean 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
```
default QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder greedy(String 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 QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder 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
```
default QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder initialDelay(String 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 QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder 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
```
default QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder repeatCount(String 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 QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder 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 QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder 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 QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder 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 QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder 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
```
default QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder scheduler(Object 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
```
default QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder scheduler(String 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 QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder 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<java.lang.String, java.lang.Object></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 QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder 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<java.lang.String, java.lang.Object></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 QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder 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 QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder 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
```
default QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder timeUnit(TimeUnit 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
```
default QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder timeUnit(String 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 QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder 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 QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder 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
```
default QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder 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 QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder credentials(Object 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
  - credentials
```
default QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder 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 <code>com.azure.storage.common.StorageSharedKeyCredential</code> type. Group: security
    
    Parameters:
    
    credentials - the value to set
    
    Returns:
    
    the dsl builder

Interface QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder

Method Summary

Methods inherited from interface org.apache.camel.builder.EndpointConsumerBuilder

Methods inherited from interface org.apache.camel.EndpointConsumerResolver

Method Detail

advanced

serviceClient

serviceClient

bridgeErrorHandler

bridgeErrorHandler

sendEmptyMessageWhenIdle

sendEmptyMessageWhenIdle

maxMessages

maxMessages

messageId

popReceipt

timeout

timeout

timeToLive

timeToLive

visibilityTimeout

visibilityTimeout

backoffErrorThreshold

backoffErrorThreshold

backoffIdleThreshold

backoffIdleThreshold

backoffMultiplier

backoffMultiplier

delay

delay

greedy

greedy

initialDelay

initialDelay

repeatCount

repeatCount

runLoggingLevel

runLoggingLevel

scheduledExecutorService

scheduledExecutorService

scheduler

scheduler

schedulerProperties

schedulerProperties

startScheduler

startScheduler

timeUnit

timeUnit

useFixedDelay

useFixedDelay

accessKey

credentials

credentials