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

Interface Ddb2StreamEndpointBuilderFactory.Ddb2StreamEndpointBuilder

  • All Superinterfaces:
    org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver
    Enclosing interface:
    Ddb2StreamEndpointBuilderFactory
    public static interface Ddb2StreamEndpointBuilderFactory.Ddb2StreamEndpointBuilder
extends org.apache.camel.builder.EndpointConsumerBuilder
    Builder for endpoint for the AWS DynamoDB Streams component.

    • Method Detail

      • amazonDynamoDbStreamsClient

        default Ddb2StreamEndpointBuilderFactory.Ddb2StreamEndpointBuilder amazonDynamoDbStreamsClient​(software.amazon.awssdk.services.dynamodb.streams.DynamoDbStreamsClient amazonDynamoDbStreamsClient)
        Amazon DynamoDB client to use for all requests for this endpoint. The option is a: <code>software.amazon.awssdk.services.dynamodb.streams.DynamoDbStreamsClient</code> type. Group: consumer
        Parameters:
        amazonDynamoDbStreamsClient - the value to set
        Returns:
        the dsl builder

      • amazonDynamoDbStreamsClient

        default Ddb2StreamEndpointBuilderFactory.Ddb2StreamEndpointBuilder amazonDynamoDbStreamsClient​(String amazonDynamoDbStreamsClient)
        Amazon DynamoDB client to use for all requests for this endpoint. The option will be converted to a <code>software.amazon.awssdk.services.dynamodb.streams.DynamoDbStreamsClient</code> type. Group: consumer
        Parameters:
        amazonDynamoDbStreamsClient - the value to set
        Returns:
        the dsl builder

      • maxResultsPerRequest

        default Ddb2StreamEndpointBuilderFactory.Ddb2StreamEndpointBuilder maxResultsPerRequest​(int maxResultsPerRequest)
        Maximum number of records that will be fetched in each poll. The option is a: <code>int</code> type. Group: consumer
        Parameters:
        maxResultsPerRequest - the value to set
        Returns:
        the dsl builder

      • maxResultsPerRequest

        default Ddb2StreamEndpointBuilderFactory.Ddb2StreamEndpointBuilder maxResultsPerRequest​(String maxResultsPerRequest)
        Maximum number of records that will be fetched in each poll. The option will be converted to a <code>int</code> type. Group: consumer
        Parameters:
        maxResultsPerRequest - the value to set
        Returns:
        the dsl builder

      • overrideEndpoint

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

      • overrideEndpoint

        default Ddb2StreamEndpointBuilderFactory.Ddb2StreamEndpointBuilder overrideEndpoint​(String overrideEndpoint)
        Set the need for overidding 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: consumer
        Parameters:
        overrideEndpoint - the value to set
        Returns:
        the dsl builder

      • proxyPort

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

      • proxyProtocol

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

      • proxyProtocol

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

      • sendEmptyMessageWhenIdle

        default Ddb2StreamEndpointBuilderFactory.Ddb2StreamEndpointBuilder 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 Ddb2StreamEndpointBuilderFactory.Ddb2StreamEndpointBuilder 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

      • streamIteratorType

        default Ddb2StreamEndpointBuilderFactory.Ddb2StreamEndpointBuilder streamIteratorType​(org.apache.camel.component.aws2.ddbstream.Ddb2StreamConfiguration.StreamIteratorType streamIteratorType)
        Defines where in the DynamoDB stream to start getting records. Note that using FROM_START can cause a significant delay before the stream has caught up to real-time. The option is a: <code>org.apache.camel.component.aws2.ddbstream.Ddb2StreamConfiguration.StreamIteratorType</code> type. Default: FROM_LATEST Group: consumer
        Parameters:
        streamIteratorType - the value to set
        Returns:
        the dsl builder

      • streamIteratorType

        default Ddb2StreamEndpointBuilderFactory.Ddb2StreamEndpointBuilder streamIteratorType​(String streamIteratorType)
        Defines where in the DynamoDB stream to start getting records. Note that using FROM_START can cause a significant delay before the stream has caught up to real-time. The option will be converted to a <code>org.apache.camel.component.aws2.ddbstream.Ddb2StreamConfiguration.StreamIteratorType</code> type. Default: FROM_LATEST Group: consumer
        Parameters:
        streamIteratorType - the value to set
        Returns:
        the dsl builder

      • trustAllCertificates

        default Ddb2StreamEndpointBuilderFactory.Ddb2StreamEndpointBuilder 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: consumer
        Parameters:
        trustAllCertificates - the value to set
        Returns:
        the dsl builder

      • trustAllCertificates

        default Ddb2StreamEndpointBuilderFactory.Ddb2StreamEndpointBuilder 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: consumer
        Parameters:
        trustAllCertificates - the value to set
        Returns:
        the dsl builder

      • uriEndpointOverride

        default Ddb2StreamEndpointBuilderFactory.Ddb2StreamEndpointBuilder 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: consumer
        Parameters:
        uriEndpointOverride - the value to set
        Returns:
        the dsl builder

      • useDefaultCredentialsProvider

        default Ddb2StreamEndpointBuilderFactory.Ddb2StreamEndpointBuilder useDefaultCredentialsProvider​(boolean useDefaultCredentialsProvider)
        Set whether the DynamoDB Streams client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in. The option is a: <code>boolean</code> type. Default: false Group: consumer
        Parameters:
        useDefaultCredentialsProvider - the value to set
        Returns:
        the dsl builder

      • useDefaultCredentialsProvider

        default Ddb2StreamEndpointBuilderFactory.Ddb2StreamEndpointBuilder useDefaultCredentialsProvider​(String useDefaultCredentialsProvider)
        Set whether the DynamoDB Streams client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in. The option will be converted to a <code>boolean</code> type. Default: false Group: consumer
        Parameters:
        useDefaultCredentialsProvider - the value to set
        Returns:
        the dsl builder

      • backoffErrorThreshold

        default Ddb2StreamEndpointBuilderFactory.Ddb2StreamEndpointBuilder 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 Ddb2StreamEndpointBuilderFactory.Ddb2StreamEndpointBuilder 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 Ddb2StreamEndpointBuilderFactory.Ddb2StreamEndpointBuilder 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 Ddb2StreamEndpointBuilderFactory.Ddb2StreamEndpointBuilder 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 Ddb2StreamEndpointBuilderFactory.Ddb2StreamEndpointBuilder 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 Ddb2StreamEndpointBuilderFactory.Ddb2StreamEndpointBuilder 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

      • greedy

        default Ddb2StreamEndpointBuilderFactory.Ddb2StreamEndpointBuilder 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 Ddb2StreamEndpointBuilderFactory.Ddb2StreamEndpointBuilder 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 Ddb2StreamEndpointBuilderFactory.Ddb2StreamEndpointBuilder 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 Ddb2StreamEndpointBuilderFactory.Ddb2StreamEndpointBuilder 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 Ddb2StreamEndpointBuilderFactory.Ddb2StreamEndpointBuilder 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 Ddb2StreamEndpointBuilderFactory.Ddb2StreamEndpointBuilder 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 Ddb2StreamEndpointBuilderFactory.Ddb2StreamEndpointBuilder 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 Ddb2StreamEndpointBuilderFactory.Ddb2StreamEndpointBuilder 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 Ddb2StreamEndpointBuilderFactory.Ddb2StreamEndpointBuilder 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 Ddb2StreamEndpointBuilderFactory.Ddb2StreamEndpointBuilder 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 Ddb2StreamEndpointBuilderFactory.Ddb2StreamEndpointBuilder 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 Ddb2StreamEndpointBuilderFactory.Ddb2StreamEndpointBuilder 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 Ddb2StreamEndpointBuilderFactory.Ddb2StreamEndpointBuilder 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 Ddb2StreamEndpointBuilderFactory.Ddb2StreamEndpointBuilder 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 Ddb2StreamEndpointBuilderFactory.Ddb2StreamEndpointBuilder 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 Ddb2StreamEndpointBuilderFactory.Ddb2StreamEndpointBuilder 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 Ddb2StreamEndpointBuilderFactory.Ddb2StreamEndpointBuilder 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 Ddb2StreamEndpointBuilderFactory.Ddb2StreamEndpointBuilder 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 Ddb2StreamEndpointBuilderFactory.Ddb2StreamEndpointBuilder 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