Skip to content

Commit

Permalink
fix #389 : Improve documentation TOC
Browse files Browse the repository at this point in the history
  • Loading branch information
@valdar
valdar committed Jun 5, 2021
1 parent eddd4b6 commit ac23b6f
Show file tree
Hide file tree
Showing 1,102 changed files with 46,111 additions and 1,289 deletions.
14 changes: 14 additions & 0 deletions connectors/camel-kafka-kafka-connector/src/generated/resources/camel-kafka-sink.json
View file
Expand Up @@ -80,6 +80,13 @@
"priority": "MEDIUM",
"required": "false"
},
"camel.sink.endpoint.deliveryTimeoutMs": {
"name": "camel.sink.endpoint.deliveryTimeoutMs",
"description": "An upper bound on the time to report success or failure after a call to send() returns. This limits the total time that a record will be delayed prior to sending, the time to await acknowledgement from the broker (if expected), and the time allowed for retriable send failures.",
"defaultValue": "\"120000\"",
"priority": "MEDIUM",
"required": "false"
},
"camel.sink.endpoint.enableIdempotence": {
"name": "camel.sink.endpoint.enableIdempotence",
"description": "If set to 'true' the producer will ensure that exactly one copy of each message is written in the stream. If 'false', producer retries may write duplicates of the retried message in the stream. If set to true this option will require max.in.flight.requests.per.connection to be set to 1 and retries cannot be zero and additionally acks must be set to 'all'.",
Expand Down Expand Up @@ -530,6 +537,13 @@
"priority": "MEDIUM",
"required": "false"
},
"camel.component.kafka.deliveryTimeoutMs": {
"name": "camel.component.kafka.deliveryTimeoutMs",
"description": "An upper bound on the time to report success or failure after a call to send() returns. This limits the total time that a record will be delayed prior to sending, the time to await acknowledgement from the broker (if expected), and the time allowed for retriable send failures.",
"defaultValue": "\"120000\"",
"priority": "MEDIUM",
"required": "false"
},
"camel.component.kafka.enableIdempotence": {
"name": "camel.component.kafka.enableIdempotence",
"description": "If set to 'true' the producer will ensure that exactly one copy of each message is written in the stream. If 'false', producer retries may write duplicates of the retried message in the stream. If set to true this option will require max.in.flight.requests.per.connection to be set to 1 and retries cannot be zero and additionally acks must be set to 'all'.",
Expand Down
4 changes: 3 additions & 1 deletion ...camel-kafka-kafka-connector/src/main/docs/camel-kafka-kafka-sink-connector.adoc
View file
Expand Up @@ -24,7 +24,7 @@ connector.class=org.apache.camel.kafkaconnector.kafka.CamelKafkaSinkConnector
----


The camel-kafka sink connector supports 135 options, which are listed below.
The camel-kafka sink connector supports 137 options, which are listed below.



Expand All @@ -41,6 +41,7 @@ The camel-kafka sink connector supports 135 options, which are listed below.
| *camel.sink.endpoint.bufferMemorySize* | The total bytes of memory the producer can use to buffer records waiting to be sent to the server. If records are sent faster than they can be delivered to the server the producer will either block or throw an exception based on the preference specified by block.on.buffer.full.This setting should correspond roughly to the total memory the producer will use, but is not a hard bound since not all memory the producer uses is used for buffering. Some additional memory will be used for compression (if compression is enabled) as well as for maintaining in-flight requests. | "33554432" | false | MEDIUM
| *camel.sink.endpoint.compressionCodec* | This parameter allows you to specify the compression codec for all data generated by this producer. Valid values are none, gzip and snappy. One of: [none] [gzip] [snappy] [lz4] | "none" | false | MEDIUM
| *camel.sink.endpoint.connectionMaxIdleMs* | Close idle connections after the number of milliseconds specified by this config. | "540000" | false | MEDIUM
| *camel.sink.endpoint.deliveryTimeoutMs* | An upper bound on the time to report success or failure after a call to send() returns. This limits the total time that a record will be delayed prior to sending, the time to await acknowledgement from the broker (if expected), and the time allowed for retriable send failures. | "120000" | false | MEDIUM
| *camel.sink.endpoint.enableIdempotence* | If set to 'true' the producer will ensure that exactly one copy of each message is written in the stream. If 'false', producer retries may write duplicates of the retried message in the stream. If set to true this option will require max.in.flight.requests.per.connection to be set to 1 and retries cannot be zero and additionally acks must be set to 'all'. | false | false | MEDIUM
| *camel.sink.endpoint.headerSerializer* | To use a custom KafkaHeaderSerializer to serialize kafka headers values | null | false | MEDIUM
| *camel.sink.endpoint.key* | The record key (or null if no key is specified). If this option has been configured then it take precedence over header KafkaConstants#KEY | null | false | MEDIUM
Expand Down Expand Up @@ -107,6 +108,7 @@ The camel-kafka sink connector supports 135 options, which are listed below.
| *camel.component.kafka.bufferMemorySize* | The total bytes of memory the producer can use to buffer records waiting to be sent to the server. If records are sent faster than they can be delivered to the server the producer will either block or throw an exception based on the preference specified by block.on.buffer.full.This setting should correspond roughly to the total memory the producer will use, but is not a hard bound since not all memory the producer uses is used for buffering. Some additional memory will be used for compression (if compression is enabled) as well as for maintaining in-flight requests. | "33554432" | false | MEDIUM
| *camel.component.kafka.compressionCodec* | This parameter allows you to specify the compression codec for all data generated by this producer. Valid values are none, gzip and snappy. One of: [none] [gzip] [snappy] [lz4] | "none" | false | MEDIUM
| *camel.component.kafka.connectionMaxIdleMs* | Close idle connections after the number of milliseconds specified by this config. | "540000" | false | MEDIUM
| *camel.component.kafka.deliveryTimeoutMs* | An upper bound on the time to report success or failure after a call to send() returns. This limits the total time that a record will be delayed prior to sending, the time to await acknowledgement from the broker (if expected), and the time allowed for retriable send failures. | "120000" | false | MEDIUM
| *camel.component.kafka.enableIdempotence* | If set to 'true' the producer will ensure that exactly one copy of each message is written in the stream. If 'false', producer retries may write duplicates of the retried message in the stream. If set to true this option will require max.in.flight.requests.per.connection to be set to 1 and retries cannot be zero and additionally acks must be set to 'all'. | false | false | MEDIUM
| *camel.component.kafka.headerSerializer* | To use a custom KafkaHeaderSerializer to serialize kafka headers values | null | false | MEDIUM
| *camel.component.kafka.key* | The record key (or null if no key is specified). If this option has been configured then it take precedence over header KafkaConstants#KEY | null | false | MEDIUM
Expand Down
8 changes: 8 additions & 0 deletions ...or/src/main/java/org/apache/camel/kafkaconnector/kafka/CamelKafkaSinkConnectorConfig.java
View file
Expand Up @@ -54,6 +54,9 @@ public class CamelKafkaSinkConnectorConfig extends CamelSinkConnectorConfig {
public static final String CAMEL_SINK_KAFKA_ENDPOINT_CONNECTION_MAX_IDLE_MS_CONF = "camel.sink.endpoint.connectionMaxIdleMs";
public static final String CAMEL_SINK_KAFKA_ENDPOINT_CONNECTION_MAX_IDLE_MS_DOC = "Close idle connections after the number of milliseconds specified by this config.";
public static final String CAMEL_SINK_KAFKA_ENDPOINT_CONNECTION_MAX_IDLE_MS_DEFAULT = "540000";
public static final String CAMEL_SINK_KAFKA_ENDPOINT_DELIVERY_TIMEOUT_MS_CONF = "camel.sink.endpoint.deliveryTimeoutMs";
public static final String CAMEL_SINK_KAFKA_ENDPOINT_DELIVERY_TIMEOUT_MS_DOC = "An upper bound on the time to report success or failure after a call to send() returns. This limits the total time that a record will be delayed prior to sending, the time to await acknowledgement from the broker (if expected), and the time allowed for retriable send failures.";
public static final String CAMEL_SINK_KAFKA_ENDPOINT_DELIVERY_TIMEOUT_MS_DEFAULT = "120000";
public static final String CAMEL_SINK_KAFKA_ENDPOINT_ENABLE_IDEMPOTENCE_CONF = "camel.sink.endpoint.enableIdempotence";
public static final String CAMEL_SINK_KAFKA_ENDPOINT_ENABLE_IDEMPOTENCE_DOC = "If set to 'true' the producer will ensure that exactly one copy of each message is written in the stream. If 'false', producer retries may write duplicates of the retried message in the stream. If set to true this option will require max.in.flight.requests.per.connection to be set to 1 and retries cannot be zero and additionally acks must be set to 'all'.";
public static final Boolean CAMEL_SINK_KAFKA_ENDPOINT_ENABLE_IDEMPOTENCE_DEFAULT = false;
Expand Down Expand Up @@ -252,6 +255,9 @@ public class CamelKafkaSinkConnectorConfig extends CamelSinkConnectorConfig {
public static final String CAMEL_SINK_KAFKA_COMPONENT_CONNECTION_MAX_IDLE_MS_CONF = "camel.component.kafka.connectionMaxIdleMs";
public static final String CAMEL_SINK_KAFKA_COMPONENT_CONNECTION_MAX_IDLE_MS_DOC = "Close idle connections after the number of milliseconds specified by this config.";
public static final String CAMEL_SINK_KAFKA_COMPONENT_CONNECTION_MAX_IDLE_MS_DEFAULT = "540000";
public static final String CAMEL_SINK_KAFKA_COMPONENT_DELIVERY_TIMEOUT_MS_CONF = "camel.component.kafka.deliveryTimeoutMs";
public static final String CAMEL_SINK_KAFKA_COMPONENT_DELIVERY_TIMEOUT_MS_DOC = "An upper bound on the time to report success or failure after a call to send() returns. This limits the total time that a record will be delayed prior to sending, the time to await acknowledgement from the broker (if expected), and the time allowed for retriable send failures.";
public static final String CAMEL_SINK_KAFKA_COMPONENT_DELIVERY_TIMEOUT_MS_DEFAULT = "120000";
public static final String CAMEL_SINK_KAFKA_COMPONENT_ENABLE_IDEMPOTENCE_CONF = "camel.component.kafka.enableIdempotence";
public static final String CAMEL_SINK_KAFKA_COMPONENT_ENABLE_IDEMPOTENCE_DOC = "If set to 'true' the producer will ensure that exactly one copy of each message is written in the stream. If 'false', producer retries may write duplicates of the retried message in the stream. If set to true this option will require max.in.flight.requests.per.connection to be set to 1 and retries cannot be zero and additionally acks must be set to 'all'.";
public static final Boolean CAMEL_SINK_KAFKA_COMPONENT_ENABLE_IDEMPOTENCE_DEFAULT = false;
Expand Down Expand Up @@ -452,6 +458,7 @@ public static ConfigDef conf() {
conf.define(CAMEL_SINK_KAFKA_ENDPOINT_BUFFER_MEMORY_SIZE_CONF, ConfigDef.Type.STRING, CAMEL_SINK_KAFKA_ENDPOINT_BUFFER_MEMORY_SIZE_DEFAULT, ConfigDef.Importance.MEDIUM, CAMEL_SINK_KAFKA_ENDPOINT_BUFFER_MEMORY_SIZE_DOC);
conf.define(CAMEL_SINK_KAFKA_ENDPOINT_COMPRESSION_CODEC_CONF, ConfigDef.Type.STRING, CAMEL_SINK_KAFKA_ENDPOINT_COMPRESSION_CODEC_DEFAULT, ConfigDef.Importance.MEDIUM, CAMEL_SINK_KAFKA_ENDPOINT_COMPRESSION_CODEC_DOC);
conf.define(CAMEL_SINK_KAFKA_ENDPOINT_CONNECTION_MAX_IDLE_MS_CONF, ConfigDef.Type.STRING, CAMEL_SINK_KAFKA_ENDPOINT_CONNECTION_MAX_IDLE_MS_DEFAULT, ConfigDef.Importance.MEDIUM, CAMEL_SINK_KAFKA_ENDPOINT_CONNECTION_MAX_IDLE_MS_DOC);
conf.define(CAMEL_SINK_KAFKA_ENDPOINT_DELIVERY_TIMEOUT_MS_CONF, ConfigDef.Type.STRING, CAMEL_SINK_KAFKA_ENDPOINT_DELIVERY_TIMEOUT_MS_DEFAULT, ConfigDef.Importance.MEDIUM, CAMEL_SINK_KAFKA_ENDPOINT_DELIVERY_TIMEOUT_MS_DOC);
conf.define(CAMEL_SINK_KAFKA_ENDPOINT_ENABLE_IDEMPOTENCE_CONF, ConfigDef.Type.BOOLEAN, CAMEL_SINK_KAFKA_ENDPOINT_ENABLE_IDEMPOTENCE_DEFAULT, ConfigDef.Importance.MEDIUM, CAMEL_SINK_KAFKA_ENDPOINT_ENABLE_IDEMPOTENCE_DOC);
conf.define(CAMEL_SINK_KAFKA_ENDPOINT_HEADER_SERIALIZER_CONF, ConfigDef.Type.STRING, CAMEL_SINK_KAFKA_ENDPOINT_HEADER_SERIALIZER_DEFAULT, ConfigDef.Importance.MEDIUM, CAMEL_SINK_KAFKA_ENDPOINT_HEADER_SERIALIZER_DOC);
conf.define(CAMEL_SINK_KAFKA_ENDPOINT_KEY_CONF, ConfigDef.Type.STRING, CAMEL_SINK_KAFKA_ENDPOINT_KEY_DEFAULT, ConfigDef.Importance.MEDIUM, CAMEL_SINK_KAFKA_ENDPOINT_KEY_DOC);
Expand Down Expand Up @@ -518,6 +525,7 @@ public static ConfigDef conf() {
conf.define(CAMEL_SINK_KAFKA_COMPONENT_BUFFER_MEMORY_SIZE_CONF, ConfigDef.Type.STRING, CAMEL_SINK_KAFKA_COMPONENT_BUFFER_MEMORY_SIZE_DEFAULT, ConfigDef.Importance.MEDIUM, CAMEL_SINK_KAFKA_COMPONENT_BUFFER_MEMORY_SIZE_DOC);
conf.define(CAMEL_SINK_KAFKA_COMPONENT_COMPRESSION_CODEC_CONF, ConfigDef.Type.STRING, CAMEL_SINK_KAFKA_COMPONENT_COMPRESSION_CODEC_DEFAULT, ConfigDef.Importance.MEDIUM, CAMEL_SINK_KAFKA_COMPONENT_COMPRESSION_CODEC_DOC);
conf.define(CAMEL_SINK_KAFKA_COMPONENT_CONNECTION_MAX_IDLE_MS_CONF, ConfigDef.Type.STRING, CAMEL_SINK_KAFKA_COMPONENT_CONNECTION_MAX_IDLE_MS_DEFAULT, ConfigDef.Importance.MEDIUM, CAMEL_SINK_KAFKA_COMPONENT_CONNECTION_MAX_IDLE_MS_DOC);
conf.define(CAMEL_SINK_KAFKA_COMPONENT_DELIVERY_TIMEOUT_MS_CONF, ConfigDef.Type.STRING, CAMEL_SINK_KAFKA_COMPONENT_DELIVERY_TIMEOUT_MS_DEFAULT, ConfigDef.Importance.MEDIUM, CAMEL_SINK_KAFKA_COMPONENT_DELIVERY_TIMEOUT_MS_DOC);
conf.define(CAMEL_SINK_KAFKA_COMPONENT_ENABLE_IDEMPOTENCE_CONF, ConfigDef.Type.BOOLEAN, CAMEL_SINK_KAFKA_COMPONENT_ENABLE_IDEMPOTENCE_DEFAULT, ConfigDef.Importance.MEDIUM, CAMEL_SINK_KAFKA_COMPONENT_ENABLE_IDEMPOTENCE_DOC);
conf.define(CAMEL_SINK_KAFKA_COMPONENT_HEADER_SERIALIZER_CONF, ConfigDef.Type.STRING, CAMEL_SINK_KAFKA_COMPONENT_HEADER_SERIALIZER_DEFAULT, ConfigDef.Importance.MEDIUM, CAMEL_SINK_KAFKA_COMPONENT_HEADER_SERIALIZER_DOC);
conf.define(CAMEL_SINK_KAFKA_COMPONENT_KEY_CONF, ConfigDef.Type.STRING, CAMEL_SINK_KAFKA_COMPONENT_KEY_DEFAULT, ConfigDef.Importance.MEDIUM, CAMEL_SINK_KAFKA_COMPONENT_KEY_DOC);
Expand Down

0 comments on commit ac23b6f

Please sign in to comment.