Interface OBSEndpointBuilderFactory.OBSEndpointConsumerBuilder
- All Superinterfaces:
org.apache.camel.builder.EndpointConsumerBuilder
,org.apache.camel.EndpointConsumerResolver
- All Known Subinterfaces:
OBSEndpointBuilderFactory.OBSEndpointBuilder
- Enclosing interface:
- OBSEndpointBuilderFactory
public static interface OBSEndpointBuilderFactory.OBSEndpointConsumerBuilder
extends org.apache.camel.builder.EndpointConsumerBuilder
Builder for endpoint consumers for the Huawei Object Storage Service
(OBS) component.
-
Method Summary
Modifier and TypeMethodDescriptionAccess key for the cloud user.advanced()
backoffErrorThreshold
(int backoffErrorThreshold) The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.backoffErrorThreshold
(String backoffErrorThreshold) The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.backoffIdleThreshold
(int backoffIdleThreshold) The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.backoffIdleThreshold
(String backoffIdleThreshold) The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.backoffMultiplier
(int backoffMultiplier) To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row.backoffMultiplier
(String backoffMultiplier) To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row.bucketName
(String bucketName) Name of bucket to perform operation on.delay
(long delay) Milliseconds before the next poll.Milliseconds before the next poll.deleteAfterRead
(boolean deleteAfterRead) Determines if objects should be deleted after it has been retrieved.deleteAfterRead
(String deleteAfterRead) Determines if objects should be deleted after it has been retrieved.The character used for grouping object names.destinationBucket
(String destinationBucket) Name of destination bucket where objects will be moved when moveAfterRead is set to true.OBS url.Get the object from the bucket with the given file name.greedy
(boolean greedy) If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages.If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages.ignoreSslVerification
(boolean ignoreSslVerification) Ignore SSL verification.ignoreSslVerification
(String ignoreSslVerification) Ignore SSL verification.includeFolders
(boolean includeFolders) If true, objects in folders will be consumed.includeFolders
(String includeFolders) If true, objects in folders will be consumed.initialDelay
(long initialDelay) Milliseconds before the first poll starts.initialDelay
(String initialDelay) Milliseconds before the first poll starts.maxMessagesPerPoll
(int maxMessagesPerPoll) The maximum number of messages to poll at each polling.maxMessagesPerPoll
(String maxMessagesPerPoll) The maximum number of messages to poll at each polling.moveAfterRead
(boolean moveAfterRead) Determines whether objects should be moved to a different bucket after they have been retrieved.moveAfterRead
(String moveAfterRead) Determines whether objects should be moved to a different bucket after they have been retrieved.objectName
(String objectName) Name of object to perform operation with.The object name prefix used for filtering objects to be listed.Proxy server ip/hostname.proxyPassword
(String proxyPassword) Proxy authentication password.proxyPort
(int proxyPort) Proxy server port.Proxy server port.Proxy authentication user.OBS service region.repeatCount
(long repeatCount) Specifies a maximum limit of number of fires.repeatCount
(String repeatCount) Specifies a maximum limit of number of fires.runLoggingLevel
(String runLoggingLevel) The consumer logs a start/complete log line when it polls.runLoggingLevel
(org.apache.camel.LoggingLevel runLoggingLevel) The consumer logs a start/complete log line when it polls.scheduledExecutorService
(String scheduledExecutorService) Allows for configuring a custom/shared thread pool to use for the consumer.scheduledExecutorService
(ScheduledExecutorService scheduledExecutorService) Allows for configuring a custom/shared thread pool to use for the consumer.To use a cron scheduler from either camel-spring or camel-quartz component.To use a cron scheduler from either camel-spring or camel-quartz component.schedulerProperties
(String key, Object value) To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler.schedulerProperties
(Map values) To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler.Secret key for the cloud user.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.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.serviceKeys
(String serviceKeys) Configuration object for cloud service authentication.serviceKeys
(org.apache.camel.component.huaweicloud.common.models.ServiceKeys serviceKeys) Configuration object for cloud service authentication.startScheduler
(boolean startScheduler) Whether the scheduler should be auto started.startScheduler
(String startScheduler) Whether the scheduler should be auto started.Time unit for initialDelay and delay options.Time unit for initialDelay and delay options.useFixedDelay
(boolean useFixedDelay) Controls if fixed delay or fixed rate is used.useFixedDelay
(String useFixedDelay) Controls if fixed delay or fixed rate is used.Methods inherited from interface org.apache.camel.builder.EndpointConsumerBuilder
doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getRawUri, getUri
Methods inherited from interface org.apache.camel.EndpointConsumerResolver
resolve, resolve
-
Method Details
-
advanced
-
bucketName
Name of bucket to perform operation on. The option is a: <code>java.lang.String</code> type. Group: common- Parameters:
bucketName
- the value to set- Returns:
- the dsl builder
-
endpoint
OBS url. Carries higher precedence than region parameter based client initialization. The option is a: <code>java.lang.String</code> type. Group: common- Parameters:
endpoint
- the value to set- Returns:
- the dsl builder
-
objectName
Name of object to perform operation with. The option is a: <code>java.lang.String</code> type. Group: common- Parameters:
objectName
- the value to set- Returns:
- the dsl builder
-
region
OBS service region. This is lower precedence than endpoint based configuration. The option is a: <code>java.lang.String</code> type. Required: true Group: common- Parameters:
region
- the value to set- Returns:
- the dsl builder
-
deleteAfterRead
default OBSEndpointBuilderFactory.OBSEndpointConsumerBuilder deleteAfterRead(boolean deleteAfterRead) Determines if objects should be deleted after it has been retrieved. The option is a: <code>boolean</code> type. Default: false Group: consumer- Parameters:
deleteAfterRead
- the value to set- Returns:
- the dsl builder
-
deleteAfterRead
default OBSEndpointBuilderFactory.OBSEndpointConsumerBuilder deleteAfterRead(String deleteAfterRead) Determines if objects should be deleted after it has been retrieved. The option will be converted to a <code>boolean</code> type. Default: false Group: consumer- Parameters:
deleteAfterRead
- the value to set- Returns:
- the dsl builder
-
delimiter
The character used for grouping object names. The option is a: <code>java.lang.String</code> type. Group: consumer- Parameters:
delimiter
- the value to set- Returns:
- the dsl builder
-
destinationBucket
default OBSEndpointBuilderFactory.OBSEndpointConsumerBuilder destinationBucket(String destinationBucket) Name of destination bucket where objects will be moved when moveAfterRead is set to true. The option is a: <code>java.lang.String</code> type. Group: consumer- Parameters:
destinationBucket
- the value to set- Returns:
- the dsl builder
-
fileName
Get the object from the bucket with the given file name. The option is a: <code>java.lang.String</code> type. Group: consumer- Parameters:
fileName
- the value to set- Returns:
- the dsl builder
-
includeFolders
If true, objects in folders will be consumed. Otherwise, they will be ignored and no Exchanges will be created for them. The option is a: <code>boolean</code> type. Default: true Group: consumer- Parameters:
includeFolders
- the value to set- Returns:
- the dsl builder
-
includeFolders
If true, objects in folders will be consumed. Otherwise, they will be ignored and no Exchanges will be created for them. The option will be converted to a <code>boolean</code> type. Default: true Group: consumer- Parameters:
includeFolders
- the value to set- Returns:
- the dsl builder
-
maxMessagesPerPoll
default OBSEndpointBuilderFactory.OBSEndpointConsumerBuilder maxMessagesPerPoll(int maxMessagesPerPoll) The maximum number of messages to poll at each polling. The option is a: <code>int</code> type. Default: 10 Group: consumer- Parameters:
maxMessagesPerPoll
- the value to set- Returns:
- the dsl builder
-
maxMessagesPerPoll
default OBSEndpointBuilderFactory.OBSEndpointConsumerBuilder maxMessagesPerPoll(String maxMessagesPerPoll) The maximum number of messages to poll at each polling. The option will be converted to a <code>int</code> type. Default: 10 Group: consumer- Parameters:
maxMessagesPerPoll
- the value to set- Returns:
- the dsl builder
-
moveAfterRead
Determines whether objects should be moved to a different bucket after they have been retrieved. The destinationBucket option must also be set for this option to work. The option is a: <code>boolean</code> type. Default: false Group: consumer- Parameters:
moveAfterRead
- the value to set- Returns:
- the dsl builder
-
moveAfterRead
Determines whether objects should be moved to a different bucket after they have been retrieved. The destinationBucket option must also be set for this option to work. The option will be converted to a <code>boolean</code> type. Default: false Group: consumer- Parameters:
moveAfterRead
- the value to set- Returns:
- the dsl builder
-
prefix
The object name prefix used for filtering objects to be listed. The option is a: <code>java.lang.String</code> type. Group: consumer- Parameters:
prefix
- the value to set- Returns:
- the dsl builder
-
sendEmptyMessageWhenIdle
default OBSEndpointBuilderFactory.OBSEndpointConsumerBuilder 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 OBSEndpointBuilderFactory.OBSEndpointConsumerBuilder 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
-
proxyHost
Proxy server ip/hostname. The option is a: <code>java.lang.String</code> type. Group: proxy- Parameters:
proxyHost
- the value to set- Returns:
- the dsl builder
-
proxyPassword
Proxy authentication password. The option is a: <code>java.lang.String</code> type. Group: proxy- Parameters:
proxyPassword
- the value to set- Returns:
- the dsl builder
-
proxyPort
Proxy server port. The option is a: <code>int</code> type. Group: proxy- Parameters:
proxyPort
- the value to set- Returns:
- the dsl builder
-
proxyPort
Proxy server port. The option will be converted to a <code>int</code> type. Group: proxy- Parameters:
proxyPort
- the value to set- Returns:
- the dsl builder
-
proxyUser
Proxy authentication user. The option is a: <code>java.lang.String</code> type. Group: proxy- Parameters:
proxyUser
- the value to set- Returns:
- the dsl builder
-
backoffErrorThreshold
default OBSEndpointBuilderFactory.OBSEndpointConsumerBuilder 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 OBSEndpointBuilderFactory.OBSEndpointConsumerBuilder 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 OBSEndpointBuilderFactory.OBSEndpointConsumerBuilder 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 OBSEndpointBuilderFactory.OBSEndpointConsumerBuilder 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 OBSEndpointBuilderFactory.OBSEndpointConsumerBuilder 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 OBSEndpointBuilderFactory.OBSEndpointConsumerBuilder 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
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
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 OBSEndpointBuilderFactory.OBSEndpointConsumerBuilder 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 OBSEndpointBuilderFactory.OBSEndpointConsumerBuilder 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 OBSEndpointBuilderFactory.OBSEndpointConsumerBuilder 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 OBSEndpointBuilderFactory.OBSEndpointConsumerBuilder 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 OBSEndpointBuilderFactory.OBSEndpointConsumerBuilder 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 keyvalue
- the option value- Returns:
- the dsl builder
-
schedulerProperties
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
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
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
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
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 cloud user. The option is a: <code>java.lang.String</code> type. Required: true Group: security- Parameters:
accessKey
- the value to set- Returns:
- the dsl builder
-
ignoreSslVerification
default OBSEndpointBuilderFactory.OBSEndpointConsumerBuilder ignoreSslVerification(boolean ignoreSslVerification) Ignore SSL verification. The option is a: <code>boolean</code> type. Default: false Group: security- Parameters:
ignoreSslVerification
- the value to set- Returns:
- the dsl builder
-
ignoreSslVerification
default OBSEndpointBuilderFactory.OBSEndpointConsumerBuilder ignoreSslVerification(String ignoreSslVerification) Ignore SSL verification. The option will be converted to a <code>boolean</code> type. Default: false Group: security- Parameters:
ignoreSslVerification
- the value to set- Returns:
- the dsl builder
-
secretKey
Secret key for the cloud user. The option is a: <code>java.lang.String</code> type. Required: true Group: security- Parameters:
secretKey
- the value to set- Returns:
- the dsl builder
-
serviceKeys
default OBSEndpointBuilderFactory.OBSEndpointConsumerBuilder serviceKeys(org.apache.camel.component.huaweicloud.common.models.ServiceKeys serviceKeys) Configuration object for cloud service authentication. The option is a: <code>org.apache.camel.component.huaweicloud.common.models.ServiceKeys</code> type. Group: security- Parameters:
serviceKeys
- the value to set- Returns:
- the dsl builder
-
serviceKeys
Configuration object for cloud service authentication. The option will be converted to a <code>org.apache.camel.component.huaweicloud.common.models.ServiceKeys</code> type. Group: security- Parameters:
serviceKeys
- the value to set- Returns:
- the dsl builder
-