Interface Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder

All Superinterfaces:
org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver
All Known Subinterfaces:
Kinesis2EndpointBuilderFactory.Kinesis2EndpointBuilder
Enclosing interface:
Kinesis2EndpointBuilderFactory

public static interface Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder extends org.apache.camel.builder.EndpointConsumerBuilder
Builder for endpoint consumers for the AWS Kinesis component.
  • Method Details

    • advanced

    • cborEnabled

      default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder cborEnabled(boolean cborEnabled)
      This option will set the CBOR_ENABLED property during the execution. The option is a: boolean type. Default: true Group: common
      Parameters:
      cborEnabled - the value to set
      Returns:
      the dsl builder
    • cborEnabled

      This option will set the CBOR_ENABLED property during the execution. The option will be converted to a boolean type. Default: true Group: common
      Parameters:
      cborEnabled - the value to set
      Returns:
      the dsl builder
    • overrideEndpoint

      default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder 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: boolean type. Default: false Group: common
      Parameters:
      overrideEndpoint - the value to set
      Returns:
      the dsl builder
    • overrideEndpoint

      default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder 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 boolean type. Default: false Group: common
      Parameters:
      overrideEndpoint - the value to set
      Returns:
      the dsl builder
    • 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: java.lang.String type. Group: common
      Parameters:
      region - the value to set
      Returns:
      the dsl builder
    • uriEndpointOverride

      default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder uriEndpointOverride(String uriEndpointOverride)
      Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option. The option is a: java.lang.String type. Group: common
      Parameters:
      uriEndpointOverride - the value to set
      Returns:
      the dsl builder
    • iteratorType

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

      Defines where in the Kinesis stream to start getting records. The option will be converted to a software.amazon.awssdk.services.kinesis.model.ShardIteratorType type. Default: TRIM_HORIZON Group: consumer
      Parameters:
      iteratorType - the value to set
      Returns:
      the dsl builder
    • maxResultsPerRequest

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

      default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder maxResultsPerRequest(String maxResultsPerRequest)
      Maximum number of records that will be fetched in each poll. The option will be converted to a int type. Default: 1 Group: consumer
      Parameters:
      maxResultsPerRequest - the value to set
      Returns:
      the dsl builder
    • messageTimestamp

      default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder messageTimestamp(String messageTimestamp)
      The message timestamp to start polling from. Required if iteratorType is set to AT_TIMESTAMP. The option is a: java.lang.String type. Group: consumer
      Parameters:
      messageTimestamp - the value to set
      Returns:
      the dsl builder
    • sendEmptyMessageWhenIdle

      default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder 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
      Parameters:
      sendEmptyMessageWhenIdle - the value to set
      Returns:
      the dsl builder
    • sendEmptyMessageWhenIdle

      default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder 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
      Parameters:
      sendEmptyMessageWhenIdle - the value to set
      Returns:
      the dsl builder
    • 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: java.lang.String type. Group: consumer
      Parameters:
      sequenceNumber - the value to set
      Returns:
      the dsl builder
    • shardClosed

      default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder 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: org.apache.camel.component.aws2.kinesis.Kinesis2ShardClosedStrategyEnum type. Default: ignore Group: consumer
      Parameters:
      shardClosed - the value to set
      Returns:
      the dsl builder
    • 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 will be converted to a org.apache.camel.component.aws2.kinesis.Kinesis2ShardClosedStrategyEnum type. Default: ignore Group: consumer
      Parameters:
      shardClosed - the value to set
      Returns:
      the dsl builder
    • shardId

      Defines which shardId in the Kinesis stream to get records from. The option is a: java.lang.String type. Group: consumer
      Parameters:
      shardId - the value to set
      Returns:
      the dsl builder
    • proxyHost

      To define a proxy host when instantiating the Kinesis client. The option is a: java.lang.String type. Group: proxy
      Parameters:
      proxyHost - the value to set
      Returns:
      the dsl builder
    • proxyPort

      To define a proxy port when instantiating the Kinesis client. The option is a: java.lang.Integer type. Group: proxy
      Parameters:
      proxyPort - the value to set
      Returns:
      the dsl builder
    • proxyPort

      To define a proxy port when instantiating the Kinesis client. The option will be converted to a java.lang.Integer type. Group: proxy
      Parameters:
      proxyPort - the value to set
      Returns:
      the dsl builder
    • proxyProtocol

      default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder proxyProtocol(software.amazon.awssdk.core.Protocol proxyProtocol)
      To define a proxy protocol when instantiating the Kinesis client. The option is a: software.amazon.awssdk.core.Protocol type. Default: HTTPS Group: proxy
      Parameters:
      proxyProtocol - the value to set
      Returns:
      the dsl builder
    • proxyProtocol

      To define a proxy protocol when instantiating the Kinesis client. The option will be converted to a software.amazon.awssdk.core.Protocol type. Default: HTTPS Group: proxy
      Parameters:
      proxyProtocol - the value to set
      Returns:
      the dsl builder
    • backoffErrorThreshold

      default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder 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
      Parameters:
      backoffErrorThreshold - the value to set
      Returns:
      the dsl builder
    • backoffErrorThreshold

      default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder 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
      Parameters:
      backoffErrorThreshold - the value to set
      Returns:
      the dsl builder
    • backoffIdleThreshold

      default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder 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
      Parameters:
      backoffIdleThreshold - the value to set
      Returns:
      the dsl builder
    • backoffIdleThreshold

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

      default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder 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
      Parameters:
      backoffMultiplier - the value to set
      Returns:
      the dsl builder
    • backoffMultiplier

      default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder 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
      Parameters:
      backoffMultiplier - the value to set
      Returns:
      the dsl builder
    • delay

      Milliseconds before the next poll. The option is a: long type. Default: 500 Group: scheduler
      Parameters:
      delay - the value to set
      Returns:
      the dsl builder
    • delay

      Milliseconds before the next poll. The option will be converted to a long type. Default: 500 Group: scheduler
      Parameters:
      delay - the value to set
      Returns:
      the dsl builder
    • 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
      Parameters:
      greedy - the value to set
      Returns:
      the dsl builder
    • 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 boolean type. Default: false Group: scheduler
      Parameters:
      greedy - the value to set
      Returns:
      the dsl builder
    • initialDelay

      default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder initialDelay(long initialDelay)
      Milliseconds before the first poll starts. The option is a: long type. Default: 1000 Group: scheduler
      Parameters:
      initialDelay - the value to set
      Returns:
      the dsl builder
    • initialDelay

      Milliseconds before the first poll starts. The option will be converted to a long type. Default: 1000 Group: scheduler
      Parameters:
      initialDelay - the value to set
      Returns:
      the dsl builder
    • 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
      Parameters:
      repeatCount - the value to set
      Returns:
      the dsl builder
    • 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
      Parameters:
      repeatCount - the value to set
      Returns:
      the dsl builder
    • runLoggingLevel

      default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder 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
      Parameters:
      runLoggingLevel - the value to set
      Returns:
      the dsl builder
    • 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
      Parameters:
      runLoggingLevel - the value to set
      Returns:
      the dsl builder
    • scheduledExecutorService

      default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder 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
      Parameters:
      scheduledExecutorService - the value to set
      Returns:
      the dsl builder
    • scheduledExecutorService

      default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder 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
      Parameters:
      scheduledExecutorService - the value to set
      Returns:
      the dsl builder
    • 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: java.lang.Object type. Default: none Group: scheduler
      Parameters:
      scheduler - the value to set
      Returns:
      the dsl builder
    • 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
      Parameters:
      scheduler - the value to set
      Returns:
      the dsl builder
    • schedulerProperties

      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
      Parameters:
      key - the option key
      value - the option value
      Returns:
      the dsl builder
    • schedulerProperties

      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
      Parameters:
      values - the values
      Returns:
      the dsl builder
    • startScheduler

      default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder startScheduler(boolean startScheduler)
      Whether the scheduler should be auto started. The option is a: boolean type. Default: true Group: scheduler
      Parameters:
      startScheduler - the value to set
      Returns:
      the dsl builder
    • startScheduler

      Whether the scheduler should be auto started. The option will be converted to a boolean type. Default: true Group: scheduler
      Parameters:
      startScheduler - the value to set
      Returns:
      the dsl builder
    • timeUnit

      Time unit for initialDelay and delay options. The option is a: java.util.concurrent.TimeUnit type. Default: MILLISECONDS Group: scheduler
      Parameters:
      timeUnit - the value to set
      Returns:
      the dsl builder
    • timeUnit

      Time unit for initialDelay and delay options. The option will be converted to a java.util.concurrent.TimeUnit type. Default: MILLISECONDS Group: scheduler
      Parameters:
      timeUnit - the value to set
      Returns:
      the dsl builder
    • useFixedDelay

      default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder 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
      Parameters:
      useFixedDelay - the value to set
      Returns:
      the dsl builder
    • useFixedDelay

      Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. The option will be converted to a boolean type. Default: true Group: scheduler
      Parameters:
      useFixedDelay - the value to set
      Returns:
      the dsl builder
    • accessKey

      Amazon AWS Access Key. The option is a: java.lang.String type. Group: security
      Parameters:
      accessKey - the value to set
      Returns:
      the dsl builder
    • profileCredentialsName

      default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder profileCredentialsName(String profileCredentialsName)
      If using a profile credentials provider this parameter will set the profile name. The option is a: java.lang.String type. Group: security
      Parameters:
      profileCredentialsName - the value to set
      Returns:
      the dsl builder
    • secretKey

      Amazon AWS Secret Key. The option is a: java.lang.String type. Group: security
      Parameters:
      secretKey - the value to set
      Returns:
      the dsl builder
    • sessionToken

      Amazon AWS Session Token used when the user needs to assume a IAM role. The option is a: java.lang.String type. Group: security
      Parameters:
      sessionToken - the value to set
      Returns:
      the dsl builder
    • trustAllCertificates

      default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder trustAllCertificates(boolean trustAllCertificates)
      If we want to trust all certificates in case of overriding the endpoint. The option is a: boolean type. Default: false Group: security
      Parameters:
      trustAllCertificates - the value to set
      Returns:
      the dsl builder
    • trustAllCertificates

      default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder trustAllCertificates(String trustAllCertificates)
      If we want to trust all certificates in case of overriding the endpoint. The option will be converted to a boolean type. Default: false Group: security
      Parameters:
      trustAllCertificates - the value to set
      Returns:
      the dsl builder
    • useDefaultCredentialsProvider

      default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder 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: boolean type. Default: false Group: security
      Parameters:
      useDefaultCredentialsProvider - the value to set
      Returns:
      the dsl builder
    • useDefaultCredentialsProvider

      default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder useDefaultCredentialsProvider(String 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 will be converted to a boolean type. Default: false Group: security
      Parameters:
      useDefaultCredentialsProvider - the value to set
      Returns:
      the dsl builder
    • useProfileCredentialsProvider

      default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder useProfileCredentialsProvider(boolean useProfileCredentialsProvider)
      Set whether the Kinesis client should expect to load credentials through a profile credentials provider. The option is a: boolean type. Default: false Group: security
      Parameters:
      useProfileCredentialsProvider - the value to set
      Returns:
      the dsl builder
    • useProfileCredentialsProvider

      default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder useProfileCredentialsProvider(String useProfileCredentialsProvider)
      Set whether the Kinesis client should expect to load credentials through a profile credentials provider. The option will be converted to a boolean type. Default: false Group: security
      Parameters:
      useProfileCredentialsProvider - the value to set
      Returns:
      the dsl builder
    • useSessionCredentials

      default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder 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: boolean type. Default: false Group: security
      Parameters:
      useSessionCredentials - the value to set
      Returns:
      the dsl builder
    • useSessionCredentials

      default Kinesis2EndpointBuilderFactory.Kinesis2EndpointConsumerBuilder useSessionCredentials(String 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 will be converted to a boolean type. Default: false Group: security
      Parameters:
      useSessionCredentials - the value to set
      Returns:
      the dsl builder