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

Interface Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder

All Superinterfaces:
org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver
All Known Subinterfaces:
Sqs2EndpointBuilderFactory.Sqs2EndpointBuilder
Enclosing interface:
Sqs2EndpointBuilderFactory
public static interface Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder extends org.apache.camel.builder.EndpointProducerBuilder
Builder for endpoint producers for the AWS Simple Queue Service (SQS) component.

  • Method Details

    • advanced

      default Sqs2EndpointBuilderFactory.AdvancedSqs2EndpointProducerBuilder advanced()

    • amazonAWSHost

      default Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder amazonAWSHost(String amazonAWSHost)
      The hostname of the Amazon AWS cloud. The option is a: <code>java.lang.String</code> type. Default: amazonaws.com Group: common
      Parameters:
      amazonAWSHost - the value to set
      Returns:
      the dsl builder

    • autoCreateQueue

      default Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder autoCreateQueue(boolean autoCreateQueue)
      Setting the autocreation of the queue. The option is a: <code>boolean</code> type. Default: false Group: common
      Parameters:
      autoCreateQueue - the value to set
      Returns:
      the dsl builder

    • autoCreateQueue

      default Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder autoCreateQueue(String autoCreateQueue)
      Setting the autocreation of the queue. The option will be converted to a <code>boolean</code> type. Default: false Group: common
      Parameters:
      autoCreateQueue - the value to set
      Returns:
      the dsl builder

    • headerFilterStrategy

      default Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder headerFilterStrategy(org.apache.camel.spi.HeaderFilterStrategy headerFilterStrategy)
      To use a custom HeaderFilterStrategy to map headers to/from Camel. The option is a: <code>org.apache.camel.spi.HeaderFilterStrategy</code> type. Group: common
      Parameters:
      headerFilterStrategy - the value to set
      Returns:
      the dsl builder

    • headerFilterStrategy

      default Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder headerFilterStrategy(String headerFilterStrategy)
      To use a custom HeaderFilterStrategy to map headers to/from Camel. The option will be converted to a <code>org.apache.camel.spi.HeaderFilterStrategy</code> type. Group: common
      Parameters:
      headerFilterStrategy - the value to set
      Returns:
      the dsl builder

    • overrideEndpoint

      default Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder overrideEndpoint(boolean overrideEndpoint)
      Set the need for overriding the endpoint. This option needs to be used in combination with uriEndpointOverride option. The option is a: <code>boolean</code> type. Default: false Group: common
      Parameters:
      overrideEndpoint - the value to set
      Returns:
      the dsl builder

    • overrideEndpoint

      default Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder overrideEndpoint(String overrideEndpoint)
      Set the need for overriding the endpoint. This option needs to be used in combination with uriEndpointOverride option. The option will be converted to a <code>boolean</code> type. Default: false Group: common
      Parameters:
      overrideEndpoint - the value to set
      Returns:
      the dsl builder

    • protocol

      default Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder protocol(String protocol)
      The underlying protocol used to communicate with SQS. The option is a: <code>java.lang.String</code> type. Default: https Group: common
      Parameters:
      protocol - the value to set
      Returns:
      the dsl builder

    • queueOwnerAWSAccountId

      default Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder 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: <code>java.lang.String</code> type. Group: common
      Parameters:
      queueOwnerAWSAccountId - the value to set
      Returns:
      the dsl builder

    • region

      default Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder 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: <code>java.lang.String</code> type. Group: common
      Parameters:
      region - the value to set
      Returns:
      the dsl builder

    • uriEndpointOverride

      default Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder uriEndpointOverride(String uriEndpointOverride)
      Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option. The option is a: <code>java.lang.String</code> type. Group: common
      Parameters:
      uriEndpointOverride - the value to set
      Returns:
      the dsl builder

    • batchSeparator

      default Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder batchSeparator(String batchSeparator)
      Set the separator when passing a String to send batch message operation. The option is a: <code>java.lang.String</code> type. Default: , Group: producer
      Parameters:
      batchSeparator - the value to set
      Returns:
      the dsl builder

    • delaySeconds

      default Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder delaySeconds(Integer delaySeconds)
      Delay sending messages for a number of seconds. The option is a: <code>java.lang.Integer</code> type. Group: producer
      Parameters:
      delaySeconds - the value to set
      Returns:
      the dsl builder

    • delaySeconds

      default Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder delaySeconds(String delaySeconds)
      Delay sending messages for a number of seconds. The option will be converted to a <code>java.lang.Integer</code> type. Group: producer
      Parameters:
      delaySeconds - the value to set
      Returns:
      the dsl builder

    • messageDeduplicationIdStrategy

      default Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder 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: <code>java.lang.String</code> type. Default: useExchangeId Group: producer
      Parameters:
      messageDeduplicationIdStrategy - the value to set
      Returns:
      the dsl builder

    • messageGroupIdStrategy

      default Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder 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: <code>java.lang.String</code> type. Group: producer
      Parameters:
      messageGroupIdStrategy - the value to set
      Returns:
      the dsl builder

    • messageHeaderExceededLimit

      default Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder messageHeaderExceededLimit(String messageHeaderExceededLimit)
      What to do if sending to AWS SQS has more messages than AWS allows (currently only maximum 10 message headers is allowed). WARN will log a WARN about the limit is for each additional header, so the message can be sent to AWS. WARN_ONCE will only log one time a WARN about the limit is hit, and drop additional headers, so the message can be sent to AWS. IGNORE will ignore (no logging) and drop additional headers, so the message can be sent to AWS. FAIL will cause an exception to be thrown and the message is not sent to AWS. The option is a: <code>java.lang.String</code> type. Default: WARN Group: producer
      Parameters:
      messageHeaderExceededLimit - the value to set
      Returns:
      the dsl builder

    • operation

      default Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder operation(org.apache.camel.component.aws2.sqs.Sqs2Operations operation)
      The operation to do in case the user don't want to send only a message. The option is a: <code>org.apache.camel.component.aws2.sqs.Sqs2Operations</code> type. Group: producer
      Parameters:
      operation - the value to set
      Returns:
      the dsl builder

    • operation

      default Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder operation(String operation)
      The operation to do in case the user don't want to send only a message. The option will be converted to a <code>org.apache.camel.component.aws2.sqs.Sqs2Operations</code> type. Group: producer
      Parameters:
      operation - the value to set
      Returns:
      the dsl builder

    • proxyHost

      default Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder proxyHost(String proxyHost)
      To define a proxy host when instantiating the SQS client. The option is a: <code>java.lang.String</code> type. Group: proxy
      Parameters:
      proxyHost - the value to set
      Returns:
      the dsl builder

    • proxyPort

      default Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder proxyPort(Integer proxyPort)
      To define a proxy port when instantiating the SQS client. The option is a: <code>java.lang.Integer</code> type. Group: proxy
      Parameters:
      proxyPort - the value to set
      Returns:
      the dsl builder

    • proxyPort

      default Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder proxyPort(String proxyPort)
      To define a proxy port when instantiating the SQS client. The option will be converted to a <code>java.lang.Integer</code> type. Group: proxy
      Parameters:
      proxyPort - the value to set
      Returns:
      the dsl builder

    • proxyProtocol

      default Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder proxyProtocol(software.amazon.awssdk.core.Protocol proxyProtocol)
      To define a proxy protocol when instantiating the SQS client. The option is a: <code>software.amazon.awssdk.core.Protocol</code> type. Default: HTTPS Group: proxy
      Parameters:
      proxyProtocol - the value to set
      Returns:
      the dsl builder

    • proxyProtocol

      default Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder proxyProtocol(String proxyProtocol)
      To define a proxy protocol when instantiating the SQS client. The option will be converted to a <code>software.amazon.awssdk.core.Protocol</code> type. Default: HTTPS Group: proxy
      Parameters:
      proxyProtocol - the value to set
      Returns:
      the dsl builder

    • maximumMessageSize

      default Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder maximumMessageSize(Integer maximumMessageSize)
      The maximumMessageSize (in bytes) an SQS message can contain for this queue. The option is a: <code>java.lang.Integer</code> type. Group: queue
      Parameters:
      maximumMessageSize - the value to set
      Returns:
      the dsl builder

    • maximumMessageSize

      default Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder maximumMessageSize(String maximumMessageSize)
      The maximumMessageSize (in bytes) an SQS message can contain for this queue. The option will be converted to a <code>java.lang.Integer</code> type. Group: queue
      Parameters:
      maximumMessageSize - the value to set
      Returns:
      the dsl builder

    • messageRetentionPeriod

      default Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder messageRetentionPeriod(Integer messageRetentionPeriod)
      The messageRetentionPeriod (in seconds) a message will be retained by SQS for this queue. The option is a: <code>java.lang.Integer</code> type. Group: queue
      Parameters:
      messageRetentionPeriod - the value to set
      Returns:
      the dsl builder

    • messageRetentionPeriod

      default Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder messageRetentionPeriod(String messageRetentionPeriod)
      The messageRetentionPeriod (in seconds) a message will be retained by SQS for this queue. The option will be converted to a <code>java.lang.Integer</code> type. Group: queue
      Parameters:
      messageRetentionPeriod - the value to set
      Returns:
      the dsl builder

    • policy

      default Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder policy(String policy)
      The policy for this queue. It can be loaded by default from classpath, but you can prefix with classpath:, file:, or http: to load the resource from different systems. This option can also be loaded from an existing file, by prefixing with file: or classpath: followed by the location of the file. The option is a: <code>java.lang.String</code> type. Group: queue
      Parameters:
      policy - the value to set
      Returns:
      the dsl builder

    • queueUrl

      default Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder 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: <code>java.lang.String</code> type. Group: queue
      Parameters:
      queueUrl - the value to set
      Returns:
      the dsl builder

    • receiveMessageWaitTimeSeconds

      default Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder 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: <code>java.lang.Integer</code> type. Group: queue
      Parameters:
      receiveMessageWaitTimeSeconds - the value to set
      Returns:
      the dsl builder

    • receiveMessageWaitTimeSeconds

      default Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder 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 <code>java.lang.Integer</code> type. Group: queue
      Parameters:
      receiveMessageWaitTimeSeconds - the value to set
      Returns:
      the dsl builder

    • redrivePolicy

      default Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder redrivePolicy(String redrivePolicy)
      Specify the policy that send message to DeadLetter queue. See detail at Amazon docs. The option is a: <code>java.lang.String</code> type. Group: queue
      Parameters:
      redrivePolicy - the value to set
      Returns:
      the dsl builder

    • accessKey

      default Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder accessKey(String accessKey)
      Amazon AWS Access Key. The option is a: <code>java.lang.String</code> type. Group: security
      Parameters:
      accessKey - the value to set
      Returns:
      the dsl builder

    • profileCredentialsName

      default Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder profileCredentialsName(String profileCredentialsName)
      If using a profile credentials provider this parameter will set the profile name. The option is a: <code>java.lang.String</code> type. Group: security
      Parameters:
      profileCredentialsName - the value to set
      Returns:
      the dsl builder

    • secretKey

      default Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder secretKey(String secretKey)
      Amazon AWS Secret Key. The option is a: <code>java.lang.String</code> type. Group: security
      Parameters:
      secretKey - the value to set
      Returns:
      the dsl builder

    • trustAllCertificates

      default Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder trustAllCertificates(boolean trustAllCertificates)
      If we want to trust all certificates in case of overriding the endpoint. The option is a: <code>boolean</code> type. Default: false Group: security
      Parameters:
      trustAllCertificates - the value to set
      Returns:
      the dsl builder

    • trustAllCertificates

      default Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder trustAllCertificates(String trustAllCertificates)
      If we want to trust all certificates in case of overriding the endpoint. The option will be converted to a <code>boolean</code> type. Default: false Group: security
      Parameters:
      trustAllCertificates - the value to set
      Returns:
      the dsl builder

    • useDefaultCredentialsProvider

      default Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder useDefaultCredentialsProvider(boolean useDefaultCredentialsProvider)
      Set whether the SQS client should expect to load credentials on an AWS infra instance or to expect static credentials to be passed in. The option is a: <code>boolean</code> type. Default: false Group: security
      Parameters:
      useDefaultCredentialsProvider - the value to set
      Returns:
      the dsl builder

    • useDefaultCredentialsProvider

      default Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder useDefaultCredentialsProvider(String useDefaultCredentialsProvider)
      Set whether the SQS client should expect to load credentials on an AWS infra instance or to expect static credentials to be passed in. The option will be converted to a <code>boolean</code> type. Default: false Group: security
      Parameters:
      useDefaultCredentialsProvider - the value to set
      Returns:
      the dsl builder

    • useProfileCredentialsProvider

      default Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder useProfileCredentialsProvider(boolean useProfileCredentialsProvider)
      Set whether the SQS client should expect to load credentials through a profile credentials provider. The option is a: <code>boolean</code> type. Default: false Group: security
      Parameters:
      useProfileCredentialsProvider - the value to set
      Returns:
      the dsl builder

    • useProfileCredentialsProvider

      default Sqs2EndpointBuilderFactory.Sqs2EndpointProducerBuilder useProfileCredentialsProvider(String useProfileCredentialsProvider)
      Set whether the SQS client should expect to load credentials through a profile credentials provider. The option will be converted to a <code>boolean</code> type. Default: false Group: security
      Parameters:
      useProfileCredentialsProvider - the value to set
      Returns:
      the dsl builder