4.4. 端点选项
AWS Kinesis 端点使用 URI 语法进行配置:
aws2-kinesis:streamName
使用以下路径和查询参数:
4.4.1. 路径参数(1 参数)
Name | 描述 | 默认值 | 类型 |
---|---|---|---|
streamName (common) | 流必需的名称。 | 字符串 |
4.4.2. 查询参数 (38 参数)
Name | 描述 | 默认值 | 类型 |
---|---|---|---|
amazonKinesisClient (common) | Autowired Amazon Kinesis 客户端用于此端点的所有请求。 | KinesisClient | |
cborEnabled (common) | 此选项将在执行期间设置 CBOR_ENABLED 属性。 | true | 布尔值 |
overrideEndpoint (common) | 设置覆盖端点的需要。这个选项需要与 uriEndpointOverride 选项结合使用。 | false | 布尔值 |
proxyHost (common) | 在实例化 Kinesis 客户端时定义代理主机。 | 字符串 | |
proxyPort (common) | 在实例化 Kinesis 客户端时定义代理端口。 | 整数 | |
proxyProtocol (common) | 在实例化 Kinesis 客户端时定义代理协议。 Enum 值:
| HTTPS | 协议 |
region (common) | Kinesis Firehose 客户端需要工作的区域。使用此参数时,配置将预期区域(如 ap-east-1)的小写名称,您需要使用名称 Region.EU_WEST_1.id()。 | 字符串 | |
trustAllCertificates (common) | 如果要在覆盖端点时信任所有证书。 | false | 布尔值 |
uriEndpointOverride (common) | 设置覆盖 uri 端点。这个选项需要与 overrideEndpoint 选项结合使用。 | 字符串 | |
useDefaultCredentialsProvider (common) | 设置 Kinesis 客户端是否应该希望通过默认凭证提供程序加载凭证,或者希望传递静态凭证。 | false | 布尔值 |
bridgeErrorHandler (consumer) | 允许将消费者桥接到 Camel 路由错误处理程序,这意味着当消费者试图选择传入消息或类似信息时发生异常,现在将作为消息处理并由路由 Error Handler 处理。默认情况下,使用者将使用 org.apache.camel.spi.ExceptionHandler 来处理例外情况,该处理程序将被记录在 WARN 或 ERROR 级别,并忽略。 | false | 布尔值 |
iteratorType (consumer) | 定义在 Kinesis 流中开始获取记录的位置。 Enum 值:
| TRIM_HORIZON | ShardIteratorType |
maxResultsPerRequest (consumer) | 每次轮询中将获取的最大记录数。 | 1 | int |
resumeStrategy (consumer) | 为 AWS Kinesis 定义恢复策略。如果提供,默认策略将读取 sequenceNumber。 | KinesisUserConfigurationResumeStrategy | KinesisResumeStrategy |
sendEmptyMessageWhenIdle (consumer) | 如果轮询使用者没有轮询任何文件,您可以启用此选项来发送空消息(无正文)。 | false | 布尔值 |
sequenceNumber (consumer) | 开始轮询的序列号。如果 iteratorType 设置为 AFTER_SEQUENCE_NUMBER 或 AT_SEQUENCE_NUMBER,则需要此项。 | 字符串 | |
shardClosed (consumer) | 定义在分片关闭时的行为是什么。可能的值有 ignore, silent 和 fail。如果忽略了消息,并且消费者将从开始重新启动,如果为 silent,则消费者将从开始记录。如果开始,消费者将引发故障关闭状态异常。 Enum 值:
| ignore | Kinesis2ShardClosedStrategyEnum |
shardId (consumer) | 定义 Kinesis 流中要从哪些分片 ID 获取记录。 | 字符串 | |
exceptionHandler (consumer (advanced)) | 要让使用者使用自定义例外处理程序:请注意,如果启用了 bridgeErrorHandler 选项,则此选项不使用。默认情况下,消费者将处理异常,其记录在 WARN 或 ERROR 级别中,并忽略。 | ExceptionHandler | |
exchangePattern (consumer (advanced)) | 在消费者创建交换时设置交换模式。 Enum 值:
| ExchangePattern | |
pollStrategy (consumer (advanced)) | 可插拔 org.apache.camel.PollingConsumerPollingStrategy 允许您提供自定义实施来控制在轮询操作期间通常会发生错误处理,然后再创建交换并在 Camel 中路由。 | PollingConsumerPollStrategy | |
lazyStartProducer (producer) | 生成者是否应懒惰启动 (在第一个消息中)。通过懒惰启动,您可以使用此选项来允许 CamelContext 和路由在生成者启动期间启动,并导致路由启动失败。通过懒惰启动,启动失败可以在路由信息时通过 Camel 的路由错误处理程序进行处理。请注意,在处理第一个消息时,创建并启动生成者可能需要稍等时间,并延长处理的总处理时间。 | false | 布尔值 |
backoffErrorThreshold (scheduler) | 在 backoffMultipler 应该 kick-in 之前发生的后续错误轮询(因为某些错误)的数量。 | int | |
backoffIdleThreshold (scheduler) | 在 backoffMultipler 应该 kick-in 之前应该发生的后续空闲轮询数量。 | int | |
backoffMultiplier (scheduler) | 如果一行中有很多后续空闲/errors,则让调度的轮询消费者避退。然后,倍数是在下一次实际尝试再次发生前跳过的轮询数量。当使用这个选项时,还必须配置 backoffIdleThreshold 和/或 backoffErrorThreshold。 | int | |
delay (scheduler) | 下一次轮询前的时间(毫秒)。 | 500 | long |
greedy (scheduler) | 如果启用了 greedy,如果上一个运行轮询 1 或更多消息,则 ScheduledPollConsumer 将立即运行。 | false | 布尔值 |
initialDelay (scheduler) | 第一次轮询开始前的毫秒。 | 1000 | long |
repeatCount (scheduler) | 指定触发的最大数量。因此,如果您将其设置为 1,调度程序将只触发一次。如果您将其设置为 5,它将只触发五次。值为零或负数表示会永久触发。 | 0 | long |
runLoggingLevel (scheduler) | 消费者在轮询时记录 start/complete log 行。这个选项允许您为其配置日志级别。 Enum 值:
| TRACE | LoggingLevel |
scheduledExecutorService (scheduler) | 允许配置用于消费者的自定义/共享线程池。默认情况下,每个使用者都有自己的单线程线程池。 | ScheduledExecutorService | |
scheduler (scheduler) | 要使用 camel-spring 或 camel-quartz 组件的 cron 调度程序。使用值 spring 或 quartz 用于内置在调度程序中。 | none | 对象 |
schedulerProperties (scheduler) | 在使用自定义调度程序或任何基于 Spring 的调度程序时配置附加属性。 | Map | |
startScheduler (scheduler) | 调度程序是否应自动启动。 | true | 布尔值 |
timeUnit (scheduler) | initialDelay 和 delay 选项的时间单位。 Enum 值:
| MILLISECONDS | TimeUnit |
useFixedDelay (scheduler) | 控制是否使用固定延迟或固定率。详情请参阅 JDK 中的 ScheduledExecutorService。 | true | 布尔值 |
accessKey (security) | Amazon AWS 访问密钥. | 字符串 | |
secretKey (security) | Amazon AWS Secret 密钥。 | 字符串 |
所需的 Kinesis 组件选项
您必须在 Registry 中提供 KinesisClient,并配置了代理和相关凭证。