Interface AwsSqsComponentBuilderFactory.AwsSqsComponentBuilder

    • Method Detail

      • amazonSQSClient

        default AwsSqsComponentBuilderFactory.AwsSqsComponentBuilder amazonSQSClient​(com.amazonaws.services.sqs.AmazonSQS amazonSQSClient)
        To use the AmazonSQS as client. The option is a: com.amazonaws.services.sqs.AmazonSQS type. Group: common
      • autoDiscoverClient

        default AwsSqsComponentBuilderFactory.AwsSqsComponentBuilder autoDiscoverClient​(boolean autoDiscoverClient)
        Setting the autoDiscoverClient mechanism, if true, the component will look for a client instance in the registry automatically otherwise it will skip that checking. The option is a: boolean type. Default: true Group: common
      • configuration

        default AwsSqsComponentBuilderFactory.AwsSqsComponentBuilder configuration​(org.apache.camel.component.aws.sqs.SqsConfiguration configuration)
        The component configuration. The option is a: org.apache.camel.component.aws.sqs.SqsConfiguration type. Group: common
      • proxyProtocol

        default AwsSqsComponentBuilderFactory.AwsSqsComponentBuilder proxyProtocol​(com.amazonaws.Protocol proxyProtocol)
        To define a proxy protocol when instantiating the SQS client. The option is a: com.amazonaws.Protocol type. Default: HTTPS Group: common
      • queueOwnerAWSAccountId

        default AwsSqsComponentBuilderFactory.AwsSqsComponentBuilder 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 AwsSqsComponentBuilderFactory.AwsSqsComponentBuilder region​(String region)
        Specify the queue region which could be used with queueOwnerAWSAccountId to build the service URL. 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
      • bridgeErrorHandler

        default AwsSqsComponentBuilderFactory.AwsSqsComponentBuilder 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
      • concurrentConsumers

        default AwsSqsComponentBuilderFactory.AwsSqsComponentBuilder 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 AwsSqsComponentBuilderFactory.AwsSqsComponentBuilder 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
      • extendMessageVisibility

        default AwsSqsComponentBuilderFactory.AwsSqsComponentBuilder 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
      • kmsDataKeyReusePeriodSeconds

        default AwsSqsComponentBuilderFactory.AwsSqsComponentBuilder 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
      • messageAttributeNames

        default AwsSqsComponentBuilderFactory.AwsSqsComponentBuilder 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
      • serverSideEncryptionEnabled

        default AwsSqsComponentBuilderFactory.AwsSqsComponentBuilder 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
      • visibilityTimeout

        default AwsSqsComponentBuilderFactory.AwsSqsComponentBuilder 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
      • waitTimeSeconds

        default AwsSqsComponentBuilderFactory.AwsSqsComponentBuilder 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
      • lazyStartProducer

        default AwsSqsComponentBuilderFactory.AwsSqsComponentBuilder lazyStartProducer​(boolean lazyStartProducer)
        Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. The option is a: boolean type. Default: false Group: producer
      • messageDeduplicationIdStrategy

        default AwsSqsComponentBuilderFactory.AwsSqsComponentBuilder messageDeduplicationIdStrategy​(String messageDeduplicationIdStrategy)
        Only for FIFO queues. Strategy for setting the messageDeduplicationId on the message. Can be one of the following options: useExchangeId, useContentBasedDeduplication. For the useContentBasedDeduplication option, no messageDeduplicationId will be set on the message. The option is a: java.lang.String type. Default: useExchangeId Group: producer
      • messageGroupIdStrategy

        default AwsSqsComponentBuilderFactory.AwsSqsComponentBuilder messageGroupIdStrategy​(String messageGroupIdStrategy)
        Only for FIFO queues. Strategy for setting the messageGroupId on the message. Can be one of the following options: useConstant, useExchangeId, usePropertyValue. For the usePropertyValue option, the value of property CamelAwsMessageGroupId will be used. The option is a: java.lang.String type. Group: producer
      • operation

        default AwsSqsComponentBuilderFactory.AwsSqsComponentBuilder operation​(org.apache.camel.component.aws.sqs.SqsOperations operation)
        The operation to do in case the user don't want to send only a message. The option is a: org.apache.camel.component.aws.sqs.SqsOperations type. Group: producer
      • autowiredEnabled

        default AwsSqsComponentBuilderFactory.AwsSqsComponentBuilder autowiredEnabled​(boolean autowiredEnabled)
        Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. The option is a: boolean type. Default: true Group: advanced
      • queueUrl

        default AwsSqsComponentBuilderFactory.AwsSqsComponentBuilder queueUrl​(String queueUrl)
        To define the queueUrl explicitly. All other parameters, which would influence the queueUrl, are ignored. This parameter is intended to be used, to connect to a mock implementation of SQS, for testing purposes. The option is a: java.lang.String type. Group: advanced
      • receiveMessageWaitTimeSeconds

        default AwsSqsComponentBuilderFactory.AwsSqsComponentBuilder 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