From 7f5ea9260ecd5453c481268476b1071f753f2bb5 Mon Sep 17 00:00:00 2001 From: Chris Bono Date: Mon, 17 Oct 2022 17:06:38 -0500 Subject: [PATCH] [SB3 Update] Config prop driven README updates --- .../header-enricher-processor/README.adoc | 2 +- .../http-request-processor/README.adoc | 2 +- .../image-recognition-processor/README.adoc | 12 ++++---- .../object-detection-processor/README.adoc | 14 +++++----- .../README.adoc | 10 +++---- .../processor/splitter-processor/README.adoc | 4 +-- .../twitter-trend-processor/README.adoc | 2 +- .../sink/elasticsearch-sink/README.adoc | 8 +++--- applications/sink/file-sink/README.adoc | 8 +++--- applications/sink/ftp-sink/README.adoc | 16 +++++------ applications/sink/jdbc-sink/README.adoc | 10 +++---- applications/sink/log-sink/README.adoc | 2 +- applications/sink/mqtt-sink/README.adoc | 28 +++++++++---------- applications/sink/rabbit-sink/README.adoc | 10 +++---- applications/sink/router-sink/README.adoc | 6 ++-- applications/sink/rsocket-sink/README.adoc | 4 +-- applications/sink/s3-sink/README.adoc | 2 +- applications/sink/tcp-sink/README.adoc | 14 +++++----- applications/sink/throughput-sink/README.adoc | 2 +- .../sink/twitter-message-sink/README.adoc | 2 +- .../sink/twitter-update-sink/README.adoc | 2 +- applications/sink/websocket-sink/README.adoc | 8 +++--- .../source/cdc-debezium-source/README.adoc | 14 +++++----- applications/source/http-source/README.adoc | 2 +- applications/source/jms-source/README.adoc | 2 +- .../source/load-generator-source/README.adoc | 8 +++--- applications/source/mail-source/README.adoc | 10 +++---- .../source/mongodb-source/README.adoc | 4 +-- applications/source/mqtt-source/README.adoc | 26 ++++++++--------- applications/source/rabbit-source/README.adoc | 18 ++++++------ applications/source/s3-source/README.adoc | 18 ++++++------ applications/source/sftp-source/README.adoc | 2 +- applications/source/syslog-source/README.adoc | 12 ++++---- applications/source/tcp-source/README.adoc | 12 ++++---- applications/source/time-source/README.adoc | 2 +- .../source/twitter-message-source/README.adoc | 6 ++-- .../source/twitter-search-source/README.adoc | 16 +++++------ .../source/twitter-stream-source/README.adoc | 6 ++-- .../source/websocket-source/README.adoc | 6 ++-- applications/source/zeromq-source/README.adoc | 6 ++-- 40 files changed, 169 insertions(+), 169 deletions(-) diff --git a/applications/processor/header-enricher-processor/README.adoc b/applications/processor/header-enricher-processor/README.adoc index ee3972d6..b2e5f8f3 100644 --- a/applications/processor/header-enricher-processor/README.adoc +++ b/applications/processor/header-enricher-processor/README.adoc @@ -12,7 +12,7 @@ The **$$header-enricher$$** $$processor$$ has the following options: //tag::configuration-properties[] $$header.enricher.headers$$:: $$\n separated properties representing headers in which values are SpEL expressions, e.g foo='bar' \n baz=payload.baz.$$ *($$Properties$$, default: `$$$$`)* -$$header.enricher.overwrite$$:: $$set to true to overwrite any existing message headers.$$ *($$Boolean$$, default: `$$$$`)* +$$header.enricher.overwrite$$:: $$set to true to overwrite any existing message headers.$$ *($$Boolean$$, default: `$$false$$`)* //end::configuration-properties[] //end::ref-doc[] diff --git a/applications/processor/http-request-processor/README.adoc b/applications/processor/http-request-processor/README.adoc index b4ef1306..44a8b477 100644 --- a/applications/processor/http-request-processor/README.adoc +++ b/applications/processor/http-request-processor/README.adoc @@ -53,7 +53,7 @@ $$expected-response-type$$:: $$The type used to interpret the response.$$ *($$Cl $$headers-expression$$:: $$A SpEL expression used to derive the http headers map to use.$$ *($$Expression$$, default: `$$$$`)* $$http-method-expression$$:: $$A SpEL expression to derive the request method from the incoming message.$$ *($$Expression$$, default: `$$$$`)* $$reply-expression$$:: $$A SpEL expression used to compute the final result, applied against the whole http {@link org.springframework.http.ResponseEntity}.$$ *($$Expression$$, default: `$$$$`)* -$$timeout$$:: $$Request timeout in milliseconds.$$ *($$Long$$, default: `$$$$`)* +$$timeout$$:: $$Request timeout in milliseconds.$$ *($$Long$$, default: `$$30000$$`)* $$url-expression$$:: $$A SpEL expression against incoming message to determine the URL to use.$$ *($$Expression$$, default: `$$$$`)* === spring.codec diff --git a/applications/processor/image-recognition-processor/README.adoc b/applications/processor/image-recognition-processor/README.adoc index 71a84301..7fb79c0b 100644 --- a/applications/processor/image-recognition-processor/README.adoc +++ b/applications/processor/image-recognition-processor/README.adoc @@ -41,13 +41,13 @@ If the incoming type is `byte[]` and the content type is set to `application/oct == Options //tag::configuration-properties[] -$$image.recognition.cache-model$$:: $$cache the pre-trained tensorflow model.$$ *($$Boolean$$, default: `$$$$`)* -$$image.recognition.debug-output$$:: $$$$ *($$Boolean$$, default: `$$$$`)* -$$image.recognition.debug-output-path$$:: $$$$ *($$String$$, default: `$$$$`)* -$$image.recognition.model$$:: $$pre-trained tensorflow image recognition model. Note that the model must match the selected model type!$$ *($$String$$, default: `$$$$`)* +$$image.recognition.cache-model$$:: $$cache the pre-trained tensorflow model.$$ *($$Boolean$$, default: `$$true$$`)* +$$image.recognition.debug-output$$:: $$$$ *($$Boolean$$, default: `$$false$$`)* +$$image.recognition.debug-output-path$$:: $$$$ *($$String$$, default: `$$image-recognition-result.png$$`)* +$$image.recognition.model$$:: $$pre-trained tensorflow image recognition model. Note that the model must match the selected model type!$$ *($$String$$, default: `$$https://storage.googleapis.com/mobilenet_v2/checkpoints/mobilenet_v2_1.4_224.tgz#mobilenet_v2_1.4_224_frozen.pb$$`)* $$image.recognition.model-type$$:: $$Supports three different pre-trained tensorflow image recognition models: Inception, MobileNetV1 and MobileNetV2 1. Inception graph uses 'input' as input and 'output' as output. 2. MobileNetV2 pre-trained models: https://github.com/tensorflow/models/tree/master/research/slim/nets/mobilenet#pretrained-models - normalized image size is always square (e.g. H=W) - graph uses 'input' as input and 'MobilenetV2/Predictions/Reshape_1' as output. 3. MobileNetV1 pre-trained models: https://github.com/tensorflow/models/blob/master/research/slim/nets/mobilenet_v1.md#pre-trained-models - graph uses 'input' as input and 'MobilenetV1/Predictions/Reshape_1' as output.$$ *($$ModelType$$, default: `$$$$`, possible values: `inception`,`mobilenetv1`,`mobilenetv2`)* -$$image.recognition.normalized-image-size$$:: $$Normalized image size.$$ *($$Integer$$, default: `$$$$`)* -$$image.recognition.response-size$$:: $$number of recognized images.$$ *($$Integer$$, default: `$$$$`)* +$$image.recognition.normalized-image-size$$:: $$Normalized image size.$$ *($$Integer$$, default: `$$224$$`)* +$$image.recognition.response-size$$:: $$number of recognized images.$$ *($$Integer$$, default: `$$5$$`)* //end::configuration-properties[] //end::ref-doc[] diff --git a/applications/processor/object-detection-processor/README.adoc b/applications/processor/object-detection-processor/README.adoc index eba703b3..345fa79c 100644 --- a/applications/processor/object-detection-processor/README.adoc +++ b/applications/processor/object-detection-processor/README.adoc @@ -43,14 +43,14 @@ The incoming type is `byte[]`, and the content type is `application/octet-stream == Options //tag::configuration-properties[] -$$object.detection.cache-model$$:: $$$$ *($$Boolean$$, default: `$$$$`)* -$$object.detection.confidence$$:: $$$$ *($$Float$$, default: `$$$$`)* -$$object.detection.debug-output$$:: $$$$ *($$Boolean$$, default: `$$$$`)* -$$object.detection.debug-output-path$$:: $$$$ *($$String$$, default: `$$$$`)* -$$object.detection.labels$$:: $$Labels URI.$$ *($$String$$, default: `$$$$`)* -$$object.detection.model$$:: $$pre-trained tensorflow object detection model.$$ *($$String$$, default: `$$$$`)* +$$object.detection.cache-model$$:: $$$$ *($$Boolean$$, default: `$$true$$`)* +$$object.detection.confidence$$:: $$$$ *($$Float$$, default: `$$0.4$$`)* +$$object.detection.debug-output$$:: $$$$ *($$Boolean$$, default: `$$false$$`)* +$$object.detection.debug-output-path$$:: $$$$ *($$String$$, default: `$$object-detection-result.png$$`)* +$$object.detection.labels$$:: $$Labels URI.$$ *($$String$$, default: `$$https://storage.googleapis.com/scdf-tensorflow-models/object-detection/mscoco_label_map.pbtxt$$`)* +$$object.detection.model$$:: $$pre-trained tensorflow object detection model.$$ *($$String$$, default: `$$https://download.tensorflow.org/models/object_detection/ssdlite_mobilenet_v2_coco_2018_05_09.tar.gz#frozen_inference_graph.pb$$`)* $$object.detection.response-size$$:: $$$$ *($$Integer$$, default: `$$$$`)* -$$object.detection.with-masks$$:: $$$$ *($$Boolean$$, default: `$$$$`)* +$$object.detection.with-masks$$:: $$$$ *($$Boolean$$, default: `$$false$$`)* //end::configuration-properties[] //end::ref-doc[] diff --git a/applications/processor/semantic-segmentation-processor/README.adoc b/applications/processor/semantic-segmentation-processor/README.adoc index c2f6228b..2a8ba95a 100644 --- a/applications/processor/semantic-segmentation-processor/README.adoc +++ b/applications/processor/semantic-segmentation-processor/README.adoc @@ -30,11 +30,11 @@ The output header json format represents the color pixel map computed from the i == Options //tag::configuration-properties[] -$$semantic.segmentation.color-map-uri$$:: $$Every pre-trained model is based on certain object color maps. The pre-defined options are: - classpath:/colormap/citymap_colormap.json - classpath:/colormap/ade20k_colormap.json - classpath:/colormap/black_white_colormap.json - classpath:/colormap/mapillary_colormap.json$$ *($$String$$, default: `$$$$`)* -$$semantic.segmentation.debug-output$$:: $$save output image inn the local debugOutputPath path.$$ *($$Boolean$$, default: `$$$$`)* -$$semantic.segmentation.debug-output-path$$:: $$$$ *($$String$$, default: `$$$$`)* -$$semantic.segmentation.mask-transparency$$:: $$The alpha color of the computed segmentation mask image.$$ *($$Float$$, default: `$$$$`)* -$$semantic.segmentation.model$$:: $$pre-trained tensorflow semantic segmentation model.$$ *($$String$$, default: `$$$$`)* +$$semantic.segmentation.color-map-uri$$:: $$Every pre-trained model is based on certain object color maps. The pre-defined options are: - classpath:/colormap/citymap_colormap.json - classpath:/colormap/ade20k_colormap.json - classpath:/colormap/black_white_colormap.json - classpath:/colormap/mapillary_colormap.json$$ *($$String$$, default: `$$classpath:/colormap/citymap_colormap.json$$`)* +$$semantic.segmentation.debug-output$$:: $$save output image inn the local debugOutputPath path.$$ *($$Boolean$$, default: `$$false$$`)* +$$semantic.segmentation.debug-output-path$$:: $$$$ *($$String$$, default: `$$semantic-segmentation-result.png$$`)* +$$semantic.segmentation.mask-transparency$$:: $$The alpha color of the computed segmentation mask image.$$ *($$Float$$, default: `$$0.45$$`)* +$$semantic.segmentation.model$$:: $$pre-trained tensorflow semantic segmentation model.$$ *($$String$$, default: `$$https://download.tensorflow.org/models/deeplabv3_mnv2_cityscapes_train_2018_02_05.tar.gz#frozen_inference_graph.pb$$`)* $$semantic.segmentation.output-type$$:: $$Specifies the output image type. You can return either the input image with the computed mask overlay, or the mask alone.$$ *($$OutputType$$, default: `$$$$`, possible values: `blended`,`mask`)* //end::configuration-properties[] diff --git a/applications/processor/splitter-processor/README.adoc b/applications/processor/splitter-processor/README.adoc index 2dc0d4bd..08834790 100644 --- a/applications/processor/splitter-processor/README.adoc +++ b/applications/processor/splitter-processor/README.adoc @@ -17,12 +17,12 @@ If the incoming type is `byte[]` and the content type is set to `text/plain` or == Options //tag::configuration-properties[] -$$splitter.apply-sequence$$:: $$Add correlation/sequence information in headers to facilitate later aggregation.$$ *($$Boolean$$, default: `$$$$`)* +$$splitter.apply-sequence$$:: $$Add correlation/sequence information in headers to facilitate later aggregation.$$ *($$Boolean$$, default: `$$true$$`)* $$splitter.charset$$:: $$The charset to use when converting bytes in text-based files to String.$$ *($$String$$, default: `$$$$`)* $$splitter.delimiters$$:: $$When expression is null, delimiters to use when tokenizing {@link String} payloads.$$ *($$String$$, default: `$$$$`)* $$splitter.expression$$:: $$A SpEL expression for splitting payloads.$$ *($$String$$, default: `$$$$`)* $$splitter.file-markers$$:: $$Set to true or false to use a {@code FileSplitter} (to split text-based files by line) that includes (or not) beginning/end of file markers.$$ *($$Boolean$$, default: `$$$$`)* -$$splitter.markers-json$$:: $$When 'fileMarkers == true', specify if they should be produced as FileSplitter.FileMarker objects or JSON.$$ *($$Boolean$$, default: `$$$$`)* +$$splitter.markers-json$$:: $$When 'fileMarkers == true', specify if they should be produced as FileSplitter.FileMarker objects or JSON.$$ *($$Boolean$$, default: `$$true$$`)* //end::configuration-properties[] //end::ref-doc[] diff --git a/applications/processor/twitter-trend-processor/README.adoc b/applications/processor/twitter-trend-processor/README.adoc index dbf84aac..691466f8 100644 --- a/applications/processor/twitter-trend-processor/README.adoc +++ b/applications/processor/twitter-trend-processor/README.adoc @@ -36,7 +36,7 @@ $$lon$$:: $$If provided with a lat parameter the available trend locations will === twitter.trend -$$location-id$$:: $$The Yahoo! Where On Earth ID of the location to return trending information for. Global information is available by using 1 as the WOEID.$$ *($$Expression$$, default: `$$$$`)* +$$location-id$$:: $$The Yahoo! Where On Earth ID of the location to return trending information for. Global information is available by using 1 as the WOEID.$$ *($$Expression$$, default: `$$payload$$`)* $$trend-query-type$$:: $$$$ *($$TrendQueryType$$, default: `$$$$`, possible values: `trend`,`trendLocation`)* //end::configuration-properties[] diff --git a/applications/sink/elasticsearch-sink/README.adoc b/applications/sink/elasticsearch-sink/README.adoc index 0dc53a69..967225e1 100644 --- a/applications/sink/elasticsearch-sink/README.adoc +++ b/applications/sink/elasticsearch-sink/README.adoc @@ -15,13 +15,13 @@ This is provided mainly for direct invocation of the consumer. The **$$Elasticsearch$$** $$sink$$ has the following options: //tag::configuration-properties[] -$$elasticsearch.consumer.async$$:: $$Indicates whether the indexing operation is async or not. By default indexing is done synchronously.$$ *($$Boolean$$, default: `$$$$`)* -$$elasticsearch.consumer.batch-size$$:: $$Number of items to index for each request. It defaults to 1. For values greater than 1 bulk indexing API will be used.$$ *($$Integer$$, default: `$$$$`)* -$$elasticsearch.consumer.group-timeout$$:: $$Timeout in milliseconds after which message group is flushed when bulk indexing is active. It defaults to -1, meaning no automatic flush of idle message groups occurs.$$ *($$Long$$, default: `$$$$`)* +$$elasticsearch.consumer.async$$:: $$Indicates whether the indexing operation is async or not. By default indexing is done synchronously.$$ *($$Boolean$$, default: `$$false$$`)* +$$elasticsearch.consumer.batch-size$$:: $$Number of items to index for each request. It defaults to 1. For values greater than 1 bulk indexing API will be used.$$ *($$Integer$$, default: `$$1$$`)* +$$elasticsearch.consumer.group-timeout$$:: $$Timeout in milliseconds after which message group is flushed when bulk indexing is active. It defaults to -1, meaning no automatic flush of idle message groups occurs.$$ *($$Long$$, default: `$$-1$$`)* $$elasticsearch.consumer.id$$:: $$The id of the document to index. If set, the INDEX_ID header value overrides this property on a per message basis.$$ *($$Expression$$, default: `$$$$`)* $$elasticsearch.consumer.index$$:: $$Name of the index. If set, the INDEX_NAME header value overrides this property on a per message basis.$$ *($$String$$, default: `$$$$`)* $$elasticsearch.consumer.routing$$:: $$Indicates the shard to route to. If not provided, Elasticsearch will default to a hash of the document id.$$ *($$String$$, default: `$$$$`)* -$$elasticsearch.consumer.timeout-seconds$$:: $$Timeout for the shard to be available. If not set, it defaults to 1 minute set by the Elasticsearch client.$$ *($$Long$$, default: `$$$$`)* +$$elasticsearch.consumer.timeout-seconds$$:: $$Timeout for the shard to be available. If not set, it defaults to 1 minute set by the Elasticsearch client.$$ *($$Long$$, default: `$$0$$`)* //end::configuration-properties[] == Examples of running this sink diff --git a/applications/sink/file-sink/README.adoc b/applications/sink/file-sink/README.adoc index de4922ca..d09c637a 100644 --- a/applications/sink/file-sink/README.adoc +++ b/applications/sink/file-sink/README.adoc @@ -15,14 +15,14 @@ The file sink app writes each message it receives to a file. The `file-sink` has the following options: //tag::configuration-properties[] -$$file.consumer.binary$$:: $$A flag to indicate whether adding a newline after the write should be suppressed.$$ *($$Boolean$$, default: `$$$$`)* -$$file.consumer.charset$$:: $$The charset to use when writing text content.$$ *($$String$$, default: `$$$$`)* +$$file.consumer.binary$$:: $$A flag to indicate whether adding a newline after the write should be suppressed.$$ *($$Boolean$$, default: `$$false$$`)* +$$file.consumer.charset$$:: $$The charset to use when writing text content.$$ *($$String$$, default: `$$UTF-8$$`)* $$file.consumer.directory$$:: $$The parent directory of the target file.$$ *($$File$$, default: `$$$$`)* $$file.consumer.directory-expression$$:: $$The expression to evaluate for the parent directory of the target file.$$ *($$String$$, default: `$$$$`)* $$file.consumer.mode$$:: $$The FileExistsMode to use if the target file already exists.$$ *($$FileExistsMode$$, default: `$$$$`, possible values: `APPEND`,`APPEND_NO_FLUSH`,`FAIL`,`IGNORE`,`REPLACE`,`REPLACE_IF_MODIFIED`)* -$$file.consumer.name$$:: $$The name of the target file.$$ *($$String$$, default: `$$$$`)* +$$file.consumer.name$$:: $$The name of the target file.$$ *($$String$$, default: `$$file-consumer$$`)* $$file.consumer.name-expression$$:: $$The expression to evaluate for the name of the target file.$$ *($$String$$, default: `$$$$`)* -$$file.consumer.suffix$$:: $$The suffix to append to file name.$$ *($$String$$, default: `$$$$`)* +$$file.consumer.suffix$$:: $$The suffix to append to file name.$$ *($$String$$, default: `$$$$`)* //end::configuration-properties[] //end::ref-doc[] diff --git a/applications/sink/ftp-sink/README.adoc b/applications/sink/ftp-sink/README.adoc index 3fc09b39..fae1cadd 100644 --- a/applications/sink/ftp-sink/README.adoc +++ b/applications/sink/ftp-sink/README.adoc @@ -37,22 +37,22 @@ Properties grouped by prefix: === ftp.consumer -$$auto-create-dir$$:: $$Whether or not to create the remote directory.$$ *($$Boolean$$, default: `$$$$`)* +$$auto-create-dir$$:: $$Whether or not to create the remote directory.$$ *($$Boolean$$, default: `$$true$$`)* $$filename-expression$$:: $$A SpEL expression to generate the remote file name.$$ *($$String$$, default: `$$$$`)* $$mode$$:: $$Action to take if the remote file already exists.$$ *($$FileExistsMode$$, default: `$$$$`, possible values: `APPEND`,`APPEND_NO_FLUSH`,`FAIL`,`IGNORE`,`REPLACE`,`REPLACE_IF_MODIFIED`)* -$$remote-dir$$:: $$The remote FTP directory.$$ *($$String$$, default: `$$$$`)* -$$remote-file-separator$$:: $$The remote file separator.$$ *($$String$$, default: `$$$$`)* -$$temporary-remote-dir$$:: $$A temporary directory where the file will be written if '#isUseTemporaryFilename()' is true.$$ *($$String$$, default: `$$$$`)* -$$tmp-file-suffix$$:: $$The suffix to use while the transfer is in progress.$$ *($$String$$, default: `$$$$`)* -$$use-temporary-filename$$:: $$Whether or not to write to a temporary file and rename.$$ *($$Boolean$$, default: `$$$$`)* +$$remote-dir$$:: $$The remote FTP directory.$$ *($$String$$, default: `$$/$$`)* +$$remote-file-separator$$:: $$The remote file separator.$$ *($$String$$, default: `$$/$$`)* +$$temporary-remote-dir$$:: $$A temporary directory where the file will be written if '#isUseTemporaryFilename()' is true.$$ *($$String$$, default: `$$/$$`)* +$$tmp-file-suffix$$:: $$The suffix to use while the transfer is in progress.$$ *($$String$$, default: `$$.tmp$$`)* +$$use-temporary-filename$$:: $$Whether or not to write to a temporary file and rename.$$ *($$Boolean$$, default: `$$true$$`)* === ftp.factory $$cache-sessions$$:: $$Cache sessions.$$ *($$Boolean$$, default: `$$$$`)* $$client-mode$$:: $$The client mode to use for the FTP session.$$ *($$ClientMode$$, default: `$$$$`, possible values: `ACTIVE`,`PASSIVE`)* -$$host$$:: $$The host name of the server.$$ *($$String$$, default: `$$$$`)* +$$host$$:: $$The host name of the server.$$ *($$String$$, default: `$$localhost$$`)* $$password$$:: $$The password to use to connect to the server.$$ *($$String$$, default: `$$$$`)* -$$port$$:: $$The port of the server.$$ *($$Integer$$, default: `$$$$`)* +$$port$$:: $$The port of the server.$$ *($$Integer$$, default: `$$21$$`)* $$username$$:: $$The username to use to connect to the server.$$ *($$String$$, default: `$$$$`)* //end::configuration-properties[] diff --git a/applications/sink/jdbc-sink/README.adoc b/applications/sink/jdbc-sink/README.adoc index 7e2e663f..745ff19d 100644 --- a/applications/sink/jdbc-sink/README.adoc +++ b/applications/sink/jdbc-sink/README.adoc @@ -46,11 +46,11 @@ Properties grouped by prefix: === jdbc.consumer -$$batch-size$$:: $$Threshold in number of messages when data will be flushed to database table.$$ *($$Integer$$, default: `$$$$`)* -$$columns$$:: $$The comma separated colon-based pairs of column names and SpEL expressions for values to insert/update. Names are used at initialization time to issue the DDL.$$ *($$String$$, default: `$$$$`)* -$$idle-timeout$$:: $$Idle timeout in milliseconds when data is automatically flushed to database table.$$ *($$Long$$, default: `$$$$`)* -$$initialize$$:: $$'true', 'false' or the location of a custom initialization script for the table.$$ *($$String$$, default: `$$$$`)* -$$table-name$$:: $$The name of the table to write into.$$ *($$String$$, default: `$$$$`)* +$$batch-size$$:: $$Threshold in number of messages when data will be flushed to database table.$$ *($$Integer$$, default: `$$1$$`)* +$$columns$$:: $$The comma separated colon-based pairs of column names and SpEL expressions for values to insert/update. Names are used at initialization time to issue the DDL.$$ *($$String$$, default: `$$payload:payload.toString()$$`)* +$$idle-timeout$$:: $$Idle timeout in milliseconds when data is automatically flushed to database table.$$ *($$Long$$, default: `$$-1$$`)* +$$initialize$$:: $$'true', 'false' or the location of a custom initialization script for the table.$$ *($$String$$, default: `$$false$$`)* +$$table-name$$:: $$The name of the table to write into.$$ *($$String$$, default: `$$messages$$`)* === spring.datasource diff --git a/applications/sink/log-sink/README.adoc b/applications/sink/log-sink/README.adoc index d63e5ea0..44b7671e 100644 --- a/applications/sink/log-sink/README.adoc +++ b/applications/sink/log-sink/README.adoc @@ -13,7 +13,7 @@ The **$$log$$** $$sink$$ has the following options: //tag::configuration-properties[] -$$log.expression$$:: $$A SpEL expression (against the incoming message) to evaluate as the logged message.$$ *($$String$$, default: `$$$$`)* +$$log.expression$$:: $$A SpEL expression (against the incoming message) to evaluate as the logged message.$$ *($$String$$, default: `$$payload$$`)* $$log.level$$:: $$The level at which to log messages.$$ *($$Level$$, default: `$$$$`, possible values: `FATAL`,`ERROR`,`WARN`,`INFO`,`DEBUG`,`TRACE`)* $$log.name$$:: $$The name of the logger to use.$$ *($$String$$, default: `$$$$`)* //end::configuration-properties[] diff --git a/applications/sink/mqtt-sink/README.adoc b/applications/sink/mqtt-sink/README.adoc index a27dd110..61ccba5b 100644 --- a/applications/sink/mqtt-sink/README.adoc +++ b/applications/sink/mqtt-sink/README.adoc @@ -18,24 +18,24 @@ Properties grouped by prefix: === mqtt -$$clean-session$$:: $$whether the client and server should remember state across restarts and reconnects.$$ *($$Boolean$$, default: `$$$$`)* -$$connection-timeout$$:: $$the connection timeout in seconds.$$ *($$Integer$$, default: `$$$$`)* -$$keep-alive-interval$$:: $$the ping interval in seconds.$$ *($$Integer$$, default: `$$$$`)* -$$password$$:: $$the password to use when connecting to the broker.$$ *($$String$$, default: `$$$$`)* -$$persistence$$:: $$'memory' or 'file'.$$ *($$String$$, default: `$$$$`)* -$$persistence-directory$$:: $$Persistence directory.$$ *($$String$$, default: `$$$$`)* +$$clean-session$$:: $$whether the client and server should remember state across restarts and reconnects.$$ *($$Boolean$$, default: `$$true$$`)* +$$connection-timeout$$:: $$the connection timeout in seconds.$$ *($$Integer$$, default: `$$30$$`)* +$$keep-alive-interval$$:: $$the ping interval in seconds.$$ *($$Integer$$, default: `$$60$$`)* +$$password$$:: $$the password to use when connecting to the broker.$$ *($$String$$, default: `$$guest$$`)* +$$persistence$$:: $$'memory' or 'file'.$$ *($$String$$, default: `$$memory$$`)* +$$persistence-directory$$:: $$Persistence directory.$$ *($$String$$, default: `$$/tmp/paho$$`)* $$ssl-properties$$:: $$MQTT Client SSL properties.$$ *($$Map$$, default: `$$$$`)* -$$url$$:: $$location of the mqtt broker(s) (comma-delimited list).$$ *($$String[]$$, default: `$$$$`)* -$$username$$:: $$the username to use when connecting to the broker.$$ *($$String$$, default: `$$$$`)* +$$url$$:: $$location of the mqtt broker(s) (comma-delimited list).$$ *($$String[]$$, default: `$$[tcp://localhost:1883]$$`)* +$$username$$:: $$the username to use when connecting to the broker.$$ *($$String$$, default: `$$guest$$`)* === mqtt.consumer -$$async$$:: $$whether or not to use async sends.$$ *($$Boolean$$, default: `$$$$`)* -$$charset$$:: $$the charset used to convert a String payload to byte[].$$ *($$String$$, default: `$$$$`)* -$$client-id$$:: $$identifies the client.$$ *($$String$$, default: `$$$$`)* -$$qos$$:: $$the quality of service to use.$$ *($$Integer$$, default: `$$$$`)* -$$retained$$:: $$whether to set the 'retained' flag.$$ *($$Boolean$$, default: `$$$$`)* -$$topic$$:: $$the topic to which the sink will publish.$$ *($$String$$, default: `$$$$`)* +$$async$$:: $$whether or not to use async sends.$$ *($$Boolean$$, default: `$$false$$`)* +$$charset$$:: $$the charset used to convert a String payload to byte[].$$ *($$String$$, default: `$$UTF-8$$`)* +$$client-id$$:: $$identifies the client.$$ *($$String$$, default: `$$stream.client.id.sink$$`)* +$$qos$$:: $$the quality of service to use.$$ *($$Integer$$, default: `$$1$$`)* +$$retained$$:: $$whether to set the 'retained' flag.$$ *($$Boolean$$, default: `$$false$$`)* +$$topic$$:: $$the topic to which the sink will publish.$$ *($$String$$, default: `$$stream.mqtt$$`)* //end::configuration-properties[] //end::ref-doc[] diff --git a/applications/sink/rabbit-sink/README.adoc b/applications/sink/rabbit-sink/README.adoc index 2716cc70..6aba9f75 100644 --- a/applications/sink/rabbit-sink/README.adoc +++ b/applications/sink/rabbit-sink/README.adoc @@ -16,12 +16,12 @@ Properties grouped by prefix: === rabbit $$converter-bean-name$$:: $$The bean name for a custom message converter; if omitted, a SimpleMessageConverter is used. If 'jsonConverter', a Jackson2JsonMessageConverter bean will be created for you.$$ *($$String$$, default: `$$$$`)* -$$exchange$$:: $$Exchange name - overridden by exchangeNameExpression, if supplied.$$ *($$String$$, default: `$$$$`)* +$$exchange$$:: $$Exchange name - overridden by exchangeNameExpression, if supplied.$$ *($$String$$, default: `$$$$`)* $$exchange-expression$$:: $$A SpEL expression that evaluates to an exchange name.$$ *($$Expression$$, default: `$$$$`)* -$$headers-mapped-last$$:: $$When mapping headers for the outbound message, determine whether the headers are mapped before the message is converted, or afterwards.$$ *($$Boolean$$, default: `$$$$`)* -$$mapped-request-headers$$:: $$Headers that will be mapped.$$ *($$String[]$$, default: `$$$$`)* -$$own-connection$$:: $$When true, use a separate connection based on the boot properties.$$ *($$Boolean$$, default: `$$$$`)* -$$persistent-delivery-mode$$:: $$Default delivery mode when 'amqp_deliveryMode' header is not present, true for PERSISTENT.$$ *($$Boolean$$, default: `$$$$`)* +$$headers-mapped-last$$:: $$When mapping headers for the outbound message, determine whether the headers are mapped before the message is converted, or afterwards.$$ *($$Boolean$$, default: `$$true$$`)* +$$mapped-request-headers$$:: $$Headers that will be mapped.$$ *($$String[]$$, default: `$$[*]$$`)* +$$own-connection$$:: $$When true, use a separate connection based on the boot properties.$$ *($$Boolean$$, default: `$$false$$`)* +$$persistent-delivery-mode$$:: $$Default delivery mode when 'amqp_deliveryMode' header is not present, true for PERSISTENT.$$ *($$Boolean$$, default: `$$false$$`)* $$routing-key$$:: $$Routing key - overridden by routingKeyExpression, if supplied.$$ *($$String$$, default: `$$$$`)* $$routing-key-expression$$:: $$A SpEL expression that evaluates to a routing key.$$ *($$Expression$$, default: `$$$$`)* diff --git a/applications/sink/router-sink/README.adoc b/applications/sink/router-sink/README.adoc index 4a5dfc67..4b8b3853 100644 --- a/applications/sink/router-sink/README.adoc +++ b/applications/sink/router-sink/README.adoc @@ -8,11 +8,11 @@ This application routes messages to named channels. The **$$router$$** $$sink$$ has the following options: //tag::configuration-properties[] -$$router.default-output-channel$$:: $$Where to send un-routable messages.$$ *($$String$$, default: `$$$$`)* +$$router.default-output-channel$$:: $$Where to send un-routable messages.$$ *($$String$$, default: `$$nullChannel$$`)* $$router.destination-mappings$$:: $$Destination mappings as a new line delimited string of name-value pairs, e.g. 'foo=bar\n baz=car'.$$ *($$Properties$$, default: `$$$$`)* $$router.expression$$:: $$The expression to be applied to the message to determine the channel(s) to route to. Note that the payload wire format for content types such as text, json or xml is byte[] not String!. Consult the documentation for how to handle byte array payload content.$$ *($$Expression$$, default: `$$$$`)* -$$router.refresh-delay$$:: $$How often to check for script changes in ms (if present); < 0 means don't refresh.$$ *($$Integer$$, default: `$$$$`)* -$$router.resolution-required$$:: $$Whether or not channel resolution is required.$$ *($$Boolean$$, default: `$$$$`)* +$$router.refresh-delay$$:: $$How often to check for script changes in ms (if present); < 0 means don't refresh.$$ *($$Integer$$, default: `$$60000$$`)* +$$router.resolution-required$$:: $$Whether or not channel resolution is required.$$ *($$Boolean$$, default: `$$false$$`)* $$router.script$$:: $$The location of a groovy script that returns channels or channel mapping resolution keys.$$ *($$Resource$$, default: `$$$$`)* $$router.variables$$:: $$Variable bindings as a new line delimited string of name-value pairs, e.g. 'foo=bar\n baz=car'.$$ *($$Properties$$, default: `$$$$`)* $$router.variables-location$$:: $$The location of a properties file containing custom script variable bindings.$$ *($$Resource$$, default: `$$$$`)* diff --git a/applications/sink/rsocket-sink/README.adoc b/applications/sink/rsocket-sink/README.adoc index 73c00a15..fe5359b9 100644 --- a/applications/sink/rsocket-sink/README.adoc +++ b/applications/sink/rsocket-sink/README.adoc @@ -8,8 +8,8 @@ RSocket sink to send data using RSocket protocols' fire and forget strategy. The **$$rsocket$$** $$sink$$ has the following options: //tag::configuration-properties[] -$$rsocket.consumer.host$$:: $$RSocket host.$$ *($$String$$, default: `$$$$`)* -$$rsocket.consumer.port$$:: $$RSocket port.$$ *($$Integer$$, default: `$$$$`)* +$$rsocket.consumer.host$$:: $$RSocket host.$$ *($$String$$, default: `$$localhost$$`)* +$$rsocket.consumer.port$$:: $$RSocket port.$$ *($$Integer$$, default: `$$7000$$`)* $$rsocket.consumer.route$$:: $$Route used for RSocket.$$ *($$String$$, default: `$$$$`)* $$rsocket.consumer.uri$$:: $$URI that can be used for websocket based transport.$$ *($$URI$$, default: `$$$$`)* //end::configuration-properties[] diff --git a/applications/sink/s3-sink/README.adoc b/applications/sink/s3-sink/README.adoc index 0469c487..be85aaec 100644 --- a/applications/sink/s3-sink/README.adoc +++ b/applications/sink/s3-sink/README.adoc @@ -21,7 +21,7 @@ Properties grouped by prefix: === s3.common $$endpoint-url$$:: $$Optional endpoint url to connect to s3 compatible storage.$$ *($$String$$, default: `$$$$`)* -$$path-style-access$$:: $$Use path style access.$$ *($$Boolean$$, default: `$$$$`)* +$$path-style-access$$:: $$Use path style access.$$ *($$Boolean$$, default: `$$false$$`)* === s3.consumer diff --git a/applications/sink/tcp-sink/README.adoc b/applications/sink/tcp-sink/README.adoc index d30b4d92..5f940b24 100644 --- a/applications/sink/tcp-sink/README.adoc +++ b/applications/sink/tcp-sink/README.adoc @@ -16,18 +16,18 @@ Properties grouped by prefix: === tcp.consumer -$$charset$$:: $$The charset used when converting from bytes to String.$$ *($$String$$, default: `$$$$`)* -$$close$$:: $$Whether to close the socket after each message.$$ *($$Boolean$$, default: `$$$$`)* +$$charset$$:: $$The charset used when converting from bytes to String.$$ *($$String$$, default: `$$UTF-8$$`)* +$$close$$:: $$Whether to close the socket after each message.$$ *($$Boolean$$, default: `$$false$$`)* $$encoder$$:: $$The encoder to use when sending messages.$$ *($$Encoding$$, default: `$$$$`, possible values: `CRLF`,`LF`,`NULL`,`STXETX`,`RAW`,`L1`,`L2`,`L4`)* $$host$$:: $$The host to which this sink will connect.$$ *($$String$$, default: `$$$$`)* === tcp -$$nio$$:: $$Whether or not to use NIO.$$ *($$Boolean$$, default: `$$$$`)* -$$port$$:: $$The port on which to listen; 0 for the OS to choose a port.$$ *($$Integer$$, default: `$$$$`)* -$$reverse-lookup$$:: $$Perform a reverse DNS lookup on the remote IP Address; if false, just the IP address is included in the message headers.$$ *($$Boolean$$, default: `$$$$`)* -$$socket-timeout$$:: $$The timeout (ms) before closing the socket when no data is received.$$ *($$Integer$$, default: `$$$$`)* -$$use-direct-buffers$$:: $$Whether or not to use direct buffers.$$ *($$Boolean$$, default: `$$$$`)* +$$nio$$:: $$Whether or not to use NIO.$$ *($$Boolean$$, default: `$$false$$`)* +$$port$$:: $$The port on which to listen; 0 for the OS to choose a port.$$ *($$Integer$$, default: `$$1234$$`)* +$$reverse-lookup$$:: $$Perform a reverse DNS lookup on the remote IP Address; if false, just the IP address is included in the message headers.$$ *($$Boolean$$, default: `$$false$$`)* +$$socket-timeout$$:: $$The timeout (ms) before closing the socket when no data is received.$$ *($$Integer$$, default: `$$120000$$`)* +$$use-direct-buffers$$:: $$Whether or not to use direct buffers.$$ *($$Boolean$$, default: `$$false$$`)* //end::configuration-properties[] == Available Encoders diff --git a/applications/sink/throughput-sink/README.adoc b/applications/sink/throughput-sink/README.adoc index b7589fa8..1a077a49 100644 --- a/applications/sink/throughput-sink/README.adoc +++ b/applications/sink/throughput-sink/README.adoc @@ -8,7 +8,7 @@ Sink that will count messages and log the observed throughput at a selected inte The **$$throughput$$** $$sink$$ has the following options: //tag::configuration-properties[] -$$throughput.report-every-ms$$:: $$how often to report.$$ *($$Integer$$, default: `$$$$`)* +$$throughput.report-every-ms$$:: $$how often to report.$$ *($$Integer$$, default: `$$1000$$`)* //end::configuration-properties[] //end::ref-doc[] diff --git a/applications/sink/twitter-message-sink/README.adoc b/applications/sink/twitter-message-sink/README.adoc index 10c7599a..db22224a 100644 --- a/applications/sink/twitter-message-sink/README.adoc +++ b/applications/sink/twitter-message-sink/README.adoc @@ -19,7 +19,7 @@ For fixed target userId use `userId='666'`. //tag::configuration-properties[] $$twitter.message.update.media-id$$:: $$A media id to associate with the message. A Direct Message may only reference a single media id.$$ *($$Expression$$, default: `$$$$`)* $$twitter.message.update.screen-name$$:: $$The screen name of the user to whom send the direct message.$$ *($$Expression$$, default: `$$$$`)* -$$twitter.message.update.text$$:: $$The direct message text. URL encode as necessary. Max length of 10,000 characters.$$ *($$Expression$$, default: `$$$$`)* +$$twitter.message.update.text$$:: $$The direct message text. URL encode as necessary. Max length of 10,000 characters.$$ *($$Expression$$, default: `$$payload$$`)* $$twitter.message.update.user-id$$:: $$The user id of the user to whom send the direct message.$$ *($$Expression$$, default: `$$$$`)* //end::configuration-properties[] diff --git a/applications/sink/twitter-update-sink/README.adoc b/applications/sink/twitter-update-sink/README.adoc index b8c82580..076390d2 100644 --- a/applications/sink/twitter-update-sink/README.adoc +++ b/applications/sink/twitter-update-sink/README.adoc @@ -26,7 +26,7 @@ $$display-coordinates$$:: $$(SpEL expression) Whether or not to put a pin on the $$in-reply-to-status-id$$:: $$(SpEL expression) The ID of an existing text that the update is in reply to. Note: This parameter will be ignored unless the author of the Tweet this parameter references is mentioned within the text text. Therefore, you must include @username, where username is the author of the referenced Tweet, within the update. When inReplyToStatusId is set the auto_populate_reply_metadata is automatically set as well. Later ensures that leading @mentions will be looked up from the original Tweet, and added to the new Tweet from there. This wil append @mentions into the metadata of an extended Tweet as a reply chain grows, until the limit on @mentions is reached. In cases where the original Tweet has been deleted, the reply will fail.$$ *($$Expression$$, default: `$$$$`)* $$media-ids$$:: $$(SpEL expression) A comma-delimited list of media_ids to associate with the Tweet. You may include up to 4 photos or 1 animated GIF or 1 video in a Tweet. See Uploading Media for further details on uploading media.$$ *($$Expression$$, default: `$$$$`)* $$place-id$$:: $$(SpEL expression) A place in the world.$$ *($$Expression$$, default: `$$$$`)* -$$text$$:: $$(SpEL expression) The text of the text update. URL encode as necessary. t.co link wrapping will affect character counts. Defaults to message's payload$$ *($$Expression$$, default: `$$$$`)* +$$text$$:: $$(SpEL expression) The text of the text update. URL encode as necessary. t.co link wrapping will affect character counts. Defaults to message's payload$$ *($$Expression$$, default: `$$payload$$`)* === twitter.update.location diff --git a/applications/sink/websocket-sink/README.adoc b/applications/sink/websocket-sink/README.adoc index 89bd3f77..9a99b02e 100644 --- a/applications/sink/websocket-sink/README.adoc +++ b/applications/sink/websocket-sink/README.adoc @@ -8,10 +8,10 @@ The following options are supported: //tag::configuration-properties[] $$websocket.consumer.log-level$$:: $$the logLevel for netty channels. Default is WARN$$ *($$String$$, default: `$$$$`)* -$$websocket.consumer.path$$:: $$the path on which a WebsocketSink consumer needs to connect. Default is /websocket$$ *($$String$$, default: `$$$$`)* -$$websocket.consumer.port$$:: $$the port on which the Netty server listens. Default is 9292$$ *($$Integer$$, default: `$$$$`)* -$$websocket.consumer.ssl$$:: $$whether or not to create a {@link io.netty.handler.ssl.SslContext}.$$ *($$Boolean$$, default: `$$$$`)* -$$websocket.consumer.threads$$:: $$the number of threads for the Netty {@link io.netty.channel.EventLoopGroup}. Default is 1$$ *($$Integer$$, default: `$$$$`)* +$$websocket.consumer.path$$:: $$the path on which a WebsocketSink consumer needs to connect. Default is /websocket$$ *($$String$$, default: `$$/websocket$$`)* +$$websocket.consumer.port$$:: $$the port on which the Netty server listens. Default is 9292$$ *($$Integer$$, default: `$$9292$$`)* +$$websocket.consumer.ssl$$:: $$whether or not to create a {@link io.netty.handler.ssl.SslContext}.$$ *($$Boolean$$, default: `$$false$$`)* +$$websocket.consumer.threads$$:: $$the number of threads for the Netty {@link io.netty.channel.EventLoopGroup}. Default is 1$$ *($$Integer$$, default: `$$1$$`)* //end::configuration-properties[] == Examples diff --git a/applications/source/cdc-debezium-source/README.adoc b/applications/source/cdc-debezium-source/README.adoc index a5de1fc6..51511542 100644 --- a/applications/source/cdc-debezium-source/README.adoc +++ b/applications/source/cdc-debezium-source/README.adoc @@ -25,27 +25,27 @@ Properties grouped by prefix: $$config$$:: $$Spring pass-trough wrapper for debezium configuration properties. All properties with a 'cdc.config.' prefix are native Debezium properties. The prefix is removed, converting them into Debezium io.debezium.config.Configuration.$$ *($$Map$$, default: `$$$$`)* $$connector$$:: $$Shortcut for the cdc.config.connector.class property. Either of those can be used as long as they do not contradict with each other.$$ *($$ConnectorType$$, default: `$$$$`, possible values: `mysql`,`postgres`,`mongodb`,`oracle`,`sqlserver`)* $$name$$:: $$Unique name for this sourceConnector instance.$$ *($$String$$, default: `$$$$`)* -$$schema$$:: $$Include the schema's as part of the outbound message.$$ *($$Boolean$$, default: `$$$$`)* +$$schema$$:: $$Include the schema's as part of the outbound message.$$ *($$Boolean$$, default: `$$false$$`)* === cdc.flattening $$add-fields$$:: $$Comma separated list of metadata fields to add to the flattened message. The fields will be prefixed with "__" or "__[<]struct]__", depending on the specification of the struct.$$ *($$String$$, default: `$$$$`)* $$add-headers$$:: $$Comma separated list specify a list of metadata fields to add to the header of the flattened message. The fields will be prefixed with "__" or "__[struct]__".$$ *($$String$$, default: `$$$$`)* $$delete-handling-mode$$:: $$Options for handling deleted records: (1) none - pass the records through, (2) drop - remove the records and (3) rewrite - add a '__deleted' field to the records.$$ *($$DeleteHandlingMode$$, default: `$$$$`, possible values: `drop`,`rewrite`,`none`)* -$$drop-tombstones$$:: $$By default Debezium generates tombstone records to enable Kafka compaction on deleted records. The dropTombstones can suppress the tombstone records.$$ *($$Boolean$$, default: `$$$$`)* -$$enabled$$:: $$Enable flattening the source record events (https://debezium.io/docs/configuration/event-flattening).$$ *($$Boolean$$, default: `$$$$`)* +$$drop-tombstones$$:: $$By default Debezium generates tombstone records to enable Kafka compaction on deleted records. The dropTombstones can suppress the tombstone records.$$ *($$Boolean$$, default: `$$true$$`)* +$$enabled$$:: $$Enable flattening the source record events (https://debezium.io/docs/configuration/event-flattening).$$ *($$Boolean$$, default: `$$true$$`)* === cdc.offset -$$commit-timeout$$:: $$Maximum number of milliseconds to wait for records to flush and partition offset data to be committed to offset storage before cancelling the process and restoring the offset data to be committed in a future attempt.$$ *($$Duration$$, default: `$$$$`)* -$$flush-interval$$:: $$Interval at which to try committing offsets. The default is 1 minute.$$ *($$Duration$$, default: `$$$$`)* +$$commit-timeout$$:: $$Maximum number of milliseconds to wait for records to flush and partition offset data to be committed to offset storage before cancelling the process and restoring the offset data to be committed in a future attempt.$$ *($$Duration$$, default: `$$5000ms$$`)* +$$flush-interval$$:: $$Interval at which to try committing offsets. The default is 1 minute.$$ *($$Duration$$, default: `$$60000ms$$`)* $$policy$$:: $$Offset storage commit policy.$$ *($$OffsetPolicy$$, default: `$$$$`)* $$storage$$:: $$Kafka connector tracks the number processed records and regularly stores the count (as "offsets") in a preconfigured metadata storage. On restart the connector resumes the reading from the last recorded source offset.$$ *($$OffsetStorageType$$, default: `$$$$`, possible values: `memory`,`file`,`kafka`,`metadata`)* === cdc.stream.header -$$convert-connect-headers$$:: $$When true the {@link org.apache.kafka.connect.header.Header} are converted into message headers with the {@link org.apache.kafka.connect.header.Header#key()} as name and {@link org.apache.kafka.connect.header.Header#value()}.$$ *($$Boolean$$, default: `$$$$`)* -$$offset$$:: $$Serializes the source record's offset metadata into the outbound message header under cdc.offset.$$ *($$Boolean$$, default: `$$$$`)* +$$convert-connect-headers$$:: $$When true the {@link org.apache.kafka.connect.header.Header} are converted into message headers with the {@link org.apache.kafka.connect.header.Header#key()} as name and {@link org.apache.kafka.connect.header.Header#value()}.$$ *($$Boolean$$, default: `$$true$$`)* +$$offset$$:: $$Serializes the source record's offset metadata into the outbound message header under cdc.offset.$$ *($$Boolean$$, default: `$$false$$`)* === metadata.store.dynamo-db diff --git a/applications/source/http-source/README.adoc b/applications/source/http-source/README.adoc index cae0807e..2bb03088 100644 --- a/applications/source/http-source/README.adoc +++ b/applications/source/http-source/README.adoc @@ -32,7 +32,7 @@ $$allowed-origins$$:: $$List of allowed origins, e.g. https://domain1.com.$$ *($ === http $$mapped-request-headers$$:: $$Headers that will be mapped.$$ *($$String[]$$, default: `$$$$`)* -$$path-pattern$$:: $$HTTP endpoint path mapping.$$ *($$String$$, default: `$$$$`)* +$$path-pattern$$:: $$HTTP endpoint path mapping.$$ *($$String$$, default: `$$/$$`)* === server diff --git a/applications/source/jms-source/README.adoc b/applications/source/jms-source/README.adoc index 4efd0203..d709e604 100644 --- a/applications/source/jms-source/README.adoc +++ b/applications/source/jms-source/README.adoc @@ -16,7 +16,7 @@ Properties grouped by prefix: $$client-id$$:: $$Client id for durable subscriptions.$$ *($$String$$, default: `$$$$`)* $$destination$$:: $$The destination from which to receive messages (queue or topic).$$ *($$String$$, default: `$$$$`)* $$message-selector$$:: $$A selector for messages.$$ *($$String$$, default: `$$$$`)* -$$session-transacted$$:: $$True to enable transactions and select a DefaultMessageListenerContainer, false to select a SimpleMessageListenerContainer.$$ *($$Boolean$$, default: `$$$$`)* +$$session-transacted$$:: $$True to enable transactions and select a DefaultMessageListenerContainer, false to select a SimpleMessageListenerContainer.$$ *($$Boolean$$, default: `$$true$$`)* $$subscription-durable$$:: $$True for a durable subscription.$$ *($$Boolean$$, default: `$$$$`)* $$subscription-name$$:: $$The name of a durable or shared subscription.$$ *($$String$$, default: `$$$$`)* $$subscription-shared$$:: $$True for a shared subscription.$$ *($$Boolean$$, default: `$$$$`)* diff --git a/applications/source/load-generator-source/README.adoc b/applications/source/load-generator-source/README.adoc index 1a3fd572..4ea48e26 100644 --- a/applications/source/load-generator-source/README.adoc +++ b/applications/source/load-generator-source/README.adoc @@ -8,10 +8,10 @@ A source that sends generated data and dispatches it to the stream. The **$$load-generator$$** $$source$$ has the following options: //tag::configuration-properties[] -$$load-generator.generate-timestamp$$:: $$Whether timestamp generated.$$ *($$Boolean$$, default: `$$$$`)* -$$load-generator.message-count$$:: $$Message count.$$ *($$Integer$$, default: `$$$$`)* -$$load-generator.message-size$$:: $$Message size.$$ *($$Integer$$, default: `$$$$`)* -$$load-generator.producers$$:: $$Number of producers.$$ *($$Integer$$, default: `$$$$`)* +$$load-generator.generate-timestamp$$:: $$Whether timestamp generated.$$ *($$Boolean$$, default: `$$false$$`)* +$$load-generator.message-count$$:: $$Message count.$$ *($$Integer$$, default: `$$1000$$`)* +$$load-generator.message-size$$:: $$Message size.$$ *($$Integer$$, default: `$$1000$$`)* +$$load-generator.producers$$:: $$Number of producers.$$ *($$Integer$$, default: `$$1$$`)* //end::configuration-properties[] //end::ref-doc[] diff --git a/applications/source/mail-source/README.adoc b/applications/source/mail-source/README.adoc index 48f8673c..a0873759 100644 --- a/applications/source/mail-source/README.adoc +++ b/applications/source/mail-source/README.adoc @@ -8,12 +8,12 @@ A source application that listens for Emails and emits the message body as a mes The **$$mail$$** $$source$$ has the following options: //tag::configuration-properties[] -$$mail.supplier.charset$$:: $$The charset for byte[] mail-to-string transformation.$$ *($$String$$, default: `$$$$`)* -$$mail.supplier.delete$$:: $$Set to true to delete email after download.$$ *($$Boolean$$, default: `$$$$`)* -$$mail.supplier.expression$$:: $$Configure a SpEL expression to select messages.$$ *($$String$$, default: `$$$$`)* -$$mail.supplier.idle-imap$$:: $$Set to true to use IdleImap Configuration.$$ *($$Boolean$$, default: `$$$$`)* +$$mail.supplier.charset$$:: $$The charset for byte[] mail-to-string transformation.$$ *($$String$$, default: `$$UTF-8$$`)* +$$mail.supplier.delete$$:: $$Set to true to delete email after download.$$ *($$Boolean$$, default: `$$false$$`)* +$$mail.supplier.expression$$:: $$Configure a SpEL expression to select messages.$$ *($$String$$, default: `$$true$$`)* +$$mail.supplier.idle-imap$$:: $$Set to true to use IdleImap Configuration.$$ *($$Boolean$$, default: `$$false$$`)* $$mail.supplier.java-mail-properties$$:: $$JavaMail properties as a new line delimited string of name-value pairs, e.g. 'foo=bar\n baz=car'.$$ *($$Properties$$, default: `$$$$`)* -$$mail.supplier.mark-as-read$$:: $$Set to true to mark email as read.$$ *($$Boolean$$, default: `$$$$`)* +$$mail.supplier.mark-as-read$$:: $$Set to true to mark email as read.$$ *($$Boolean$$, default: `$$false$$`)* $$mail.supplier.url$$:: $$Mail connection URL for connection to Mail server e.g. 'imaps://username:password@imap.server.com:993/Inbox'.$$ *($$URLName$$, default: `$$$$`)* $$mail.supplier.user-flag$$:: $$The flag to mark messages when the server does not support \Recent.$$ *($$String$$, default: `$$$$`)* //end::configuration-properties[] diff --git a/applications/source/mongodb-source/README.adoc b/applications/source/mongodb-source/README.adoc index ba5914a0..466abcf8 100644 --- a/applications/source/mongodb-source/README.adoc +++ b/applications/source/mongodb-source/README.adoc @@ -19,9 +19,9 @@ Properties grouped by prefix: === mongodb.supplier $$collection$$:: $$The MongoDB collection to query.$$ *($$String$$, default: `$$$$`)* -$$query$$:: $$The MongoDB query.$$ *($$String$$, default: `$$$$`)* +$$query$$:: $$The MongoDB query.$$ *($$String$$, default: `$${ }$$`)* $$query-expression$$:: $$The SpEL expression in MongoDB query DSL style.$$ *($$Expression$$, default: `$$$$`)* -$$split$$:: $$Whether to split the query result as individual messages.$$ *($$Boolean$$, default: `$$$$`)* +$$split$$:: $$Whether to split the query result as individual messages.$$ *($$Boolean$$, default: `$$true$$`)* $$update-expression$$:: $$The SpEL expression in MongoDB update DSL style.$$ *($$Expression$$, default: `$$$$`)* === spring.data.mongodb diff --git a/applications/source/mqtt-source/README.adoc b/applications/source/mqtt-source/README.adoc index 9b9c1dd1..ed098c9b 100644 --- a/applications/source/mqtt-source/README.adoc +++ b/applications/source/mqtt-source/README.adoc @@ -18,23 +18,23 @@ Properties grouped by prefix: === mqtt -$$clean-session$$:: $$whether the client and server should remember state across restarts and reconnects.$$ *($$Boolean$$, default: `$$$$`)* -$$connection-timeout$$:: $$the connection timeout in seconds.$$ *($$Integer$$, default: `$$$$`)* -$$keep-alive-interval$$:: $$the ping interval in seconds.$$ *($$Integer$$, default: `$$$$`)* -$$password$$:: $$the password to use when connecting to the broker.$$ *($$String$$, default: `$$$$`)* -$$persistence$$:: $$'memory' or 'file'.$$ *($$String$$, default: `$$$$`)* -$$persistence-directory$$:: $$Persistence directory.$$ *($$String$$, default: `$$$$`)* +$$clean-session$$:: $$whether the client and server should remember state across restarts and reconnects.$$ *($$Boolean$$, default: `$$true$$`)* +$$connection-timeout$$:: $$the connection timeout in seconds.$$ *($$Integer$$, default: `$$30$$`)* +$$keep-alive-interval$$:: $$the ping interval in seconds.$$ *($$Integer$$, default: `$$60$$`)* +$$password$$:: $$the password to use when connecting to the broker.$$ *($$String$$, default: `$$guest$$`)* +$$persistence$$:: $$'memory' or 'file'.$$ *($$String$$, default: `$$memory$$`)* +$$persistence-directory$$:: $$Persistence directory.$$ *($$String$$, default: `$$/tmp/paho$$`)* $$ssl-properties$$:: $$MQTT Client SSL properties.$$ *($$Map$$, default: `$$$$`)* -$$url$$:: $$location of the mqtt broker(s) (comma-delimited list).$$ *($$String[]$$, default: `$$$$`)* -$$username$$:: $$the username to use when connecting to the broker.$$ *($$String$$, default: `$$$$`)* +$$url$$:: $$location of the mqtt broker(s) (comma-delimited list).$$ *($$String[]$$, default: `$$[tcp://localhost:1883]$$`)* +$$username$$:: $$the username to use when connecting to the broker.$$ *($$String$$, default: `$$guest$$`)* === mqtt.supplier -$$binary$$:: $$true to leave the payload as bytes.$$ *($$Boolean$$, default: `$$$$`)* -$$charset$$:: $$the charset used to convert bytes to String (when binary is false).$$ *($$String$$, default: `$$$$`)* -$$client-id$$:: $$identifies the client.$$ *($$String$$, default: `$$$$`)* -$$qos$$:: $$the qos; a single value for all topics or a comma-delimited list to match the topics.$$ *($$Integer[]$$, default: `$$$$`)* -$$topics$$:: $$the topic(s) (comma-delimited) to which the source will subscribe.$$ *($$String[]$$, default: `$$$$`)* +$$binary$$:: $$true to leave the payload as bytes.$$ *($$Boolean$$, default: `$$false$$`)* +$$charset$$:: $$the charset used to convert bytes to String (when binary is false).$$ *($$String$$, default: `$$UTF-8$$`)* +$$client-id$$:: $$identifies the client.$$ *($$String$$, default: `$$stream.client.id.source$$`)* +$$qos$$:: $$the qos; a single value for all topics or a comma-delimited list to match the topics.$$ *($$Integer[]$$, default: `$$[0]$$`)* +$$topics$$:: $$the topic(s) (comma-delimited) to which the source will subscribe.$$ *($$String[]$$, default: `$$[stream.mqtt]$$`)* //end::configuration-properties[] //end::ref-doc[] diff --git a/applications/source/rabbit-source/README.adoc b/applications/source/rabbit-source/README.adoc index 92fd94af..d58758da 100644 --- a/applications/source/rabbit-source/README.adoc +++ b/applications/source/rabbit-source/README.adoc @@ -26,16 +26,16 @@ Properties grouped by prefix: === rabbit.supplier -$$enable-retry$$:: $$true to enable retry.$$ *($$Boolean$$, default: `$$$$`)* -$$initial-retry-interval$$:: $$Initial retry interval when retry is enabled.$$ *($$Integer$$, default: `$$$$`)* -$$mapped-request-headers$$:: $$Headers that will be mapped.$$ *($$String[]$$, default: `$$$$`)* -$$max-attempts$$:: $$The maximum delivery attempts when retry is enabled.$$ *($$Integer$$, default: `$$$$`)* -$$max-retry-interval$$:: $$Max retry interval when retry is enabled.$$ *($$Integer$$, default: `$$$$`)* -$$own-connection$$:: $$When true, use a separate connection based on the boot properties.$$ *($$Boolean$$, default: `$$$$`)* +$$enable-retry$$:: $$true to enable retry.$$ *($$Boolean$$, default: `$$false$$`)* +$$initial-retry-interval$$:: $$Initial retry interval when retry is enabled.$$ *($$Integer$$, default: `$$1000$$`)* +$$mapped-request-headers$$:: $$Headers that will be mapped.$$ *($$String[]$$, default: `$$[STANDARD_REQUEST_HEADERS]$$`)* +$$max-attempts$$:: $$The maximum delivery attempts when retry is enabled.$$ *($$Integer$$, default: `$$3$$`)* +$$max-retry-interval$$:: $$Max retry interval when retry is enabled.$$ *($$Integer$$, default: `$$30000$$`)* +$$own-connection$$:: $$When true, use a separate connection based on the boot properties.$$ *($$Boolean$$, default: `$$false$$`)* $$queues$$:: $$The queues to which the source will listen for messages.$$ *($$String[]$$, default: `$$$$`)* -$$requeue$$:: $$Whether rejected messages should be requeued.$$ *($$Boolean$$, default: `$$$$`)* -$$retry-multiplier$$:: $$Retry backoff multiplier when retry is enabled.$$ *($$Double$$, default: `$$$$`)* -$$transacted$$:: $$Whether the channel is transacted.$$ *($$Boolean$$, default: `$$$$`)* +$$requeue$$:: $$Whether rejected messages should be requeued.$$ *($$Boolean$$, default: `$$true$$`)* +$$retry-multiplier$$:: $$Retry backoff multiplier when retry is enabled.$$ *($$Double$$, default: `$$2$$`)* +$$transacted$$:: $$Whether the channel is transacted.$$ *($$Boolean$$, default: `$$false$$`)* === spring.rabbitmq diff --git a/applications/source/s3-source/README.adoc b/applications/source/s3-source/README.adoc index eb2bdd8e..51ce8f74 100644 --- a/applications/source/s3-source/README.adoc +++ b/applications/source/s3-source/README.adoc @@ -58,7 +58,7 @@ Properties grouped by prefix: === file.consumer -$$markers-json$$:: $$When 'fileMarkers == true', specify if they should be produced as FileSplitter.FileMarker objects or JSON.$$ *($$Boolean$$, default: `$$$$`)* +$$markers-json$$:: $$When 'fileMarkers == true', specify if they should be produced as FileSplitter.FileMarker objects or JSON.$$ *($$Boolean$$, default: `$$true$$`)* $$mode$$:: $$The FileReadingMode to use for file reading sources. Values are 'ref' - The File object, 'lines' - a message per line, or 'contents' - the contents as bytes.$$ *($$FileReadingMode$$, default: `$$$$`, possible values: `ref`,`lines`,`contents`)* $$with-markers$$:: $$Set to true to emit start of file/end of file marker messages before/after the data. Only valid with FileReadingMode 'lines'.$$ *($$Boolean$$, default: `$$$$`)* @@ -98,20 +98,20 @@ $$root$$:: $$Root node - store entries are children of this node.$$ *($$String$$ === s3.common $$endpoint-url$$:: $$Optional endpoint url to connect to s3 compatible storage.$$ *($$String$$, default: `$$$$`)* -$$path-style-access$$:: $$Use path style access.$$ *($$Boolean$$, default: `$$$$`)* +$$path-style-access$$:: $$Use path style access.$$ *($$Boolean$$, default: `$$false$$`)* === s3.supplier -$$auto-create-local-dir$$:: $$Create or not the local directory.$$ *($$Boolean$$, default: `$$$$`)* -$$delete-remote-files$$:: $$Delete or not remote files after processing.$$ *($$Boolean$$, default: `$$$$`)* +$$auto-create-local-dir$$:: $$Create or not the local directory.$$ *($$Boolean$$, default: `$$true$$`)* +$$delete-remote-files$$:: $$Delete or not remote files after processing.$$ *($$Boolean$$, default: `$$false$$`)* $$filename-pattern$$:: $$The pattern to filter remote files.$$ *($$String$$, default: `$$$$`)* $$filename-regex$$:: $$The regexp to filter remote files.$$ *($$Pattern$$, default: `$$$$`)* -$$list-only$$:: $$Set to true to return s3 object metadata without copying file to a local directory.$$ *($$Boolean$$, default: `$$$$`)* +$$list-only$$:: $$Set to true to return s3 object metadata without copying file to a local directory.$$ *($$Boolean$$, default: `$$false$$`)* $$local-dir$$:: $$The local directory to store files.$$ *($$File$$, default: `$$$$`)* -$$preserve-timestamp$$:: $$To transfer or not the timestamp of the remote file to the local one.$$ *($$Boolean$$, default: `$$$$`)* -$$remote-dir$$:: $$AWS S3 bucket resource.$$ *($$String$$, default: `$$$$`)* -$$remote-file-separator$$:: $$Remote File separator.$$ *($$String$$, default: `$$$$`)* -$$tmp-file-suffix$$:: $$Temporary file suffix.$$ *($$String$$, default: `$$$$`)* +$$preserve-timestamp$$:: $$To transfer or not the timestamp of the remote file to the local one.$$ *($$Boolean$$, default: `$$true$$`)* +$$remote-dir$$:: $$AWS S3 bucket resource.$$ *($$String$$, default: `$$bucket$$`)* +$$remote-file-separator$$:: $$Remote File separator.$$ *($$String$$, default: `$$/$$`)* +$$tmp-file-suffix$$:: $$Temporary file suffix.$$ *($$String$$, default: `$$.tmp$$`)* //end::configuration-properties[] == Amazon AWS common options diff --git a/applications/source/sftp-source/README.adoc b/applications/source/sftp-source/README.adoc index d23db644..790511f4 100644 --- a/applications/source/sftp-source/README.adoc +++ b/applications/source/sftp-source/README.adoc @@ -87,7 +87,7 @@ Properties grouped by prefix: === file.consumer -$$markers-json$$:: $$When 'fileMarkers == true', specify if they should be produced as FileSplitter.FileMarker objects or JSON.$$ *($$Boolean$$, default: `$$$$`)* +$$markers-json$$:: $$When 'fileMarkers == true', specify if they should be produced as FileSplitter.FileMarker objects or JSON.$$ *($$Boolean$$, default: `$$true$$`)* $$mode$$:: $$The FileReadingMode to use for file reading sources. Values are 'ref' - The File object, 'lines' - a message per line, or 'contents' - the contents as bytes.$$ *($$FileReadingMode$$, default: `$$$$`, possible values: `ref`,`lines`,`contents`)* $$with-markers$$:: $$Set to true to emit start of file/end of file marker messages before/after the data. Only valid with FileReadingMode 'lines'.$$ *($$Boolean$$, default: `$$$$`)* diff --git a/applications/source/syslog-source/README.adoc b/applications/source/syslog-source/README.adoc index 882bb05c..74f6ab2f 100644 --- a/applications/source/syslog-source/README.adoc +++ b/applications/source/syslog-source/README.adoc @@ -6,13 +6,13 @@ The syslog source receives SYSLOG packets over UDP, TCP, or both. RFC3164 (BSD) == Options //tag::configuration-properties[] -$$syslog.supplier.buffer-size$$:: $$the buffer size used when decoding messages; larger messages will be rejected.$$ *($$Integer$$, default: `$$$$`)* -$$syslog.supplier.nio$$:: $$whether or not to use NIO (when supporting a large number of connections).$$ *($$Boolean$$, default: `$$$$`)* -$$syslog.supplier.port$$:: $$The port to listen on.$$ *($$Integer$$, default: `$$$$`)* +$$syslog.supplier.buffer-size$$:: $$the buffer size used when decoding messages; larger messages will be rejected.$$ *($$Integer$$, default: `$$2048$$`)* +$$syslog.supplier.nio$$:: $$whether or not to use NIO (when supporting a large number of connections).$$ *($$Boolean$$, default: `$$false$$`)* +$$syslog.supplier.port$$:: $$The port to listen on.$$ *($$Integer$$, default: `$$1514$$`)* $$syslog.supplier.protocol$$:: $$Protocol used for SYSLOG (tcp or udp).$$ *($$Protocol$$, default: `$$$$`, possible values: `tcp`,`udp`,`both`)* -$$syslog.supplier.reverse-lookup$$:: $$whether or not to perform a reverse lookup on the incoming socket.$$ *($$Boolean$$, default: `$$$$`)* -$$syslog.supplier.rfc$$:: $$'5424' or '3164' - the syslog format according to the RFC; 3164 is aka 'BSD' format.$$ *($$String$$, default: `$$$$`)* -$$syslog.supplier.socket-timeout$$:: $$the socket timeout.$$ *($$Integer$$, default: `$$$$`)* +$$syslog.supplier.reverse-lookup$$:: $$whether or not to perform a reverse lookup on the incoming socket.$$ *($$Boolean$$, default: `$$false$$`)* +$$syslog.supplier.rfc$$:: $$'5424' or '3164' - the syslog format according to the RFC; 3164 is aka 'BSD' format.$$ *($$String$$, default: `$$3164$$`)* +$$syslog.supplier.socket-timeout$$:: $$the socket timeout.$$ *($$Integer$$, default: `$$0$$`)* //end::configuration-properties[] //end::ref-doc[] diff --git a/applications/source/tcp-source/README.adoc b/applications/source/tcp-source/README.adoc index fcb4496b..6fb00232 100644 --- a/applications/source/tcp-source/README.adoc +++ b/applications/source/tcp-source/README.adoc @@ -15,15 +15,15 @@ Properties grouped by prefix: === tcp -$$nio$$:: $$Whether or not to use NIO.$$ *($$Boolean$$, default: `$$$$`)* -$$port$$:: $$The port on which to listen; 0 for the OS to choose a port.$$ *($$Integer$$, default: `$$$$`)* -$$reverse-lookup$$:: $$Perform a reverse DNS lookup on the remote IP Address; if false, just the IP address is included in the message headers.$$ *($$Boolean$$, default: `$$$$`)* -$$socket-timeout$$:: $$The timeout (ms) before closing the socket when no data is received.$$ *($$Integer$$, default: `$$$$`)* -$$use-direct-buffers$$:: $$Whether or not to use direct buffers.$$ *($$Boolean$$, default: `$$$$`)* +$$nio$$:: $$Whether or not to use NIO.$$ *($$Boolean$$, default: `$$false$$`)* +$$port$$:: $$The port on which to listen; 0 for the OS to choose a port.$$ *($$Integer$$, default: `$$1234$$`)* +$$reverse-lookup$$:: $$Perform a reverse DNS lookup on the remote IP Address; if false, just the IP address is included in the message headers.$$ *($$Boolean$$, default: `$$false$$`)* +$$socket-timeout$$:: $$The timeout (ms) before closing the socket when no data is received.$$ *($$Integer$$, default: `$$120000$$`)* +$$use-direct-buffers$$:: $$Whether or not to use direct buffers.$$ *($$Boolean$$, default: `$$false$$`)* === tcp.supplier -$$buffer-size$$:: $$The buffer size used when decoding messages; larger messages will be rejected.$$ *($$Integer$$, default: `$$$$`)* +$$buffer-size$$:: $$The buffer size used when decoding messages; larger messages will be rejected.$$ *($$Integer$$, default: `$$2048$$`)* $$decoder$$:: $$The decoder to use when receiving messages.$$ *($$Encoding$$, default: `$$$$`, possible values: `CRLF`,`LF`,`NULL`,`STXETX`,`RAW`,`L1`,`L2`,`L4`)* //end::configuration-properties[] diff --git a/applications/source/time-source/README.adoc b/applications/source/time-source/README.adoc index ffa08cf9..824d079d 100644 --- a/applications/source/time-source/README.adoc +++ b/applications/source/time-source/README.adoc @@ -14,7 +14,7 @@ $$spring.integration.poller.fixed-rate$$:: $$Polling rate period. Mutually exclu $$spring.integration.poller.initial-delay$$:: $$Polling initial delay. Applied for 'fixedDelay' and 'fixedRate'; ignored for 'cron'.$$ *($$Duration$$, default: `$$$$`)* $$spring.integration.poller.max-messages-per-poll$$:: $$Maximum number of messages to poll per polling cycle.$$ *($$Integer$$, default: `$$$$`)* $$spring.integration.poller.receive-timeout$$:: $$How long to wait for messages on poll.$$ *($$Duration$$, default: `$$1s$$`)* -$$time.date-format$$:: $$Format for the date value.$$ *($$String$$, default: `$$$$`)* +$$time.date-format$$:: $$Format for the date value.$$ *($$String$$, default: `$$MM/dd/yy HH:mm:ss$$`)* //end::configuration-properties[] //end::ref-doc[] diff --git a/applications/source/twitter-message-source/README.adoc b/applications/source/twitter-message-source/README.adoc index 84af985f..c5e734be 100644 --- a/applications/source/twitter-message-source/README.adoc +++ b/applications/source/twitter-message-source/README.adoc @@ -31,12 +31,12 @@ $$access-token$$:: $$Your Twitter token.$$ *($$String$$, default: `$$$$`)* $$access-token-secret$$:: $$Your Twitter token secret.$$ *($$String$$, default: `$$$$`)* $$consumer-key$$:: $$Your Twitter key.$$ *($$String$$, default: `$$$$`)* $$consumer-secret$$:: $$Your Twitter secret.$$ *($$String$$, default: `$$$$`)* -$$debug-enabled$$:: $$Enables Twitter4J debug mode.$$ *($$Boolean$$, default: `$$$$`)* -$$raw-json$$:: $$Enable caching the original (raw) JSON objects as returned by the Twitter APIs. When set to False the result will use the Twitter4J's json representations. When set to True the result will use the original Twitter APISs json representations.$$ *($$Boolean$$, default: `$$$$`)* +$$debug-enabled$$:: $$Enables Twitter4J debug mode.$$ *($$Boolean$$, default: `$$false$$`)* +$$raw-json$$:: $$Enable caching the original (raw) JSON objects as returned by the Twitter APIs. When set to False the result will use the Twitter4J's json representations. When set to True the result will use the original Twitter APISs json representations.$$ *($$Boolean$$, default: `$$true$$`)* === twitter.message.source -$$count$$:: $$Max number of events to be returned. 20 default. 50 max.$$ *($$Integer$$, default: `$$$$`)* +$$count$$:: $$Max number of events to be returned. 20 default. 50 max.$$ *($$Integer$$, default: `$$20$$`)* //end::configuration-properties[] //end::ref-doc[] diff --git a/applications/source/twitter-search-source/README.adoc b/applications/source/twitter-search-source/README.adoc index f180b2e2..306de4d2 100644 --- a/applications/source/twitter-search-source/README.adoc +++ b/applications/source/twitter-search-source/README.adoc @@ -34,24 +34,24 @@ $$access-token$$:: $$Your Twitter token.$$ *($$String$$, default: `$$$$`)* $$access-token-secret$$:: $$Your Twitter token secret.$$ *($$String$$, default: `$$$$`)* $$consumer-key$$:: $$Your Twitter key.$$ *($$String$$, default: `$$$$`)* $$consumer-secret$$:: $$Your Twitter secret.$$ *($$String$$, default: `$$$$`)* -$$debug-enabled$$:: $$Enables Twitter4J debug mode.$$ *($$Boolean$$, default: `$$$$`)* -$$raw-json$$:: $$Enable caching the original (raw) JSON objects as returned by the Twitter APIs. When set to False the result will use the Twitter4J's json representations. When set to True the result will use the original Twitter APISs json representations.$$ *($$Boolean$$, default: `$$$$`)* +$$debug-enabled$$:: $$Enables Twitter4J debug mode.$$ *($$Boolean$$, default: `$$false$$`)* +$$raw-json$$:: $$Enable caching the original (raw) JSON objects as returned by the Twitter APIs. When set to False the result will use the Twitter4J's json representations. When set to True the result will use the original Twitter APISs json representations.$$ *($$Boolean$$, default: `$$true$$`)* === twitter.search -$$count$$:: $$Number of tweets to return per page (e.g. per single request), up to a max of 100.$$ *($$Integer$$, default: `$$$$`)* +$$count$$:: $$Number of tweets to return per page (e.g. per single request), up to a max of 100.$$ *($$Integer$$, default: `$$100$$`)* $$lang$$:: $$Restricts searched tweets to the given language, given by an http://en.wikipedia.org/wiki/ISO_639-1 .$$ *($$String$$, default: `$$$$`)* -$$page$$:: $$Number of pages (e.g. requests) to search backwards (from most recent to the oldest tweets) before start the search from the most recent tweets again. The total amount of tweets searched backwards is (page * count)$$ *($$Integer$$, default: `$$$$`)* +$$page$$:: $$Number of pages (e.g. requests) to search backwards (from most recent to the oldest tweets) before start the search from the most recent tweets again. The total amount of tweets searched backwards is (page * count)$$ *($$Integer$$, default: `$$3$$`)* $$query$$:: $$Search tweets by search query string.$$ *($$String$$, default: `$$$$`)* -$$restart-from-most-recent-on-empty-response$$:: $$Restart search from the most recent tweets on empty response. Applied only after the first restart (e.g. when since_id != UNBOUNDED)$$ *($$Boolean$$, default: `$$$$`)* +$$restart-from-most-recent-on-empty-response$$:: $$Restart search from the most recent tweets on empty response. Applied only after the first restart (e.g. when since_id != UNBOUNDED)$$ *($$Boolean$$, default: `$$false$$`)* $$result-type$$:: $$Specifies what type of search results you would prefer to receive. The current default is "mixed." Valid values include: mixed : Include both popular and real time results in the response. recent : return only the most recent results in the response popular : return only the most popular results in the response$$ *($$ResultType$$, default: `$$$$`, possible values: `popular`,`mixed`,`recent`)* $$since$$:: $$If specified, returns tweets with since the given date. Date should be formatted as YYYY-MM-DD.$$ *($$String$$, default: `$$$$`)* === twitter.search.geocode -$$latitude$$:: $$User's latitude.$$ *($$Double$$, default: `$$$$`)* -$$longitude$$:: $$User's longitude.$$ *($$Double$$, default: `$$$$`)* -$$radius$$:: $$Radius (in kilometers) around the (latitude, longitude) point.$$ *($$Double$$, default: `$$$$`)* +$$latitude$$:: $$User's latitude.$$ *($$Double$$, default: `$$-1$$`)* +$$longitude$$:: $$User's longitude.$$ *($$Double$$, default: `$$-1$$`)* +$$radius$$:: $$Radius (in kilometers) around the (latitude, longitude) point.$$ *($$Double$$, default: `$$-1$$`)* //end::configuration-properties[] //end::ref-doc[] diff --git a/applications/source/twitter-stream-source/README.adoc b/applications/source/twitter-stream-source/README.adoc index 8d8d8417..6fb96b03 100644 --- a/applications/source/twitter-stream-source/README.adoc +++ b/applications/source/twitter-stream-source/README.adoc @@ -25,12 +25,12 @@ $$access-token$$:: $$Your Twitter token.$$ *($$String$$, default: `$$$$`)* $$access-token-secret$$:: $$Your Twitter token secret.$$ *($$String$$, default: `$$$$`)* $$consumer-key$$:: $$Your Twitter key.$$ *($$String$$, default: `$$$$`)* $$consumer-secret$$:: $$Your Twitter secret.$$ *($$String$$, default: `$$$$`)* -$$debug-enabled$$:: $$Enables Twitter4J debug mode.$$ *($$Boolean$$, default: `$$$$`)* -$$raw-json$$:: $$Enable caching the original (raw) JSON objects as returned by the Twitter APIs. When set to False the result will use the Twitter4J's json representations. When set to True the result will use the original Twitter APISs json representations.$$ *($$Boolean$$, default: `$$$$`)* +$$debug-enabled$$:: $$Enables Twitter4J debug mode.$$ *($$Boolean$$, default: `$$false$$`)* +$$raw-json$$:: $$Enable caching the original (raw) JSON objects as returned by the Twitter APIs. When set to False the result will use the Twitter4J's json representations. When set to True the result will use the original Twitter APISs json representations.$$ *($$Boolean$$, default: `$$true$$`)* === twitter.stream.filter -$$count$$:: $$Indicates the number of previous statuses to stream before transitioning to the live stream.$$ *($$Integer$$, default: `$$$$`)* +$$count$$:: $$Indicates the number of previous statuses to stream before transitioning to the live stream.$$ *($$Integer$$, default: `$$0$$`)* $$filter-level$$:: $$The filter level limits what tweets appear in the stream to those with a minimum filterLevel attribute value. One of either none, low, or medium.$$ *($$FilterLevel$$, default: `$$$$`)* $$follow$$:: $$Specifies the users, by ID, to receive public tweets from.$$ *($$List$$, default: `$$$$`)* $$language$$:: $$Specifies the tweets language of the stream.$$ *($$List$$, default: `$$$$`)* diff --git a/applications/source/websocket-source/README.adoc b/applications/source/websocket-source/README.adoc index a644428f..3df4f069 100644 --- a/applications/source/websocket-source/README.adoc +++ b/applications/source/websocket-source/README.adoc @@ -10,12 +10,12 @@ Properties grouped by prefix: === websocket.supplier -$$allowed-origins$$:: $$The allowed origins.$$ *($$String$$, default: `$$$$`)* -$$path$$:: $$The path on which server WebSocket handler is exposed.$$ *($$String$$, default: `$$$$`)* +$$allowed-origins$$:: $$The allowed origins.$$ *($$String$$, default: `$$*$$`)* +$$path$$:: $$The path on which server WebSocket handler is exposed.$$ *($$String$$, default: `$$/websocket$$`)* === websocket.supplier.sock-js -$$enable$$:: $$Enable SockJS service on the server. Default is 'false'$$ *($$Boolean$$, default: `$$$$`)* +$$enable$$:: $$Enable SockJS service on the server. Default is 'false'$$ *($$Boolean$$, default: `$$false$$`)* //end::configuration-properties[] == Examples diff --git a/applications/source/zeromq-source/README.adoc b/applications/source/zeromq-source/README.adoc index 7daa1bd2..e63ea85a 100644 --- a/applications/source/zeromq-source/README.adoc +++ b/applications/source/zeromq-source/README.adoc @@ -18,11 +18,11 @@ N/A The **$$zeromq$$** $$source$$ has the following options: //tag::configuration-properties[] -$$zeromq.supplier.bind-port$$:: $$Bind Port for creating a ZeroMQ Socket; 0 selects a random port.$$ *($$Integer$$, default: `$$$$`)* +$$zeromq.supplier.bind-port$$:: $$Bind Port for creating a ZeroMQ Socket; 0 selects a random port.$$ *($$Integer$$, default: `$$0$$`)* $$zeromq.supplier.connect-url$$:: $$Connection URL for to the ZeroMQ Socket.$$ *($$String$$, default: `$$$$`)* -$$zeromq.supplier.consume-delay$$:: $$The delay to consume from the ZeroMQ Socket when no data received.$$ *($$Duration$$, default: `$$$$`)* +$$zeromq.supplier.consume-delay$$:: $$The delay to consume from the ZeroMQ Socket when no data received.$$ *($$Duration$$, default: `$$1s$$`)* $$zeromq.supplier.socket-type$$:: $$The Socket Type the connection should make.$$ *($$SocketType$$, default: `$$$$`, possible values: `PAIR`,`PUB`,`SUB`,`REQ`,`REP`,`DEALER`,`ROUTER`,`PULL`,`PUSH`,`XPUB`,`XSUB`,`STREAM`)* -$$zeromq.supplier.topics$$:: $$The Topics to subscribe to.$$ *($$String[]$$, default: `$$$$`)* +$$zeromq.supplier.topics$$:: $$The Topics to subscribe to.$$ *($$String[]$$, default: `$$[]$$`)* //end::configuration-properties[] Also see the https://docs.spring.io/spring-boot/docs/current/reference/html/common-application-properties.html[Spring Boot Documentation]