Interface AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder
- All Superinterfaces:
org.apache.camel.builder.EndpointConsumerBuilder
,org.apache.camel.EndpointConsumerResolver
- All Known Subinterfaces:
AWS2S3EndpointBuilderFactory.AWS2S3EndpointBuilder
- Enclosing interface:
AWS2S3EndpointBuilderFactory
public static interface AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder
extends org.apache.camel.builder.EndpointConsumerBuilder
Builder for endpoint consumers for the AWS S3 Storage Service component.
-
Method Summary
Modifier and TypeMethodDescriptionAmazon AWS Access Key.advanced()
autoCreateBucket
(boolean autoCreateBucket) Setting the autocreation of the S3 bucket bucketName.autoCreateBucket
(String autoCreateBucket) Setting the autocreation of the S3 bucket bucketName.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.delay
(long delay) Milliseconds before the next poll.Milliseconds before the next poll.deleteAfterRead
(boolean deleteAfterRead) Delete objects from S3 after they have been retrieved.deleteAfterRead
(String deleteAfterRead) Delete objects from S3 after they have been retrieved.The delimiter which is used in the com.amazonaws.services.s3.model.ListObjectsRequest to only consume objects we are interested in.destinationBucket
(String destinationBucket) Define the destination bucket where an object must be moved when moveAfterRead is set to true.destinationBucketPrefix
(String destinationBucketPrefix) Define the destination bucket prefix to use when an object must be moved, and moveAfterRead is set to true.destinationBucketSuffix
(String destinationBucketSuffix) Define the destination bucket suffix to use when an object must be moved, and moveAfterRead is set to true.doneFileName
(String doneFileName) If provided, Camel will only consume files if a done file exists.To get the object from the bucket with the given file name.forcePathStyle
(boolean forcePathStyle) Set whether the S3 client should use path-style URL instead of virtual-hosted-style.forcePathStyle
(String forcePathStyle) Set whether the S3 client should use path-style URL instead of virtual-hosted-style.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.ignoreBody
(boolean ignoreBody) If it is true, the S3 Object Body will be ignored completely if it is set to false, the S3 Object will be put in the body.ignoreBody
(String ignoreBody) If it is true, the S3 Object Body will be ignored completely if it is set to false, the S3 Object will be put in the body.includeBody
(boolean includeBody) If it is true, the S3Object exchange will be consumed and put into the body and closed.includeBody
(String includeBody) If it is true, the S3Object exchange will be consumed and put into the body and closed.includeFolders
(boolean includeFolders) If it is true, the folders/directories will be consumed.includeFolders
(String includeFolders) If it is true, the folders/directories will be consumed.initialDelay
(long initialDelay) Milliseconds before the first poll starts.initialDelay
(String initialDelay) Milliseconds before the first poll starts.maxConnections
(int maxConnections) Set the maxConnections parameter in the S3 client configuration.maxConnections
(String maxConnections) Set the maxConnections parameter in the S3 client configuration.maxMessagesPerPoll
(int maxMessagesPerPoll) Gets the maximum number of messages as a limit to poll at each polling.maxMessagesPerPoll
(String maxMessagesPerPoll) Gets the maximum number of messages as a limit to poll at each polling.moveAfterRead
(boolean moveAfterRead) Move objects from S3 bucket to a different bucket after they have been retrieved.moveAfterRead
(String moveAfterRead) Move objects from S3 bucket to a different bucket after they have been retrieved.overrideEndpoint
(boolean overrideEndpoint) Set the need for overriding the endpoint.overrideEndpoint
(String overrideEndpoint) Set the need for overriding the endpoint.pojoRequest
(boolean pojoRequest) If we want to use a POJO request as body or not.pojoRequest
(String pojoRequest) If we want to use a POJO request as body or not.The policy for this queue to set in the com.amazonaws.services.s3.AmazonS3#setBucketPolicy() method.The prefix which is used in the com.amazonaws.services.s3.model.ListObjectsRequest to only consume objects we are interested in.profileCredentialsName
(String profileCredentialsName) If using a profile credentials provider, this parameter will set the profile name.To define a proxy host when instantiating the SQS client.Specify a proxy port to be used inside the client definition.Specify a proxy port to be used inside the client definition.proxyProtocol
(String proxyProtocol) To define a proxy protocol when instantiating the S3 client.proxyProtocol
(software.amazon.awssdk.core.Protocol proxyProtocol) To define a proxy protocol when instantiating the S3 client.The region in which the S3 client needs to work.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.Amazon AWS Secret Key.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.sessionToken
(String sessionToken) Amazon AWS Session Token used when the user needs to assume an IAM role.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.trustAllCertificates
(boolean trustAllCertificates) If we want to trust all certificates in case of overriding the endpoint.trustAllCertificates
(String trustAllCertificates) If we want to trust all certificates in case of overriding the endpoint.uriEndpointOverride
(String uriEndpointOverride) Set the overriding uri endpoint.useDefaultCredentialsProvider
(boolean useDefaultCredentialsProvider) Set whether the S3 client should expect to load credentials through a default credentials provider.useDefaultCredentialsProvider
(String useDefaultCredentialsProvider) Set whether the S3 client should expect to load credentials through a default credentials provider.useFixedDelay
(boolean useFixedDelay) Controls if fixed delay or fixed rate is used.useFixedDelay
(String useFixedDelay) Controls if fixed delay or fixed rate is used.useProfileCredentialsProvider
(boolean useProfileCredentialsProvider) Set whether the S3 client should expect to load credentials through a profile credentials provider.useProfileCredentialsProvider
(String useProfileCredentialsProvider) Set whether the S3 client should expect to load credentials through a profile credentials provider.useSessionCredentials
(boolean useSessionCredentials) Set whether the S3 client should expect to use Session Credentials.useSessionCredentials
(String useSessionCredentials) Set whether the S3 client should expect to use Session Credentials.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
-
autoCreateBucket
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder autoCreateBucket(boolean autoCreateBucket) Setting the autocreation of the S3 bucket bucketName. This will apply also in case of moveAfterRead option enabled, and it will create the destinationBucket if it doesn't exist already. The option is a: <code>boolean</code> type. Default: false Group: common- Parameters:
autoCreateBucket
- the value to set- Returns:
- the dsl builder
-
autoCreateBucket
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder autoCreateBucket(String autoCreateBucket) Setting the autocreation of the S3 bucket bucketName. This will apply also in case of moveAfterRead option enabled, and it will create the destinationBucket if it doesn't exist already. The option will be converted to a <code>boolean</code> type. Default: false Group: common- Parameters:
autoCreateBucket
- the value to set- Returns:
- the dsl builder
-
delimiter
The delimiter which is used in the com.amazonaws.services.s3.model.ListObjectsRequest to only consume objects we are interested in. The option is a: <code>java.lang.String</code> type. Group: common- Parameters:
delimiter
- the value to set- Returns:
- the dsl builder
-
forcePathStyle
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder forcePathStyle(boolean forcePathStyle) Set whether the S3 client should use path-style URL instead of virtual-hosted-style. The option is a: <code>boolean</code> type. Default: false Group: common- Parameters:
forcePathStyle
- the value to set- Returns:
- the dsl builder
-
forcePathStyle
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder forcePathStyle(String forcePathStyle) Set whether the S3 client should use path-style URL instead of virtual-hosted-style. The option will be converted to a <code>boolean</code> type. Default: false Group: common- Parameters:
forcePathStyle
- the value to set- Returns:
- the dsl builder
-
overrideEndpoint
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder overrideEndpoint(boolean overrideEndpoint) Set the need for overriding the endpoint. This option needs to be used in combination with the uriEndpointOverride option. The option is a: <code>boolean</code> type. Default: false Group: common- Parameters:
overrideEndpoint
- the value to set- Returns:
- the dsl builder
-
overrideEndpoint
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder overrideEndpoint(String overrideEndpoint) Set the need for overriding the endpoint. This option needs to be used in combination with the uriEndpointOverride option. The option will be converted to a <code>boolean</code> type. Default: false Group: common- Parameters:
overrideEndpoint
- the value to set- Returns:
- the dsl builder
-
pojoRequest
If we want to use a POJO request as body or not. The option is a: <code>boolean</code> type. Default: false Group: common- Parameters:
pojoRequest
- the value to set- Returns:
- the dsl builder
-
pojoRequest
If we want to use a POJO request as body or not. The option will be converted to a <code>boolean</code> type. Default: false Group: common- Parameters:
pojoRequest
- the value to set- Returns:
- the dsl builder
-
policy
The policy for this queue to set in the com.amazonaws.services.s3.AmazonS3#setBucketPolicy() method. The option is a: <code>java.lang.String</code> type. Group: common- Parameters:
policy
- the value to set- Returns:
- the dsl builder
-
prefix
The prefix which is used in the com.amazonaws.services.s3.model.ListObjectsRequest to only consume objects we are interested in. The option is a: <code>java.lang.String</code> type. Group: common- Parameters:
prefix
- the value to set- Returns:
- the dsl builder
-
region
The region in which the S3 client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example, ap-east-1) You'll need to use the name Region.EU_WEST_1.id(). The option is a: <code>java.lang.String</code> type. Group: common- Parameters:
region
- the value to set- Returns:
- the dsl builder
-
uriEndpointOverride
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder uriEndpointOverride(String uriEndpointOverride) Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option. The option is a: <code>java.lang.String</code> type. Group: common- Parameters:
uriEndpointOverride
- the value to set- Returns:
- the dsl builder
-
deleteAfterRead
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder deleteAfterRead(boolean deleteAfterRead) Delete objects from S3 after they have been retrieved. The deleting is only performed if the Exchange is committed. If a rollback occurs, the object is not deleted. If this option is false, then the same objects will be retrieved over and over again in the polls. Therefore, you need to use the Idempotent Consumer EIP in the route to filter out duplicates. You can filter using the AWS2S3Constants#BUCKET_NAME and AWS2S3Constants#KEY headers, or only the AWS2S3Constants#KEY header. The option is a: <code>boolean</code> type. Default: true Group: consumer- Parameters:
deleteAfterRead
- the value to set- Returns:
- the dsl builder
-
deleteAfterRead
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder deleteAfterRead(String deleteAfterRead) Delete objects from S3 after they have been retrieved. The deleting is only performed if the Exchange is committed. If a rollback occurs, the object is not deleted. If this option is false, then the same objects will be retrieved over and over again in the polls. Therefore, you need to use the Idempotent Consumer EIP in the route to filter out duplicates. You can filter using the AWS2S3Constants#BUCKET_NAME and AWS2S3Constants#KEY headers, or only the AWS2S3Constants#KEY header. The option will be converted to a <code>boolean</code> type. Default: true Group: consumer- Parameters:
deleteAfterRead
- the value to set- Returns:
- the dsl builder
-
destinationBucket
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder destinationBucket(String destinationBucket) Define the destination bucket where an object must 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
-
destinationBucketPrefix
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder destinationBucketPrefix(String destinationBucketPrefix) Define the destination bucket prefix to use when an object must be moved, and moveAfterRead is set to true. The option is a: <code>java.lang.String</code> type. Group: consumer- Parameters:
destinationBucketPrefix
- the value to set- Returns:
- the dsl builder
-
destinationBucketSuffix
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder destinationBucketSuffix(String destinationBucketSuffix) Define the destination bucket suffix to use when an object must be moved, and moveAfterRead is set to true. The option is a: <code>java.lang.String</code> type. Group: consumer- Parameters:
destinationBucketSuffix
- the value to set- Returns:
- the dsl builder
-
doneFileName
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder doneFileName(String doneFileName) If provided, Camel will only consume files if a done file exists. The option is a: <code>java.lang.String</code> type. Group: consumer- Parameters:
doneFileName
- the value to set- Returns:
- the dsl builder
-
fileName
To 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
-
ignoreBody
If it is true, the S3 Object Body will be ignored completely if it is set to false, the S3 Object will be put in the body. Setting this to true will override any behavior defined by includeBody option. The option is a: <code>boolean</code> type. Default: false Group: consumer- Parameters:
ignoreBody
- the value to set- Returns:
- the dsl builder
-
ignoreBody
If it is true, the S3 Object Body will be ignored completely if it is set to false, the S3 Object will be put in the body. Setting this to true will override any behavior defined by includeBody option. The option will be converted to a <code>boolean</code> type. Default: false Group: consumer- Parameters:
ignoreBody
- the value to set- Returns:
- the dsl builder
-
includeBody
If it is true, the S3Object exchange will be consumed and put into the body and closed. If false, the S3Object stream will be put raw into the body and the headers will be set with the S3 object metadata. This option is strongly related to the autocloseBody option. In case of setting includeBody to true because the S3Object stream will be consumed then it will also be closed, while in case of includeBody false then it will be up to the caller to close the S3Object stream. However, setting autocloseBody to true when includeBody is false it will schedule to close the S3Object stream automatically on exchange completion. The option is a: <code>boolean</code> type. Default: true Group: consumer- Parameters:
includeBody
- the value to set- Returns:
- the dsl builder
-
includeBody
If it is true, the S3Object exchange will be consumed and put into the body and closed. If false, the S3Object stream will be put raw into the body and the headers will be set with the S3 object metadata. This option is strongly related to the autocloseBody option. In case of setting includeBody to true because the S3Object stream will be consumed then it will also be closed, while in case of includeBody false then it will be up to the caller to close the S3Object stream. However, setting autocloseBody to true when includeBody is false it will schedule to close the S3Object stream automatically on exchange completion. The option will be converted to a <code>boolean</code> type. Default: true Group: consumer- Parameters:
includeBody
- the value to set- Returns:
- the dsl builder
-
includeFolders
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder includeFolders(boolean includeFolders) If it is true, the folders/directories will be consumed. If it is false, they will be ignored, and Exchanges will not be created for those. The option is a: <code>boolean</code> type. Default: true Group: consumer- Parameters:
includeFolders
- the value to set- Returns:
- the dsl builder
-
includeFolders
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder includeFolders(String includeFolders) If it is true, the folders/directories will be consumed. If it is false, they will be ignored, and Exchanges will not be created for those. 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
-
maxConnections
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder maxConnections(int maxConnections) Set the maxConnections parameter in the S3 client configuration. The option is a: <code>int</code> type. Default: 60 Group: consumer- Parameters:
maxConnections
- the value to set- Returns:
- the dsl builder
-
maxConnections
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder maxConnections(String maxConnections) Set the maxConnections parameter in the S3 client configuration. The option will be converted to a <code>int</code> type. Default: 60 Group: consumer- Parameters:
maxConnections
- the value to set- Returns:
- the dsl builder
-
maxMessagesPerPoll
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder maxMessagesPerPoll(int maxMessagesPerPoll) Gets the maximum number of messages as a limit to poll at each polling. Gets the maximum number of messages as a limit to poll at each polling. The default value is 10. Use 0 or a negative number to set it as unlimited. The option is a: <code>int</code> type. Default: 10 Group: consumer- Parameters:
maxMessagesPerPoll
- the value to set- Returns:
- the dsl builder
-
maxMessagesPerPoll
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder maxMessagesPerPoll(String maxMessagesPerPoll) Gets the maximum number of messages as a limit to poll at each polling. Gets the maximum number of messages as a limit to poll at each polling. The default value is 10. Use 0 or a negative number to set it as unlimited. 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
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder moveAfterRead(boolean moveAfterRead) Move objects from S3 bucket to a different bucket after they have been retrieved. To accomplish the operation, the destinationBucket option must be set. The copy bucket operation is only performed if the Exchange is committed. If a rollback occurs, the object is not moved. The option is a: <code>boolean</code> type. Default: false Group: consumer- Parameters:
moveAfterRead
- the value to set- Returns:
- the dsl builder
-
moveAfterRead
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder moveAfterRead(String moveAfterRead) Move objects from S3 bucket to a different bucket after they have been retrieved. To accomplish the operation, the destinationBucket option must be set. The copy bucket operation is only performed if the Exchange is committed. If a rollback occurs, the object is not moved. 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
-
sendEmptyMessageWhenIdle
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder 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 AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder 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
To define a proxy host when instantiating the SQS client. The option is a: <code>java.lang.String</code> type. Group: proxy- Parameters:
proxyHost
- the value to set- Returns:
- the dsl builder
-
proxyPort
Specify a proxy port to be used inside the client definition. The option is a: <code>java.lang.Integer</code> type. Group: proxy- Parameters:
proxyPort
- the value to set- Returns:
- the dsl builder
-
proxyPort
Specify a proxy port to be used inside the client definition. The option will be converted to a <code>java.lang.Integer</code> type. Group: proxy- Parameters:
proxyPort
- the value to set- Returns:
- the dsl builder
-
proxyProtocol
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder proxyProtocol(software.amazon.awssdk.core.Protocol proxyProtocol) To define a proxy protocol when instantiating the S3 client. The option is a: <code>software.amazon.awssdk.core.Protocol</code> type. Default: HTTPS Group: proxy- Parameters:
proxyProtocol
- the value to set- Returns:
- the dsl builder
-
proxyProtocol
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder proxyProtocol(String proxyProtocol) To define a proxy protocol when instantiating the S3 client. The option will be converted to a <code>software.amazon.awssdk.core.Protocol</code> type. Default: HTTPS Group: proxy- Parameters:
proxyProtocol
- the value to set- Returns:
- the dsl builder
-
backoffErrorThreshold
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder 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 AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder 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 AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder 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 AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder 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 AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder 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 AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder 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
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder 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
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 AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder 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 AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder 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 AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder 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 AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder 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 AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder 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
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder 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 AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder 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
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
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder 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 AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder 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
Amazon AWS Access Key. The option is a: <code>java.lang.String</code> type. Group: security- Parameters:
accessKey
- the value to set- Returns:
- the dsl builder
-
profileCredentialsName
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder profileCredentialsName(String profileCredentialsName) If using a profile credentials provider, this parameter will set the profile name. The option is a: <code>java.lang.String</code> type. Group: security- Parameters:
profileCredentialsName
- the value to set- Returns:
- the dsl builder
-
secretKey
Amazon AWS Secret Key. The option is a: <code>java.lang.String</code> type. Group: security- Parameters:
secretKey
- the value to set- Returns:
- the dsl builder
-
sessionToken
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder sessionToken(String sessionToken) Amazon AWS Session Token used when the user needs to assume an IAM role. The option is a: <code>java.lang.String</code> type. Group: security- Parameters:
sessionToken
- the value to set- Returns:
- the dsl builder
-
trustAllCertificates
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder trustAllCertificates(boolean trustAllCertificates) If we want to trust all certificates in case of overriding the endpoint. The option is a: <code>boolean</code> type. Default: false Group: security- Parameters:
trustAllCertificates
- the value to set- Returns:
- the dsl builder
-
trustAllCertificates
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder trustAllCertificates(String trustAllCertificates) If we want to trust all certificates in case of overriding the endpoint. The option will be converted to a <code>boolean</code> type. Default: false Group: security- Parameters:
trustAllCertificates
- the value to set- Returns:
- the dsl builder
-
useDefaultCredentialsProvider
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder useDefaultCredentialsProvider(boolean useDefaultCredentialsProvider) Set whether the S3 client should expect to load credentials through a default credentials provider. The option is a: <code>boolean</code> type. Default: false Group: security- Parameters:
useDefaultCredentialsProvider
- the value to set- Returns:
- the dsl builder
-
useDefaultCredentialsProvider
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder useDefaultCredentialsProvider(String useDefaultCredentialsProvider) Set whether the S3 client should expect to load credentials through a default credentials provider. The option will be converted to a <code>boolean</code> type. Default: false Group: security- Parameters:
useDefaultCredentialsProvider
- the value to set- Returns:
- the dsl builder
-
useProfileCredentialsProvider
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder useProfileCredentialsProvider(boolean useProfileCredentialsProvider) Set whether the S3 client should expect to load credentials through a profile credentials provider. The option is a: <code>boolean</code> type. Default: false Group: security- Parameters:
useProfileCredentialsProvider
- the value to set- Returns:
- the dsl builder
-
useProfileCredentialsProvider
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder useProfileCredentialsProvider(String useProfileCredentialsProvider) Set whether the S3 client should expect to load credentials through a profile credentials provider. The option will be converted to a <code>boolean</code> type. Default: false Group: security- Parameters:
useProfileCredentialsProvider
- the value to set- Returns:
- the dsl builder
-
useSessionCredentials
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder useSessionCredentials(boolean useSessionCredentials) Set whether the S3 client should expect to use Session Credentials. This is useful in a situation in which the user needs to assume an IAM role for doing operations in S3. The option is a: <code>boolean</code> type. Default: false Group: security- Parameters:
useSessionCredentials
- the value to set- Returns:
- the dsl builder
-
useSessionCredentials
default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder useSessionCredentials(String useSessionCredentials) Set whether the S3 client should expect to use Session Credentials. This is useful in a situation in which the user needs to assume an IAM role for doing operations in S3. The option will be converted to a <code>boolean</code> type. Default: false Group: security- Parameters:
useSessionCredentials
- the value to set- Returns:
- the dsl builder
-