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

Interface S3EndpointBuilderFactory.S3EndpointConsumerBuilder

  • All Superinterfaces:
    org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver
    All Known Subinterfaces:
    S3EndpointBuilderFactory.S3EndpointBuilder
    Enclosing interface:
    S3EndpointBuilderFactory
    public static interface S3EndpointBuilderFactory.S3EndpointConsumerBuilder
extends org.apache.camel.builder.EndpointConsumerBuilder
    Builder for endpoint consumers for the AWS S3 Storage Service component.

    • Method Detail

      • endpointConfiguration

        default S3EndpointBuilderFactory.S3EndpointConsumerBuilder endpointConfiguration​(Object endpointConfiguration)
        Amazon AWS Endpoint Configuration. The option is a: com.amazonaws.client.builder.AwsClientBuilder$EndpointConfiguration type. Group: common

      • endpointConfiguration

        default S3EndpointBuilderFactory.S3EndpointConsumerBuilder endpointConfiguration​(String endpointConfiguration)
        Amazon AWS Endpoint Configuration. The option will be converted to a com.amazonaws.client.builder.AwsClientBuilder$EndpointConfiguration type. Group: common

      • region

        default S3EndpointBuilderFactory.S3EndpointConsumerBuilder region​(String region)
        The region in which S3 client needs to work. When using this parameter, the configuration will expect the capitalized name of the region (for example AP_EAST_1) You'll need to use the name Regions.EU_WEST_1.name(). The option is a: java.lang.String type. Group: common

      • useIAMCredentials

        default S3EndpointBuilderFactory.S3EndpointConsumerBuilder useIAMCredentials​(boolean useIAMCredentials)
        Set whether the S3 client should expect to load credentials on an EC2 instance or to expect static credentials to be passed in. The option is a: boolean type. Default: false Group: common

      • useIAMCredentials

        default S3EndpointBuilderFactory.S3EndpointConsumerBuilder useIAMCredentials​(String useIAMCredentials)
        Set whether the S3 client should expect to load credentials on an EC2 instance or to expect static credentials to be passed in. The option will be converted to a boolean type. Default: false Group: common

      • bridgeErrorHandler

        default S3EndpointBuilderFactory.S3EndpointConsumerBuilder 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 S3EndpointBuilderFactory.S3EndpointConsumerBuilder 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 S3EndpointBuilderFactory.S3EndpointConsumerBuilder 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 S3Constants#BUCKET_NAME and S3Constants#KEY headers, or only the S3Constants#KEY header. The option is a: boolean type. Default: true Group: consumer

      • deleteAfterRead

        default S3EndpointBuilderFactory.S3EndpointConsumerBuilder 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 S3Constants#BUCKET_NAME and S3Constants#KEY headers, or only the S3Constants#KEY header. The option will be converted to a boolean type. Default: true Group: consumer

      • delimiter

        default S3EndpointBuilderFactory.S3EndpointConsumerBuilder delimiter​(String 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: java.lang.String type. Group: consumer

      • includeBody

        default S3EndpointBuilderFactory.S3EndpointConsumerBuilder includeBody​(boolean includeBody)
        If it is true, the exchange body will be set to a stream to the contents of the file. If false, the headers will be set with the S3 object metadata, but the body will be null. This option is strongly related to autocloseBody option. In case of setting includeBody to true and autocloseBody to false, it will be up to the caller to close the S3Object stream. Setting autocloseBody to true, will close the S3Object stream automatically. The option is a: boolean type. Default: true Group: consumer

      • includeBody

        default S3EndpointBuilderFactory.S3EndpointConsumerBuilder includeBody​(String includeBody)
        If it is true, the exchange body will be set to a stream to the contents of the file. If false, the headers will be set with the S3 object metadata, but the body will be null. This option is strongly related to autocloseBody option. In case of setting includeBody to true and autocloseBody to false, it will be up to the caller to close the S3Object stream. Setting autocloseBody to true, will close the S3Object stream automatically. The option will be converted to a boolean type. Default: true Group: consumer

      • maxMessagesPerPoll

        default S3EndpointBuilderFactory.S3EndpointConsumerBuilder 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 S3EndpointBuilderFactory.S3EndpointConsumerBuilder 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

      • prefix

        default S3EndpointBuilderFactory.S3EndpointConsumerBuilder prefix​(String 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: java.lang.String type. Group: consumer

      • sendEmptyMessageWhenIdle

        default S3EndpointBuilderFactory.S3EndpointConsumerBuilder 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 S3EndpointBuilderFactory.S3EndpointConsumerBuilder 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 S3EndpointBuilderFactory.S3EndpointConsumerBuilder 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 S3EndpointBuilderFactory.S3EndpointConsumerBuilder 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 S3EndpointBuilderFactory.S3EndpointConsumerBuilder 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 S3EndpointBuilderFactory.S3EndpointConsumerBuilder 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 S3EndpointBuilderFactory.S3EndpointConsumerBuilder 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 S3EndpointBuilderFactory.S3EndpointConsumerBuilder 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 S3EndpointBuilderFactory.S3EndpointConsumerBuilder 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 S3EndpointBuilderFactory.S3EndpointConsumerBuilder 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

      • repeatCount

        default S3EndpointBuilderFactory.S3EndpointConsumerBuilder 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 S3EndpointBuilderFactory.S3EndpointConsumerBuilder 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 S3EndpointBuilderFactory.S3EndpointConsumerBuilder 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 S3EndpointBuilderFactory.S3EndpointConsumerBuilder 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 S3EndpointBuilderFactory.S3EndpointConsumerBuilder 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 S3EndpointBuilderFactory.S3EndpointConsumerBuilder 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

      • schedulerProperties

        default S3EndpointBuilderFactory.S3EndpointConsumerBuilder 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 S3EndpointBuilderFactory.S3EndpointConsumerBuilder 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

      • useFixedDelay

        default S3EndpointBuilderFactory.S3EndpointConsumerBuilder 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 S3EndpointBuilderFactory.S3EndpointConsumerBuilder 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