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 2 S3 Storage Service component.
    • Method Detail

      • amazonS3Presigner

        default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder amazonS3Presigner​(String amazonS3Presigner)
        An S3 Presigner for Request, used mainly in createDownloadLink operation. The option will be converted to a software.amazon.awssdk.services.s3.presigner.S3Presigner type. Group: common
      • 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: boolean type. Default: true Group: common
      • 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 boolean type. Default: true Group: common
      • overrideEndpoint

        default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder overrideEndpoint​(boolean overrideEndpoint)
        Set the need for overidding the endpoint. This option needs to be used in combination with uriEndpointOverride option. The option is a: boolean type. Default: false Group: common
      • overrideEndpoint

        default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder overrideEndpoint​(String overrideEndpoint)
        Set the need for overidding the endpoint. This option needs to be used in combination with uriEndpointOverride option. The option will be converted to a boolean type. Default: false Group: common
      • region

        default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder region​(String region)
        The region in which 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: java.lang.String type. Group: common
      • useDefaultCredentialsProvider

        default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder useDefaultCredentialsProvider​(boolean useDefaultCredentialsProvider)
        Set whether the S3 client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in. The option is a: boolean type. Default: false Group: common
      • useDefaultCredentialsProvider

        default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder useDefaultCredentialsProvider​(String useDefaultCredentialsProvider)
        Set whether the S3 client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in. The option will be converted to a boolean type. Default: false Group: common
      • bridgeErrorHandler

        default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder 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 AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder 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
      • deleteAfterRead

        default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder deleteAfterRead​(boolean deleteAfterRead)
        Delete objects from S3 after they have been retrieved. The delete 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 retrieve over and over again on 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: boolean type. Default: true Group: consumer
      • deleteAfterRead

        default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder deleteAfterRead​(String deleteAfterRead)
        Delete objects from S3 after they have been retrieved. The delete 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 retrieve over and over again on 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 boolean type. Default: true Group: consumer
      • includeBody

        default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder includeBody​(boolean 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 autocloseBody option. In case of setting includeBody to true because the S3Object stream will be consumed then it will also be closed 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: boolean type. Default: true Group: consumer
      • includeBody

        default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder includeBody​(String 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 autocloseBody option. In case of setting includeBody to true because the S3Object stream will be consumed then it will also be closed 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 boolean type. Default: true Group: consumer
      • 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: boolean type. Default: true Group: consumer
      • 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 boolean type. Default: true Group: consumer
      • 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: int type. Default: 10 Group: consumer
      • 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 int type. Default: 10 Group: consumer
      • 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: boolean type. Default: false Group: consumer
      • 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 boolean type. Default: false Group: consumer
      • 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: boolean type. Default: false Group: consumer
      • 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 boolean type. Default: false Group: consumer
      • 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: int type. Group: scheduler
      • 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 int type. Group: scheduler
      • 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: int type. Group: scheduler
      • 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 int type. Group: scheduler
      • greedy

        default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder 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
      • repeatCount

        default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder 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 AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder 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 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: org.apache.camel.LoggingLevel type. Default: TRACE Group: scheduler
      • 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 org.apache.camel.LoggingLevel type. Default: TRACE Group: scheduler
      • 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 java.util.concurrent.ScheduledExecutorService type. Group: scheduler
      • scheduler

        default AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder 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 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: 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 AWS2S3EndpointBuilderFactory.AWS2S3EndpointConsumerBuilder 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