Package org.apache.camel.builder.endpoint.dsl

Interface CouchbaseEndpointBuilderFactory.CouchbaseEndpointConsumerBuilder

All Superinterfaces:
org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver
All Known Subinterfaces:
CouchbaseEndpointBuilderFactory.CouchbaseEndpointBuilder
Enclosing interface:
CouchbaseEndpointBuilderFactory
public static interface CouchbaseEndpointBuilderFactory.CouchbaseEndpointConsumerBuilder extends org.apache.camel.builder.EndpointConsumerBuilder
Builder for endpoint consumers for the Couchbase component.

  • Method Details

    • advanced

      default CouchbaseEndpointBuilderFactory.AdvancedCouchbaseEndpointConsumerBuilder advanced()

    • bucket

      default CouchbaseEndpointBuilderFactory.CouchbaseEndpointConsumerBuilder bucket(String bucket)
      The bucket to use. The option is a: <code>java.lang.String</code> type. Required: true Group: common
      Parameters:
      bucket - the value to set
      Returns:
      the dsl builder

    • collection

      default CouchbaseEndpointBuilderFactory.CouchbaseEndpointConsumerBuilder collection(String collection)
      The collection to use. The option is a: <code>java.lang.String</code> type. Group: common
      Parameters:
      collection - the value to set
      Returns:
      the dsl builder

    • key

      default CouchbaseEndpointBuilderFactory.CouchbaseEndpointConsumerBuilder key(String key)
      The key to use. The option is a: <code>java.lang.String</code> type. Group: common
      Parameters:
      key - the value to set
      Returns:
      the dsl builder

    • scope

      default CouchbaseEndpointBuilderFactory.CouchbaseEndpointConsumerBuilder scope(String scope)
      The scope to use. The option is a: <code>java.lang.String</code> type. Group: common
      Parameters:
      scope - the value to set
      Returns:
      the dsl builder

    • consumerProcessedStrategy

      default CouchbaseEndpointBuilderFactory.CouchbaseEndpointConsumerBuilder consumerProcessedStrategy(String consumerProcessedStrategy)
      Define the consumer Processed strategy to use. The option is a: <code>java.lang.String</code> type. Default: none Group: consumer
      Parameters:
      consumerProcessedStrategy - the value to set
      Returns:
      the dsl builder

    • descending

      default CouchbaseEndpointBuilderFactory.CouchbaseEndpointConsumerBuilder descending(boolean descending)
      Define if this operation is descending or not. The option is a: <code>boolean</code> type. Default: false Group: consumer
      Parameters:
      descending - the value to set
      Returns:
      the dsl builder

    • descending

      default CouchbaseEndpointBuilderFactory.CouchbaseEndpointConsumerBuilder descending(String descending)
      Define if this operation is descending or not. The option will be converted to a <code>boolean</code> type. Default: false Group: consumer
      Parameters:
      descending - the value to set
      Returns:
      the dsl builder

    • designDocumentName

      default CouchbaseEndpointBuilderFactory.CouchbaseEndpointConsumerBuilder designDocumentName(String designDocumentName)
      The design document name to use. The option is a: <code>java.lang.String</code> type. Default: beer Group: consumer
      Parameters:
      designDocumentName - the value to set
      Returns:
      the dsl builder

    • fullDocument

      default CouchbaseEndpointBuilderFactory.CouchbaseEndpointConsumerBuilder fullDocument(boolean fullDocument)
      If true consumer will return complete document instead data defined in view. The option is a: <code>boolean</code> type. Default: false Group: consumer
      Parameters:
      fullDocument - the value to set
      Returns:
      the dsl builder

    • fullDocument

      default CouchbaseEndpointBuilderFactory.CouchbaseEndpointConsumerBuilder fullDocument(String fullDocument)
      If true consumer will return complete document instead data defined in view. The option will be converted to a <code>boolean</code> type. Default: false Group: consumer
      Parameters:
      fullDocument - the value to set
      Returns:
      the dsl builder

    • limit

      default CouchbaseEndpointBuilderFactory.CouchbaseEndpointConsumerBuilder limit(int limit)
      The output limit to use. The option is a: <code>int</code> type. Default: -1 Group: consumer
      Parameters:
      limit - the value to set
      Returns:
      the dsl builder

    • limit

      default CouchbaseEndpointBuilderFactory.CouchbaseEndpointConsumerBuilder limit(String limit)
      The output limit to use. The option will be converted to a <code>int</code> type. Default: -1 Group: consumer
      Parameters:
      limit - the value to set
      Returns:
      the dsl builder

    • rangeEndKey

      default CouchbaseEndpointBuilderFactory.CouchbaseEndpointConsumerBuilder rangeEndKey(String rangeEndKey)
      Define a range for the end key. The option is a: <code>java.lang.String</code> type. Group: consumer
      Parameters:
      rangeEndKey - the value to set
      Returns:
      the dsl builder

    • rangeStartKey

      default CouchbaseEndpointBuilderFactory.CouchbaseEndpointConsumerBuilder rangeStartKey(String rangeStartKey)
      Define a range for the start key. The option is a: <code>java.lang.String</code> type. Group: consumer
      Parameters:
      rangeStartKey - the value to set
      Returns:
      the dsl builder

    • sendEmptyMessageWhenIdle

      default CouchbaseEndpointBuilderFactory.CouchbaseEndpointConsumerBuilder 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 CouchbaseEndpointBuilderFactory.CouchbaseEndpointConsumerBuilder 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

    • skip

      default CouchbaseEndpointBuilderFactory.CouchbaseEndpointConsumerBuilder skip(int skip)
      Define the skip to use. The option is a: <code>int</code> type. Default: -1 Group: consumer
      Parameters:
      skip - the value to set
      Returns:
      the dsl builder

    • skip

      default CouchbaseEndpointBuilderFactory.CouchbaseEndpointConsumerBuilder skip(String skip)
      Define the skip to use. The option will be converted to a <code>int</code> type. Default: -1 Group: consumer
      Parameters:
      skip - the value to set
      Returns:
      the dsl builder

    • viewName

      default CouchbaseEndpointBuilderFactory.CouchbaseEndpointConsumerBuilder viewName(String viewName)
      The view name to use. The option is a: <code>java.lang.String</code> type. Default: brewery_beers Group: consumer
      Parameters:
      viewName - the value to set
      Returns:
      the dsl builder

    • backoffErrorThreshold

      default CouchbaseEndpointBuilderFactory.CouchbaseEndpointConsumerBuilder 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 CouchbaseEndpointBuilderFactory.CouchbaseEndpointConsumerBuilder 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 CouchbaseEndpointBuilderFactory.CouchbaseEndpointConsumerBuilder 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 CouchbaseEndpointBuilderFactory.CouchbaseEndpointConsumerBuilder 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 CouchbaseEndpointBuilderFactory.CouchbaseEndpointConsumerBuilder 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 CouchbaseEndpointBuilderFactory.CouchbaseEndpointConsumerBuilder 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 CouchbaseEndpointBuilderFactory.CouchbaseEndpointConsumerBuilder 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 CouchbaseEndpointBuilderFactory.CouchbaseEndpointConsumerBuilder 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 CouchbaseEndpointBuilderFactory.CouchbaseEndpointConsumerBuilder 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 CouchbaseEndpointBuilderFactory.CouchbaseEndpointConsumerBuilder 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 CouchbaseEndpointBuilderFactory.CouchbaseEndpointConsumerBuilder 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 CouchbaseEndpointBuilderFactory.CouchbaseEndpointConsumerBuilder 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 CouchbaseEndpointBuilderFactory.CouchbaseEndpointConsumerBuilder 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 CouchbaseEndpointBuilderFactory.CouchbaseEndpointConsumerBuilder 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 CouchbaseEndpointBuilderFactory.CouchbaseEndpointConsumerBuilder 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 CouchbaseEndpointBuilderFactory.CouchbaseEndpointConsumerBuilder 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 CouchbaseEndpointBuilderFactory.CouchbaseEndpointConsumerBuilder 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 CouchbaseEndpointBuilderFactory.CouchbaseEndpointConsumerBuilder 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 CouchbaseEndpointBuilderFactory.CouchbaseEndpointConsumerBuilder 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 CouchbaseEndpointBuilderFactory.CouchbaseEndpointConsumerBuilder 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 CouchbaseEndpointBuilderFactory.CouchbaseEndpointConsumerBuilder 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 CouchbaseEndpointBuilderFactory.CouchbaseEndpointConsumerBuilder 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 CouchbaseEndpointBuilderFactory.CouchbaseEndpointConsumerBuilder 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 CouchbaseEndpointBuilderFactory.CouchbaseEndpointConsumerBuilder 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 CouchbaseEndpointBuilderFactory.CouchbaseEndpointConsumerBuilder 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 CouchbaseEndpointBuilderFactory.CouchbaseEndpointConsumerBuilder 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 CouchbaseEndpointBuilderFactory.CouchbaseEndpointConsumerBuilder 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 CouchbaseEndpointBuilderFactory.CouchbaseEndpointConsumerBuilder 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

    • password

      default CouchbaseEndpointBuilderFactory.CouchbaseEndpointConsumerBuilder password(String password)
      The password to use. The option is a: <code>java.lang.String</code> type. Group: security
      Parameters:
      password - the value to set
      Returns:
      the dsl builder

    • username

      default CouchbaseEndpointBuilderFactory.CouchbaseEndpointConsumerBuilder username(String username)
      The username to use. The option is a: <code>java.lang.String</code> type. Group: security
      Parameters:
      username - the value to set
      Returns:
      the dsl builder