BoxEndpointBuilderFactory.BoxEndpointConsumerBuilder (Camel

All Superinterfaces:

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

All Known Subinterfaces:

BoxEndpointBuilderFactory.BoxEndpointBuilder

Enclosing interface:

BoxEndpointBuilderFactory
```
public static interface BoxEndpointBuilderFactory.BoxEndpointConsumerBuilder
extends org.apache.camel.builder.EndpointConsumerBuilder
```
Builder for endpoint consumers for the Box component.

Method Summary

All Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`default BoxEndpointBuilderFactory.AdvancedBoxEndpointConsumerBuilder`	`advanced()`
`default BoxEndpointBuilderFactory.BoxEndpointConsumerBuilder`	`authenticationType(String authenticationType)` The type of authentication for connection.
`default BoxEndpointBuilderFactory.BoxEndpointConsumerBuilder`	`backoffErrorThreshold(int backoffErrorThreshold)` The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.
`default BoxEndpointBuilderFactory.BoxEndpointConsumerBuilder`	`backoffErrorThreshold(String backoffErrorThreshold)` The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.
`default BoxEndpointBuilderFactory.BoxEndpointConsumerBuilder`	`backoffIdleThreshold(int backoffIdleThreshold)` The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.
`default BoxEndpointBuilderFactory.BoxEndpointConsumerBuilder`	`backoffIdleThreshold(String backoffIdleThreshold)` The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.
`default BoxEndpointBuilderFactory.BoxEndpointConsumerBuilder`	`backoffMultiplier(int backoffMultiplier)` To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row.
`default BoxEndpointBuilderFactory.BoxEndpointConsumerBuilder`	`backoffMultiplier(String backoffMultiplier)` To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row.
`default BoxEndpointBuilderFactory.BoxEndpointConsumerBuilder`	`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 BoxEndpointBuilderFactory.BoxEndpointConsumerBuilder`	`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 BoxEndpointBuilderFactory.BoxEndpointConsumerBuilder`	`clientId(String clientId)` Box application client ID.
`default BoxEndpointBuilderFactory.BoxEndpointConsumerBuilder`	`clientSecret(String clientSecret)` Box application client secret.
`default BoxEndpointBuilderFactory.BoxEndpointConsumerBuilder`	`delay(long delay)` Milliseconds before the next poll.
`default BoxEndpointBuilderFactory.BoxEndpointConsumerBuilder`	`delay(String delay)` Milliseconds before the next poll.
`default BoxEndpointBuilderFactory.BoxEndpointConsumerBuilder`	`enterpriseId(String enterpriseId)` The enterprise ID to use for an App Enterprise.
`default BoxEndpointBuilderFactory.BoxEndpointConsumerBuilder`	`greedy(boolean greedy)` If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages.
`default BoxEndpointBuilderFactory.BoxEndpointConsumerBuilder`	`greedy(String greedy)` If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages.
`default BoxEndpointBuilderFactory.BoxEndpointConsumerBuilder`	`inBody(String inBody)` Sets the name of a parameter to be passed in the exchange In Body.
`default BoxEndpointBuilderFactory.BoxEndpointConsumerBuilder`	`initialDelay(long initialDelay)` Milliseconds before the first poll starts.
`default BoxEndpointBuilderFactory.BoxEndpointConsumerBuilder`	`initialDelay(String initialDelay)` Milliseconds before the first poll starts.
`default BoxEndpointBuilderFactory.BoxEndpointConsumerBuilder`	`privateKeyFile(String privateKeyFile)` The private key for generating the JWT signature.
`default BoxEndpointBuilderFactory.BoxEndpointConsumerBuilder`	`privateKeyPassword(String privateKeyPassword)` The password for the private key.
`default BoxEndpointBuilderFactory.BoxEndpointConsumerBuilder`	`publicKeyId(String publicKeyId)` The ID for public key for validating the JWT signature.
`default BoxEndpointBuilderFactory.BoxEndpointConsumerBuilder`	`repeatCount(long repeatCount)` Specifies a maximum limit of number of fires.
`default BoxEndpointBuilderFactory.BoxEndpointConsumerBuilder`	`repeatCount(String repeatCount)` Specifies a maximum limit of number of fires.
`default BoxEndpointBuilderFactory.BoxEndpointConsumerBuilder`	`runLoggingLevel(org.apache.camel.LoggingLevel runLoggingLevel)` The consumer logs a start/complete log line when it polls.
`default BoxEndpointBuilderFactory.BoxEndpointConsumerBuilder`	`runLoggingLevel(String runLoggingLevel)` The consumer logs a start/complete log line when it polls.
`default BoxEndpointBuilderFactory.BoxEndpointConsumerBuilder`	`scheduledExecutorService(ScheduledExecutorService scheduledExecutorService)` Allows for configuring a custom/shared thread pool to use for the consumer.
`default BoxEndpointBuilderFactory.BoxEndpointConsumerBuilder`	`scheduledExecutorService(String scheduledExecutorService)` Allows for configuring a custom/shared thread pool to use for the consumer.
`default BoxEndpointBuilderFactory.BoxEndpointConsumerBuilder`	`scheduler(Object scheduler)` To use a cron scheduler from either camel-spring or camel-quartz component.
`default BoxEndpointBuilderFactory.BoxEndpointConsumerBuilder`	`scheduler(String scheduler)` To use a cron scheduler from either camel-spring or camel-quartz component.
`default BoxEndpointBuilderFactory.BoxEndpointConsumerBuilder`	`schedulerProperties(Map values)` To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler.
`default BoxEndpointBuilderFactory.BoxEndpointConsumerBuilder`	`schedulerProperties(String key, Object value)` To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler.
`default BoxEndpointBuilderFactory.BoxEndpointConsumerBuilder`	`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 BoxEndpointBuilderFactory.BoxEndpointConsumerBuilder`	`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 BoxEndpointBuilderFactory.BoxEndpointConsumerBuilder`	`sslContextParameters(Object sslContextParameters)` To configure security using SSLContextParameters.
`default BoxEndpointBuilderFactory.BoxEndpointConsumerBuilder`	`sslContextParameters(String sslContextParameters)` To configure security using SSLContextParameters.
`default BoxEndpointBuilderFactory.BoxEndpointConsumerBuilder`	`startScheduler(boolean startScheduler)` Whether the scheduler should be auto started.
`default BoxEndpointBuilderFactory.BoxEndpointConsumerBuilder`	`startScheduler(String startScheduler)` Whether the scheduler should be auto started.
`default BoxEndpointBuilderFactory.BoxEndpointConsumerBuilder`	`timeUnit(String timeUnit)` Time unit for initialDelay and delay options.
`default BoxEndpointBuilderFactory.BoxEndpointConsumerBuilder`	`timeUnit(TimeUnit timeUnit)` Time unit for initialDelay and delay options.
`default BoxEndpointBuilderFactory.BoxEndpointConsumerBuilder`	`useFixedDelay(boolean useFixedDelay)` Controls if fixed delay or fixed rate is used.
`default BoxEndpointBuilderFactory.BoxEndpointConsumerBuilder`	`useFixedDelay(String useFixedDelay)` Controls if fixed delay or fixed rate is used.
`default BoxEndpointBuilderFactory.BoxEndpointConsumerBuilder`	`userId(String userId)` The user ID to use for an App User.
`default BoxEndpointBuilderFactory.BoxEndpointConsumerBuilder`	`userName(String userName)` Box user name, MUST be provided.
`default BoxEndpointBuilderFactory.BoxEndpointConsumerBuilder`	`userPassword(String userPassword)` Box user password, MUST be provided if authSecureStorage is not set, or returns null on first call.

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

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

- Method Detail
  - advanced
```
default BoxEndpointBuilderFactory.AdvancedBoxEndpointConsumerBuilder advanced()
```
  - clientId
```
default BoxEndpointBuilderFactory.BoxEndpointConsumerBuilder clientId(String clientId)
```
    Box application client ID. The option is a: java.lang.String type. Group: common
  - enterpriseId
```
default BoxEndpointBuilderFactory.BoxEndpointConsumerBuilder enterpriseId(String enterpriseId)
```
    The enterprise ID to use for an App Enterprise. The option is a: java.lang.String type. Group: common
  - inBody
```
default BoxEndpointBuilderFactory.BoxEndpointConsumerBuilder inBody(String inBody)
```
    Sets the name of a parameter to be passed in the exchange In Body. The option is a: java.lang.String type. Group: common
  - userId
```
default BoxEndpointBuilderFactory.BoxEndpointConsumerBuilder userId(String userId)
```
    The user ID to use for an App User. The option is a: java.lang.String type. Group: common
  - bridgeErrorHandler
```
default BoxEndpointBuilderFactory.BoxEndpointConsumerBuilder 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: boolean type. Default: false Group: consumer
  - bridgeErrorHandler
```
default BoxEndpointBuilderFactory.BoxEndpointConsumerBuilder 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 boolean type. Default: false Group: consumer
  - sendEmptyMessageWhenIdle
```
default BoxEndpointBuilderFactory.BoxEndpointConsumerBuilder 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: boolean type. Default: false Group: consumer
  - sendEmptyMessageWhenIdle
```
default BoxEndpointBuilderFactory.BoxEndpointConsumerBuilder 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 boolean type. Default: false Group: consumer
  - authenticationType
```
default BoxEndpointBuilderFactory.BoxEndpointConsumerBuilder authenticationType(String authenticationType)
```
    The type of authentication for connection. Types of Authentication: STANDARD_AUTHENTICATION - OAuth 2.0 (3-legged) SERVER_AUTHENTICATION - OAuth 2.0 with JSON Web Tokens. The option is a: java.lang.String type. Default: APP_USER_AUTHENTICATION Group: authentication
  - backoffErrorThreshold
```
default BoxEndpointBuilderFactory.BoxEndpointConsumerBuilder 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: int type. Group: scheduler
  - backoffErrorThreshold
```
default BoxEndpointBuilderFactory.BoxEndpointConsumerBuilder 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 int type. Group: scheduler
  - backoffIdleThreshold
```
default BoxEndpointBuilderFactory.BoxEndpointConsumerBuilder backoffIdleThreshold(int backoffIdleThreshold)
```
    The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. The option is a: int type. Group: scheduler
  - backoffIdleThreshold
```
default BoxEndpointBuilderFactory.BoxEndpointConsumerBuilder 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 int type. Group: scheduler
  - backoffMultiplier
```
default BoxEndpointBuilderFactory.BoxEndpointConsumerBuilder 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: int type. Group: scheduler
  - backoffMultiplier
```
default BoxEndpointBuilderFactory.BoxEndpointConsumerBuilder 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 int type. Group: scheduler
  - delay
```
default BoxEndpointBuilderFactory.BoxEndpointConsumerBuilder delay(long delay)
```
    Milliseconds before the next poll. The option is a: long type. Default: 500 Group: scheduler
  - delay
```
default BoxEndpointBuilderFactory.BoxEndpointConsumerBuilder delay(String delay)
```
    Milliseconds before the next poll. The option will be converted to a long type. Default: 500 Group: scheduler
  - greedy
```
default BoxEndpointBuilderFactory.BoxEndpointConsumerBuilder 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: boolean type. Default: false Group: scheduler
  - greedy
```
default BoxEndpointBuilderFactory.BoxEndpointConsumerBuilder 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 boolean type. Default: false Group: scheduler
  - initialDelay
```
default BoxEndpointBuilderFactory.BoxEndpointConsumerBuilder initialDelay(long initialDelay)
```
    Milliseconds before the first poll starts. The option is a: long type. Default: 1000 Group: scheduler
  - initialDelay
```
default BoxEndpointBuilderFactory.BoxEndpointConsumerBuilder initialDelay(String initialDelay)
```
    Milliseconds before the first poll starts. The option will be converted to a long type. Default: 1000 Group: scheduler
  - repeatCount
```
default BoxEndpointBuilderFactory.BoxEndpointConsumerBuilder 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: long type. Default: 0 Group: scheduler
  - repeatCount
```
default BoxEndpointBuilderFactory.BoxEndpointConsumerBuilder 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 long type. Default: 0 Group: scheduler
  - runLoggingLevel
```
default BoxEndpointBuilderFactory.BoxEndpointConsumerBuilder 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: org.apache.camel.LoggingLevel type. Default: TRACE Group: scheduler
  - runLoggingLevel
```
default BoxEndpointBuilderFactory.BoxEndpointConsumerBuilder 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 org.apache.camel.LoggingLevel type. Default: TRACE Group: scheduler
  - scheduledExecutorService
```
default BoxEndpointBuilderFactory.BoxEndpointConsumerBuilder 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: java.util.concurrent.ScheduledExecutorService type. Group: scheduler
  - scheduledExecutorService
```
default BoxEndpointBuilderFactory.BoxEndpointConsumerBuilder 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 java.util.concurrent.ScheduledExecutorService type. Group: scheduler
  - scheduler
```
default BoxEndpointBuilderFactory.BoxEndpointConsumerBuilder 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: java.lang.Object type. Default: none Group: scheduler
  - scheduler
```
default BoxEndpointBuilderFactory.BoxEndpointConsumerBuilder 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 java.lang.Object type. Default: none Group: scheduler
  - schedulerProperties
```
default BoxEndpointBuilderFactory.BoxEndpointConsumerBuilder 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: java.util.Map<java.lang.String, java.lang.Object> 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
  - schedulerProperties
```
default BoxEndpointBuilderFactory.BoxEndpointConsumerBuilder schedulerProperties(Map values)
```
    To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler. The option is a: java.util.Map<java.lang.String, java.lang.Object> 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
  - startScheduler
```
default BoxEndpointBuilderFactory.BoxEndpointConsumerBuilder startScheduler(boolean startScheduler)
```
    Whether the scheduler should be auto started. The option is a: boolean type. Default: true Group: scheduler
  - startScheduler
```
default BoxEndpointBuilderFactory.BoxEndpointConsumerBuilder startScheduler(String startScheduler)
```
    Whether the scheduler should be auto started. The option will be converted to a boolean type. Default: true Group: scheduler
  - timeUnit
```
default BoxEndpointBuilderFactory.BoxEndpointConsumerBuilder timeUnit(TimeUnit timeUnit)
```
    Time unit for initialDelay and delay options. The option is a: java.util.concurrent.TimeUnit type. Default: MILLISECONDS Group: scheduler
  - timeUnit
```
default BoxEndpointBuilderFactory.BoxEndpointConsumerBuilder timeUnit(String timeUnit)
```
    Time unit for initialDelay and delay options. The option will be converted to a java.util.concurrent.TimeUnit type. Default: MILLISECONDS Group: scheduler
  - useFixedDelay
```
default BoxEndpointBuilderFactory.BoxEndpointConsumerBuilder useFixedDelay(boolean useFixedDelay)
```
    Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. The option is a: boolean type. Default: true Group: scheduler
  - useFixedDelay
```
default BoxEndpointBuilderFactory.BoxEndpointConsumerBuilder 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 boolean type. Default: true Group: scheduler
  - clientSecret
```
default BoxEndpointBuilderFactory.BoxEndpointConsumerBuilder clientSecret(String clientSecret)
```
    Box application client secret. The option is a: java.lang.String type. Group: security
  - privateKeyFile
```
default BoxEndpointBuilderFactory.BoxEndpointConsumerBuilder privateKeyFile(String privateKeyFile)
```
    The private key for generating the JWT signature. The option is a: java.lang.String type. Group: security
  - privateKeyPassword
```
default BoxEndpointBuilderFactory.BoxEndpointConsumerBuilder privateKeyPassword(String privateKeyPassword)
```
    The password for the private key. The option is a: java.lang.String type. Group: security
  - publicKeyId
```
default BoxEndpointBuilderFactory.BoxEndpointConsumerBuilder publicKeyId(String publicKeyId)
```
    The ID for public key for validating the JWT signature. The option is a: java.lang.String type. Group: security
  - sslContextParameters
```
default BoxEndpointBuilderFactory.BoxEndpointConsumerBuilder sslContextParameters(Object sslContextParameters)
```
    To configure security using SSLContextParameters. The option is a: org.apache.camel.support.jsse.SSLContextParameters type. Group: security
  - sslContextParameters
```
default BoxEndpointBuilderFactory.BoxEndpointConsumerBuilder sslContextParameters(String sslContextParameters)
```
    To configure security using SSLContextParameters. The option will be converted to a org.apache.camel.support.jsse.SSLContextParameters type. Group: security
  - userName
```
default BoxEndpointBuilderFactory.BoxEndpointConsumerBuilder userName(String userName)
```
    Box user name, MUST be provided. The option is a: java.lang.String type. Group: security
  - userPassword
```
default BoxEndpointBuilderFactory.BoxEndpointConsumerBuilder userPassword(String userPassword)
```
    Box user password, MUST be provided if authSecureStorage is not set, or returns null on first call. The option is a: java.lang.String type. Group: security

Interface BoxEndpointBuilderFactory.BoxEndpointConsumerBuilder

Method Summary

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

Methods inherited from interface org.apache.camel.EndpointConsumerResolver

Method Detail

advanced

clientId

enterpriseId

inBody

userId

bridgeErrorHandler

bridgeErrorHandler

sendEmptyMessageWhenIdle

sendEmptyMessageWhenIdle

authenticationType

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

clientSecret

privateKeyFile

privateKeyPassword

publicKeyId

sslContextParameters

sslContextParameters

userName

userPassword