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

Interface Sqs2EndpointBuilderFactory.AdvancedSqs2EndpointConsumerBuilder

All Superinterfaces:
org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver
All Known Subinterfaces:
Sqs2EndpointBuilderFactory.AdvancedSqs2EndpointBuilder
Enclosing interface:
Sqs2EndpointBuilderFactory
public static interface Sqs2EndpointBuilderFactory.AdvancedSqs2EndpointConsumerBuilder extends org.apache.camel.builder.EndpointConsumerBuilder
Advanced builder for endpoint consumers for the AWS Simple Queue Service (SQS) component.

  • Method Details

    • basic

      default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder basic()

    • bridgeErrorHandler

      default Sqs2EndpointBuilderFactory.AdvancedSqs2EndpointConsumerBuilder bridgeErrorHandler(boolean bridgeErrorHandler)
      Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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 (advanced)
      Parameters:
      bridgeErrorHandler - the value to set
      Returns:
      the dsl builder

    • bridgeErrorHandler

      default Sqs2EndpointBuilderFactory.AdvancedSqs2EndpointConsumerBuilder bridgeErrorHandler(String bridgeErrorHandler)
      Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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 (advanced)
      Parameters:
      bridgeErrorHandler - the value to set
      Returns:
      the dsl builder

    • exceptionHandler

      default Sqs2EndpointBuilderFactory.AdvancedSqs2EndpointConsumerBuilder exceptionHandler(org.apache.camel.spi.ExceptionHandler exceptionHandler)
      To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored. The option is a: org.apache.camel.spi.ExceptionHandler type. Group: consumer (advanced)
      Parameters:
      exceptionHandler - the value to set
      Returns:
      the dsl builder

    • exceptionHandler

      default Sqs2EndpointBuilderFactory.AdvancedSqs2EndpointConsumerBuilder exceptionHandler(String exceptionHandler)
      To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored. The option will be converted to a org.apache.camel.spi.ExceptionHandler type. Group: consumer (advanced)
      Parameters:
      exceptionHandler - the value to set
      Returns:
      the dsl builder

    • exchangePattern

      default Sqs2EndpointBuilderFactory.AdvancedSqs2EndpointConsumerBuilder exchangePattern(org.apache.camel.ExchangePattern exchangePattern)
      Sets the exchange pattern when the consumer creates an exchange. The option is a: org.apache.camel.ExchangePattern type. Group: consumer (advanced)
      Parameters:
      exchangePattern - the value to set
      Returns:
      the dsl builder

    • exchangePattern

      default Sqs2EndpointBuilderFactory.AdvancedSqs2EndpointConsumerBuilder exchangePattern(String exchangePattern)
      Sets the exchange pattern when the consumer creates an exchange. The option will be converted to a org.apache.camel.ExchangePattern type. Group: consumer (advanced)
      Parameters:
      exchangePattern - the value to set
      Returns:
      the dsl builder

    • pollStrategy

      default Sqs2EndpointBuilderFactory.AdvancedSqs2EndpointConsumerBuilder pollStrategy(org.apache.camel.spi.PollingConsumerPollStrategy pollStrategy)
      A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. The option is a: org.apache.camel.spi.PollingConsumerPollStrategy type. Group: consumer (advanced)
      Parameters:
      pollStrategy - the value to set
      Returns:
      the dsl builder

    • pollStrategy

      default Sqs2EndpointBuilderFactory.AdvancedSqs2EndpointConsumerBuilder pollStrategy(String pollStrategy)
      A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. The option will be converted to a org.apache.camel.spi.PollingConsumerPollStrategy type. Group: consumer (advanced)
      Parameters:
      pollStrategy - the value to set
      Returns:
      the dsl builder

    • amazonSQSClient

      default Sqs2EndpointBuilderFactory.AdvancedSqs2EndpointConsumerBuilder amazonSQSClient(software.amazon.awssdk.services.sqs.SqsClient amazonSQSClient)
      To use the AmazonSQS client. The option is a: software.amazon.awssdk.services.sqs.SqsClient type. Group: advanced
      Parameters:
      amazonSQSClient - the value to set
      Returns:
      the dsl builder

    • amazonSQSClient

      default Sqs2EndpointBuilderFactory.AdvancedSqs2EndpointConsumerBuilder amazonSQSClient(String amazonSQSClient)
      To use the AmazonSQS client. The option will be converted to a software.amazon.awssdk.services.sqs.SqsClient type. Group: advanced
      Parameters:
      amazonSQSClient - the value to set
      Returns:
      the dsl builder

    • delayQueue

      default Sqs2EndpointBuilderFactory.AdvancedSqs2EndpointConsumerBuilder delayQueue(boolean delayQueue)
      Define if you want to apply delaySeconds option to the queue or on single messages. The option is a: boolean type. Default: false Group: advanced
      Parameters:
      delayQueue - the value to set
      Returns:
      the dsl builder

    • delayQueue

      default Sqs2EndpointBuilderFactory.AdvancedSqs2EndpointConsumerBuilder delayQueue(String delayQueue)
      Define if you want to apply delaySeconds option to the queue or on single messages. The option will be converted to a boolean type. Default: false Group: advanced
      Parameters:
      delayQueue - the value to set
      Returns:
      the dsl builder