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

Interface Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder

  • All Superinterfaces:
    org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver
    All Known Subinterfaces:
    Sqs2EndpointBuilderFactory.Sqs2EndpointBuilder
    Enclosing interface:
    Sqs2EndpointBuilderFactory
    public static interface Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder
extends org.apache.camel.builder.EndpointConsumerBuilder
    Builder for endpoint consumers for the AWS 2 Simple Queue Service (SQS) component.

    • Method Detail

      • headerFilterStrategy

        default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder headerFilterStrategy​(org.apache.camel.spi.HeaderFilterStrategy headerFilterStrategy)
        To use a custom HeaderFilterStrategy to map headers to/from Camel. The option is a: org.apache.camel.spi.HeaderFilterStrategy type. Group: common

      • headerFilterStrategy

        default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder headerFilterStrategy​(String headerFilterStrategy)
        To use a custom HeaderFilterStrategy to map headers to/from Camel. The option will be converted to a org.apache.camel.spi.HeaderFilterStrategy type. Group: common

      • queueOwnerAWSAccountId

        default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder queueOwnerAWSAccountId​(String queueOwnerAWSAccountId)
        Specify the queue owner aws account id when you need to connect the queue with different account owner. The option is a: java.lang.String type. Group: common

      • region

        default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder region​(String region)
        The region in which SQS 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

      • bridgeErrorHandler

        default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder 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 Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder 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

      • concurrentConsumers

        default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder concurrentConsumers​(int concurrentConsumers)
        Allows you to use multiple threads to poll the sqs queue to increase throughput. The option is a: int type. Default: 1 Group: consumer

      • deleteIfFiltered

        default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder deleteIfFiltered​(boolean deleteIfFiltered)
        Whether or not to send the DeleteMessage to the SQS queue if an exchange fails to get through a filter. If 'false' and exchange does not make it through a Camel filter upstream in the route, then don't send DeleteMessage. The option is a: boolean type. Default: true Group: consumer

      • deleteIfFiltered

        default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder deleteIfFiltered​(String deleteIfFiltered)
        Whether or not to send the DeleteMessage to the SQS queue if an exchange fails to get through a filter. If 'false' and exchange does not make it through a Camel filter upstream in the route, then don't send DeleteMessage. The option will be converted to a boolean type. Default: true Group: consumer

      • extendMessageVisibility

        default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder extendMessageVisibility​(boolean extendMessageVisibility)
        If enabled then a scheduled background task will keep extending the message visibility on SQS. This is needed if it takes a long time to process the message. If set to true defaultVisibilityTimeout must be set. See details at Amazon docs. The option is a: boolean type. Default: false Group: consumer

      • extendMessageVisibility

        default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder extendMessageVisibility​(String extendMessageVisibility)
        If enabled then a scheduled background task will keep extending the message visibility on SQS. This is needed if it takes a long time to process the message. If set to true defaultVisibilityTimeout must be set. See details at Amazon docs. The option will be converted to a boolean type. Default: false Group: consumer

      • kmsDataKeyReusePeriodSeconds

        default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder kmsDataKeyReusePeriodSeconds​(Integer kmsDataKeyReusePeriodSeconds)
        The length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again. An integer representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). Default: 300 (5 minutes). The option is a: java.lang.Integer type. Group: consumer

      • kmsDataKeyReusePeriodSeconds

        default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder kmsDataKeyReusePeriodSeconds​(String kmsDataKeyReusePeriodSeconds)
        The length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again. An integer representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). Default: 300 (5 minutes). The option will be converted to a java.lang.Integer type. Group: consumer

      • maxMessagesPerPoll

        default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder maxMessagesPerPoll​(int maxMessagesPerPoll)
        Gets the maximum number of messages as a limit to poll at each polling. Is default unlimited, but use 0 or negative number to disable it as unlimited. The option is a: int type. Group: consumer

      • maxMessagesPerPoll

        default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder maxMessagesPerPoll​(String maxMessagesPerPoll)
        Gets the maximum number of messages as a limit to poll at each polling. Is default unlimited, but use 0 or negative number to disable it as unlimited. The option will be converted to a int type. Group: consumer

      • messageAttributeNames

        default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder messageAttributeNames​(String messageAttributeNames)
        A list of message attribute names to receive when consuming. Multiple names can be separated by comma. The option is a: java.lang.String type. Group: consumer

      • sendEmptyMessageWhenIdle

        default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder 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 Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder 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

      • serverSideEncryptionEnabled

        default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder serverSideEncryptionEnabled​(boolean serverSideEncryptionEnabled)
        Define if Server Side Encryption is enabled or not on the queue. The option is a: boolean type. Default: false Group: consumer

      • serverSideEncryptionEnabled

        default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder serverSideEncryptionEnabled​(String serverSideEncryptionEnabled)
        Define if Server Side Encryption is enabled or not on the queue. The option will be converted to a boolean type. Default: false Group: consumer

      • visibilityTimeout

        default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder visibilityTimeout​(Integer visibilityTimeout)
        The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved by a ReceiveMessage request to set in the com.amazonaws.services.sqs.model.SetQueueAttributesRequest. This only make sense if its different from defaultVisibilityTimeout. It changes the queue visibility timeout attribute permanently. The option is a: java.lang.Integer type. Group: consumer

      • visibilityTimeout

        default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder visibilityTimeout​(String visibilityTimeout)
        The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved by a ReceiveMessage request to set in the com.amazonaws.services.sqs.model.SetQueueAttributesRequest. This only make sense if its different from defaultVisibilityTimeout. It changes the queue visibility timeout attribute permanently. The option will be converted to a java.lang.Integer type. Group: consumer

      • waitTimeSeconds

        default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder waitTimeSeconds​(Integer waitTimeSeconds)
        Duration in seconds (0 to 20) that the ReceiveMessage action call will wait until a message is in the queue to include in the response. The option is a: java.lang.Integer type. Group: consumer

      • waitTimeSeconds

        default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder waitTimeSeconds​(String waitTimeSeconds)
        Duration in seconds (0 to 20) that the ReceiveMessage action call will wait until a message is in the queue to include in the response. The option will be converted to a java.lang.Integer type. Group: consumer

      • messageRetentionPeriod

        default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder messageRetentionPeriod​(String messageRetentionPeriod)
        The messageRetentionPeriod (in seconds) a message will be retained by SQS for this queue. The option will be converted to a java.lang.Integer type. Group: queue

      • receiveMessageWaitTimeSeconds

        default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder receiveMessageWaitTimeSeconds​(Integer receiveMessageWaitTimeSeconds)
        If you do not specify WaitTimeSeconds in the request, the queue attribute ReceiveMessageWaitTimeSeconds is used to determine how long to wait. The option is a: java.lang.Integer type. Group: queue

      • receiveMessageWaitTimeSeconds

        default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder receiveMessageWaitTimeSeconds​(String receiveMessageWaitTimeSeconds)
        If you do not specify WaitTimeSeconds in the request, the queue attribute ReceiveMessageWaitTimeSeconds is used to determine how long to wait. The option will be converted to a java.lang.Integer type. Group: queue

      • backoffErrorThreshold

        default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder 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 Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder 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 Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder 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 Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder 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 Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder 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 Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder 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 Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder 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 Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder 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 Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder 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 Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder 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 Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder 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 Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder 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 Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder 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 Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder 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 Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder 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 Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder 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 Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder 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