Interface SqsEndpointBuilderFactory.SqsEndpointProducerBuilder

  • All Superinterfaces:
    org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver
    All Known Subinterfaces:
    SqsEndpointBuilderFactory.SqsEndpointBuilder
    Enclosing interface:
    SqsEndpointBuilderFactory

    public static interface SqsEndpointBuilderFactory.SqsEndpointProducerBuilder
    extends org.apache.camel.builder.EndpointProducerBuilder
    Builder for endpoint producers for the AWS Simple Queue Service (SQS) component.
    • Method Detail

      • autoDiscoverClient

        default SqsEndpointBuilderFactory.SqsEndpointProducerBuilder 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
      • autoDiscoverClient

        default SqsEndpointBuilderFactory.SqsEndpointProducerBuilder autoDiscoverClient​(String 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 will be converted to a boolean type. Default: true Group: common
      • headerFilterStrategy

        default SqsEndpointBuilderFactory.SqsEndpointProducerBuilder 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 SqsEndpointBuilderFactory.SqsEndpointProducerBuilder 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 SqsEndpointBuilderFactory.SqsEndpointProducerBuilder 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 SqsEndpointBuilderFactory.SqsEndpointProducerBuilder 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
      • lazyStartProducer

        default SqsEndpointBuilderFactory.SqsEndpointProducerBuilder 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
      • lazyStartProducer

        default SqsEndpointBuilderFactory.SqsEndpointProducerBuilder lazyStartProducer​(String 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 will be converted to a boolean type. Default: false Group: producer
      • messageDeduplicationIdStrategy

        default SqsEndpointBuilderFactory.SqsEndpointProducerBuilder messageDeduplicationIdStrategy​(Object 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: org.apache.camel.component.aws.sqs.MessageDeduplicationIdStrategy type. Default: useExchangeId Group: producer
      • messageDeduplicationIdStrategy

        default SqsEndpointBuilderFactory.SqsEndpointProducerBuilder 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 will be converted to a org.apache.camel.component.aws.sqs.MessageDeduplicationIdStrategy type. Default: useExchangeId Group: producer
      • messageGroupIdStrategy

        default SqsEndpointBuilderFactory.SqsEndpointProducerBuilder messageGroupIdStrategy​(Object 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: org.apache.camel.component.aws.sqs.MessageGroupIdStrategy type. Group: producer
      • messageGroupIdStrategy

        default SqsEndpointBuilderFactory.SqsEndpointProducerBuilder 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 will be converted to a org.apache.camel.component.aws.sqs.MessageGroupIdStrategy type. Group: producer
      • messageRetentionPeriod

        default SqsEndpointBuilderFactory.SqsEndpointProducerBuilder 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 SqsEndpointBuilderFactory.SqsEndpointProducerBuilder 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 SqsEndpointBuilderFactory.SqsEndpointProducerBuilder 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