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 Simple Queue Service (SQS) component.

  • Method Details

    • advanced

      default Sqs2EndpointBuilderFactory.AdvancedSqs2EndpointConsumerBuilder advanced()

    • amazonAWSHost

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

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

    • uriEndpointOverride

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

    • attributeNames

      default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder attributeNames(String attributeNames)
      A list of attribute names to receive when consuming. Multiple names can be separated by comma. The option is a: <code>java.lang.String</code> type. Group: consumer
      Parameters:
      attributeNames - the value to set
      Returns:
      the dsl builder

    • 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: <code>int</code> type. Default: 1 Group: consumer
      Parameters:
      concurrentConsumers - the value to set
      Returns:
      the dsl builder

    • concurrentConsumers

      default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder concurrentConsumers(String concurrentConsumers)
      Allows you to use multiple threads to poll the sqs queue to increase throughput. The option will be converted to a <code>int</code> type. Default: 1 Group: consumer
      Parameters:
      concurrentConsumers - the value to set
      Returns:
      the dsl builder

    • defaultVisibilityTimeout

      default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder defaultVisibilityTimeout(Integer defaultVisibilityTimeout)
      The default visibility timeout (in seconds). The option is a: <code>java.lang.Integer</code> type. Group: consumer
      Parameters:
      defaultVisibilityTimeout - the value to set
      Returns:
      the dsl builder

    • defaultVisibilityTimeout

      default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder defaultVisibilityTimeout(String defaultVisibilityTimeout)
      The default visibility timeout (in seconds). The option will be converted to a <code>java.lang.Integer</code> type. Group: consumer
      Parameters:
      defaultVisibilityTimeout - the value to set
      Returns:
      the dsl builder

    • deleteAfterRead

      default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder deleteAfterRead(boolean deleteAfterRead)
      Delete message from SQS after it has been read. The option is a: <code>boolean</code> type. Default: true Group: consumer
      Parameters:
      deleteAfterRead - the value to set
      Returns:
      the dsl builder

    • deleteAfterRead

      default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder deleteAfterRead(String deleteAfterRead)
      Delete message from SQS after it has been read. The option will be converted to a <code>boolean</code> type. Default: true Group: consumer
      Parameters:
      deleteAfterRead - the value to set
      Returns:
      the dsl builder

    • deleteIfFiltered

      default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder deleteIfFiltered(boolean deleteIfFiltered)
      Whether or not to send the DeleteMessage to the SQS queue if the exchange has property with key Sqs2Constants#SQS_DELETE_FILTERED (CamelAwsSqsDeleteFiltered) set to true. The option is a: <code>boolean</code> type. Default: true Group: consumer
      Parameters:
      deleteIfFiltered - the value to set
      Returns:
      the dsl builder

    • deleteIfFiltered

      default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder deleteIfFiltered(String deleteIfFiltered)
      Whether or not to send the DeleteMessage to the SQS queue if the exchange has property with key Sqs2Constants#SQS_DELETE_FILTERED (CamelAwsSqsDeleteFiltered) set to true. The option will be converted to a <code>boolean</code> type. Default: true Group: consumer
      Parameters:
      deleteIfFiltered - the value to set
      Returns:
      the dsl builder

    • 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: <code>boolean</code> type. Default: false Group: consumer
      Parameters:
      extendMessageVisibility - the value to set
      Returns:
      the dsl builder

    • 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 <code>boolean</code> type. Default: false Group: consumer
      Parameters:
      extendMessageVisibility - the value to set
      Returns:
      the dsl builder

    • 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: <code>java.lang.Integer</code> type. Group: consumer
      Parameters:
      kmsDataKeyReusePeriodSeconds - the value to set
      Returns:
      the dsl builder

    • 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 <code>java.lang.Integer</code> type. Group: consumer
      Parameters:
      kmsDataKeyReusePeriodSeconds - the value to set
      Returns:
      the dsl builder

    • kmsMasterKeyId

      default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder kmsMasterKeyId(String kmsMasterKeyId)
      The ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK. The option is a: <code>java.lang.String</code> type. Group: consumer
      Parameters:
      kmsMasterKeyId - the value to set
      Returns:
      the dsl builder

    • 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: <code>int</code> type. Group: consumer
      Parameters:
      maxMessagesPerPoll - the value to set
      Returns:
      the dsl builder

    • 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 <code>int</code> type. Group: consumer
      Parameters:
      maxMessagesPerPoll - the value to set
      Returns:
      the dsl builder

    • 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: <code>java.lang.String</code> type. Group: consumer
      Parameters:
      messageAttributeNames - the value to set
      Returns:
      the dsl builder

    • 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: <code>boolean</code> type. Default: false Group: consumer
      Parameters:
      sendEmptyMessageWhenIdle - the value to set
      Returns:
      the dsl builder

    • 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 <code>boolean</code> type. Default: false Group: consumer
      Parameters:
      sendEmptyMessageWhenIdle - the value to set
      Returns:
      the dsl builder

    • serverSideEncryptionEnabled

      default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder serverSideEncryptionEnabled(boolean serverSideEncryptionEnabled)
      Define if Server Side Encryption is enabled or not on the queue. The option is a: <code>boolean</code> type. Default: false Group: consumer
      Parameters:
      serverSideEncryptionEnabled - the value to set
      Returns:
      the dsl builder

    • 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 <code>boolean</code> type. Default: false Group: consumer
      Parameters:
      serverSideEncryptionEnabled - the value to set
      Returns:
      the dsl builder

    • 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: <code>java.lang.Integer</code> type. Group: consumer
      Parameters:
      visibilityTimeout - the value to set
      Returns:
      the dsl builder

    • 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 <code>java.lang.Integer</code> type. Group: consumer
      Parameters:
      visibilityTimeout - the value to set
      Returns:
      the dsl builder

    • 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: <code>java.lang.Integer</code> type. Group: consumer
      Parameters:
      waitTimeSeconds - the value to set
      Returns:
      the dsl builder

    • 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 <code>java.lang.Integer</code> type. Group: consumer
      Parameters:
      waitTimeSeconds - the value to set
      Returns:
      the dsl builder

    • proxyHost

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

    • policy

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

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

    • redrivePolicy

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

    • 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: <code>int</code> type. Group: scheduler
      Parameters:
      backoffErrorThreshold - the value to set
      Returns:
      the dsl builder

    • 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 <code>int</code> type. Group: scheduler
      Parameters:
      backoffErrorThreshold - the value to set
      Returns:
      the dsl builder

    • 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: <code>int</code> type. Group: scheduler
      Parameters:
      backoffIdleThreshold - the value to set
      Returns:
      the dsl builder

    • 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 <code>int</code> type. Group: scheduler
      Parameters:
      backoffIdleThreshold - the value to set
      Returns:
      the dsl builder

    • 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: <code>int</code> type. Group: scheduler
      Parameters:
      backoffMultiplier - the value to set
      Returns:
      the dsl builder

    • 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 <code>int</code> type. Group: scheduler
      Parameters:
      backoffMultiplier - the value to set
      Returns:
      the dsl builder

    • delay

      default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder delay(long delay)
      Milliseconds before the next poll. The option is a: <code>long</code> type. Default: 500 Group: scheduler
      Parameters:
      delay - the value to set
      Returns:
      the dsl builder

    • delay

      default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder delay(String delay)
      Milliseconds before the next poll. The option will be converted to a <code>long</code> type. Default: 500 Group: scheduler
      Parameters:
      delay - the value to set
      Returns:
      the dsl builder

    • 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: <code>boolean</code> type. Default: false Group: scheduler
      Parameters:
      greedy - the value to set
      Returns:
      the dsl builder

    • 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 <code>boolean</code> type. Default: false Group: scheduler
      Parameters:
      greedy - the value to set
      Returns:
      the dsl builder

    • initialDelay

      default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder initialDelay(long initialDelay)
      Milliseconds before the first poll starts. The option is a: <code>long</code> type. Default: 1000 Group: scheduler
      Parameters:
      initialDelay - the value to set
      Returns:
      the dsl builder

    • initialDelay

      default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder initialDelay(String initialDelay)
      Milliseconds before the first poll starts. The option will be converted to a <code>long</code> type. Default: 1000 Group: scheduler
      Parameters:
      initialDelay - the value to set
      Returns:
      the dsl builder

    • 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: <code>long</code> type. Default: 0 Group: scheduler
      Parameters:
      repeatCount - the value to set
      Returns:
      the dsl builder

    • 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 <code>long</code> type. Default: 0 Group: scheduler
      Parameters:
      repeatCount - the value to set
      Returns:
      the dsl builder

    • 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: <code>org.apache.camel.LoggingLevel</code> type. Default: TRACE Group: scheduler
      Parameters:
      runLoggingLevel - the value to set
      Returns:
      the dsl builder

    • 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 <code>org.apache.camel.LoggingLevel</code> type. Default: TRACE Group: scheduler
      Parameters:
      runLoggingLevel - the value to set
      Returns:
      the dsl builder

    • 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: <code>java.util.concurrent.ScheduledExecutorService</code> type. Group: scheduler
      Parameters:
      scheduledExecutorService - the value to set
      Returns:
      the dsl builder

    • 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 <code>java.util.concurrent.ScheduledExecutorService</code> type. Group: scheduler
      Parameters:
      scheduledExecutorService - the value to set
      Returns:
      the dsl builder

    • scheduler

      default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder scheduler(Object scheduler)
      To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler. The option is a: <code>java.lang.Object</code> type. Default: none Group: scheduler
      Parameters:
      scheduler - the value to set
      Returns:
      the dsl builder

    • scheduler

      default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder scheduler(String scheduler)
      To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler. The option will be converted to a <code>java.lang.Object</code> type. Default: none Group: scheduler
      Parameters:
      scheduler - the value to set
      Returns:
      the dsl builder

    • 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: <code>java.util.Map&lt;java.lang.String, java.lang.Object&gt;</code> 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
      Parameters:
      key - the option key
      value - the option value
      Returns:
      the dsl builder

    • 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: <code>java.util.Map&lt;java.lang.String, java.lang.Object&gt;</code> 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
      Parameters:
      values - the values
      Returns:
      the dsl builder

    • startScheduler

      default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder startScheduler(boolean startScheduler)
      Whether the scheduler should be auto started. The option is a: <code>boolean</code> type. Default: true Group: scheduler
      Parameters:
      startScheduler - the value to set
      Returns:
      the dsl builder

    • startScheduler

      default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder startScheduler(String startScheduler)
      Whether the scheduler should be auto started. The option will be converted to a <code>boolean</code> type. Default: true Group: scheduler
      Parameters:
      startScheduler - the value to set
      Returns:
      the dsl builder

    • timeUnit

      default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder timeUnit(TimeUnit timeUnit)
      Time unit for initialDelay and delay options. The option is a: <code>java.util.concurrent.TimeUnit</code> type. Default: MILLISECONDS Group: scheduler
      Parameters:
      timeUnit - the value to set
      Returns:
      the dsl builder

    • timeUnit

      default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder timeUnit(String timeUnit)
      Time unit for initialDelay and delay options. The option will be converted to a <code>java.util.concurrent.TimeUnit</code> type. Default: MILLISECONDS Group: scheduler
      Parameters:
      timeUnit - the value to set
      Returns:
      the dsl builder

    • 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: <code>boolean</code> type. Default: true Group: scheduler
      Parameters:
      useFixedDelay - the value to set
      Returns:
      the dsl builder

    • useFixedDelay

      default Sqs2EndpointBuilderFactory.Sqs2EndpointConsumerBuilder useFixedDelay(String useFixedDelay)
      Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. The option will be converted to a <code>boolean</code> type. Default: true Group: scheduler
      Parameters:
      useFixedDelay - the value to set
      Returns:
      the dsl builder

    • accessKey

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