Package org.apache.camel.builder.component.dsl

Interface Aws2KinesisComponentBuilderFactory.Aws2KinesisComponentBuilder

All Superinterfaces:
ComponentBuilder<org.apache.camel.component.aws2.kinesis.Kinesis2Component>
All Known Implementing Classes:
Aws2KinesisComponentBuilderFactory.Aws2KinesisComponentBuilderImpl
Enclosing interface:
Aws2KinesisComponentBuilderFactory
public static interface Aws2KinesisComponentBuilderFactory.Aws2KinesisComponentBuilder extends ComponentBuilder<org.apache.camel.component.aws2.kinesis.Kinesis2Component>
Builder for the AWS Kinesis component.

  • Method Details

    • cborEnabled

      default Aws2KinesisComponentBuilderFactory.Aws2KinesisComponentBuilder cborEnabled(boolean cborEnabled)
      This option will set the CBOR_ENABLED property during the execution. The option is a: <code>boolean</code> type. Default: true Group: common
      Parameters:
      cborEnabled - the value to set
      Returns:
      the dsl builder

    • configuration

      default Aws2KinesisComponentBuilderFactory.Aws2KinesisComponentBuilder configuration(org.apache.camel.component.aws2.kinesis.Kinesis2Configuration configuration)
      Component configuration. The option is a: <code>org.apache.camel.component.aws2.kinesis.Kinesis2Configuration</code> type. Group: common
      Parameters:
      configuration - the value to set
      Returns:
      the dsl builder

    • overrideEndpoint

      default Aws2KinesisComponentBuilderFactory.Aws2KinesisComponentBuilder 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

    • region

      default Aws2KinesisComponentBuilderFactory.Aws2KinesisComponentBuilder region(String region)
      The region in which Kinesis Firehose 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 Aws2KinesisComponentBuilderFactory.Aws2KinesisComponentBuilder 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

    • bridgeErrorHandler

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

    • iteratorType

      default Aws2KinesisComponentBuilderFactory.Aws2KinesisComponentBuilder iteratorType(software.amazon.awssdk.services.kinesis.model.ShardIteratorType iteratorType)
      Defines where in the Kinesis stream to start getting records. The option is a: <code>software.amazon.awssdk.services.kinesis.model.ShardIteratorType</code> type. Default: TRIM_HORIZON Group: consumer
      Parameters:
      iteratorType - the value to set
      Returns:
      the dsl builder

    • maxResultsPerRequest

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

    • sequenceNumber

      default Aws2KinesisComponentBuilderFactory.Aws2KinesisComponentBuilder sequenceNumber(String sequenceNumber)
      The sequence number to start polling from. Required if iteratorType is set to AFTER_SEQUENCE_NUMBER or AT_SEQUENCE_NUMBER. The option is a: <code>java.lang.String</code> type. Group: consumer
      Parameters:
      sequenceNumber - the value to set
      Returns:
      the dsl builder

    • shardClosed

      default Aws2KinesisComponentBuilderFactory.Aws2KinesisComponentBuilder shardClosed(org.apache.camel.component.aws2.kinesis.Kinesis2ShardClosedStrategyEnum shardClosed)
      Define what will be the behavior in case of shard closed. Possible value are ignore, silent and fail. In case of ignore a WARN message will be logged once and the consumer will not process new messages until restarted,in case of silent there will be no logging and the consumer will not process new messages until restarted,in case of fail a ReachedClosedStateException will be thrown. The option is a: <code>org.apache.camel.component.aws2.kinesis.Kinesis2ShardClosedStrategyEnum</code> type. Default: ignore Group: consumer
      Parameters:
      shardClosed - the value to set
      Returns:
      the dsl builder

    • shardId

      default Aws2KinesisComponentBuilderFactory.Aws2KinesisComponentBuilder shardId(String shardId)
      Defines which shardId in the Kinesis stream to get records from. The option is a: <code>java.lang.String</code> type. Group: consumer
      Parameters:
      shardId - the value to set
      Returns:
      the dsl builder

    • shardMonitorInterval

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

    • lazyStartProducer

      default Aws2KinesisComponentBuilderFactory.Aws2KinesisComponentBuilder lazyStartProducer(boolean lazyStartProducer)
      Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. The option is a: <code>boolean</code> type. Default: false Group: producer
      Parameters:
      lazyStartProducer - the value to set
      Returns:
      the dsl builder

    • amazonKinesisClient

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

    • asyncClient

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

    • autowiredEnabled

      default Aws2KinesisComponentBuilderFactory.Aws2KinesisComponentBuilder autowiredEnabled(boolean autowiredEnabled)
      Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. The option is a: <code>boolean</code> type. Default: true Group: advanced
      Parameters:
      autowiredEnabled - the value to set
      Returns:
      the dsl builder

    • cloudWatchAsyncClient

      default Aws2KinesisComponentBuilderFactory.Aws2KinesisComponentBuilder 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: <code>software.amazon.awssdk.services.cloudwatch.CloudWatchAsyncClient</code> type. Group: advanced
      Parameters:
      cloudWatchAsyncClient - the value to set
      Returns:
      the dsl builder

    • dynamoDbAsyncClient

      default Aws2KinesisComponentBuilderFactory.Aws2KinesisComponentBuilder 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: <code>software.amazon.awssdk.services.dynamodb.DynamoDbAsyncClient</code> type. Group: advanced
      Parameters:
      dynamoDbAsyncClient - the value to set
      Returns:
      the dsl builder

    • kclDisableCloudwatchMetricsExport

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

    • useKclConsumers

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

    • healthCheckConsumerEnabled

      default Aws2KinesisComponentBuilderFactory.Aws2KinesisComponentBuilder healthCheckConsumerEnabled(boolean healthCheckConsumerEnabled)
      Used for enabling or disabling all consumer based health checks from this component. The option is a: <code>boolean</code> type. Default: true Group: health
      Parameters:
      healthCheckConsumerEnabled - the value to set
      Returns:
      the dsl builder

    • healthCheckProducerEnabled

      default Aws2KinesisComponentBuilderFactory.Aws2KinesisComponentBuilder healthCheckProducerEnabled(boolean healthCheckProducerEnabled)
      Used for enabling or disabling all producer based health checks from this component. Notice: Camel has by default disabled all producer based health-checks. You can turn on producer checks globally by setting camel.health.producersEnabled=true. The option is a: <code>boolean</code> type. Default: true Group: health
      Parameters:
      healthCheckProducerEnabled - the value to set
      Returns:
      the dsl builder

    • proxyHost

      default Aws2KinesisComponentBuilderFactory.Aws2KinesisComponentBuilder proxyHost(String proxyHost)
      To define a proxy host when instantiating the Kinesis 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 Aws2KinesisComponentBuilderFactory.Aws2KinesisComponentBuilder proxyPort(Integer proxyPort)
      To define a proxy port when instantiating the Kinesis client. The option is a: <code>java.lang.Integer</code> type. Group: proxy
      Parameters:
      proxyPort - the value to set
      Returns:
      the dsl builder

    • proxyProtocol

      default Aws2KinesisComponentBuilderFactory.Aws2KinesisComponentBuilder proxyProtocol(software.amazon.awssdk.core.Protocol proxyProtocol)
      To define a proxy protocol when instantiating the Kinesis 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

    • accessKey

      default Aws2KinesisComponentBuilderFactory.Aws2KinesisComponentBuilder 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 Aws2KinesisComponentBuilderFactory.Aws2KinesisComponentBuilder 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 Aws2KinesisComponentBuilderFactory.Aws2KinesisComponentBuilder 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

    • sessionToken

      default Aws2KinesisComponentBuilderFactory.Aws2KinesisComponentBuilder sessionToken(String sessionToken)
      Amazon AWS Session Token used when the user needs to assume a IAM role. The option is a: <code>java.lang.String</code> type. Group: security
      Parameters:
      sessionToken - the value to set
      Returns:
      the dsl builder

    • trustAllCertificates

      default Aws2KinesisComponentBuilderFactory.Aws2KinesisComponentBuilder 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

    • useDefaultCredentialsProvider

      default Aws2KinesisComponentBuilderFactory.Aws2KinesisComponentBuilder useDefaultCredentialsProvider(boolean useDefaultCredentialsProvider)
      Set whether the Kinesis 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: security
      Parameters:
      useDefaultCredentialsProvider - the value to set
      Returns:
      the dsl builder

    • useProfileCredentialsProvider

      default Aws2KinesisComponentBuilderFactory.Aws2KinesisComponentBuilder useProfileCredentialsProvider(boolean useProfileCredentialsProvider)
      Set whether the Kinesis 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

    • useSessionCredentials

      default Aws2KinesisComponentBuilderFactory.Aws2KinesisComponentBuilder useSessionCredentials(boolean useSessionCredentials)
      Set whether the Kinesis client should expect to use Session Credentials. This is useful in situation in which the user needs to assume a IAM role for doing operations in Kinesis. The option is a: <code>boolean</code> type. Default: false Group: security
      Parameters:
      useSessionCredentials - the value to set
      Returns:
      the dsl builder