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

Interface Kinesis2EndpointBuilderFactory.AdvancedKinesis2EndpointConsumerBuilder

All Superinterfaces:
org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver
All Known Subinterfaces:
Kinesis2EndpointBuilderFactory.AdvancedKinesis2EndpointBuilder
Enclosing interface:
Kinesis2EndpointBuilderFactory
public static interface Kinesis2EndpointBuilderFactory.AdvancedKinesis2EndpointConsumerBuilder extends org.apache.camel.builder.EndpointConsumerBuilder
Advanced builder for endpoint consumers for the AWS Kinesis component.

  • Method Details

    • basic

      default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder basic()

    • bridgeErrorHandler

      default Kinesis2EndpointBuilderFactory.AdvancedKinesis2EndpointConsumerBuilder bridgeErrorHandler(boolean bridgeErrorHandler)
      Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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 (advanced)
      Parameters:
      bridgeErrorHandler - the value to set
      Returns:
      the dsl builder

    • bridgeErrorHandler

      default Kinesis2EndpointBuilderFactory.AdvancedKinesis2EndpointConsumerBuilder bridgeErrorHandler(String bridgeErrorHandler)
      Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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 (advanced)
      Parameters:
      bridgeErrorHandler - the value to set
      Returns:
      the dsl builder

    • exceptionHandler

      default Kinesis2EndpointBuilderFactory.AdvancedKinesis2EndpointConsumerBuilder exceptionHandler(org.apache.camel.spi.ExceptionHandler exceptionHandler)
      To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored. The option is a: org.apache.camel.spi.ExceptionHandler type. Group: consumer (advanced)
      Parameters:
      exceptionHandler - the value to set
      Returns:
      the dsl builder

    • exceptionHandler

      default Kinesis2EndpointBuilderFactory.AdvancedKinesis2EndpointConsumerBuilder exceptionHandler(String exceptionHandler)
      To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored. The option will be converted to a org.apache.camel.spi.ExceptionHandler type. Group: consumer (advanced)
      Parameters:
      exceptionHandler - the value to set
      Returns:
      the dsl builder

    • exchangePattern

      default Kinesis2EndpointBuilderFactory.AdvancedKinesis2EndpointConsumerBuilder exchangePattern(org.apache.camel.ExchangePattern exchangePattern)
      Sets the exchange pattern when the consumer creates an exchange. The option is a: org.apache.camel.ExchangePattern type. Group: consumer (advanced)
      Parameters:
      exchangePattern - the value to set
      Returns:
      the dsl builder

    • exchangePattern

      default Kinesis2EndpointBuilderFactory.AdvancedKinesis2EndpointConsumerBuilder exchangePattern(String exchangePattern)
      Sets the exchange pattern when the consumer creates an exchange. The option will be converted to a org.apache.camel.ExchangePattern type. Group: consumer (advanced)
      Parameters:
      exchangePattern - the value to set
      Returns:
      the dsl builder

    • pollStrategy

      default Kinesis2EndpointBuilderFactory.AdvancedKinesis2EndpointConsumerBuilder pollStrategy(org.apache.camel.spi.PollingConsumerPollStrategy pollStrategy)
      A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. The option is a: org.apache.camel.spi.PollingConsumerPollStrategy type. Group: consumer (advanced)
      Parameters:
      pollStrategy - the value to set
      Returns:
      the dsl builder

    • pollStrategy

      default Kinesis2EndpointBuilderFactory.AdvancedKinesis2EndpointConsumerBuilder pollStrategy(String pollStrategy)
      A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. The option will be converted to a org.apache.camel.spi.PollingConsumerPollStrategy type. Group: consumer (advanced)
      Parameters:
      pollStrategy - the value to set
      Returns:
      the dsl builder

    • shardMonitorInterval

      default Kinesis2EndpointBuilderFactory.AdvancedKinesis2EndpointConsumerBuilder shardMonitorInterval(long shardMonitorInterval)
      The interval in milliseconds to wait between shard polling. The option is a: long type. Default: 10000 Group: consumer (advanced)
      Parameters:
      shardMonitorInterval - the value to set
      Returns:
      the dsl builder

    • shardMonitorInterval

      default Kinesis2EndpointBuilderFactory.AdvancedKinesis2EndpointConsumerBuilder shardMonitorInterval(String shardMonitorInterval)
      The interval in milliseconds to wait between shard polling. The option will be converted to a long type. Default: 10000 Group: consumer (advanced)
      Parameters:
      shardMonitorInterval - the value to set
      Returns:
      the dsl builder

    • amazonKinesisAsyncClient

      default Kinesis2EndpointBuilderFactory.AdvancedKinesis2EndpointConsumerBuilder amazonKinesisAsyncClient(software.amazon.awssdk.services.kinesis.KinesisAsyncClient amazonKinesisAsyncClient)
      Supply a pre-constructed Amazon Kinesis async client to use for the KCL Consumer. The option is a: software.amazon.awssdk.services.kinesis.KinesisAsyncClient type. Group: advanced
      Parameters:
      amazonKinesisAsyncClient - the value to set
      Returns:
      the dsl builder

    • amazonKinesisAsyncClient

      default Kinesis2EndpointBuilderFactory.AdvancedKinesis2EndpointConsumerBuilder amazonKinesisAsyncClient(String amazonKinesisAsyncClient)
      Supply a pre-constructed Amazon Kinesis async client to use for the KCL Consumer. The option will be converted to a software.amazon.awssdk.services.kinesis.KinesisAsyncClient type. Group: advanced
      Parameters:
      amazonKinesisAsyncClient - the value to set
      Returns:
      the dsl builder

    • amazonKinesisClient

      default Kinesis2EndpointBuilderFactory.AdvancedKinesis2EndpointConsumerBuilder amazonKinesisClient(software.amazon.awssdk.services.kinesis.KinesisClient amazonKinesisClient)
      Amazon Kinesis client to use for all requests for this endpoint. The option is a: software.amazon.awssdk.services.kinesis.KinesisClient type. Group: advanced
      Parameters:
      amazonKinesisClient - the value to set
      Returns:
      the dsl builder

    • amazonKinesisClient

      default Kinesis2EndpointBuilderFactory.AdvancedKinesis2EndpointConsumerBuilder amazonKinesisClient(String amazonKinesisClient)
      Amazon Kinesis client to use for all requests for this endpoint. The option will be converted to a software.amazon.awssdk.services.kinesis.KinesisClient type. Group: advanced
      Parameters:
      amazonKinesisClient - the value to set
      Returns:
      the dsl builder

    • applicationName

      default Kinesis2EndpointBuilderFactory.AdvancedKinesis2EndpointConsumerBuilder applicationName(String applicationName)
      Name of the KCL application. This defaults to the stream name. The option is a: java.lang.String type. Group: advanced
      Parameters:
      applicationName - the value to set
      Returns:
      the dsl builder

    • asyncClient

      default Kinesis2EndpointBuilderFactory.AdvancedKinesis2EndpointConsumerBuilder asyncClient(boolean asyncClient)
      If we want to a KinesisAsyncClient instance set it to true. The option is a: boolean type. Default: false Group: advanced
      Parameters:
      asyncClient - the value to set
      Returns:
      the dsl builder

    • asyncClient

      default Kinesis2EndpointBuilderFactory.AdvancedKinesis2EndpointConsumerBuilder asyncClient(String asyncClient)
      If we want to a KinesisAsyncClient instance set it to true. The option will be converted to a boolean type. Default: false Group: advanced
      Parameters:
      asyncClient - the value to set
      Returns:
      the dsl builder

    • cloudWatchAsyncClient

      default Kinesis2EndpointBuilderFactory.AdvancedKinesis2EndpointConsumerBuilder cloudWatchAsyncClient(software.amazon.awssdk.services.cloudwatch.CloudWatchAsyncClient cloudWatchAsyncClient)
      If we want to a KCL Consumer, we can pass an instance of CloudWatchAsyncClient. The option is a: software.amazon.awssdk.services.cloudwatch.CloudWatchAsyncClient type. Group: advanced
      Parameters:
      cloudWatchAsyncClient - the value to set
      Returns:
      the dsl builder

    • cloudWatchAsyncClient

      default Kinesis2EndpointBuilderFactory.AdvancedKinesis2EndpointConsumerBuilder cloudWatchAsyncClient(String cloudWatchAsyncClient)
      If we want to a KCL Consumer, we can pass an instance of CloudWatchAsyncClient. The option will be converted to a software.amazon.awssdk.services.cloudwatch.CloudWatchAsyncClient type. Group: advanced
      Parameters:
      cloudWatchAsyncClient - the value to set
      Returns:
      the dsl builder

    • dynamoDbAsyncClient

      default Kinesis2EndpointBuilderFactory.AdvancedKinesis2EndpointConsumerBuilder dynamoDbAsyncClient(software.amazon.awssdk.services.dynamodb.DynamoDbAsyncClient dynamoDbAsyncClient)
      If we want to a KCL Consumer, we can pass an instance of DynamoDbAsyncClient. The option is a: software.amazon.awssdk.services.dynamodb.DynamoDbAsyncClient type. Group: advanced
      Parameters:
      dynamoDbAsyncClient - the value to set
      Returns:
      the dsl builder

    • dynamoDbAsyncClient

      default Kinesis2EndpointBuilderFactory.AdvancedKinesis2EndpointConsumerBuilder dynamoDbAsyncClient(String dynamoDbAsyncClient)
      If we want to a KCL Consumer, we can pass an instance of DynamoDbAsyncClient. The option will be converted to a software.amazon.awssdk.services.dynamodb.DynamoDbAsyncClient type. Group: advanced
      Parameters:
      dynamoDbAsyncClient - the value to set
      Returns:
      the dsl builder

    • kclDisableCloudwatchMetricsExport

      default Kinesis2EndpointBuilderFactory.AdvancedKinesis2EndpointConsumerBuilder kclDisableCloudwatchMetricsExport(boolean kclDisableCloudwatchMetricsExport)
      If we want to use a KCL Consumer and disable the CloudWatch Metrics Export. The option is a: boolean type. Default: false Group: advanced
      Parameters:
      kclDisableCloudwatchMetricsExport - the value to set
      Returns:
      the dsl builder

    • kclDisableCloudwatchMetricsExport

      default Kinesis2EndpointBuilderFactory.AdvancedKinesis2EndpointConsumerBuilder kclDisableCloudwatchMetricsExport(String kclDisableCloudwatchMetricsExport)
      If we want to use a KCL Consumer and disable the CloudWatch Metrics Export. The option will be converted to a boolean type. Default: false Group: advanced
      Parameters:
      kclDisableCloudwatchMetricsExport - the value to set
      Returns:
      the dsl builder

    • useKclConsumers

      default Kinesis2EndpointBuilderFactory.AdvancedKinesis2EndpointConsumerBuilder useKclConsumers(boolean useKclConsumers)
      If we want to a KCL Consumer set it to true. The option is a: boolean type. Default: false Group: advanced
      Parameters:
      useKclConsumers - the value to set
      Returns:
      the dsl builder

    • useKclConsumers

      default Kinesis2EndpointBuilderFactory.AdvancedKinesis2EndpointConsumerBuilder useKclConsumers(String useKclConsumers)
      If we want to a KCL Consumer set it to true. The option will be converted to a boolean type. Default: false Group: advanced
      Parameters:
      useKclConsumers - the value to set
      Returns:
      the dsl builder