Interface DdbStreamEndpointBuilderFactory.DdbStreamEndpointBuilder

  • All Superinterfaces:
    org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver
    Enclosing interface:
    DdbStreamEndpointBuilderFactory

    public static interface DdbStreamEndpointBuilderFactory.DdbStreamEndpointBuilder
    extends org.apache.camel.builder.EndpointConsumerBuilder
    Builder for endpoint for the AWS DynamoDB Streams component.
    • Method Detail

      • autoDiscoverClient

        default DdbStreamEndpointBuilderFactory.DdbStreamEndpointBuilder 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 DdbStreamEndpointBuilderFactory.DdbStreamEndpointBuilder 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
      • amazonDynamoDbStreamsClient

        default DdbStreamEndpointBuilderFactory.DdbStreamEndpointBuilder amazonDynamoDbStreamsClient​(Object amazonDynamoDbStreamsClient)
        Amazon DynamoDB client to use for all requests for this endpoint. The option is a: com.amazonaws.services.dynamodbv2.AmazonDynamoDBStreams type. Group: consumer
      • amazonDynamoDbStreamsClient

        default DdbStreamEndpointBuilderFactory.DdbStreamEndpointBuilder amazonDynamoDbStreamsClient​(String amazonDynamoDbStreamsClient)
        Amazon DynamoDB client to use for all requests for this endpoint. The option will be converted to a com.amazonaws.services.dynamodbv2.AmazonDynamoDBStreams type. Group: consumer
      • bridgeErrorHandler

        default DdbStreamEndpointBuilderFactory.DdbStreamEndpointBuilder 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
      • bridgeErrorHandler

        default DdbStreamEndpointBuilderFactory.DdbStreamEndpointBuilder bridgeErrorHandler​(String 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 will be converted to a boolean type. Default: false Group: consumer
      • iteratorType

        default DdbStreamEndpointBuilderFactory.DdbStreamEndpointBuilder iteratorType​(DdbStreamEndpointBuilderFactory.ShardIteratorType iteratorType)
        Defines where in the DynaboDB stream to start getting records. Note that using TRIM_HORIZON can cause a significant delay before the stream has caught up to real-time. if {AT,AFTER}_SEQUENCE_NUMBER are used, then a sequenceNumberProvider MUST be supplied. The option is a: com.amazonaws.services.dynamodbv2.model.ShardIteratorType type. Default: LATEST Group: consumer
      • iteratorType

        default DdbStreamEndpointBuilderFactory.DdbStreamEndpointBuilder iteratorType​(String iteratorType)
        Defines where in the DynaboDB stream to start getting records. Note that using TRIM_HORIZON can cause a significant delay before the stream has caught up to real-time. if {AT,AFTER}_SEQUENCE_NUMBER are used, then a sequenceNumberProvider MUST be supplied. The option will be converted to a com.amazonaws.services.dynamodbv2.model.ShardIteratorType type. Default: LATEST Group: consumer
      • sendEmptyMessageWhenIdle

        default DdbStreamEndpointBuilderFactory.DdbStreamEndpointBuilder 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: boolean type. Default: false Group: consumer
      • sendEmptyMessageWhenIdle

        default DdbStreamEndpointBuilderFactory.DdbStreamEndpointBuilder 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 boolean type. Default: false Group: consumer
      • sequenceNumberProvider

        default DdbStreamEndpointBuilderFactory.DdbStreamEndpointBuilder sequenceNumberProvider​(Object sequenceNumberProvider)
        Provider for the sequence number when using one of the two ShardIteratorType.{AT,AFTER}_SEQUENCE_NUMBER iterator types. Can be a registry reference or a literal sequence number. The option is a: org.apache.camel.component.aws.ddbstream.SequenceNumberProvider type. Group: consumer
      • sequenceNumberProvider

        default DdbStreamEndpointBuilderFactory.DdbStreamEndpointBuilder sequenceNumberProvider​(String sequenceNumberProvider)
        Provider for the sequence number when using one of the two ShardIteratorType.{AT,AFTER}_SEQUENCE_NUMBER iterator types. Can be a registry reference or a literal sequence number. The option will be converted to a org.apache.camel.component.aws.ddbstream.SequenceNumberProvider type. Group: consumer
      • backoffErrorThreshold

        default DdbStreamEndpointBuilderFactory.DdbStreamEndpointBuilder 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: int type. Group: scheduler
      • backoffErrorThreshold

        default DdbStreamEndpointBuilderFactory.DdbStreamEndpointBuilder 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 int type. Group: scheduler
      • backoffIdleThreshold

        default DdbStreamEndpointBuilderFactory.DdbStreamEndpointBuilder backoffIdleThreshold​(int backoffIdleThreshold)
        The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. The option is a: int type. Group: scheduler
      • backoffMultiplier

        default DdbStreamEndpointBuilderFactory.DdbStreamEndpointBuilder 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: int type. Group: scheduler
      • backoffMultiplier

        default DdbStreamEndpointBuilderFactory.DdbStreamEndpointBuilder 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 int type. Group: scheduler
      • greedy

        default DdbStreamEndpointBuilderFactory.DdbStreamEndpointBuilder 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: boolean type. Default: false Group: scheduler
      • repeatCount

        default DdbStreamEndpointBuilderFactory.DdbStreamEndpointBuilder 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: long type. Default: 0 Group: scheduler
      • repeatCount

        default DdbStreamEndpointBuilderFactory.DdbStreamEndpointBuilder 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 long type. Default: 0 Group: scheduler
      • runLoggingLevel

        default DdbStreamEndpointBuilderFactory.DdbStreamEndpointBuilder 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: org.apache.camel.LoggingLevel type. Default: TRACE Group: scheduler
      • runLoggingLevel

        default DdbStreamEndpointBuilderFactory.DdbStreamEndpointBuilder 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 org.apache.camel.LoggingLevel type. Default: TRACE Group: scheduler
      • scheduledExecutorService

        default DdbStreamEndpointBuilderFactory.DdbStreamEndpointBuilder 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: java.util.concurrent.ScheduledExecutorService type. Group: scheduler
      • scheduledExecutorService

        default DdbStreamEndpointBuilderFactory.DdbStreamEndpointBuilder 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 java.util.concurrent.ScheduledExecutorService type. Group: scheduler
      • scheduler

        default DdbStreamEndpointBuilderFactory.DdbStreamEndpointBuilder 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 java.lang.Object type. Default: none Group: scheduler
      • schedulerProperties

        default DdbStreamEndpointBuilderFactory.DdbStreamEndpointBuilder 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: java.util.Map<java.lang.String, java.lang.Object> 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
      • schedulerProperties

        default DdbStreamEndpointBuilderFactory.DdbStreamEndpointBuilder schedulerProperties​(Map values)
        To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler. The option is a: java.util.Map<java.lang.String, java.lang.Object> 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
      • useFixedDelay

        default DdbStreamEndpointBuilderFactory.DdbStreamEndpointBuilder useFixedDelay​(boolean useFixedDelay)
        Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. The option is a: boolean type. Default: true Group: scheduler