diff --git a/applications/processor/aggregator-processor/README.adoc b/applications/processor/aggregator-processor/README.adoc index 999c6c1e..43794fe5 100644 --- a/applications/processor/aggregator-processor/README.adoc +++ b/applications/processor/aggregator-processor/README.adoc @@ -12,53 +12,70 @@ Change kafka to rabbit if you want to run it against RabbitMQ. == Options //tag::configuration-properties[] -$$aggregator.aggregation$$:: $$SpEL expression for aggregation strategy. Default is collection of payloads.$$ *($$Expression$$, default: `$$$$`)* -$$aggregator.correlation$$:: $$SpEL expression for correlation key. Default to correlationId header.$$ *($$Expression$$, default: `$$$$`)* -$$aggregator.group-timeout$$:: $$SpEL expression for timeout to expiring uncompleted groups.$$ *($$Expression$$, default: `$$$$`)* -$$aggregator.message-store-entity$$:: $$Persistence message store entity: table prefix in RDBMS, collection name in MongoDb, etc.$$ *($$String$$, default: `$$$$`)* -$$aggregator.message-store-type$$:: $$Message store type.$$ *($$String$$, default: `$$$$`)* -$$aggregator.release$$:: $$SpEL expression for release strategy. Default is based on the sequenceSize header.$$ *($$Expression$$, default: `$$$$`)* -$$spring.data.mongodb.authentication-database$$:: $$Authentication database name.$$ *($$String$$, default: `$$$$`)* -$$spring.data.mongodb.auto-index-creation$$:: $$Whether to enable auto-index creation.$$ *($$Boolean$$, default: `$$$$`)* -$$spring.data.mongodb.database$$:: $$Database name.$$ *($$String$$, default: `$$$$`)* -$$spring.data.mongodb.field-naming-strategy$$:: $$Fully qualified name of the FieldNamingStrategy to use.$$ *($$Class$$, default: `$$$$`)* -$$spring.data.mongodb.grid-fs-database$$:: $$GridFS database name.$$ *($$String$$, default: `$$$$`)* -$$spring.data.mongodb.host$$:: $$Mongo server host. Cannot be set with URI.$$ *($$String$$, default: `$$$$`)* -$$spring.data.mongodb.password$$:: $$Login password of the mongo server. Cannot be set with URI.$$ *($$Character[]$$, default: `$$$$`)* -$$spring.data.mongodb.port$$:: $$Mongo server port. Cannot be set with URI.$$ *($$Integer$$, default: `$$$$`)* -$$spring.data.mongodb.replica-set-name$$:: $$Required replica set name for the cluster. Cannot be set with URI.$$ *($$String$$, default: `$$$$`)* -$$spring.data.mongodb.uri$$:: $$Mongo database URI. Cannot be set with host, port, credentials and replica set name.$$ *($$String$$, default: `$$mongodb://localhost/test$$`)* -$$spring.data.mongodb.username$$:: $$Login user of the mongo server. Cannot be set with URI.$$ *($$String$$, default: `$$$$`)* -$$spring.data.mongodb.uuid-representation$$:: $$Representation to use when converting a UUID to a BSON binary value.$$ *($$UuidRepresentation$$, default: `$$java-legacy$$`, possible values: `UNSPECIFIED`,`STANDARD`,`C_SHARP_LEGACY`,`JAVA_LEGACY`,`PYTHON_LEGACY`)* -$$spring.datasource.continue-on-error$$:: $$Whether to stop if an error occurs while initializing the database.$$ *($$Boolean$$, default: `$$false$$`)* -$$spring.datasource.data$$:: $$Data (DML) script resource references.$$ *($$List$$, default: `$$$$`)* -$$spring.datasource.data-password$$:: $$Password of the database to execute DML scripts (if different).$$ *($$String$$, default: `$$$$`)* -$$spring.datasource.data-username$$:: $$Username of the database to execute DML scripts (if different).$$ *($$String$$, default: `$$$$`)* -$$spring.datasource.driver-class-name$$:: $$Fully qualified name of the JDBC driver. Auto-detected based on the URL by default.$$ *($$String$$, default: `$$$$`)* -$$spring.datasource.generate-unique-name$$:: $$Whether to generate a random datasource name.$$ *($$Boolean$$, default: `$$true$$`)* -$$spring.datasource.initialization-mode$$:: $$Initialize the datasource with available DDL and DML scripts.$$ *($$DataSourceInitializationMode$$, default: `$$embedded$$`, possible values: `ALWAYS`,`EMBEDDED`,`NEVER`)* -$$spring.datasource.jndi-name$$:: $$JNDI location of the datasource. Class, url, username and password are ignored when set.$$ *($$String$$, default: `$$$$`)* -$$spring.datasource.name$$:: $$Name of the datasource. Default to "testdb" when using an embedded database.$$ *($$String$$, default: `$$$$`)* -$$spring.datasource.password$$:: $$Login password of the database.$$ *($$String$$, default: `$$$$`)* -$$spring.datasource.platform$$:: $$Platform to use in the DDL or DML scripts (such as schema-${platform}.sql or data-${platform}.sql).$$ *($$String$$, default: `$$all$$`)* -$$spring.datasource.schema$$:: $$Schema (DDL) script resource references.$$ *($$List$$, default: `$$$$`)* -$$spring.datasource.schema-password$$:: $$Password of the database to execute DDL scripts (if different).$$ *($$String$$, default: `$$$$`)* -$$spring.datasource.schema-username$$:: $$Username of the database to execute DDL scripts (if different).$$ *($$String$$, default: `$$$$`)* -$$spring.datasource.separator$$:: $$Statement separator in SQL initialization scripts.$$ *($$String$$, default: `$$;$$`)* -$$spring.datasource.sql-script-encoding$$:: $$SQL scripts encoding.$$ *($$Charset$$, default: `$$$$`)* -$$spring.datasource.type$$:: $$Fully qualified name of the connection pool implementation to use. By default, it is auto-detected from the classpath.$$ *($$Class$$, default: `$$$$`)* -$$spring.datasource.url$$:: $$JDBC URL of the database.$$ *($$String$$, default: `$$$$`)* -$$spring.datasource.username$$:: $$Login username of the database.$$ *($$String$$, default: `$$$$`)* -$$spring.mongodb.embedded.features$$:: $$Comma-separated list of features to enable. Uses the defaults of the configured version by default.$$ *($$Set$$, default: `$$[sync_delay]$$`)* -$$spring.mongodb.embedded.version$$:: $$Version of Mongo to use.$$ *($$String$$, default: `$$3.5.5$$`)* -$$spring.redis.client-name$$:: $$Client name to be set on connections with CLIENT SETNAME.$$ *($$String$$, default: `$$$$`)* -$$spring.redis.database$$:: $$Database index used by the connection factory.$$ *($$Integer$$, default: `$$0$$`)* -$$spring.redis.host$$:: $$Redis server host.$$ *($$String$$, default: `$$localhost$$`)* -$$spring.redis.password$$:: $$Login password of the redis server.$$ *($$String$$, default: `$$$$`)* -$$spring.redis.port$$:: $$Redis server port.$$ *($$Integer$$, default: `$$6379$$`)* -$$spring.redis.ssl$$:: $$Whether to enable SSL support.$$ *($$Boolean$$, default: `$$false$$`)* -$$spring.redis.timeout$$:: $$Connection timeout.$$ *($$Duration$$, default: `$$$$`)* -$$spring.redis.url$$:: $$Connection URL. Overrides host, port, and password. User is ignored. Example: redis://user:password@example.com:6379$$ *($$String$$, default: `$$$$`)* +Properties grouped by prefix: + + +=== aggregator + +$$aggregation$$:: $$SpEL expression for aggregation strategy. Default is collection of payloads.$$ *($$Expression$$, default: `$$$$`)* +$$correlation$$:: $$SpEL expression for correlation key. Default to correlationId header.$$ *($$Expression$$, default: `$$$$`)* +$$group-timeout$$:: $$SpEL expression for timeout to expiring uncompleted groups.$$ *($$Expression$$, default: `$$$$`)* +$$message-store-entity$$:: $$Persistence message store entity: table prefix in RDBMS, collection name in MongoDb, etc.$$ *($$String$$, default: `$$$$`)* +$$message-store-type$$:: $$Message store type.$$ *($$String$$, default: `$$$$`)* +$$release$$:: $$SpEL expression for release strategy. Default is based on the sequenceSize header.$$ *($$Expression$$, default: `$$$$`)* + +=== spring.data.mongodb + +$$authentication-database$$:: $$Authentication database name.$$ *($$String$$, default: `$$$$`)* +$$auto-index-creation$$:: $$Whether to enable auto-index creation.$$ *($$Boolean$$, default: `$$$$`)* +$$database$$:: $$Database name.$$ *($$String$$, default: `$$$$`)* +$$field-naming-strategy$$:: $$Fully qualified name of the FieldNamingStrategy to use.$$ *($$Class$$, default: `$$$$`)* +$$grid-fs-database$$:: $$GridFS database name.$$ *($$String$$, default: `$$$$`)* +$$host$$:: $$Mongo server host. Cannot be set with URI.$$ *($$String$$, default: `$$$$`)* +$$password$$:: $$Login password of the mongo server. Cannot be set with URI.$$ *($$Character[]$$, default: `$$$$`)* +$$port$$:: $$Mongo server port. Cannot be set with URI.$$ *($$Integer$$, default: `$$$$`)* +$$replica-set-name$$:: $$Required replica set name for the cluster. Cannot be set with URI.$$ *($$String$$, default: `$$$$`)* +$$uri$$:: $$Mongo database URI. Cannot be set with host, port, credentials and replica set name.$$ *($$String$$, default: `$$mongodb://localhost/test$$`)* +$$username$$:: $$Login user of the mongo server. Cannot be set with URI.$$ *($$String$$, default: `$$$$`)* +$$uuid-representation$$:: $$Representation to use when converting a UUID to a BSON binary value.$$ *($$UuidRepresentation$$, default: `$$java-legacy$$`, possible values: `UNSPECIFIED`,`STANDARD`,`C_SHARP_LEGACY`,`JAVA_LEGACY`,`PYTHON_LEGACY`)* + +=== spring.datasource + +$$continue-on-error$$:: $$Whether to stop if an error occurs while initializing the database.$$ *($$Boolean$$, default: `$$false$$`)* +$$data$$:: $$Data (DML) script resource references.$$ *($$List$$, default: `$$$$`)* +$$data-password$$:: $$Password of the database to execute DML scripts (if different).$$ *($$String$$, default: `$$$$`)* +$$data-username$$:: $$Username of the database to execute DML scripts (if different).$$ *($$String$$, default: `$$$$`)* +$$driver-class-name$$:: $$Fully qualified name of the JDBC driver. Auto-detected based on the URL by default.$$ *($$String$$, default: `$$$$`)* +$$generate-unique-name$$:: $$Whether to generate a random datasource name.$$ *($$Boolean$$, default: `$$true$$`)* +$$initialization-mode$$:: $$Initialize the datasource with available DDL and DML scripts.$$ *($$DataSourceInitializationMode$$, default: `$$embedded$$`, possible values: `ALWAYS`,`EMBEDDED`,`NEVER`)* +$$jndi-name$$:: $$JNDI location of the datasource. Class, url, username and password are ignored when set.$$ *($$String$$, default: `$$$$`)* +$$name$$:: $$Name of the datasource. Default to "testdb" when using an embedded database.$$ *($$String$$, default: `$$$$`)* +$$password$$:: $$Login password of the database.$$ *($$String$$, default: `$$$$`)* +$$platform$$:: $$Platform to use in the DDL or DML scripts (such as schema-${platform}.sql or data-${platform}.sql).$$ *($$String$$, default: `$$all$$`)* +$$schema$$:: $$Schema (DDL) script resource references.$$ *($$List$$, default: `$$$$`)* +$$schema-password$$:: $$Password of the database to execute DDL scripts (if different).$$ *($$String$$, default: `$$$$`)* +$$schema-username$$:: $$Username of the database to execute DDL scripts (if different).$$ *($$String$$, default: `$$$$`)* +$$separator$$:: $$Statement separator in SQL initialization scripts.$$ *($$String$$, default: `$$;$$`)* +$$sql-script-encoding$$:: $$SQL scripts encoding.$$ *($$Charset$$, default: `$$$$`)* +$$type$$:: $$Fully qualified name of the connection pool implementation to use. By default, it is auto-detected from the classpath.$$ *($$Class$$, default: `$$$$`)* +$$url$$:: $$JDBC URL of the database.$$ *($$String$$, default: `$$$$`)* +$$username$$:: $$Login username of the database.$$ *($$String$$, default: `$$$$`)* + +=== spring.mongodb.embedded + +$$features$$:: $$Comma-separated list of features to enable. Uses the defaults of the configured version by default.$$ *($$Set$$, default: `$$[sync_delay]$$`)* +$$version$$:: $$Version of Mongo to use.$$ *($$String$$, default: `$$3.5.5$$`)* + +=== spring.redis + +$$client-name$$:: $$Client name to be set on connections with CLIENT SETNAME.$$ *($$String$$, default: `$$$$`)* +$$database$$:: $$Database index used by the connection factory.$$ *($$Integer$$, default: `$$0$$`)* +$$host$$:: $$Redis server host.$$ *($$String$$, default: `$$localhost$$`)* +$$password$$:: $$Login password of the redis server.$$ *($$String$$, default: `$$$$`)* +$$port$$:: $$Redis server port.$$ *($$Integer$$, default: `$$6379$$`)* +$$ssl$$:: $$Whether to enable SSL support.$$ *($$Boolean$$, default: `$$false$$`)* +$$timeout$$:: $$Connection timeout.$$ *($$Duration$$, default: `$$$$`)* +$$url$$:: $$Connection URL. Overrides host, port, and password. User is ignored. Example: redis://user:password@example.com:6379$$ *($$String$$, default: `$$$$`)* //end::configuration-properties[] //end::ref-doc[] diff --git a/applications/processor/groovy-processor/README.adoc b/applications/processor/groovy-processor/README.adoc index 05f0ff52..b5e5487d 100644 --- a/applications/processor/groovy-processor/README.adoc +++ b/applications/processor/groovy-processor/README.adoc @@ -5,7 +5,7 @@ A Processor that applies a Groovy script against messages. == Options -The **$$groovy-processor** $$processor$$ has the following options: +The **$$groovy-processor$$** $$processor$$ has the following options: //tag::configuration-properties[] //end::configuration-properties[] diff --git a/applications/processor/twitter-trend-processor/README.adoc b/applications/processor/twitter-trend-processor/README.adoc index 6d00033b..691466f8 100644 --- a/applications/processor/twitter-trend-processor/README.adoc +++ b/applications/processor/twitter-trend-processor/README.adoc @@ -26,10 +26,18 @@ Response is an array of `locations` that encode the location's WOEID and some ot == Options //tag::configuration-properties[] -$$twitter.trend.closest.lat$$:: $$If provided with a long parameter the available trend locations will be sorted by distance, nearest to furthest, to the co-ordinate pair. The valid ranges for longitude is -180.0 to +180.0 (West is negative, East is positive) inclusive.$$ *($$Expression$$, default: `$$$$`)* -$$twitter.trend.closest.lon$$:: $$If provided with a lat parameter the available trend locations will be sorted by distance, nearest to furthest, to the co-ordinate pair. The valid ranges for longitude is -180.0 to +180.0 (West is negative, East is positive) inclusive.$$ *($$Expression$$, default: `$$$$`)* -$$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: `$$payload$$`)* -$$twitter.trend.trend-query-type$$:: $$$$ *($$TrendQueryType$$, default: `$$$$`, possible values: `trend`,`trendLocation`)* +Properties grouped by prefix: + + +=== twitter.trend.closest + +$$lat$$:: $$If provided with a long parameter the available trend locations will be sorted by distance, nearest to furthest, to the co-ordinate pair. The valid ranges for longitude is -180.0 to +180.0 (West is negative, East is positive) inclusive.$$ *($$Expression$$, default: `$$$$`)* +$$lon$$:: $$If provided with a lat parameter the available trend locations will be sorted by distance, nearest to furthest, to the co-ordinate pair. The valid ranges for longitude is -180.0 to +180.0 (West is negative, East is positive) inclusive.$$ *($$Expression$$, default: `$$$$`)* + +=== 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: `$$payload$$`)* +$$trend-query-type$$:: $$$$ *($$TrendQueryType$$, default: `$$$$`, possible values: `trend`,`trendLocation`)* //end::configuration-properties[] //end::ref-doc[] diff --git a/applications/sink/analytics-sink/README.adoc b/applications/sink/analytics-sink/README.adoc index af03792c..3d1b92b9 100644 --- a/applications/sink/analytics-sink/README.adoc +++ b/applications/sink/analytics-sink/README.adoc @@ -62,12 +62,20 @@ The incoming message can contain any type of payload. == Options //tag::configuration-properties[] -$$analytics.amount-expression$$:: $$A SpEL expression to compute the output metrics value (e.g. amount). It defaults to 1.0$$ *($$Expression$$, default: `$$$$`)* -$$analytics.meter-type$$:: $$Micrometer meter type used to report the metrics to the backend.$$ *($$MeterType$$, default: `$$$$`, possible values: `counter`,`gauge`)* -$$analytics.name$$:: $$The name of the output metrics. The 'name' and 'nameExpression' are mutually exclusive. Only one of them can be set.$$ *($$String$$, default: `$$$$`)* -$$analytics.name-expression$$:: $$A SpEL expression to compute the output metrics name from the input message. The 'name' and 'nameExpression' are mutually exclusive. Only one of them can be set.$$ *($$Expression$$, default: `$$$$`)* -$$analytics.tag.expression$$:: $$Computes tags from SpEL expression. Single SpEL expression can produce an array of values, which in turn means distinct name/value tags. Every name/value tag will produce a separate meter increment. Tag expression format is: analytics.tag.expression.[tag-name]=[SpEL expression]$$ *($$Map$$, default: `$$$$`)* -$$analytics.tag.fixed$$:: $$DEPRECATED: Please use the analytics.tag.expression with literal SpEL expression. Custom, fixed Tags. Those tags have constant values, created once and then sent along with every published metrics. The convention to define a fixed Tags is: analytics.tag.fixed.[tag-name]=[tag-value] $$ *($$Map$$, default: `$$$$`)* +Properties grouped by prefix: + + +=== analytics + +$$amount-expression$$:: $$A SpEL expression to compute the output metrics value (e.g. amount). It defaults to 1.0$$ *($$Expression$$, default: `$$$$`)* +$$meter-type$$:: $$Micrometer meter type used to report the metrics to the backend.$$ *($$MeterType$$, default: `$$$$`, possible values: `counter`,`gauge`)* +$$name$$:: $$The name of the output metrics. The 'name' and 'nameExpression' are mutually exclusive. Only one of them can be set.$$ *($$String$$, default: `$$$$`)* +$$name-expression$$:: $$A SpEL expression to compute the output metrics name from the input message. The 'name' and 'nameExpression' are mutually exclusive. Only one of them can be set.$$ *($$Expression$$, default: `$$$$`)* + +=== analytics.tag + +$$expression$$:: $$Computes tags from SpEL expression. Single SpEL expression can produce an array of values, which in turn means distinct name/value tags. Every name/value tag will produce a separate meter increment. Tag expression format is: analytics.tag.expression.[tag-name]=[SpEL expression]$$ *($$Map$$, default: `$$$$`)* +$$fixed$$:: $$DEPRECATED: Please use the analytics.tag.expression with literal SpEL expression. Custom, fixed Tags. Those tags have constant values, created once and then sent along with every published metrics. The convention to define a fixed Tags is: analytics.tag.fixed.[tag-name]=[tag-value] $$ *($$Map$$, default: `$$$$`)* //end::configuration-properties[] //end::ref-doc[] diff --git a/applications/sink/elasticsearch-sink/README.adoc b/applications/sink/elasticsearch-sink/README.adoc index c0aac1a5..f210c9b3 100644 --- a/applications/sink/elasticsearch-sink/README.adoc +++ b/applications/sink/elasticsearch-sink/README.adoc @@ -15,16 +15,24 @@ 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: `$$false$$`)* -$$elasticsearch.consumer.id$$:: $$The id of the document index.$$ *($$Expression$$, default: `$$$$`)* -$$elasticsearch.consumer.index$$:: $$Name of the index.$$ *($$String$$, default: `$$$$`)* -$$elasticsearch.consumer.routing$$:: $$Indicates the shard to route to. If not provided, this resolves to the ID used on the document.$$ *($$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: `$$0$$`)* -$$spring.elasticsearch.rest.connection-timeout$$:: $$Connection timeout.$$ *($$Duration$$, default: `$$1s$$`)* -$$spring.elasticsearch.rest.password$$:: $$Credentials password.$$ *($$String$$, default: `$$$$`)* -$$spring.elasticsearch.rest.read-timeout$$:: $$Read timeout.$$ *($$Duration$$, default: `$$30s$$`)* -$$spring.elasticsearch.rest.uris$$:: $$Comma-separated list of the Elasticsearch instances to use.$$ *($$List$$, default: `$$[http://localhost:9200]$$`)* -$$spring.elasticsearch.rest.username$$:: $$Credentials username.$$ *($$String$$, default: `$$$$`)* +Properties grouped by prefix: + + +=== elasticsearch.consumer + +$$async$$:: $$Indicates whether the indexing operation is async or not. By default indexing is done synchronously.$$ *($$Boolean$$, default: `$$false$$`)* +$$id$$:: $$The id of the document index.$$ *($$Expression$$, default: `$$$$`)* +$$index$$:: $$Name of the index.$$ *($$String$$, default: `$$$$`)* +$$routing$$:: $$Indicates the shard to route to. If not provided, this resolves to the ID used on the document.$$ *($$String$$, default: `$$$$`)* +$$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$$`)* + +=== spring.elasticsearch.rest + +$$connection-timeout$$:: $$Connection timeout.$$ *($$Duration$$, default: `$$1s$$`)* +$$password$$:: $$Credentials password.$$ *($$String$$, default: `$$$$`)* +$$read-timeout$$:: $$Read timeout.$$ *($$Duration$$, default: `$$30s$$`)* +$$uris$$:: $$Comma-separated list of the Elasticsearch instances to use.$$ *($$List$$, default: `$$[http://localhost:9200]$$`)* +$$username$$:: $$Credentials username.$$ *($$String$$, default: `$$$$`)* //end::configuration-properties[] == Examples of running this sink diff --git a/applications/sink/ftp-sink/README.adoc b/applications/sink/ftp-sink/README.adoc index bbe268f9..fae1cadd 100644 --- a/applications/sink/ftp-sink/README.adoc +++ b/applications/sink/ftp-sink/README.adoc @@ -32,20 +32,28 @@ N/A (writes to the FTP server). The **$$ftp$$** $$sink$$ has the following options: //tag::configuration-properties[] -$$ftp.consumer.auto-create-dir$$:: $$Whether or not to create the remote directory.$$ *($$Boolean$$, default: `$$true$$`)* -$$ftp.consumer.filename-expression$$:: $$A SpEL expression to generate the remote file name.$$ *($$String$$, default: `$$$$`)* -$$ftp.consumer.mode$$:: $$Action to take if the remote file already exists.$$ *($$FileExistsMode$$, default: `$$$$`, possible values: `APPEND`,`APPEND_NO_FLUSH`,`FAIL`,`IGNORE`,`REPLACE`,`REPLACE_IF_MODIFIED`)* -$$ftp.consumer.remote-dir$$:: $$The remote FTP directory.$$ *($$String$$, default: `$$/$$`)* -$$ftp.consumer.remote-file-separator$$:: $$The remote file separator.$$ *($$String$$, default: `$$/$$`)* -$$ftp.consumer.temporary-remote-dir$$:: $$A temporary directory where the file will be written if '#isUseTemporaryFilename()' is true.$$ *($$String$$, default: `$$/$$`)* -$$ftp.consumer.tmp-file-suffix$$:: $$The suffix to use while the transfer is in progress.$$ *($$String$$, default: `$$.tmp$$`)* -$$ftp.consumer.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: `$$$$`)* -$$ftp.factory.client-mode$$:: $$The client mode to use for the FTP session.$$ *($$ClientMode$$, default: `$$$$`, possible values: `ACTIVE`,`PASSIVE`)* -$$ftp.factory.host$$:: $$The host name of the server.$$ *($$String$$, default: `$$localhost$$`)* -$$ftp.factory.password$$:: $$The password to use to connect to the server.$$ *($$String$$, default: `$$$$`)* -$$ftp.factory.port$$:: $$The port of the server.$$ *($$Integer$$, default: `$$21$$`)* -$$ftp.factory.username$$:: $$The username to use to connect to the server.$$ *($$String$$, default: `$$$$`)* +Properties grouped by prefix: + + +=== ftp.consumer + +$$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: `$$.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: `$$localhost$$`)* +$$password$$:: $$The password to use to connect to the server.$$ *($$String$$, 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[] //end::ref-doc[] diff --git a/applications/sink/geode-sink/README.adoc b/applications/sink/geode-sink/README.adoc index 84dfd03a..d599fd50 100644 --- a/applications/sink/geode-sink/README.adoc +++ b/applications/sink/geode-sink/README.adoc @@ -8,22 +8,39 @@ The Geode sink will write Message contents to a Geode region. The **$$geode$$** $$sink$$ has the following options: //tag::configuration-properties[] -$$geode.consumer.json$$:: $$Indicates if the Geode region stores json objects as PdxInstance.$$ *($$Boolean$$, default: `$$false$$`)* -$$geode.consumer.key-expression$$:: $$SpEL expression to use as a cache key.$$ *($$String$$, default: `$$$$`)* -$$geode.pool.connect-type$$:: $$Specifies connection type: 'server' or 'locator'.$$ *($$ConnectType$$, default: `$$$$`, possible values: `locator`,`server`)* -$$geode.pool.host-addresses$$:: $$Specifies one or more Gemfire locator or server addresses formatted as [host]:[port].$$ *($$InetSocketAddress[]$$, default: `$$$$`)* -$$geode.pool.subscription-enabled$$:: $$Set to true to enable subscriptions for the client pool. Required to sync updates to the client cache.$$ *($$Boolean$$, default: `$$false$$`)* -$$geode.region.region-name$$:: $$The region name.$$ *($$String$$, default: `$$$$`)* -$$geode.security.password$$:: $$The cache password.$$ *($$String$$, default: `$$$$`)* -$$geode.security.ssl.ciphers$$:: $$Configures the SSL ciphers used for secure Socket connections as an array of valid cipher names.$$ *($$String$$, default: `$$any$$`)* -$$geode.security.ssl.keystore-type$$:: $$Identifies the type of Keystore used for SSL communications (e.g. JKS, PKCS11, etc.).$$ *($$String$$, default: `$$JKS$$`)* -$$geode.security.ssl.keystore-uri$$:: $$Location of the pre-created Keystore URI to be used for connecting to the Geode cluster.$$ *($$Resource$$, default: `$$$$`)* -$$geode.security.ssl.ssl-keystore-password$$:: $$Password for accessing the keys truststore.$$ *($$String$$, default: `$$$$`)* -$$geode.security.ssl.ssl-truststore-password$$:: $$Password for accessing the trust store.$$ *($$String$$, default: `$$$$`)* -$$geode.security.ssl.truststore-type$$:: $$Identifies the type of truststore used for SSL communications (e.g. JKS, PKCS11, etc.).$$ *($$String$$, default: `$$JKS$$`)* -$$geode.security.ssl.truststore-uri$$:: $$Location of the pre-created truststore URI to be used for connecting to the Geode cluster.$$ *($$Resource$$, default: `$$$$`)* -$$geode.security.ssl.user-home-directory$$:: $$Local directory to cache the truststore and keystore files downloaded form the truststoreUri and keystoreUri locations.$$ *($$String$$, default: `$$user.home$$`)* -$$geode.security.username$$:: $$The cache username.$$ *($$String$$, default: `$$$$`)* +Properties grouped by prefix: + + +=== geode.consumer + +$$json$$:: $$Indicates if the Geode region stores json objects as PdxInstance.$$ *($$Boolean$$, default: `$$false$$`)* +$$key-expression$$:: $$SpEL expression to use as a cache key.$$ *($$String$$, default: `$$$$`)* + +=== geode.pool + +$$connect-type$$:: $$Specifies connection type: 'server' or 'locator'.$$ *($$ConnectType$$, default: `$$$$`, possible values: `locator`,`server`)* +$$host-addresses$$:: $$Specifies one or more Gemfire locator or server addresses formatted as [host]:[port].$$ *($$InetSocketAddress[]$$, default: `$$$$`)* +$$subscription-enabled$$:: $$Set to true to enable subscriptions for the client pool. Required to sync updates to the client cache.$$ *($$Boolean$$, default: `$$false$$`)* + +=== geode.region + +$$region-name$$:: $$The region name.$$ *($$String$$, default: `$$$$`)* + +=== geode.security + +$$password$$:: $$The cache password.$$ *($$String$$, default: `$$$$`)* +$$username$$:: $$The cache username.$$ *($$String$$, default: `$$$$`)* + +=== geode.security.ssl + +$$ciphers$$:: $$Configures the SSL ciphers used for secure Socket connections as an array of valid cipher names.$$ *($$String$$, default: `$$any$$`)* +$$keystore-type$$:: $$Identifies the type of Keystore used for SSL communications (e.g. JKS, PKCS11, etc.).$$ *($$String$$, default: `$$JKS$$`)* +$$keystore-uri$$:: $$Location of the pre-created Keystore URI to be used for connecting to the Geode cluster.$$ *($$Resource$$, default: `$$$$`)* +$$ssl-keystore-password$$:: $$Password for accessing the keys truststore.$$ *($$String$$, default: `$$$$`)* +$$ssl-truststore-password$$:: $$Password for accessing the trust store.$$ *($$String$$, default: `$$$$`)* +$$truststore-type$$:: $$Identifies the type of truststore used for SSL communications (e.g. JKS, PKCS11, etc.).$$ *($$String$$, default: `$$JKS$$`)* +$$truststore-uri$$:: $$Location of the pre-created truststore URI to be used for connecting to the Geode cluster.$$ *($$Resource$$, default: `$$$$`)* +$$user-home-directory$$:: $$Local directory to cache the truststore and keystore files downloaded form the truststoreUri and keystoreUri locations.$$ *($$String$$, default: `$$user.home$$`)* //end::configuration-properties[] //end::ref-doc[] diff --git a/applications/sink/jdbc-sink/README.adoc b/applications/sink/jdbc-sink/README.adoc index c8c47159..3a105be6 100644 --- a/applications/sink/jdbc-sink/README.adoc +++ b/applications/sink/jdbc-sink/README.adoc @@ -41,18 +41,26 @@ java -jar jdbc-sink.jar --jdbc.consumer.tableName=names --jdbc.consumer.columns= The **$$jdbc$$** $$sink$$ has the following options: //tag::configuration-properties[] -$$jdbc.consumer.batch-size$$:: $$Threshold in number of messages when data will be flushed to database table.$$ *($$Integer$$, default: `$$1$$`)* -$$jdbc.consumer.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()$$`)* -$$jdbc.consumer.idle-timeout$$:: $$Idle timeout in milliseconds when data is automatically flushed to database table.$$ *($$Long$$, default: `$$-1$$`)* -$$jdbc.consumer.initialize$$:: $$'true', 'false' or the location of a custom initialization script for the table.$$ *($$String$$, default: `$$false$$`)* -$$jdbc.consumer.table-name$$:: $$The name of the table to write into.$$ *($$String$$, default: `$$messages$$`)* -$$spring.datasource.data$$:: $$Data (DML) script resource references.$$ *($$List$$, default: `$$$$`)* -$$spring.datasource.driver-class-name$$:: $$Fully qualified name of the JDBC driver. Auto-detected based on the URL by default.$$ *($$String$$, default: `$$$$`)* -$$spring.datasource.initialization-mode$$:: $$Initialize the datasource with available DDL and DML scripts.$$ *($$DataSourceInitializationMode$$, default: `$$embedded$$`, possible values: `ALWAYS`,`EMBEDDED`,`NEVER`)* -$$spring.datasource.password$$:: $$Login password of the database.$$ *($$String$$, default: `$$$$`)* -$$spring.datasource.schema$$:: $$Schema (DDL) script resource references.$$ *($$List$$, default: `$$$$`)* -$$spring.datasource.url$$:: $$JDBC URL of the database.$$ *($$String$$, default: `$$$$`)* -$$spring.datasource.username$$:: $$Login username of the database.$$ *($$String$$, default: `$$$$`)* +Properties grouped by prefix: + + +=== jdbc.consumer + +$$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 + +$$data$$:: $$Data (DML) script resource references.$$ *($$List$$, default: `$$$$`)* +$$driver-class-name$$:: $$Fully qualified name of the JDBC driver. Auto-detected based on the URL by default.$$ *($$String$$, default: `$$$$`)* +$$initialization-mode$$:: $$Initialize the datasource with available DDL and DML scripts.$$ *($$DataSourceInitializationMode$$, default: `$$embedded$$`, possible values: `ALWAYS`,`EMBEDDED`,`NEVER`)* +$$password$$:: $$Login password of the database.$$ *($$String$$, default: `$$$$`)* +$$schema$$:: $$Schema (DDL) script resource references.$$ *($$List$$, default: `$$$$`)* +$$url$$:: $$JDBC URL of the database.$$ *($$String$$, default: `$$$$`)* +$$username$$:: $$Login username of the database.$$ *($$String$$, default: `$$$$`)* //end::configuration-properties[] //end::ref-doc[] diff --git a/applications/sink/mongodb-sink/README.adoc b/applications/sink/mongodb-sink/README.adoc index 8116167a..99e9cd72 100644 --- a/applications/sink/mongodb-sink/README.adoc +++ b/applications/sink/mongodb-sink/README.adoc @@ -18,20 +18,28 @@ The **$$mongodb$$** $$sink$$ has the following options: //tag::configuration-properties[] -$$mongodb.consumer.collection$$:: $$The MongoDB collection to store data.$$ *($$String$$, default: `$$$$`)* -$$mongodb.consumer.collection-expression$$:: $$The SpEL expression to evaluate MongoDB collection.$$ *($$Expression$$, default: `$$$$`)* -$$spring.data.mongodb.authentication-database$$:: $$Authentication database name.$$ *($$String$$, default: `$$$$`)* -$$spring.data.mongodb.auto-index-creation$$:: $$Whether to enable auto-index creation.$$ *($$Boolean$$, default: `$$$$`)* -$$spring.data.mongodb.database$$:: $$Database name.$$ *($$String$$, default: `$$$$`)* -$$spring.data.mongodb.field-naming-strategy$$:: $$Fully qualified name of the FieldNamingStrategy to use.$$ *($$Class$$, default: `$$$$`)* -$$spring.data.mongodb.grid-fs-database$$:: $$GridFS database name.$$ *($$String$$, default: `$$$$`)* -$$spring.data.mongodb.host$$:: $$Mongo server host. Cannot be set with URI.$$ *($$String$$, default: `$$$$`)* -$$spring.data.mongodb.password$$:: $$Login password of the mongo server. Cannot be set with URI.$$ *($$Character[]$$, default: `$$$$`)* -$$spring.data.mongodb.port$$:: $$Mongo server port. Cannot be set with URI.$$ *($$Integer$$, default: `$$$$`)* -$$spring.data.mongodb.replica-set-name$$:: $$Required replica set name for the cluster. Cannot be set with URI.$$ *($$String$$, default: `$$$$`)* -$$spring.data.mongodb.uri$$:: $$Mongo database URI. Cannot be set with host, port, credentials and replica set name.$$ *($$String$$, default: `$$mongodb://localhost/test$$`)* -$$spring.data.mongodb.username$$:: $$Login user of the mongo server. Cannot be set with URI.$$ *($$String$$, default: `$$$$`)* -$$spring.data.mongodb.uuid-representation$$:: $$Representation to use when converting a UUID to a BSON binary value.$$ *($$UuidRepresentation$$, default: `$$java-legacy$$`, possible values: `UNSPECIFIED`,`STANDARD`,`C_SHARP_LEGACY`,`JAVA_LEGACY`,`PYTHON_LEGACY`)* +Properties grouped by prefix: + + +=== mongodb.consumer + +$$collection$$:: $$The MongoDB collection to store data.$$ *($$String$$, default: `$$$$`)* +$$collection-expression$$:: $$The SpEL expression to evaluate MongoDB collection.$$ *($$Expression$$, default: `$$$$`)* + +=== spring.data.mongodb + +$$authentication-database$$:: $$Authentication database name.$$ *($$String$$, default: `$$$$`)* +$$auto-index-creation$$:: $$Whether to enable auto-index creation.$$ *($$Boolean$$, default: `$$$$`)* +$$database$$:: $$Database name.$$ *($$String$$, default: `$$$$`)* +$$field-naming-strategy$$:: $$Fully qualified name of the FieldNamingStrategy to use.$$ *($$Class$$, default: `$$$$`)* +$$grid-fs-database$$:: $$GridFS database name.$$ *($$String$$, default: `$$$$`)* +$$host$$:: $$Mongo server host. Cannot be set with URI.$$ *($$String$$, default: `$$$$`)* +$$password$$:: $$Login password of the mongo server. Cannot be set with URI.$$ *($$Character[]$$, default: `$$$$`)* +$$port$$:: $$Mongo server port. Cannot be set with URI.$$ *($$Integer$$, default: `$$$$`)* +$$replica-set-name$$:: $$Required replica set name for the cluster. Cannot be set with URI.$$ *($$String$$, default: `$$$$`)* +$$uri$$:: $$Mongo database URI. Cannot be set with host, port, credentials and replica set name.$$ *($$String$$, default: `$$mongodb://localhost/test$$`)* +$$username$$:: $$Login user of the mongo server. Cannot be set with URI.$$ *($$String$$, default: `$$$$`)* +$$uuid-representation$$:: $$Representation to use when converting a UUID to a BSON binary value.$$ *($$UuidRepresentation$$, default: `$$java-legacy$$`, possible values: `UNSPECIFIED`,`STANDARD`,`C_SHARP_LEGACY`,`JAVA_LEGACY`,`PYTHON_LEGACY`)* //end::configuration-properties[] //end::ref-doc[] diff --git a/applications/sink/mqtt-sink/README.adoc b/applications/sink/mqtt-sink/README.adoc index 771369a3..2648234a 100644 --- a/applications/sink/mqtt-sink/README.adoc +++ b/applications/sink/mqtt-sink/README.adoc @@ -13,20 +13,28 @@ This module sends messages to MQTT. The **$$mqtt$$** $$sink$$ has the following options: //tag::configuration-properties[] -$$mqtt.clean-session$$:: $$whether the client and server should remember state across restarts and reconnects.$$ *($$Boolean$$, default: `$$true$$`)* -$$mqtt.connection-timeout$$:: $$the connection timeout in seconds.$$ *($$Integer$$, default: `$$30$$`)* -$$mqtt.consumer.async$$:: $$whether or not to use async sends.$$ *($$Boolean$$, default: `$$false$$`)* -$$mqtt.consumer.charset$$:: $$the charset used to convert a String payload to byte[].$$ *($$String$$, default: `$$UTF-8$$`)* -$$mqtt.consumer.client-id$$:: $$identifies the client.$$ *($$String$$, default: `$$stream.client.id.sink$$`)* -$$mqtt.consumer.qos$$:: $$the quality of service to use.$$ *($$Integer$$, default: `$$1$$`)* -$$mqtt.consumer.retained$$:: $$whether to set the 'retained' flag.$$ *($$Boolean$$, default: `$$false$$`)* -$$mqtt.consumer.topic$$:: $$the topic to which the sink will publish.$$ *($$String$$, default: `$$stream.mqtt$$`)* -$$mqtt.keep-alive-interval$$:: $$the ping interval in seconds.$$ *($$Integer$$, default: `$$60$$`)* -$$mqtt.password$$:: $$the password to use when connecting to the broker.$$ *($$String$$, default: `$$guest$$`)* -$$mqtt.persistence$$:: $$'memory' or 'file'.$$ *($$String$$, default: `$$memory$$`)* -$$mqtt.persistence-directory$$:: $$Persistence directory.$$ *($$String$$, default: `$$/tmp/paho$$`)* -$$mqtt.url$$:: $$location of the mqtt broker(s) (comma-delimited list).$$ *($$String[]$$, default: `$$[tcp://localhost:1883]$$`)* -$$mqtt.username$$:: $$the username to use when connecting to the broker.$$ *($$String$$, default: `$$guest$$`)* +Properties grouped by prefix: + + +=== mqtt + +$$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$$`)* +$$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: `$$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 f5399841..b90d5547 100644 --- a/applications/sink/rabbit-sink/README.adoc +++ b/applications/sink/rabbit-sink/README.adoc @@ -10,25 +10,33 @@ The **$$rabbit$$** $$sink$$ has the following options: (See the Spring Boot documentation for RabbitMQ connection properties) //tag::configuration-properties[] -$$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: `$$$$`)* -$$rabbit.exchange$$:: $$Exchange name - overridden by exchangeNameExpression, if supplied.$$ *($$String$$, default: `$$$$`)* -$$rabbit.exchange-expression$$:: $$A SpEL expression that evaluates to an exchange name.$$ *($$Expression$$, default: `$$$$`)* -$$rabbit.mapped-request-headers$$:: $$Headers that will be mapped.$$ *($$String[]$$, default: `$$[*]$$`)* -$$rabbit.own-connection$$:: $$When true, use a separate connection based on the boot properties.$$ *($$Boolean$$, default: `$$false$$`)* -$$rabbit.persistent-delivery-mode$$:: $$Default delivery mode when 'amqp_deliveryMode' header is not present, true for PERSISTENT.$$ *($$Boolean$$, default: `$$false$$`)* -$$rabbit.routing-key$$:: $$Routing key - overridden by routingKeyExpression, if supplied.$$ *($$String$$, default: `$$$$`)* -$$rabbit.routing-key-expression$$:: $$A SpEL expression that evaluates to a routing key.$$ *($$Expression$$, default: `$$$$`)* -$$spring.rabbitmq.addresses$$:: $$Comma-separated list of addresses to which the client should connect. When set, the host and port are ignored.$$ *($$String$$, default: `$$$$`)* -$$spring.rabbitmq.connection-timeout$$:: $$Connection timeout. Set it to zero to wait forever.$$ *($$Duration$$, default: `$$$$`)* -$$spring.rabbitmq.host$$:: $$RabbitMQ host. Ignored if an address is set.$$ *($$String$$, default: `$$localhost$$`)* -$$spring.rabbitmq.password$$:: $$Login to authenticate against the broker.$$ *($$String$$, default: `$$guest$$`)* -$$spring.rabbitmq.port$$:: $$RabbitMQ port. Ignored if an address is set. Default to 5672, or 5671 if SSL is enabled.$$ *($$Integer$$, default: `$$$$`)* -$$spring.rabbitmq.publisher-confirm-type$$:: $$Type of publisher confirms to use.$$ *($$ConfirmType$$, default: `$$$$`, possible values: `SIMPLE`,`CORRELATED`,`NONE`)* -$$spring.rabbitmq.publisher-returns$$:: $$Whether to enable publisher returns.$$ *($$Boolean$$, default: `$$false$$`)* -$$spring.rabbitmq.requested-channel-max$$:: $$Number of channels per connection requested by the client. Use 0 for unlimited.$$ *($$Integer$$, default: `$$2047$$`)* -$$spring.rabbitmq.requested-heartbeat$$:: $$Requested heartbeat timeout; zero for none. If a duration suffix is not specified, seconds will be used.$$ *($$Duration$$, default: `$$$$`)* -$$spring.rabbitmq.username$$:: $$Login user to authenticate to the broker.$$ *($$String$$, default: `$$guest$$`)* -$$spring.rabbitmq.virtual-host$$:: $$Virtual host to use when connecting to the broker.$$ *($$String$$, default: `$$$$`)* +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-expression$$:: $$A SpEL expression that evaluates to an exchange name.$$ *($$Expression$$, 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: `$$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: `$$$$`)* + +=== spring.rabbitmq + +$$addresses$$:: $$Comma-separated list of addresses to which the client should connect. When set, the host and port are ignored.$$ *($$String$$, default: `$$$$`)* +$$connection-timeout$$:: $$Connection timeout. Set it to zero to wait forever.$$ *($$Duration$$, default: `$$$$`)* +$$host$$:: $$RabbitMQ host. Ignored if an address is set.$$ *($$String$$, default: `$$localhost$$`)* +$$password$$:: $$Login to authenticate against the broker.$$ *($$String$$, default: `$$guest$$`)* +$$port$$:: $$RabbitMQ port. Ignored if an address is set. Default to 5672, or 5671 if SSL is enabled.$$ *($$Integer$$, default: `$$$$`)* +$$publisher-confirm-type$$:: $$Type of publisher confirms to use.$$ *($$ConfirmType$$, default: `$$$$`, possible values: `SIMPLE`,`CORRELATED`,`NONE`)* +$$publisher-returns$$:: $$Whether to enable publisher returns.$$ *($$Boolean$$, default: `$$false$$`)* +$$requested-channel-max$$:: $$Number of channels per connection requested by the client. Use 0 for unlimited.$$ *($$Integer$$, default: `$$2047$$`)* +$$requested-heartbeat$$:: $$Requested heartbeat timeout; zero for none. If a duration suffix is not specified, seconds will be used.$$ *($$Duration$$, default: `$$$$`)* +$$username$$:: $$Login user to authenticate to the broker.$$ *($$String$$, default: `$$guest$$`)* +$$virtual-host$$:: $$Virtual host to use when connecting to the broker.$$ *($$String$$, default: `$$$$`)* //end::configuration-properties[] //end::ref-doc[] diff --git a/applications/sink/redis-sink/README.adoc b/applications/sink/redis-sink/README.adoc index b19dd31c..bdde4726 100644 --- a/applications/sink/redis-sink/README.adoc +++ b/applications/sink/redis-sink/README.adoc @@ -8,33 +8,50 @@ Sends messages to Redis. The **$$redis$$** $$sink$$ has the following options: //tag::configuration-properties[] -$$redis.consumer.key$$:: $$A literal key name to use when storing to a key.$$ *($$String$$, default: `$$$$`)* -$$redis.consumer.key-expression$$:: $$A SpEL expression to use for storing to a key.$$ *($$String$$, default: `$$$$`)* -$$redis.consumer.queue$$:: $$A literal queue name to use when storing in a queue.$$ *($$String$$, default: `$$$$`)* -$$redis.consumer.queue-expression$$:: $$A SpEL expression to use for queue.$$ *($$String$$, default: `$$$$`)* -$$redis.consumer.topic$$:: $$A literal topic name to use when publishing to a topic.$$ *($$String$$, default: `$$$$`)* -$$redis.consumer.topic-expression$$:: $$A SpEL expression to use for topic.$$ *($$String$$, default: `$$$$`)* -$$spring.redis.client-name$$:: $$Client name to be set on connections with CLIENT SETNAME.$$ *($$String$$, default: `$$$$`)* -$$spring.redis.database$$:: $$Database index used by the connection factory.$$ *($$Integer$$, default: `$$0$$`)* -$$spring.redis.host$$:: $$Redis server host.$$ *($$String$$, default: `$$localhost$$`)* -$$spring.redis.jedis.pool.max-active$$:: $$Maximum number of connections that can be allocated by the pool at a given time. Use a negative value for no limit.$$ *($$Integer$$, default: `$$8$$`)* -$$spring.redis.jedis.pool.max-idle$$:: $$Maximum number of "idle" connections in the pool. Use a negative value to indicate an unlimited number of idle connections.$$ *($$Integer$$, default: `$$8$$`)* -$$spring.redis.jedis.pool.max-wait$$:: $$Maximum amount of time a connection allocation should block before throwing an exception when the pool is exhausted. Use a negative value to block indefinitely.$$ *($$Duration$$, default: `$$-1ms$$`)* -$$spring.redis.jedis.pool.min-idle$$:: $$Target for the minimum number of idle connections to maintain in the pool. This setting only has an effect if both it and time between eviction runs are positive.$$ *($$Integer$$, default: `$$0$$`)* -$$spring.redis.jedis.pool.time-between-eviction-runs$$:: $$Time between runs of the idle object evictor thread. When positive, the idle object evictor thread starts, otherwise no idle object eviction is performed.$$ *($$Duration$$, default: `$$$$`)* -$$spring.redis.lettuce.pool.max-active$$:: $$Maximum number of connections that can be allocated by the pool at a given time. Use a negative value for no limit.$$ *($$Integer$$, default: `$$8$$`)* -$$spring.redis.lettuce.pool.max-idle$$:: $$Maximum number of "idle" connections in the pool. Use a negative value to indicate an unlimited number of idle connections.$$ *($$Integer$$, default: `$$8$$`)* -$$spring.redis.lettuce.pool.max-wait$$:: $$Maximum amount of time a connection allocation should block before throwing an exception when the pool is exhausted. Use a negative value to block indefinitely.$$ *($$Duration$$, default: `$$-1ms$$`)* -$$spring.redis.lettuce.pool.min-idle$$:: $$Target for the minimum number of idle connections to maintain in the pool. This setting only has an effect if both it and time between eviction runs are positive.$$ *($$Integer$$, default: `$$0$$`)* -$$spring.redis.lettuce.pool.time-between-eviction-runs$$:: $$Time between runs of the idle object evictor thread. When positive, the idle object evictor thread starts, otherwise no idle object eviction is performed.$$ *($$Duration$$, default: `$$$$`)* -$$spring.redis.password$$:: $$Login password of the redis server.$$ *($$String$$, default: `$$$$`)* -$$spring.redis.port$$:: $$Redis server port.$$ *($$Integer$$, default: `$$6379$$`)* -$$spring.redis.sentinel.master$$:: $$Name of the Redis server.$$ *($$String$$, default: `$$$$`)* -$$spring.redis.sentinel.nodes$$:: $$Comma-separated list of "host:port" pairs.$$ *($$List$$, default: `$$$$`)* -$$spring.redis.sentinel.password$$:: $$Password for authenticating with sentinel(s).$$ *($$String$$, default: `$$$$`)* -$$spring.redis.ssl$$:: $$Whether to enable SSL support.$$ *($$Boolean$$, default: `$$false$$`)* -$$spring.redis.timeout$$:: $$Connection timeout.$$ *($$Duration$$, default: `$$$$`)* -$$spring.redis.url$$:: $$Connection URL. Overrides host, port, and password. User is ignored. Example: redis://user:password@example.com:6379$$ *($$String$$, default: `$$$$`)* +Properties grouped by prefix: + + +=== redis.consumer + +$$key$$:: $$A literal key name to use when storing to a key.$$ *($$String$$, default: `$$$$`)* +$$key-expression$$:: $$A SpEL expression to use for storing to a key.$$ *($$String$$, default: `$$$$`)* +$$queue$$:: $$A literal queue name to use when storing in a queue.$$ *($$String$$, default: `$$$$`)* +$$queue-expression$$:: $$A SpEL expression to use for queue.$$ *($$String$$, default: `$$$$`)* +$$topic$$:: $$A literal topic name to use when publishing to a topic.$$ *($$String$$, default: `$$$$`)* +$$topic-expression$$:: $$A SpEL expression to use for topic.$$ *($$String$$, default: `$$$$`)* + +=== spring.redis + +$$client-name$$:: $$Client name to be set on connections with CLIENT SETNAME.$$ *($$String$$, default: `$$$$`)* +$$database$$:: $$Database index used by the connection factory.$$ *($$Integer$$, default: `$$0$$`)* +$$host$$:: $$Redis server host.$$ *($$String$$, default: `$$localhost$$`)* +$$password$$:: $$Login password of the redis server.$$ *($$String$$, default: `$$$$`)* +$$port$$:: $$Redis server port.$$ *($$Integer$$, default: `$$6379$$`)* +$$ssl$$:: $$Whether to enable SSL support.$$ *($$Boolean$$, default: `$$false$$`)* +$$timeout$$:: $$Connection timeout.$$ *($$Duration$$, default: `$$$$`)* +$$url$$:: $$Connection URL. Overrides host, port, and password. User is ignored. Example: redis://user:password@example.com:6379$$ *($$String$$, default: `$$$$`)* + +=== spring.redis.jedis.pool + +$$max-active$$:: $$Maximum number of connections that can be allocated by the pool at a given time. Use a negative value for no limit.$$ *($$Integer$$, default: `$$8$$`)* +$$max-idle$$:: $$Maximum number of "idle" connections in the pool. Use a negative value to indicate an unlimited number of idle connections.$$ *($$Integer$$, default: `$$8$$`)* +$$max-wait$$:: $$Maximum amount of time a connection allocation should block before throwing an exception when the pool is exhausted. Use a negative value to block indefinitely.$$ *($$Duration$$, default: `$$-1ms$$`)* +$$min-idle$$:: $$Target for the minimum number of idle connections to maintain in the pool. This setting only has an effect if both it and time between eviction runs are positive.$$ *($$Integer$$, default: `$$0$$`)* +$$time-between-eviction-runs$$:: $$Time between runs of the idle object evictor thread. When positive, the idle object evictor thread starts, otherwise no idle object eviction is performed.$$ *($$Duration$$, default: `$$$$`)* + +=== spring.redis.lettuce.pool + +$$max-active$$:: $$Maximum number of connections that can be allocated by the pool at a given time. Use a negative value for no limit.$$ *($$Integer$$, default: `$$8$$`)* +$$max-idle$$:: $$Maximum number of "idle" connections in the pool. Use a negative value to indicate an unlimited number of idle connections.$$ *($$Integer$$, default: `$$8$$`)* +$$max-wait$$:: $$Maximum amount of time a connection allocation should block before throwing an exception when the pool is exhausted. Use a negative value to block indefinitely.$$ *($$Duration$$, default: `$$-1ms$$`)* +$$min-idle$$:: $$Target for the minimum number of idle connections to maintain in the pool. This setting only has an effect if both it and time between eviction runs are positive.$$ *($$Integer$$, default: `$$0$$`)* +$$time-between-eviction-runs$$:: $$Time between runs of the idle object evictor thread. When positive, the idle object evictor thread starts, otherwise no idle object eviction is performed.$$ *($$Duration$$, default: `$$$$`)* + +=== spring.redis.sentinel + +$$master$$:: $$Name of the Redis server.$$ *($$String$$, default: `$$$$`)* +$$nodes$$:: $$Comma-separated list of "host:port" pairs.$$ *($$List$$, default: `$$$$`)* +$$password$$:: $$Password for authenticating with sentinel(s).$$ *($$String$$, default: `$$$$`)* //end::configuration-properties[] //end::ref-doc[] diff --git a/applications/sink/s3-sink/README.adoc b/applications/sink/s3-sink/README.adoc index 0423f242..be85aaec 100644 --- a/applications/sink/s3-sink/README.adoc +++ b/applications/sink/s3-sink/README.adoc @@ -15,13 +15,21 @@ Messages accepted by this sink must contain one of the `payload` as: The **$$s3$$** $$sink$$ has the following options: //tag::configuration-properties[] -$$s3.common.endpoint-url$$:: $$Optional endpoint url to connect to s3 compatible storage.$$ *($$String$$, default: `$$$$`)* -$$s3.common.path-style-access$$:: $$Use path style access.$$ *($$Boolean$$, default: `$$false$$`)* -$$s3.consumer.acl$$:: $$S3 Object access control list.$$ *($$CannedAccessControlList$$, default: `$$$$`, possible values: `private`,`public-read`,`public-read-write`,`authenticated-read`,`log-delivery-write`,`bucket-owner-read`,`bucket-owner-full-control`,`aws-exec-read`)* -$$s3.consumer.acl-expression$$:: $$Expression to evaluate S3 Object access control list.$$ *($$Expression$$, default: `$$$$`)* -$$s3.consumer.bucket$$:: $$AWS bucket for target file(s) to store.$$ *($$String$$, default: `$$$$`)* -$$s3.consumer.bucket-expression$$:: $$Expression to evaluate AWS bucket name.$$ *($$Expression$$, default: `$$$$`)* -$$s3.consumer.key-expression$$:: $$Expression to evaluate S3 Object key.$$ *($$Expression$$, default: `$$$$`)* +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: `$$false$$`)* + +=== s3.consumer + +$$acl$$:: $$S3 Object access control list.$$ *($$CannedAccessControlList$$, default: `$$$$`, possible values: `private`,`public-read`,`public-read-write`,`authenticated-read`,`log-delivery-write`,`bucket-owner-read`,`bucket-owner-full-control`,`aws-exec-read`)* +$$acl-expression$$:: $$Expression to evaluate S3 Object access control list.$$ *($$Expression$$, default: `$$$$`)* +$$bucket$$:: $$AWS bucket for target file(s) to store.$$ *($$String$$, default: `$$$$`)* +$$bucket-expression$$:: $$Expression to evaluate AWS bucket name.$$ *($$Expression$$, default: `$$$$`)* +$$key-expression$$:: $$Expression to evaluate S3 Object key.$$ *($$Expression$$, default: `$$$$`)* //end::configuration-properties[] The target generated application based on the `AmazonS3SinkConfiguration` can be enhanced with the `S3MessageHandler.UploadMetadataProvider` and/or `S3ProgressListener`, which are injected into `S3MessageHandler` bean. diff --git a/applications/sink/sftp-sink/README.adoc b/applications/sink/sftp-sink/README.adoc index 1dd2762e..8555e786 100644 --- a/applications/sink/sftp-sink/README.adoc +++ b/applications/sink/sftp-sink/README.adoc @@ -36,23 +36,31 @@ N/A (writes to the SFTP server). The **$$sftp$$** $$sink$$ has the following options: //tag::configuration-properties[] -$$sftp.consumer.auto-create-dir$$:: $$Whether or not to create the remote directory.$$ *($$Boolean$$, default: `$$true$$`)* -$$sftp.consumer.factory.allow-unknown-keys$$:: $$True to allow an unknown or changed key.$$ *($$Boolean$$, default: `$$false$$`)* -$$sftp.consumer.factory.cache-sessions$$:: $$Cache sessions.$$ *($$Boolean$$, default: `$$$$`)* -$$sftp.consumer.factory.host$$:: $$The host name of the server.$$ *($$String$$, default: `$$localhost$$`)* -$$sftp.consumer.factory.known-hosts-expression$$:: $$A SpEL expression resolving to the location of the known hosts file.$$ *($$Expression$$, default: `$$$$`)* -$$sftp.consumer.factory.pass-phrase$$:: $$Passphrase for user's private key.$$ *($$String$$, default: `$$$$`)* -$$sftp.consumer.factory.password$$:: $$The password to use to connect to the server.$$ *($$String$$, default: `$$$$`)* -$$sftp.consumer.factory.port$$:: $$The port of the server.$$ *($$Integer$$, default: `$$22$$`)* -$$sftp.consumer.factory.private-key$$:: $$Resource location of user's private key.$$ *($$Resource$$, default: `$$$$`)* -$$sftp.consumer.factory.username$$:: $$The username to use to connect to the server.$$ *($$String$$, default: `$$$$`)* -$$sftp.consumer.filename-expression$$:: $$A SpEL expression to generate the remote file name.$$ *($$String$$, default: `$$$$`)* -$$sftp.consumer.mode$$:: $$Action to take if the remote file already exists.$$ *($$FileExistsMode$$, default: `$$$$`, possible values: `APPEND`,`APPEND_NO_FLUSH`,`FAIL`,`IGNORE`,`REPLACE`,`REPLACE_IF_MODIFIED`)* -$$sftp.consumer.remote-dir$$:: $$The remote FTP directory.$$ *($$String$$, default: `$$/$$`)* -$$sftp.consumer.remote-file-separator$$:: $$The remote file separator.$$ *($$String$$, default: `$$/$$`)* -$$sftp.consumer.temporary-remote-dir$$:: $$A temporary directory where the file will be written if 'isUseTemporaryFilename()' is true.$$ *($$String$$, default: `$$/$$`)* -$$sftp.consumer.tmp-file-suffix$$:: $$The suffix to use while the transfer is in progress.$$ *($$String$$, default: `$$.tmp$$`)* -$$sftp.consumer.use-temporary-filename$$:: $$Whether or not to write to a temporary file and rename.$$ *($$Boolean$$, default: `$$true$$`)* +Properties grouped by prefix: + + +=== sftp.consumer + +$$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: `$$.tmp$$`)* +$$use-temporary-filename$$:: $$Whether or not to write to a temporary file and rename.$$ *($$Boolean$$, default: `$$true$$`)* + +=== sftp.consumer.factory + +$$allow-unknown-keys$$:: $$True to allow an unknown or changed key.$$ *($$Boolean$$, default: `$$false$$`)* +$$cache-sessions$$:: $$Cache sessions.$$ *($$Boolean$$, default: `$$$$`)* +$$host$$:: $$The host name of the server.$$ *($$String$$, default: `$$localhost$$`)* +$$known-hosts-expression$$:: $$A SpEL expression resolving to the location of the known hosts file.$$ *($$Expression$$, default: `$$$$`)* +$$pass-phrase$$:: $$Passphrase for user's private key.$$ *($$String$$, default: `$$$$`)* +$$password$$:: $$The password to use to connect to the server.$$ *($$String$$, default: `$$$$`)* +$$port$$:: $$The port of the server.$$ *($$Integer$$, default: `$$22$$`)* +$$private-key$$:: $$Resource location of user's private key.$$ *($$Resource$$, default: `$$$$`)* +$$username$$:: $$The username to use to connect to the server.$$ *($$String$$, default: `$$$$`)* //end::configuration-properties[] //end::ref-doc[] diff --git a/applications/sink/tasklauncher-sink/README.adoc b/applications/sink/tasklauncher-sink/README.adoc index 7d3b89ad..b5a14ffe 100644 --- a/applications/sink/tasklauncher-sink/README.adoc +++ b/applications/sink/tasklauncher-sink/README.adoc @@ -37,23 +37,43 @@ Minimally, it must include the task name. The **$$tasklauncher-dataflow$$** $$sink$$ supports the following configuration properties: //tag::configuration-properties[] -$$spring.cloud.dataflow.client.authentication.access-token$$:: $$OAuth2 Access Token.$$ *($$String$$, default: `$$$$`)* -$$spring.cloud.dataflow.client.authentication.basic.password$$:: $$The login password.$$ *($$String$$, default: `$$$$`)* -$$spring.cloud.dataflow.client.authentication.basic.username$$:: $$The login username.$$ *($$String$$, default: `$$$$`)* -$$spring.cloud.dataflow.client.authentication.client-id$$:: $$OAuth2 Client Id.$$ *($$String$$, default: `$$$$`)* -$$spring.cloud.dataflow.client.authentication.client-secret$$:: $$OAuth2 Client Secret.$$ *($$String$$, default: `$$$$`)* -$$spring.cloud.dataflow.client.authentication.oauth2.client-registration-id$$:: $$$$ *($$String$$, default: `$$$$`)* -$$spring.cloud.dataflow.client.authentication.oauth2.password$$:: $$$$ *($$String$$, default: `$$$$`)* -$$spring.cloud.dataflow.client.authentication.oauth2.username$$:: $$$$ *($$String$$, default: `$$$$`)* -$$spring.cloud.dataflow.client.authentication.scope$$:: $$OAuth2 Scopes.$$ *($$Set$$, default: `$$$$`)* -$$spring.cloud.dataflow.client.authentication.token-uri$$:: $$OAuth2 Token Uri.$$ *($$String$$, default: `$$$$`)* -$$spring.cloud.dataflow.client.enable-dsl$$:: $$Enable Data Flow DSL access.$$ *($$Boolean$$, default: `$$false$$`)* -$$spring.cloud.dataflow.client.server-uri$$:: $$The Data Flow server URI.$$ *($$String$$, default: `$$http://localhost:9393$$`)* -$$spring.cloud.dataflow.client.skip-ssl-validation$$:: $$Skip Ssl validation.$$ *($$Boolean$$, default: `$$false$$`)* -$$tasklauncher.platform-name$$:: $$The Spring Cloud Data Flow platform to use for launching tasks.$$ *($$String$$, default: `$$default$$`)* -$$trigger.initial-delay$$:: $$The initial delay in milliseconds.$$ *($$Integer$$, default: `$$1000$$`)* -$$trigger.max-period$$:: $$The maximum polling period in milliseconds. Will be set to period if period > maxPeriod.$$ *($$Integer$$, default: `$$30000$$`)* -$$trigger.period$$:: $$The polling period in milliseconds.$$ *($$Integer$$, default: `$$1000$$`)* +Properties grouped by prefix: + + +=== spring.cloud.dataflow.client.authentication + +$$access-token$$:: $$OAuth2 Access Token.$$ *($$String$$, default: `$$$$`)* +$$client-id$$:: $$OAuth2 Client Id.$$ *($$String$$, default: `$$$$`)* +$$client-secret$$:: $$OAuth2 Client Secret.$$ *($$String$$, default: `$$$$`)* +$$scope$$:: $$OAuth2 Scopes.$$ *($$Set$$, default: `$$$$`)* +$$token-uri$$:: $$OAuth2 Token Uri.$$ *($$String$$, default: `$$$$`)* + +=== spring.cloud.dataflow.client.authentication.basic + +$$password$$:: $$The login password.$$ *($$String$$, default: `$$$$`)* +$$username$$:: $$The login username.$$ *($$String$$, default: `$$$$`)* + +=== spring.cloud.dataflow.client.authentication.oauth2 + +$$client-registration-id$$:: $$$$ *($$String$$, default: `$$$$`)* +$$password$$:: $$$$ *($$String$$, default: `$$$$`)* +$$username$$:: $$$$ *($$String$$, default: `$$$$`)* + +=== spring.cloud.dataflow.client + +$$enable-dsl$$:: $$Enable Data Flow DSL access.$$ *($$Boolean$$, default: `$$false$$`)* +$$server-uri$$:: $$The Data Flow server URI.$$ *($$String$$, default: `$$http://localhost:9393$$`)* +$$skip-ssl-validation$$:: $$Skip Ssl validation.$$ *($$Boolean$$, default: `$$false$$`)* + +=== tasklauncher + +$$platform-name$$:: $$The Spring Cloud Data Flow platform to use for launching tasks.$$ *($$String$$, default: `$$default$$`)* + +=== trigger + +$$initial-delay$$:: $$The initial delay in milliseconds.$$ *($$Integer$$, default: `$$1000$$`)* +$$max-period$$:: $$The maximum polling period in milliseconds. Will be set to period if period > maxPeriod.$$ *($$Integer$$, default: `$$30000$$`)* +$$period$$:: $$The polling period in milliseconds.$$ *($$Integer$$, default: `$$1000$$`)* //end::configuration-properties[] == Using the TaskLauncher diff --git a/applications/sink/tcp-sink/README.adoc b/applications/sink/tcp-sink/README.adoc index 62aa0cf4..5f940b24 100644 --- a/applications/sink/tcp-sink/README.adoc +++ b/applications/sink/tcp-sink/README.adoc @@ -11,15 +11,23 @@ available, the default being 'CRLF'. The **$$tcp$$** $$sink$$ has the following options: //tag::configuration-properties[] -$$tcp.consumer.charset$$:: $$The charset used when converting from bytes to String.$$ *($$String$$, default: `$$UTF-8$$`)* -$$tcp.consumer.close$$:: $$Whether to close the socket after each message.$$ *($$Boolean$$, default: `$$false$$`)* -$$tcp.consumer.encoder$$:: $$The encoder to use when sending messages.$$ *($$Encoding$$, default: `$$$$`, possible values: `CRLF`,`LF`,`NULL`,`STXETX`,`RAW`,`L1`,`L2`,`L4`)* -$$tcp.consumer.host$$:: $$The host to which this sink will connect.$$ *($$String$$, default: `$$$$`)* -$$tcp.nio$$:: $$Whether or not to use NIO.$$ *($$Boolean$$, default: `$$false$$`)* -$$tcp.port$$:: $$The port on which to listen; 0 for the OS to choose a port.$$ *($$Integer$$, default: `$$1234$$`)* -$$tcp.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$$`)* -$$tcp.socket-timeout$$:: $$The timeout (ms) before closing the socket when no data is received.$$ *($$Integer$$, default: `$$120000$$`)* -$$tcp.use-direct-buffers$$:: $$Whether or not to use direct buffers.$$ *($$Boolean$$, default: `$$false$$`)* +Properties grouped by prefix: + + +=== tcp.consumer + +$$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: `$$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/twitter-update-sink/README.adoc b/applications/sink/twitter-update-sink/README.adoc index 4a16e1dd..076390d2 100644 --- a/applications/sink/twitter-update-sink/README.adoc +++ b/applications/sink/twitter-update-sink/README.adoc @@ -16,14 +16,22 @@ You can find details for the Update API here: https://developer.twitter.com/en/d == Options //tag::configuration-properties[] -$$twitter.update.attachment-url$$:: $$(SpEL expression) In order for a URL to not be counted in the text body of an extended Tweet, provide a URL as a Tweet attachment. This URL must be a Tweet permalink, or Direct Message deep link. Arbitrary, non-Twitter URLs must remain in the text text. URLs passed to the attachment_url parameter not matching either a Tweet permalink or Direct Message deep link will fail at Tweet creation and cause an exception.$$ *($$Expression$$, default: `$$$$`)* -$$twitter.update.display-coordinates$$:: $$(SpEL expression) Whether or not to put a pin on the exact coordinates a Tweet has been sent from.$$ *($$Expression$$, default: `$$$$`)* -$$twitter.update.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: `$$$$`)* -$$twitter.update.location.lat$$:: $$The latitude of the location this Tweet refers to. This parameter will be ignored unless it is inside the range -90.0 to +90.0 (North is positive) inclusive. It will also be ignored if there is no corresponding long parameter.$$ *($$Expression$$, default: `$$$$`)* -$$twitter.update.location.lon$$:: $$The longitude of the location this Tweet refers to. The valid ranges for longitude are -180.0 to +180.0 (East is positive) inclusive. This parameter will be ignored if outside that range, if it is not a number, if geo_enabled is disabled, or if there no corresponding lat parameter.$$ *($$Expression$$, default: `$$$$`)* -$$twitter.update.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: `$$$$`)* -$$twitter.update.place-id$$:: $$(SpEL expression) A place in the world.$$ *($$Expression$$, default: `$$$$`)* -$$twitter.update.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$$`)* +Properties grouped by prefix: + + +=== twitter.update + +$$attachment-url$$:: $$(SpEL expression) In order for a URL to not be counted in the text body of an extended Tweet, provide a URL as a Tweet attachment. This URL must be a Tweet permalink, or Direct Message deep link. Arbitrary, non-Twitter URLs must remain in the text text. URLs passed to the attachment_url parameter not matching either a Tweet permalink or Direct Message deep link will fail at Tweet creation and cause an exception.$$ *($$Expression$$, default: `$$$$`)* +$$display-coordinates$$:: $$(SpEL expression) Whether or not to put a pin on the exact coordinates a Tweet has been sent from.$$ *($$Expression$$, default: `$$$$`)* +$$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: `$$payload$$`)* + +=== twitter.update.location + +$$lat$$:: $$The latitude of the location this Tweet refers to. This parameter will be ignored unless it is inside the range -90.0 to +90.0 (North is positive) inclusive. It will also be ignored if there is no corresponding long parameter.$$ *($$Expression$$, default: `$$$$`)* +$$lon$$:: $$The longitude of the location this Tweet refers to. The valid ranges for longitude are -180.0 to +180.0 (East is positive) inclusive. This parameter will be ignored if outside that range, if it is not a number, if geo_enabled is disabled, or if there no corresponding lat parameter.$$ *($$Expression$$, default: `$$$$`)* //end::configuration-properties[] //end::ref-doc[] diff --git a/applications/source/cdc-debezium-source/README.adoc b/applications/source/cdc-debezium-source/README.adoc index 758304bb..46ce9008 100644 --- a/applications/source/cdc-debezium-source/README.adoc +++ b/applications/source/cdc-debezium-source/README.adoc @@ -17,37 +17,72 @@ The CDC Source introduces a new default `BackingOffsetStore` configuration, base == Options //tag::configuration-properties[] -$$cdc.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: `$$$$`)* -$$cdc.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`)* -$$cdc.flattering.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: `$$$$`)* -$$cdc.flattering.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: `$$$$`)* -$$cdc.flattering.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`)* -$$cdc.flattering.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$$`)* -$$cdc.flattering.enabled$$:: $$Enable flattering the source record events (https://debezium.io/docs/configuration/event-flattening).$$ *($$Boolean$$, default: `$$true$$`)* -$$cdc.name$$:: $$Unique name for this sourceConnector instance.$$ *($$String$$, default: `$$$$`)* -$$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: `$$5000ms$$`)* -$$cdc.offset.flush-interval$$:: $$Interval at which to try committing offsets. The default is 1 minute.$$ *($$Duration$$, default: `$$60000ms$$`)* -$$cdc.offset.policy$$:: $$Offset storage commit policy.$$ *($$OffsetPolicy$$, default: `$$$$`)* -$$cdc.offset.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.schema$$:: $$Include the schema's as part of the outbound message.$$ *($$Boolean$$, default: `$$false$$`)* -$$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: `$$true$$`)* -$$cdc.stream.header.offset$$:: $$Serializes the source record's offset metadata into the outbound message header under cdc.offset.$$ *($$Boolean$$, default: `$$false$$`)* -$$metadata.store.dynamo-db.create-delay$$:: $$Delay between create table retries.$$ *($$Integer$$, default: `$$1$$`)* -$$metadata.store.dynamo-db.create-retries$$:: $$Retry number for create table request.$$ *($$Integer$$, default: `$$25$$`)* -$$metadata.store.dynamo-db.read-capacity$$:: $$Read capacity on the table.$$ *($$Long$$, default: `$$1$$`)* -$$metadata.store.dynamo-db.table$$:: $$Table name for metadata.$$ *($$String$$, default: `$$$$`)* -$$metadata.store.dynamo-db.time-to-live$$:: $$TTL for table entries.$$ *($$Integer$$, default: `$$$$`)* -$$metadata.store.dynamo-db.write-capacity$$:: $$Write capacity on the table.$$ *($$Long$$, default: `$$1$$`)* -$$metadata.store.gemfire.region$$:: $$Gemfire region name for metadata.$$ *($$String$$, default: `$$$$`)* -$$metadata.store.jdbc.region$$:: $$Unique grouping identifier for messages persisted with this store.$$ *($$String$$, default: `$$DEFAULT$$`)* -$$metadata.store.jdbc.table-prefix$$:: $$Prefix for the custom table name.$$ *($$String$$, default: `$$$$`)* -$$metadata.store.mongo-db.collection$$:: $$MongoDB collection name for metadata.$$ *($$String$$, default: `$$metadataStore$$`)* -$$metadata.store.redis.key$$:: $$Redis key for metadata.$$ *($$String$$, default: `$$$$`)* -$$metadata.store.type$$:: $$Indicates the type of metadata store to configure (default is 'memory'). You must include the corresponding Spring Integration dependency to use a persistent store.$$ *($$StoreType$$, default: `$$$$`, possible values: `mongodb`,`gemfire`,`redis`,`dynamodb`,`jdbc`,`zookeeper`,`hazelcast`,`memory`)* -$$metadata.store.zookeeper.connect-string$$:: $$Zookeeper connect string in form HOST:PORT.$$ *($$String$$, default: `$$127.0.0.1:2181$$`)* -$$metadata.store.zookeeper.encoding$$:: $$Encoding to use when storing data in Zookeeper.$$ *($$Charset$$, default: `$$UTF-8$$`)* -$$metadata.store.zookeeper.retry-interval$$:: $$Retry interval for Zookeeper operations in milliseconds.$$ *($$Integer$$, default: `$$1000$$`)* -$$metadata.store.zookeeper.root$$:: $$Root node - store entries are children of this node.$$ *($$String$$, default: `$$/SpringIntegration-MetadataStore$$`)* +Properties grouped by prefix: + + +=== cdc + +$$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: `$$false$$`)* + +=== cdc.flattering + +$$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: `$$true$$`)* +$$enabled$$:: $$Enable flattering 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: `$$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: `$$true$$`)* +$$offset$$:: $$Serializes the source record's offset metadata into the outbound message header under cdc.offset.$$ *($$Boolean$$, default: `$$false$$`)* + +=== metadata.store.dynamo-db + +$$create-delay$$:: $$Delay between create table retries.$$ *($$Integer$$, default: `$$1$$`)* +$$create-retries$$:: $$Retry number for create table request.$$ *($$Integer$$, default: `$$25$$`)* +$$read-capacity$$:: $$Read capacity on the table.$$ *($$Long$$, default: `$$1$$`)* +$$table$$:: $$Table name for metadata.$$ *($$String$$, default: `$$$$`)* +$$time-to-live$$:: $$TTL for table entries.$$ *($$Integer$$, default: `$$$$`)* +$$write-capacity$$:: $$Write capacity on the table.$$ *($$Long$$, default: `$$1$$`)* + +=== metadata.store.gemfire + +$$region$$:: $$Gemfire region name for metadata.$$ *($$String$$, default: `$$$$`)* + +=== metadata.store.jdbc + +$$region$$:: $$Unique grouping identifier for messages persisted with this store.$$ *($$String$$, default: `$$DEFAULT$$`)* +$$table-prefix$$:: $$Prefix for the custom table name.$$ *($$String$$, default: `$$$$`)* + +=== metadata.store.mongo-db + +$$collection$$:: $$MongoDB collection name for metadata.$$ *($$String$$, default: `$$metadataStore$$`)* + +=== metadata.store.redis + +$$key$$:: $$Redis key for metadata.$$ *($$String$$, default: `$$$$`)* + +=== metadata.store + +$$type$$:: $$Indicates the type of metadata store to configure (default is 'memory'). You must include the corresponding Spring Integration dependency to use a persistent store.$$ *($$StoreType$$, default: `$$$$`, possible values: `mongodb`,`gemfire`,`redis`,`dynamodb`,`jdbc`,`zookeeper`,`hazelcast`,`memory`)* + +=== metadata.store.zookeeper + +$$connect-string$$:: $$Zookeeper connect string in form HOST:PORT.$$ *($$String$$, default: `$$127.0.0.1:2181$$`)* +$$encoding$$:: $$Encoding to use when storing data in Zookeeper.$$ *($$Charset$$, default: `$$UTF-8$$`)* +$$retry-interval$$:: $$Retry interval for Zookeeper operations in milliseconds.$$ *($$Integer$$, default: `$$1000$$`)* +$$root$$:: $$Root node - store entries are children of this node.$$ *($$String$$, default: `$$/SpringIntegration-MetadataStore$$`)* //end::configuration-properties[] ==== Debezium property Shortcut mapping diff --git a/applications/source/file-source/README.adoc b/applications/source/file-source/README.adoc index 36b08f32..c3b1a502 100644 --- a/applications/source/file-source/README.adoc +++ b/applications/source/file-source/README.adoc @@ -20,14 +20,22 @@ The payload of these 2 additional marker messages is of type `FileSplitter.FileM The **$$file$$** $$source$$ has the following options: //tag::configuration-properties[] -$$file.consumer.markers-json$$:: $$When 'fileMarkers == true', specify if they should be produced as FileSplitter.FileMarker objects or JSON.$$ *($$Boolean$$, default: `$$true$$`)* -$$file.consumer.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`)* -$$file.consumer.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: `$$$$`)* -$$file.supplier.delay-when-empty$$:: $$Duration of delay when no new files are detected.$$ *($$Duration$$, default: `$$1s$$`)* -$$file.supplier.directory$$:: $$The directory to poll for new files.$$ *($$File$$, default: `$$$$`)* -$$file.supplier.filename-pattern$$:: $$A simple ant pattern to match files.$$ *($$String$$, default: `$$$$`)* -$$file.supplier.filename-regex$$:: $$A regex pattern to match files.$$ *($$Pattern$$, default: `$$$$`)* -$$file.supplier.prevent-duplicates$$:: $$Set to true to include an AcceptOnceFileListFilter which prevents duplicates.$$ *($$Boolean$$, default: `$$true$$`)* +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: `$$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: `$$$$`)* + +=== file.supplier + +$$delay-when-empty$$:: $$Duration of delay when no new files are detected.$$ *($$Duration$$, default: `$$1s$$`)* +$$directory$$:: $$The directory to poll for new files.$$ *($$File$$, default: `$$$$`)* +$$filename-pattern$$:: $$A simple ant pattern to match files.$$ *($$String$$, default: `$$$$`)* +$$filename-regex$$:: $$A regex pattern to match files.$$ *($$Pattern$$, default: `$$$$`)* +$$prevent-duplicates$$:: $$Set to true to include an AcceptOnceFileListFilter which prevents duplicates.$$ *($$Boolean$$, default: `$$true$$`)* //end::configuration-properties[] //end::ref-doc[] diff --git a/applications/source/ftp-source/README.adoc b/applications/source/ftp-source/README.adoc index c0c4d539..9bc8a1cd 100644 --- a/applications/source/ftp-source/README.adoc +++ b/applications/source/ftp-source/README.adoc @@ -68,41 +68,73 @@ A `java.io.File` object. The **$$ftp$$** $$source$$ has the following options: //tag::configuration-properties[] -$$file.consumer.markers-json$$:: $$When 'fileMarkers == true', specify if they should be produced as FileSplitter.FileMarker objects or JSON.$$ *($$Boolean$$, default: `$$true$$`)* -$$file.consumer.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`)* -$$file.consumer.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: `$$$$`)* -$$ftp.factory.cache-sessions$$:: $$Cache sessions.$$ *($$Boolean$$, default: `$$$$`)* -$$ftp.factory.client-mode$$:: $$The client mode to use for the FTP session.$$ *($$ClientMode$$, default: `$$$$`, possible values: `ACTIVE`,`PASSIVE`)* -$$ftp.factory.host$$:: $$The host name of the server.$$ *($$String$$, default: `$$localhost$$`)* -$$ftp.factory.password$$:: $$The password to use to connect to the server.$$ *($$String$$, default: `$$$$`)* -$$ftp.factory.port$$:: $$The port of the server.$$ *($$Integer$$, default: `$$21$$`)* -$$ftp.factory.username$$:: $$The username to use to connect to the server.$$ *($$String$$, default: `$$$$`)* -$$ftp.supplier.auto-create-local-dir$$:: $$Set to true to create the local directory if it does not exist.$$ *($$Boolean$$, default: `$$true$$`)* -$$ftp.supplier.delay-when-empty$$:: $$Duration of delay when no new files are detected.$$ *($$Duration$$, default: `$$1s$$`)* -$$ftp.supplier.delete-remote-files$$:: $$Set to true to delete remote files after successful transfer.$$ *($$Boolean$$, default: `$$false$$`)* -$$ftp.supplier.filename-pattern$$:: $$A filter pattern to match the names of files to transfer.$$ *($$String$$, default: `$$$$`)* -$$ftp.supplier.filename-regex$$:: $$A filter regex pattern to match the names of files to transfer.$$ *($$Pattern$$, default: `$$$$`)* -$$ftp.supplier.local-dir$$:: $$The local directory to use for file transfers.$$ *($$File$$, default: `$$$$`)* -$$ftp.supplier.preserve-timestamp$$:: $$Set to true to preserve the original timestamp.$$ *($$Boolean$$, default: `$$true$$`)* -$$ftp.supplier.remote-dir$$:: $$The remote FTP directory.$$ *($$String$$, default: `$$/$$`)* -$$ftp.supplier.remote-file-separator$$:: $$The remote file separator.$$ *($$String$$, default: `$$/$$`)* -$$ftp.supplier.tmp-file-suffix$$:: $$The suffix to use while the transfer is in progress.$$ *($$String$$, default: `$$.tmp$$`)* -$$metadata.store.dynamo-db.create-delay$$:: $$Delay between create table retries.$$ *($$Integer$$, default: `$$1$$`)* -$$metadata.store.dynamo-db.create-retries$$:: $$Retry number for create table request.$$ *($$Integer$$, default: `$$25$$`)* -$$metadata.store.dynamo-db.read-capacity$$:: $$Read capacity on the table.$$ *($$Long$$, default: `$$1$$`)* -$$metadata.store.dynamo-db.table$$:: $$Table name for metadata.$$ *($$String$$, default: `$$$$`)* -$$metadata.store.dynamo-db.time-to-live$$:: $$TTL for table entries.$$ *($$Integer$$, default: `$$$$`)* -$$metadata.store.dynamo-db.write-capacity$$:: $$Write capacity on the table.$$ *($$Long$$, default: `$$1$$`)* -$$metadata.store.gemfire.region$$:: $$Gemfire region name for metadata.$$ *($$String$$, default: `$$$$`)* -$$metadata.store.jdbc.region$$:: $$Unique grouping identifier for messages persisted with this store.$$ *($$String$$, default: `$$DEFAULT$$`)* -$$metadata.store.jdbc.table-prefix$$:: $$Prefix for the custom table name.$$ *($$String$$, default: `$$$$`)* -$$metadata.store.mongo-db.collection$$:: $$MongoDB collection name for metadata.$$ *($$String$$, default: `$$metadataStore$$`)* -$$metadata.store.redis.key$$:: $$Redis key for metadata.$$ *($$String$$, default: `$$$$`)* -$$metadata.store.type$$:: $$Indicates the type of metadata store to configure (default is 'memory'). You must include the corresponding Spring Integration dependency to use a persistent store.$$ *($$StoreType$$, default: `$$$$`, possible values: `mongodb`,`gemfire`,`redis`,`dynamodb`,`jdbc`,`zookeeper`,`hazelcast`,`memory`)* -$$metadata.store.zookeeper.connect-string$$:: $$Zookeeper connect string in form HOST:PORT.$$ *($$String$$, default: `$$127.0.0.1:2181$$`)* -$$metadata.store.zookeeper.encoding$$:: $$Encoding to use when storing data in Zookeeper.$$ *($$Charset$$, default: `$$UTF-8$$`)* -$$metadata.store.zookeeper.retry-interval$$:: $$Retry interval for Zookeeper operations in milliseconds.$$ *($$Integer$$, default: `$$1000$$`)* -$$metadata.store.zookeeper.root$$:: $$Root node - store entries are children of this node.$$ *($$String$$, default: `$$/SpringIntegration-MetadataStore$$`)* +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: `$$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: `$$$$`)* + +=== 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: `$$localhost$$`)* +$$password$$:: $$The password to use to connect to the server.$$ *($$String$$, default: `$$$$`)* +$$port$$:: $$The port of the server.$$ *($$Integer$$, default: `$$21$$`)* +$$username$$:: $$The username to use to connect to the server.$$ *($$String$$, default: `$$$$`)* + +=== ftp.supplier + +$$auto-create-local-dir$$:: $$Set to true to create the local directory if it does not exist.$$ *($$Boolean$$, default: `$$true$$`)* +$$delay-when-empty$$:: $$Duration of delay when no new files are detected.$$ *($$Duration$$, default: `$$1s$$`)* +$$delete-remote-files$$:: $$Set to true to delete remote files after successful transfer.$$ *($$Boolean$$, default: `$$false$$`)* +$$filename-pattern$$:: $$A filter pattern to match the names of files to transfer.$$ *($$String$$, default: `$$$$`)* +$$filename-regex$$:: $$A filter regex pattern to match the names of files to transfer.$$ *($$Pattern$$, default: `$$$$`)* +$$local-dir$$:: $$The local directory to use for file transfers.$$ *($$File$$, default: `$$$$`)* +$$preserve-timestamp$$:: $$Set to true to preserve the original timestamp.$$ *($$Boolean$$, default: `$$true$$`)* +$$remote-dir$$:: $$The remote FTP directory.$$ *($$String$$, default: `$$/$$`)* +$$remote-file-separator$$:: $$The remote file separator.$$ *($$String$$, default: `$$/$$`)* +$$tmp-file-suffix$$:: $$The suffix to use while the transfer is in progress.$$ *($$String$$, default: `$$.tmp$$`)* + +=== metadata.store.dynamo-db + +$$create-delay$$:: $$Delay between create table retries.$$ *($$Integer$$, default: `$$1$$`)* +$$create-retries$$:: $$Retry number for create table request.$$ *($$Integer$$, default: `$$25$$`)* +$$read-capacity$$:: $$Read capacity on the table.$$ *($$Long$$, default: `$$1$$`)* +$$table$$:: $$Table name for metadata.$$ *($$String$$, default: `$$$$`)* +$$time-to-live$$:: $$TTL for table entries.$$ *($$Integer$$, default: `$$$$`)* +$$write-capacity$$:: $$Write capacity on the table.$$ *($$Long$$, default: `$$1$$`)* + +=== metadata.store.gemfire + +$$region$$:: $$Gemfire region name for metadata.$$ *($$String$$, default: `$$$$`)* + +=== metadata.store.jdbc + +$$region$$:: $$Unique grouping identifier for messages persisted with this store.$$ *($$String$$, default: `$$DEFAULT$$`)* +$$table-prefix$$:: $$Prefix for the custom table name.$$ *($$String$$, default: `$$$$`)* + +=== metadata.store.mongo-db + +$$collection$$:: $$MongoDB collection name for metadata.$$ *($$String$$, default: `$$metadataStore$$`)* + +=== metadata.store.redis + +$$key$$:: $$Redis key for metadata.$$ *($$String$$, default: `$$$$`)* + +=== metadata.store + +$$type$$:: $$Indicates the type of metadata store to configure (default is 'memory'). You must include the corresponding Spring Integration dependency to use a persistent store.$$ *($$StoreType$$, default: `$$$$`, possible values: `mongodb`,`gemfire`,`redis`,`dynamodb`,`jdbc`,`zookeeper`,`hazelcast`,`memory`)* + +=== metadata.store.zookeeper + +$$connect-string$$:: $$Zookeeper connect string in form HOST:PORT.$$ *($$String$$, default: `$$127.0.0.1:2181$$`)* +$$encoding$$:: $$Encoding to use when storing data in Zookeeper.$$ *($$Charset$$, default: `$$UTF-8$$`)* +$$retry-interval$$:: $$Retry interval for Zookeeper operations in milliseconds.$$ *($$Integer$$, default: `$$1000$$`)* +$$root$$:: $$Root node - store entries are children of this node.$$ *($$String$$, default: `$$/SpringIntegration-MetadataStore$$`)* //end::configuration-properties[] == Examples diff --git a/applications/source/geode-source/README.adoc b/applications/source/geode-source/README.adoc index b67c5f74..9008602b 100644 --- a/applications/source/geode-source/README.adoc +++ b/applications/source/geode-source/README.adoc @@ -8,23 +8,43 @@ The Geode source will emit a stream of Objects extracted from Apache Geode Entry The **$$geode$$** $$source$$ has the following options: //tag::configuration-properties[] -$$geode.client.pdx-read-serialized$$:: $$Deserialize the Geode objects into PdxInstance instead of the domain class.$$ *($$Boolean$$, default: `$$false$$`)* -$$geode.pool.connect-type$$:: $$Specifies connection type: 'server' or 'locator'.$$ *($$ConnectType$$, default: `$$$$`, possible values: `locator`,`server`)* -$$geode.pool.host-addresses$$:: $$Specifies one or more Gemfire locator or server addresses formatted as [host]:[port].$$ *($$InetSocketAddress[]$$, default: `$$$$`)* -$$geode.pool.subscription-enabled$$:: $$Set to true to enable subscriptions for the client pool. Required to sync updates to the client cache.$$ *($$Boolean$$, default: `$$false$$`)* -$$geode.region.region-name$$:: $$The region name.$$ *($$String$$, default: `$$$$`)* -$$geode.security.password$$:: $$The cache password.$$ *($$String$$, default: `$$$$`)* -$$geode.security.ssl.ciphers$$:: $$Configures the SSL ciphers used for secure Socket connections as an array of valid cipher names.$$ *($$String$$, default: `$$any$$`)* -$$geode.security.ssl.keystore-type$$:: $$Identifies the type of Keystore used for SSL communications (e.g. JKS, PKCS11, etc.).$$ *($$String$$, default: `$$JKS$$`)* -$$geode.security.ssl.keystore-uri$$:: $$Location of the pre-created Keystore URI to be used for connecting to the Geode cluster.$$ *($$Resource$$, default: `$$$$`)* -$$geode.security.ssl.ssl-keystore-password$$:: $$Password for accessing the keys truststore.$$ *($$String$$, default: `$$$$`)* -$$geode.security.ssl.ssl-truststore-password$$:: $$Password for accessing the trust store.$$ *($$String$$, default: `$$$$`)* -$$geode.security.ssl.truststore-type$$:: $$Identifies the type of truststore used for SSL communications (e.g. JKS, PKCS11, etc.).$$ *($$String$$, default: `$$JKS$$`)* -$$geode.security.ssl.truststore-uri$$:: $$Location of the pre-created truststore URI to be used for connecting to the Geode cluster.$$ *($$Resource$$, default: `$$$$`)* -$$geode.security.ssl.user-home-directory$$:: $$Local directory to cache the truststore and keystore files downloaded form the truststoreUri and keystoreUri locations.$$ *($$String$$, default: `$$user.home$$`)* -$$geode.security.username$$:: $$The cache username.$$ *($$String$$, default: `$$$$`)* -$$geode.supplier.event-expression$$:: $$SpEL expression to extract data from an {@link org.apache.geode.cache.EntryEvent} or {@link org.apache.geode.cache.query.CqEvent}.$$ *($$Expression$$, default: `$$$$`)* -$$geode.supplier.query$$:: $$An OQL query. This will enable continuous query if provided.$$ *($$String$$, default: `$$$$`)* +Properties grouped by prefix: + + +=== geode.client + +$$pdx-read-serialized$$:: $$Deserialize the Geode objects into PdxInstance instead of the domain class.$$ *($$Boolean$$, default: `$$false$$`)* + +=== geode.pool + +$$connect-type$$:: $$Specifies connection type: 'server' or 'locator'.$$ *($$ConnectType$$, default: `$$$$`, possible values: `locator`,`server`)* +$$host-addresses$$:: $$Specifies one or more Gemfire locator or server addresses formatted as [host]:[port].$$ *($$InetSocketAddress[]$$, default: `$$$$`)* +$$subscription-enabled$$:: $$Set to true to enable subscriptions for the client pool. Required to sync updates to the client cache.$$ *($$Boolean$$, default: `$$false$$`)* + +=== geode.region + +$$region-name$$:: $$The region name.$$ *($$String$$, default: `$$$$`)* + +=== geode.security + +$$password$$:: $$The cache password.$$ *($$String$$, default: `$$$$`)* +$$username$$:: $$The cache username.$$ *($$String$$, default: `$$$$`)* + +=== geode.security.ssl + +$$ciphers$$:: $$Configures the SSL ciphers used for secure Socket connections as an array of valid cipher names.$$ *($$String$$, default: `$$any$$`)* +$$keystore-type$$:: $$Identifies the type of Keystore used for SSL communications (e.g. JKS, PKCS11, etc.).$$ *($$String$$, default: `$$JKS$$`)* +$$keystore-uri$$:: $$Location of the pre-created Keystore URI to be used for connecting to the Geode cluster.$$ *($$Resource$$, default: `$$$$`)* +$$ssl-keystore-password$$:: $$Password for accessing the keys truststore.$$ *($$String$$, default: `$$$$`)* +$$ssl-truststore-password$$:: $$Password for accessing the trust store.$$ *($$String$$, default: `$$$$`)* +$$truststore-type$$:: $$Identifies the type of truststore used for SSL communications (e.g. JKS, PKCS11, etc.).$$ *($$String$$, default: `$$JKS$$`)* +$$truststore-uri$$:: $$Location of the pre-created truststore URI to be used for connecting to the Geode cluster.$$ *($$Resource$$, default: `$$$$`)* +$$user-home-directory$$:: $$Local directory to cache the truststore and keystore files downloaded form the truststoreUri and keystoreUri locations.$$ *($$String$$, default: `$$user.home$$`)* + +=== geode.supplier + +$$event-expression$$:: $$SpEL expression to extract data from an {@link org.apache.geode.cache.EntryEvent} or {@link org.apache.geode.cache.query.CqEvent}.$$ *($$Expression$$, default: `$$$$`)* +$$query$$:: $$An OQL query. This will enable continuous query if provided.$$ *($$String$$, default: `$$$$`)* //end::configuration-properties[] //end::ref-doc[] diff --git a/applications/source/http-source/README.adoc b/applications/source/http-source/README.adoc index 3c20747a..2bb03088 100644 --- a/applications/source/http-source/README.adoc +++ b/applications/source/http-source/README.adoc @@ -20,12 +20,23 @@ If content type does not match `text/*` or `application/json` The **$$http$$** $$source$$ supports the following configuration properties: //tag::configuration-properties[] -$$http.cors.allow-credentials$$:: $$Whether the browser should include any cookies associated with the domain of the request being annotated.$$ *($$Boolean$$, default: `$$$$`)* -$$http.cors.allowed-headers$$:: $$List of request headers that can be used during the actual request.$$ *($$String[]$$, default: `$$$$`)* -$$http.cors.allowed-origins$$:: $$List of allowed origins, e.g. https://domain1.com.$$ *($$String[]$$, default: `$$$$`)* -$$http.mapped-request-headers$$:: $$Headers that will be mapped.$$ *($$String[]$$, default: `$$$$`)* -$$http.path-pattern$$:: $$HTTP endpoint path mapping.$$ *($$String$$, default: `$$/$$`)* -$$server.port$$:: $$Server HTTP port.$$ *($$Integer$$, default: `$$8080$$`)* +Properties grouped by prefix: + + +=== http.cors + +$$allow-credentials$$:: $$Whether the browser should include any cookies associated with the domain of the request being annotated.$$ *($$Boolean$$, default: `$$$$`)* +$$allowed-headers$$:: $$List of request headers that can be used during the actual request.$$ *($$String[]$$, default: `$$$$`)* +$$allowed-origins$$:: $$List of allowed origins, e.g. https://domain1.com.$$ *($$String[]$$, default: `$$$$`)* + +=== http + +$$mapped-request-headers$$:: $$Headers that will be mapped.$$ *($$String[]$$, default: `$$$$`)* +$$path-pattern$$:: $$HTTP endpoint path mapping.$$ *($$String$$, default: `$$/$$`)* + +=== server + +$$port$$:: $$Server HTTP port.$$ *($$Integer$$, default: `$$8080$$`)* //end::configuration-properties[] //end::ref-doc[] diff --git a/applications/source/jdbc-source/README.adoc b/applications/source/jdbc-source/README.adoc index 78dd7544..946bb8b7 100644 --- a/applications/source/jdbc-source/README.adoc +++ b/applications/source/jdbc-source/README.adoc @@ -13,21 +13,32 @@ This source is fully based on the `DataSourceAutoConfiguration`, so refer to the The **$$jdbc$$** $$source$$ has the following options: //tag::configuration-properties[] -$$jdbc.supplier.max-rows$$:: $$Max numbers of rows to process for query.$$ *($$Integer$$, default: `$$0$$`)* -$$jdbc.supplier.query$$:: $$The query to use to select data.$$ *($$String$$, default: `$$$$`)* -$$jdbc.supplier.split$$:: $$Whether to split the SQL result as individual messages.$$ *($$Boolean$$, default: `$$true$$`)* -$$jdbc.supplier.update$$:: $$An SQL update statement to execute for marking polled messages as 'seen'.$$ *($$String$$, default: `$$$$`)* -$$spring.cloud.stream.poller.cron$$:: $$Cron expression value for the Cron Trigger.$$ *($$String$$, default: `$$$$`)* -$$spring.cloud.stream.poller.fixed-delay$$:: $$Fixed delay for default poller.$$ *($$Long$$, default: `$$1000$$`)* -$$spring.cloud.stream.poller.initial-delay$$:: $$Initial delay for periodic triggers.$$ *($$Integer$$, default: `$$0$$`)* -$$spring.cloud.stream.poller.max-messages-per-poll$$:: $$Maximum messages per poll for the default poller.$$ *($$Long$$, default: `$$1$$`)* -$$spring.datasource.data$$:: $$Data (DML) script resource references.$$ *($$List$$, default: `$$$$`)* -$$spring.datasource.driver-class-name$$:: $$Fully qualified name of the JDBC driver. Auto-detected based on the URL by default.$$ *($$String$$, default: `$$$$`)* -$$spring.datasource.initialization-mode$$:: $$Initialize the datasource with available DDL and DML scripts.$$ *($$DataSourceInitializationMode$$, default: `$$embedded$$`, possible values: `ALWAYS`,`EMBEDDED`,`NEVER`)* -$$spring.datasource.password$$:: $$Login password of the database.$$ *($$String$$, default: `$$$$`)* -$$spring.datasource.schema$$:: $$Schema (DDL) script resource references.$$ *($$List$$, default: `$$$$`)* -$$spring.datasource.url$$:: $$JDBC URL of the database.$$ *($$String$$, default: `$$$$`)* -$$spring.datasource.username$$:: $$Login username of the database.$$ *($$String$$, default: `$$$$`)* +Properties grouped by prefix: + + +=== jdbc.supplier + +$$max-rows$$:: $$Max numbers of rows to process for query.$$ *($$Integer$$, default: `$$0$$`)* +$$query$$:: $$The query to use to select data.$$ *($$String$$, default: `$$$$`)* +$$split$$:: $$Whether to split the SQL result as individual messages.$$ *($$Boolean$$, default: `$$true$$`)* +$$update$$:: $$An SQL update statement to execute for marking polled messages as 'seen'.$$ *($$String$$, default: `$$$$`)* + +=== spring.cloud.stream.poller + +$$cron$$:: $$Cron expression value for the Cron Trigger.$$ *($$String$$, default: `$$$$`)* +$$fixed-delay$$:: $$Fixed delay for default poller.$$ *($$Long$$, default: `$$1000$$`)* +$$initial-delay$$:: $$Initial delay for periodic triggers.$$ *($$Integer$$, default: `$$0$$`)* +$$max-messages-per-poll$$:: $$Maximum messages per poll for the default poller.$$ *($$Long$$, default: `$$1$$`)* + +=== spring.datasource + +$$data$$:: $$Data (DML) script resource references.$$ *($$List$$, default: `$$$$`)* +$$driver-class-name$$:: $$Fully qualified name of the JDBC driver. Auto-detected based on the URL by default.$$ *($$String$$, default: `$$$$`)* +$$initialization-mode$$:: $$Initialize the datasource with available DDL and DML scripts.$$ *($$DataSourceInitializationMode$$, default: `$$embedded$$`, possible values: `ALWAYS`,`EMBEDDED`,`NEVER`)* +$$password$$:: $$Login password of the database.$$ *($$String$$, default: `$$$$`)* +$$schema$$:: $$Schema (DDL) script resource references.$$ *($$List$$, default: `$$$$`)* +$$url$$:: $$JDBC URL of the database.$$ *($$String$$, default: `$$$$`)* +$$username$$:: $$Login username of the database.$$ *($$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] diff --git a/applications/source/jms-source/README.adoc b/applications/source/jms-source/README.adoc index 5911445e..d709e604 100644 --- a/applications/source/jms-source/README.adoc +++ b/applications/source/jms-source/README.adoc @@ -8,20 +8,31 @@ The JMS source enables receiving messages from JMS. The **JMS** $$source$$ has the following options: //tag::configuration-properties[] -$$jms.supplier.client-id$$:: $$Client id for durable subscriptions.$$ *($$String$$, default: `$$$$`)* -$$jms.supplier.destination$$:: $$The destination from which to receive messages (queue or topic).$$ *($$String$$, default: `$$$$`)* -$$jms.supplier.message-selector$$:: $$A selector for messages.$$ *($$String$$, default: `$$$$`)* -$$jms.supplier.session-transacted$$:: $$True to enable transactions and select a DefaultMessageListenerContainer, false to select a SimpleMessageListenerContainer.$$ *($$Boolean$$, default: `$$true$$`)* -$$jms.supplier.subscription-durable$$:: $$True for a durable subscription.$$ *($$Boolean$$, default: `$$$$`)* -$$jms.supplier.subscription-name$$:: $$The name of a durable or shared subscription.$$ *($$String$$, default: `$$$$`)* -$$jms.supplier.subscription-shared$$:: $$True for a shared subscription.$$ *($$Boolean$$, default: `$$$$`)* -$$spring.jms.jndi-name$$:: $$Connection factory JNDI name. When set, takes precedence to others connection factory auto-configurations.$$ *($$String$$, default: `$$$$`)* -$$spring.jms.listener.acknowledge-mode$$:: $$Acknowledge mode of the container. By default, the listener is transacted with automatic acknowledgment.$$ *($$AcknowledgeMode$$, default: `$$$$`, possible values: `AUTO`,`CLIENT`,`DUPS_OK`)* -$$spring.jms.listener.auto-startup$$:: $$Start the container automatically on startup.$$ *($$Boolean$$, default: `$$true$$`)* -$$spring.jms.listener.concurrency$$:: $$Minimum number of concurrent consumers.$$ *($$Integer$$, default: `$$$$`)* -$$spring.jms.listener.max-concurrency$$:: $$Maximum number of concurrent consumers.$$ *($$Integer$$, default: `$$$$`)* -$$spring.jms.listener.receive-timeout$$:: $$Timeout to use for receive calls. Use -1 for a no-wait receive or 0 for no timeout at all. The latter is only feasible if not running within a transaction manager and is generally discouraged since it prevents clean shutdown.$$ *($$Duration$$, default: `$$1s$$`)* -$$spring.jms.pub-sub-domain$$:: $$Whether the default destination type is topic.$$ *($$Boolean$$, default: `$$false$$`)* +Properties grouped by prefix: + + +=== jms.supplier + +$$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: `$$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: `$$$$`)* + +=== spring.jms + +$$jndi-name$$:: $$Connection factory JNDI name. When set, takes precedence to others connection factory auto-configurations.$$ *($$String$$, default: `$$$$`)* +$$pub-sub-domain$$:: $$Whether the default destination type is topic.$$ *($$Boolean$$, default: `$$false$$`)* + +=== spring.jms.listener + +$$acknowledge-mode$$:: $$Acknowledge mode of the container. By default, the listener is transacted with automatic acknowledgment.$$ *($$AcknowledgeMode$$, default: `$$$$`, possible values: `AUTO`,`CLIENT`,`DUPS_OK`)* +$$auto-startup$$:: $$Start the container automatically on startup.$$ *($$Boolean$$, default: `$$true$$`)* +$$concurrency$$:: $$Minimum number of concurrent consumers.$$ *($$Integer$$, default: `$$$$`)* +$$max-concurrency$$:: $$Maximum number of concurrent consumers.$$ *($$Integer$$, default: `$$$$`)* +$$receive-timeout$$:: $$Timeout to use for receive calls. Use -1 for a no-wait receive or 0 for no timeout at all. The latter is only feasible if not running within a transaction manager and is generally discouraged since it prevents clean shutdown.$$ *($$Duration$$, default: `$$1s$$`)* //end::configuration-properties[] //end::ref-doc[] diff --git a/applications/source/mqtt-source/README.adoc b/applications/source/mqtt-source/README.adoc index 2b0ee89f..e677727a 100644 --- a/applications/source/mqtt-source/README.adoc +++ b/applications/source/mqtt-source/README.adoc @@ -13,19 +13,27 @@ Source that enables receiving messages from MQTT. The **$$mqtt$$** $$source$$ has the following options: //tag::configuration-properties[] -$$mqtt.clean-session$$:: $$whether the client and server should remember state across restarts and reconnects.$$ *($$Boolean$$, default: `$$true$$`)* -$$mqtt.connection-timeout$$:: $$the connection timeout in seconds.$$ *($$Integer$$, default: `$$30$$`)* -$$mqtt.keep-alive-interval$$:: $$the ping interval in seconds.$$ *($$Integer$$, default: `$$60$$`)* -$$mqtt.password$$:: $$the password to use when connecting to the broker.$$ *($$String$$, default: `$$guest$$`)* -$$mqtt.persistence$$:: $$'memory' or 'file'.$$ *($$String$$, default: `$$memory$$`)* -$$mqtt.persistence-directory$$:: $$Persistence directory.$$ *($$String$$, default: `$$/tmp/paho$$`)* -$$mqtt.supplier.binary$$:: $$true to leave the payload as bytes.$$ *($$Boolean$$, default: `$$false$$`)* -$$mqtt.supplier.charset$$:: $$the charset used to convert bytes to String (when binary is false).$$ *($$String$$, default: `$$UTF-8$$`)* -$$mqtt.supplier.client-id$$:: $$identifies the client.$$ *($$String$$, default: `$$stream.client.id.source$$`)* -$$mqtt.supplier.qos$$:: $$the qos; a single value for all topics or a comma-delimited list to match the topics.$$ *($$Integer[]$$, default: `$$[0]$$`)* -$$mqtt.supplier.topics$$:: $$the topic(s) (comma-delimited) to which the source will subscribe.$$ *($$String[]$$, default: `$$[stream.mqtt]$$`)* -$$mqtt.url$$:: $$location of the mqtt broker(s) (comma-delimited list).$$ *($$String[]$$, default: `$$[tcp://localhost:1883]$$`)* -$$mqtt.username$$:: $$the username to use when connecting to the broker.$$ *($$String$$, default: `$$guest$$`)* +Properties grouped by prefix: + + +=== mqtt + +$$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$$`)* +$$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: `$$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 a1d88021..944398fb 100644 --- a/applications/source/rabbit-source/README.adoc +++ b/applications/source/rabbit-source/README.adoc @@ -21,27 +21,35 @@ N/A The **$$rabbit$$** $$source$$ has the following options: //tag::configuration-properties[] -$$rabbit.supplier.enable-retry$$:: $$true to enable retry.$$ *($$Boolean$$, default: `$$false$$`)* -$$rabbit.supplier.initial-retry-interval$$:: $$Initial retry interval when retry is enabled.$$ *($$Integer$$, default: `$$1000$$`)* -$$rabbit.supplier.mapped-request-headers$$:: $$Headers that will be mapped.$$ *($$String[]$$, default: `$$[STANDARD_REQUEST_HEADERS]$$`)* -$$rabbit.supplier.max-attempts$$:: $$The maximum delivery attempts when retry is enabled.$$ *($$Integer$$, default: `$$3$$`)* -$$rabbit.supplier.max-retry-interval$$:: $$Max retry interval when retry is enabled.$$ *($$Integer$$, default: `$$30000$$`)* -$$rabbit.supplier.own-connection$$:: $$When true, use a separate connection based on the boot properties.$$ *($$Boolean$$, default: `$$false$$`)* -$$rabbit.supplier.queues$$:: $$The queues to which the source will listen for messages.$$ *($$String[]$$, default: `$$$$`)* -$$rabbit.supplier.requeue$$:: $$Whether rejected messages should be requeued.$$ *($$Boolean$$, default: `$$true$$`)* -$$rabbit.supplier.retry-multiplier$$:: $$Retry backoff multiplier when retry is enabled.$$ *($$Double$$, default: `$$2$$`)* -$$rabbit.supplier.transacted$$:: $$Whether the channel is transacted.$$ *($$Boolean$$, default: `$$false$$`)* -$$spring.rabbitmq.addresses$$:: $$Comma-separated list of addresses to which the client should connect. When set, the host and port are ignored.$$ *($$String$$, default: `$$$$`)* -$$spring.rabbitmq.connection-timeout$$:: $$Connection timeout. Set it to zero to wait forever.$$ *($$Duration$$, default: `$$$$`)* -$$spring.rabbitmq.host$$:: $$RabbitMQ host. Ignored if an address is set.$$ *($$String$$, default: `$$localhost$$`)* -$$spring.rabbitmq.password$$:: $$Login to authenticate against the broker.$$ *($$String$$, default: `$$guest$$`)* -$$spring.rabbitmq.port$$:: $$RabbitMQ port. Ignored if an address is set. Default to 5672, or 5671 if SSL is enabled.$$ *($$Integer$$, default: `$$$$`)* -$$spring.rabbitmq.publisher-confirm-type$$:: $$Type of publisher confirms to use.$$ *($$ConfirmType$$, default: `$$$$`, possible values: `SIMPLE`,`CORRELATED`,`NONE`)* -$$spring.rabbitmq.publisher-returns$$:: $$Whether to enable publisher returns.$$ *($$Boolean$$, default: `$$false$$`)* -$$spring.rabbitmq.requested-channel-max$$:: $$Number of channels per connection requested by the client. Use 0 for unlimited.$$ *($$Integer$$, default: `$$2047$$`)* -$$spring.rabbitmq.requested-heartbeat$$:: $$Requested heartbeat timeout; zero for none. If a duration suffix is not specified, seconds will be used.$$ *($$Duration$$, default: `$$$$`)* -$$spring.rabbitmq.username$$:: $$Login user to authenticate to the broker.$$ *($$String$$, default: `$$guest$$`)* -$$spring.rabbitmq.virtual-host$$:: $$Virtual host to use when connecting to the broker.$$ *($$String$$, default: `$$$$`)* +Properties grouped by prefix: + + +=== rabbit.supplier + +$$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: `$$true$$`)* +$$retry-multiplier$$:: $$Retry backoff multiplier when retry is enabled.$$ *($$Double$$, default: `$$2$$`)* +$$transacted$$:: $$Whether the channel is transacted.$$ *($$Boolean$$, default: `$$false$$`)* + +=== spring.rabbitmq + +$$addresses$$:: $$Comma-separated list of addresses to which the client should connect. When set, the host and port are ignored.$$ *($$String$$, default: `$$$$`)* +$$connection-timeout$$:: $$Connection timeout. Set it to zero to wait forever.$$ *($$Duration$$, default: `$$$$`)* +$$host$$:: $$RabbitMQ host. Ignored if an address is set.$$ *($$String$$, default: `$$localhost$$`)* +$$password$$:: $$Login to authenticate against the broker.$$ *($$String$$, default: `$$guest$$`)* +$$port$$:: $$RabbitMQ port. Ignored if an address is set. Default to 5672, or 5671 if SSL is enabled.$$ *($$Integer$$, default: `$$$$`)* +$$publisher-confirm-type$$:: $$Type of publisher confirms to use.$$ *($$ConfirmType$$, default: `$$$$`, possible values: `SIMPLE`,`CORRELATED`,`NONE`)* +$$publisher-returns$$:: $$Whether to enable publisher returns.$$ *($$Boolean$$, default: `$$false$$`)* +$$requested-channel-max$$:: $$Number of channels per connection requested by the client. Use 0 for unlimited.$$ *($$Integer$$, default: `$$2047$$`)* +$$requested-heartbeat$$:: $$Requested heartbeat timeout; zero for none. If a duration suffix is not specified, seconds will be used.$$ *($$Duration$$, default: `$$$$`)* +$$username$$:: $$Login user to authenticate to the broker.$$ *($$String$$, default: `$$guest$$`)* +$$virtual-host$$:: $$Virtual host to use when connecting to the broker.$$ *($$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] diff --git a/applications/source/s3-source/README.adoc b/applications/source/s3-source/README.adoc index 9f6ac3af..76880905 100644 --- a/applications/source/s3-source/README.adoc +++ b/applications/source/s3-source/README.adoc @@ -53,37 +53,69 @@ A `java.io.File` object. The **$$s3$$** $$source$$ has the following options: //tag::configuration-properties[] -$$file.consumer.markers-json$$:: $$When 'fileMarkers == true', specify if they should be produced as FileSplitter.FileMarker objects or JSON.$$ *($$Boolean$$, default: `$$true$$`)* -$$file.consumer.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`)* -$$file.consumer.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: `$$$$`)* -$$metadata.store.dynamo-db.create-delay$$:: $$Delay between create table retries.$$ *($$Integer$$, default: `$$1$$`)* -$$metadata.store.dynamo-db.create-retries$$:: $$Retry number for create table request.$$ *($$Integer$$, default: `$$25$$`)* -$$metadata.store.dynamo-db.read-capacity$$:: $$Read capacity on the table.$$ *($$Long$$, default: `$$1$$`)* -$$metadata.store.dynamo-db.table$$:: $$Table name for metadata.$$ *($$String$$, default: `$$$$`)* -$$metadata.store.dynamo-db.time-to-live$$:: $$TTL for table entries.$$ *($$Integer$$, default: `$$$$`)* -$$metadata.store.dynamo-db.write-capacity$$:: $$Write capacity on the table.$$ *($$Long$$, default: `$$1$$`)* -$$metadata.store.gemfire.region$$:: $$Gemfire region name for metadata.$$ *($$String$$, default: `$$$$`)* -$$metadata.store.jdbc.region$$:: $$Unique grouping identifier for messages persisted with this store.$$ *($$String$$, default: `$$DEFAULT$$`)* -$$metadata.store.jdbc.table-prefix$$:: $$Prefix for the custom table name.$$ *($$String$$, default: `$$$$`)* -$$metadata.store.mongo-db.collection$$:: $$MongoDB collection name for metadata.$$ *($$String$$, default: `$$metadataStore$$`)* -$$metadata.store.redis.key$$:: $$Redis key for metadata.$$ *($$String$$, default: `$$$$`)* -$$metadata.store.type$$:: $$Indicates the type of metadata store to configure (default is 'memory'). You must include the corresponding Spring Integration dependency to use a persistent store.$$ *($$StoreType$$, default: `$$$$`, possible values: `mongodb`,`gemfire`,`redis`,`dynamodb`,`jdbc`,`zookeeper`,`hazelcast`,`memory`)* -$$metadata.store.zookeeper.connect-string$$:: $$Zookeeper connect string in form HOST:PORT.$$ *($$String$$, default: `$$127.0.0.1:2181$$`)* -$$metadata.store.zookeeper.encoding$$:: $$Encoding to use when storing data in Zookeeper.$$ *($$Charset$$, default: `$$UTF-8$$`)* -$$metadata.store.zookeeper.retry-interval$$:: $$Retry interval for Zookeeper operations in milliseconds.$$ *($$Integer$$, default: `$$1000$$`)* -$$metadata.store.zookeeper.root$$:: $$Root node - store entries are children of this node.$$ *($$String$$, default: `$$/SpringIntegration-MetadataStore$$`)* -$$s3.common.endpoint-url$$:: $$Optional endpoint url to connect to s3 compatible storage.$$ *($$String$$, default: `$$$$`)* -$$s3.common.path-style-access$$:: $$Use path style access.$$ *($$Boolean$$, default: `$$false$$`)* -$$s3.supplier.auto-create-local-dir$$:: $$Create or not the local directory.$$ *($$Boolean$$, default: `$$true$$`)* -$$s3.supplier.delete-remote-files$$:: $$Delete or not remote files after processing.$$ *($$Boolean$$, default: `$$false$$`)* -$$s3.supplier.filename-pattern$$:: $$The pattern to filter remote files.$$ *($$String$$, default: `$$$$`)* -$$s3.supplier.filename-regex$$:: $$The regexp to filter remote files.$$ *($$Pattern$$, default: `$$$$`)* -$$s3.supplier.list-only$$:: $$Set to true to return s3 object metadata without copying file to a local directory.$$ *($$Boolean$$, default: `$$false$$`)* -$$s3.supplier.local-dir$$:: $$The local directory to store files.$$ *($$File$$, default: `$$$$`)* -$$s3.supplier.preserve-timestamp$$:: $$To transfer or not the timestamp of the remote file to the local one.$$ *($$Boolean$$, default: `$$true$$`)* -$$s3.supplier.remote-dir$$:: $$AWS S3 bucket resource.$$ *($$String$$, default: `$$bucket$$`)* -$$s3.supplier.remote-file-separator$$:: $$Remote File separator.$$ *($$String$$, default: `$$/$$`)* -$$s3.supplier.tmp-file-suffix$$:: $$Temporary file suffix.$$ *($$String$$, default: `$$.tmp$$`)* +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: `$$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: `$$$$`)* + +=== metadata.store.dynamo-db + +$$create-delay$$:: $$Delay between create table retries.$$ *($$Integer$$, default: `$$1$$`)* +$$create-retries$$:: $$Retry number for create table request.$$ *($$Integer$$, default: `$$25$$`)* +$$read-capacity$$:: $$Read capacity on the table.$$ *($$Long$$, default: `$$1$$`)* +$$table$$:: $$Table name for metadata.$$ *($$String$$, default: `$$$$`)* +$$time-to-live$$:: $$TTL for table entries.$$ *($$Integer$$, default: `$$$$`)* +$$write-capacity$$:: $$Write capacity on the table.$$ *($$Long$$, default: `$$1$$`)* + +=== metadata.store.gemfire + +$$region$$:: $$Gemfire region name for metadata.$$ *($$String$$, default: `$$$$`)* + +=== metadata.store.jdbc + +$$region$$:: $$Unique grouping identifier for messages persisted with this store.$$ *($$String$$, default: `$$DEFAULT$$`)* +$$table-prefix$$:: $$Prefix for the custom table name.$$ *($$String$$, default: `$$$$`)* + +=== metadata.store.mongo-db + +$$collection$$:: $$MongoDB collection name for metadata.$$ *($$String$$, default: `$$metadataStore$$`)* + +=== metadata.store.redis + +$$key$$:: $$Redis key for metadata.$$ *($$String$$, default: `$$$$`)* + +=== metadata.store + +$$type$$:: $$Indicates the type of metadata store to configure (default is 'memory'). You must include the corresponding Spring Integration dependency to use a persistent store.$$ *($$StoreType$$, default: `$$$$`, possible values: `mongodb`,`gemfire`,`redis`,`dynamodb`,`jdbc`,`zookeeper`,`hazelcast`,`memory`)* + +=== metadata.store.zookeeper + +$$connect-string$$:: $$Zookeeper connect string in form HOST:PORT.$$ *($$String$$, default: `$$127.0.0.1:2181$$`)* +$$encoding$$:: $$Encoding to use when storing data in Zookeeper.$$ *($$Charset$$, default: `$$UTF-8$$`)* +$$retry-interval$$:: $$Retry interval for Zookeeper operations in milliseconds.$$ *($$Integer$$, default: `$$1000$$`)* +$$root$$:: $$Root node - store entries are children of this node.$$ *($$String$$, default: `$$/SpringIntegration-MetadataStore$$`)* + +=== s3.common + +$$endpoint-url$$:: $$Optional endpoint url to connect to s3 compatible storage.$$ *($$String$$, 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: `$$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: `$$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: `$$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 a1759f51..69bdef26 100644 --- a/applications/source/sftp-source/README.adoc +++ b/applications/source/sftp-source/README.adoc @@ -82,49 +82,81 @@ A `java.io.File` object. The **$$ftp$$** $$source$$ has the following options: //tag::configuration-properties[] -$$file.consumer.markers-json$$:: $$When 'fileMarkers == true', specify if they should be produced as FileSplitter.FileMarker objects or JSON.$$ *($$Boolean$$, default: `$$true$$`)* -$$file.consumer.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`)* -$$file.consumer.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: `$$$$`)* -$$metadata.store.dynamo-db.create-delay$$:: $$Delay between create table retries.$$ *($$Integer$$, default: `$$1$$`)* -$$metadata.store.dynamo-db.create-retries$$:: $$Retry number for create table request.$$ *($$Integer$$, default: `$$25$$`)* -$$metadata.store.dynamo-db.read-capacity$$:: $$Read capacity on the table.$$ *($$Long$$, default: `$$1$$`)* -$$metadata.store.dynamo-db.table$$:: $$Table name for metadata.$$ *($$String$$, default: `$$$$`)* -$$metadata.store.dynamo-db.time-to-live$$:: $$TTL for table entries.$$ *($$Integer$$, default: `$$$$`)* -$$metadata.store.dynamo-db.write-capacity$$:: $$Write capacity on the table.$$ *($$Long$$, default: `$$1$$`)* -$$metadata.store.gemfire.region$$:: $$Gemfire region name for metadata.$$ *($$String$$, default: `$$$$`)* -$$metadata.store.jdbc.region$$:: $$Unique grouping identifier for messages persisted with this store.$$ *($$String$$, default: `$$DEFAULT$$`)* -$$metadata.store.jdbc.table-prefix$$:: $$Prefix for the custom table name.$$ *($$String$$, default: `$$$$`)* -$$metadata.store.mongo-db.collection$$:: $$MongoDB collection name for metadata.$$ *($$String$$, default: `$$metadataStore$$`)* -$$metadata.store.redis.key$$:: $$Redis key for metadata.$$ *($$String$$, default: `$$$$`)* -$$metadata.store.type$$:: $$Indicates the type of metadata store to configure (default is 'memory'). You must include the corresponding Spring Integration dependency to use a persistent store.$$ *($$StoreType$$, default: `$$$$`, possible values: `mongodb`,`gemfire`,`redis`,`dynamodb`,`jdbc`,`zookeeper`,`hazelcast`,`memory`)* -$$metadata.store.zookeeper.connect-string$$:: $$Zookeeper connect string in form HOST:PORT.$$ *($$String$$, default: `$$127.0.0.1:2181$$`)* -$$metadata.store.zookeeper.encoding$$:: $$Encoding to use when storing data in Zookeeper.$$ *($$Charset$$, default: `$$UTF-8$$`)* -$$metadata.store.zookeeper.retry-interval$$:: $$Retry interval for Zookeeper operations in milliseconds.$$ *($$Integer$$, default: `$$1000$$`)* -$$metadata.store.zookeeper.root$$:: $$Root node - store entries are children of this node.$$ *($$String$$, default: `$$/SpringIntegration-MetadataStore$$`)* -$$sftp.supplier.auto-create-local-dir$$:: $$Set to true to create the local directory if it does not exist.$$ *($$Boolean$$, default: `$$true$$`)* -$$sftp.supplier.delay-when-empty$$:: $$Duration of delay when no new files are detected.$$ *($$Duration$$, default: `$$1s$$`)* -$$sftp.supplier.delete-remote-files$$:: $$Set to true to delete remote files after successful transfer.$$ *($$Boolean$$, default: `$$false$$`)* -$$sftp.supplier.directories$$:: $$A list of factory "name.directory" pairs.$$ *($$String[]$$, default: `$$$$`)* -$$sftp.supplier.factories$$:: $$A map of factory names to factories.$$ *($$Map$$, default: `$$$$`)* -$$sftp.supplier.factory.allow-unknown-keys$$:: $$True to allow an unknown or changed key.$$ *($$Boolean$$, default: `$$false$$`)* -$$sftp.supplier.factory.host$$:: $$The host name of the server.$$ *($$String$$, default: `$$localhost$$`)* -$$sftp.supplier.factory.known-hosts-expression$$:: $$A SpEL expression resolving to the location of the known hosts file.$$ *($$Expression$$, default: `$$$$`)* -$$sftp.supplier.factory.pass-phrase$$:: $$Passphrase for user's private key.$$ *($$String$$, default: `$$$$`)* -$$sftp.supplier.factory.password$$:: $$The password to use to connect to the server.$$ *($$String$$, default: `$$$$`)* -$$sftp.supplier.factory.port$$:: $$The port of the server.$$ *($$Integer$$, default: `$$22$$`)* -$$sftp.supplier.factory.private-key$$:: $$Resource location of user's private key.$$ *($$Resource$$, default: `$$$$`)* -$$sftp.supplier.factory.username$$:: $$The username to use to connect to the server.$$ *($$String$$, default: `$$$$`)* -$$sftp.supplier.fair$$:: $$True for fair rotation of multiple servers/directories. This is false by default so if a source has more than one entry, these will be received before the other sources are visited.$$ *($$Boolean$$, default: `$$false$$`)* -$$sftp.supplier.filename-pattern$$:: $$A filter pattern to match the names of files to transfer.$$ *($$String$$, default: `$$$$`)* -$$sftp.supplier.filename-regex$$:: $$A filter regex pattern to match the names of files to transfer.$$ *($$Pattern$$, default: `$$$$`)* -$$sftp.supplier.list-only$$:: $$Set to true to return file metadata without the entire payload.$$ *($$Boolean$$, default: `$$false$$`)* -$$sftp.supplier.local-dir$$:: $$The local directory to use for file transfers.$$ *($$File$$, default: `$$$$`)* -$$sftp.supplier.max-fetch$$:: $$The maximum number of remote files to fetch per poll; default unlimited. Does not apply when listing files or building task launch requests.$$ *($$Integer$$, default: `$$$$`)* -$$sftp.supplier.preserve-timestamp$$:: $$Set to true to preserve the original timestamp.$$ *($$Boolean$$, default: `$$true$$`)* -$$sftp.supplier.remote-dir$$:: $$The remote FTP directory.$$ *($$String$$, default: `$$/$$`)* -$$sftp.supplier.remote-file-separator$$:: $$The remote file separator.$$ *($$String$$, default: `$$/$$`)* -$$sftp.supplier.stream$$:: $$Set to true to stream the file rather than copy to a local directory.$$ *($$Boolean$$, default: `$$false$$`)* -$$sftp.supplier.tmp-file-suffix$$:: $$The suffix to use while the transfer is in progress.$$ *($$String$$, default: `$$.tmp$$`)* +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: `$$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: `$$$$`)* + +=== metadata.store.dynamo-db + +$$create-delay$$:: $$Delay between create table retries.$$ *($$Integer$$, default: `$$1$$`)* +$$create-retries$$:: $$Retry number for create table request.$$ *($$Integer$$, default: `$$25$$`)* +$$read-capacity$$:: $$Read capacity on the table.$$ *($$Long$$, default: `$$1$$`)* +$$table$$:: $$Table name for metadata.$$ *($$String$$, default: `$$$$`)* +$$time-to-live$$:: $$TTL for table entries.$$ *($$Integer$$, default: `$$$$`)* +$$write-capacity$$:: $$Write capacity on the table.$$ *($$Long$$, default: `$$1$$`)* + +=== metadata.store.gemfire + +$$region$$:: $$Gemfire region name for metadata.$$ *($$String$$, default: `$$$$`)* + +=== metadata.store.jdbc + +$$region$$:: $$Unique grouping identifier for messages persisted with this store.$$ *($$String$$, default: `$$DEFAULT$$`)* +$$table-prefix$$:: $$Prefix for the custom table name.$$ *($$String$$, default: `$$$$`)* + +=== metadata.store.mongo-db + +$$collection$$:: $$MongoDB collection name for metadata.$$ *($$String$$, default: `$$metadataStore$$`)* + +=== metadata.store.redis + +$$key$$:: $$Redis key for metadata.$$ *($$String$$, default: `$$$$`)* + +=== metadata.store + +$$type$$:: $$Indicates the type of metadata store to configure (default is 'memory'). You must include the corresponding Spring Integration dependency to use a persistent store.$$ *($$StoreType$$, default: `$$$$`, possible values: `mongodb`,`gemfire`,`redis`,`dynamodb`,`jdbc`,`zookeeper`,`hazelcast`,`memory`)* + +=== metadata.store.zookeeper + +$$connect-string$$:: $$Zookeeper connect string in form HOST:PORT.$$ *($$String$$, default: `$$127.0.0.1:2181$$`)* +$$encoding$$:: $$Encoding to use when storing data in Zookeeper.$$ *($$Charset$$, default: `$$UTF-8$$`)* +$$retry-interval$$:: $$Retry interval for Zookeeper operations in milliseconds.$$ *($$Integer$$, default: `$$1000$$`)* +$$root$$:: $$Root node - store entries are children of this node.$$ *($$String$$, default: `$$/SpringIntegration-MetadataStore$$`)* + +=== sftp.supplier + +$$auto-create-local-dir$$:: $$Set to true to create the local directory if it does not exist.$$ *($$Boolean$$, default: `$$true$$`)* +$$delay-when-empty$$:: $$Duration of delay when no new files are detected.$$ *($$Duration$$, default: `$$1s$$`)* +$$delete-remote-files$$:: $$Set to true to delete remote files after successful transfer.$$ *($$Boolean$$, default: `$$false$$`)* +$$directories$$:: $$A list of factory "name.directory" pairs.$$ *($$String[]$$, default: `$$$$`)* +$$factories$$:: $$A map of factory names to factories.$$ *($$Map$$, default: `$$$$`)* +$$fair$$:: $$True for fair rotation of multiple servers/directories. This is false by default so if a source has more than one entry, these will be received before the other sources are visited.$$ *($$Boolean$$, default: `$$false$$`)* +$$filename-pattern$$:: $$A filter pattern to match the names of files to transfer.$$ *($$String$$, default: `$$$$`)* +$$filename-regex$$:: $$A filter regex pattern to match the names of files to transfer.$$ *($$Pattern$$, default: `$$$$`)* +$$list-only$$:: $$Set to true to return file metadata without the entire payload.$$ *($$Boolean$$, default: `$$false$$`)* +$$local-dir$$:: $$The local directory to use for file transfers.$$ *($$File$$, default: `$$$$`)* +$$max-fetch$$:: $$The maximum number of remote files to fetch per poll; default unlimited. Does not apply when listing files or building task launch requests.$$ *($$Integer$$, default: `$$$$`)* +$$preserve-timestamp$$:: $$Set to true to preserve the original timestamp.$$ *($$Boolean$$, default: `$$true$$`)* +$$remote-dir$$:: $$The remote FTP directory.$$ *($$String$$, default: `$$/$$`)* +$$remote-file-separator$$:: $$The remote file separator.$$ *($$String$$, default: `$$/$$`)* +$$stream$$:: $$Set to true to stream the file rather than copy to a local directory.$$ *($$Boolean$$, default: `$$false$$`)* +$$tmp-file-suffix$$:: $$The suffix to use while the transfer is in progress.$$ *($$String$$, default: `$$.tmp$$`)* + +=== sftp.supplier.factory + +$$allow-unknown-keys$$:: $$True to allow an unknown or changed key.$$ *($$Boolean$$, default: `$$false$$`)* +$$host$$:: $$The host name of the server.$$ *($$String$$, default: `$$localhost$$`)* +$$known-hosts-expression$$:: $$A SpEL expression resolving to the location of the known hosts file.$$ *($$Expression$$, default: `$$$$`)* +$$pass-phrase$$:: $$Passphrase for user's private key.$$ *($$String$$, default: `$$$$`)* +$$password$$:: $$The password to use to connect to the server.$$ *($$String$$, default: `$$$$`)* +$$port$$:: $$The port of the server.$$ *($$Integer$$, default: `$$22$$`)* +$$private-key$$:: $$Resource location of user's private key.$$ *($$Resource$$, default: `$$$$`)* +$$username$$:: $$The username to use to connect to the server.$$ *($$String$$, default: `$$$$`)* //end::configuration-properties[] == Examples diff --git a/applications/source/tcp-source/README.adoc b/applications/source/tcp-source/README.adoc index 14cc15e9..6fb00232 100644 --- a/applications/source/tcp-source/README.adoc +++ b/applications/source/tcp-source/README.adoc @@ -10,13 +10,21 @@ Messages produced by the TCP source application have a `byte[]` payload. == Options //tag::configuration-properties[] -$$tcp.nio$$:: $$Whether or not to use NIO.$$ *($$Boolean$$, default: `$$false$$`)* -$$tcp.port$$:: $$The port on which to listen; 0 for the OS to choose a port.$$ *($$Integer$$, default: `$$1234$$`)* -$$tcp.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$$`)* -$$tcp.socket-timeout$$:: $$The timeout (ms) before closing the socket when no data is received.$$ *($$Integer$$, default: `$$120000$$`)* -$$tcp.supplier.buffer-size$$:: $$The buffer size used when decoding messages; larger messages will be rejected.$$ *($$Integer$$, default: `$$2048$$`)* -$$tcp.supplier.decoder$$:: $$The decoder to use when receiving messages.$$ *($$Encoding$$, default: `$$$$`, possible values: `CRLF`,`LF`,`NULL`,`STXETX`,`RAW`,`L1`,`L2`,`L4`)* -$$tcp.use-direct-buffers$$:: $$Whether or not to use direct buffers.$$ *($$Boolean$$, default: `$$false$$`)* +Properties grouped by prefix: + + +=== tcp + +$$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: `$$2048$$`)* +$$decoder$$:: $$The decoder to use when receiving messages.$$ *($$Encoding$$, default: `$$$$`, possible values: `CRLF`,`LF`,`NULL`,`STXETX`,`RAW`,`L1`,`L2`,`L4`)* //end::configuration-properties[] == Available Decoders diff --git a/applications/source/time-source/README.adoc b/applications/source/time-source/README.adoc index 9358c5ce..f672b9d8 100644 --- a/applications/source/time-source/README.adoc +++ b/applications/source/time-source/README.adoc @@ -7,7 +7,7 @@ The time source will simply emit a String with the current time every so often. The **$$time$$** $$source$$ has the following options: -//tag::configuration-properties[] +//tag::configuration-properties[group=false] $$spring.cloud.stream.poller.cron$$:: $$Cron expression value for the Cron Trigger.$$ *($$String$$, default: `$$$$`)* $$spring.cloud.stream.poller.fixed-delay$$:: $$Fixed delay for default poller.$$ *($$Long$$, default: `$$1000$$`)* $$spring.cloud.stream.poller.initial-delay$$:: $$Initial delay for periodic triggers.$$ *($$Integer$$, default: `$$0$$`)* diff --git a/applications/source/twitter-message-source/README.adoc b/applications/source/twitter-message-source/README.adoc index fc324de2..78020a81 100644 --- a/applications/source/twitter-message-source/README.adoc +++ b/applications/source/twitter-message-source/README.adoc @@ -13,17 +13,28 @@ Must be aligned with used APIs rate limit == Options //tag::configuration-properties[] -$$spring.cloud.stream.poller.cron$$:: $$Cron expression value for the Cron Trigger.$$ *($$String$$, default: `$$$$`)* -$$spring.cloud.stream.poller.fixed-delay$$:: $$Fixed delay for default poller.$$ *($$Long$$, default: `$$1000$$`)* -$$spring.cloud.stream.poller.initial-delay$$:: $$Initial delay for periodic triggers.$$ *($$Integer$$, default: `$$0$$`)* -$$spring.cloud.stream.poller.max-messages-per-poll$$:: $$Maximum messages per poll for the default poller.$$ *($$Long$$, default: `$$1$$`)* -$$twitter.connection.access-token$$:: $$Your Twitter token.$$ *($$String$$, default: `$$$$`)* -$$twitter.connection.access-token-secret$$:: $$Your Twitter token secret.$$ *($$String$$, default: `$$$$`)* -$$twitter.connection.consumer-key$$:: $$Your Twitter key.$$ *($$String$$, default: `$$$$`)* -$$twitter.connection.consumer-secret$$:: $$Your Twitter secret.$$ *($$String$$, default: `$$$$`)* -$$twitter.connection.debug-enabled$$:: $$Enables Twitter4J debug mode.$$ *($$Boolean$$, default: `$$false$$`)* -$$twitter.connection.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: `$$20$$`)* +Properties grouped by prefix: + + +=== spring.cloud.stream.poller + +$$cron$$:: $$Cron expression value for the Cron Trigger.$$ *($$String$$, default: `$$$$`)* +$$fixed-delay$$:: $$Fixed delay for default poller.$$ *($$Long$$, default: `$$1000$$`)* +$$initial-delay$$:: $$Initial delay for periodic triggers.$$ *($$Integer$$, default: `$$0$$`)* +$$max-messages-per-poll$$:: $$Maximum messages per poll for the default poller.$$ *($$Long$$, default: `$$1$$`)* + +=== twitter.connection + +$$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: `$$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: `$$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 d9b459bc..ddae6de9 100644 --- a/applications/source/twitter-search-source/README.adoc +++ b/applications/source/twitter-search-source/README.adoc @@ -16,26 +16,40 @@ Note: Twitter's search service and, by extension, the Search API is not meant to == Options //tag::configuration-properties[] -$$spring.cloud.stream.poller.cron$$:: $$Cron expression value for the Cron Trigger.$$ *($$String$$, default: `$$$$`)* -$$spring.cloud.stream.poller.fixed-delay$$:: $$Fixed delay for default poller.$$ *($$Long$$, default: `$$1000$$`)* -$$spring.cloud.stream.poller.initial-delay$$:: $$Initial delay for periodic triggers.$$ *($$Integer$$, default: `$$0$$`)* -$$spring.cloud.stream.poller.max-messages-per-poll$$:: $$Maximum messages per poll for the default poller.$$ *($$Long$$, default: `$$1$$`)* -$$twitter.connection.access-token$$:: $$Your Twitter token.$$ *($$String$$, default: `$$$$`)* -$$twitter.connection.access-token-secret$$:: $$Your Twitter token secret.$$ *($$String$$, default: `$$$$`)* -$$twitter.connection.consumer-key$$:: $$Your Twitter key.$$ *($$String$$, default: `$$$$`)* -$$twitter.connection.consumer-secret$$:: $$Your Twitter secret.$$ *($$String$$, default: `$$$$`)* -$$twitter.connection.debug-enabled$$:: $$Enables Twitter4J debug mode.$$ *($$Boolean$$, default: `$$false$$`)* -$$twitter.connection.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: `$$100$$`)* -$$twitter.search.geocode.latitude$$:: $$User's latitude.$$ *($$Double$$, default: `$$-1$$`)* -$$twitter.search.geocode.longitude$$:: $$User's longitude.$$ *($$Double$$, default: `$$-1$$`)* -$$twitter.search.geocode.radius$$:: $$Radius (in kilometers) around the (latitude, longitude) point.$$ *($$Double$$, default: `$$-1$$`)* -$$twitter.search.lang$$:: $$Restricts searched tweets to the given language, given by an http://en.wikipedia.org/wiki/ISO_639-1 .$$ *($$String$$, default: `$$$$`)* -$$twitter.search.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$$`)* -$$twitter.search.query$$:: $$Search tweets by search query string.$$ *($$String$$, default: `$$$$`)* -$$twitter.search.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$$`)* -$$twitter.search.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`)* -$$twitter.search.since$$:: $$If specified, returns tweets with since the given date. Date should be formatted as YYYY-MM-DD.$$ *($$String$$, default: `$$$$`)* +Properties grouped by prefix: + + +=== spring.cloud.stream.poller + +$$cron$$:: $$Cron expression value for the Cron Trigger.$$ *($$String$$, default: `$$$$`)* +$$fixed-delay$$:: $$Fixed delay for default poller.$$ *($$Long$$, default: `$$1000$$`)* +$$initial-delay$$:: $$Initial delay for periodic triggers.$$ *($$Integer$$, default: `$$0$$`)* +$$max-messages-per-poll$$:: $$Maximum messages per poll for the default poller.$$ *($$Long$$, default: `$$1$$`)* + +=== twitter.connection + +$$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: `$$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: `$$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: `$$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: `$$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: `$$-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 11af5b77..6fb96b03 100644 --- a/applications/source/twitter-stream-source/README.adoc +++ b/applications/source/twitter-stream-source/README.adoc @@ -16,19 +16,30 @@ The default access level allows up to 400 track keywords, 5,000 follow user Ids == Options //tag::configuration-properties[] -$$twitter.connection.access-token$$:: $$Your Twitter token.$$ *($$String$$, default: `$$$$`)* -$$twitter.connection.access-token-secret$$:: $$Your Twitter token secret.$$ *($$String$$, default: `$$$$`)* -$$twitter.connection.consumer-key$$:: $$Your Twitter key.$$ *($$String$$, default: `$$$$`)* -$$twitter.connection.consumer-secret$$:: $$Your Twitter secret.$$ *($$String$$, default: `$$$$`)* -$$twitter.connection.debug-enabled$$:: $$Enables Twitter4J debug mode.$$ *($$Boolean$$, default: `$$false$$`)* -$$twitter.connection.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: `$$0$$`)* -$$twitter.stream.filter.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: `$$$$`)* -$$twitter.stream.filter.follow$$:: $$Specifies the users, by ID, to receive public tweets from.$$ *($$List$$, default: `$$$$`)* -$$twitter.stream.filter.language$$:: $$Specifies the tweets language of the stream.$$ *($$List$$, default: `$$$$`)* -$$twitter.stream.filter.locations$$:: $$Locations to track. Internally represented as 2D array. Bounding box is invalid: 52.38, 4.90, 51.51, -0.12. The first pair must be the SW corner of the box$$ *($$List$$, default: `$$$$`)* -$$twitter.stream.filter.track$$:: $$Specifies keywords to track.$$ *($$List$$, default: `$$$$`)* -$$twitter.stream.type$$:: $$$$ *($$StreamType$$, default: `$$$$`, possible values: `sample`,`filter`,`firehose`,`link`)* +Properties grouped by prefix: + + +=== twitter.connection + +$$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: `$$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: `$$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: `$$$$`)* +$$locations$$:: $$Locations to track. Internally represented as 2D array. Bounding box is invalid: 52.38, 4.90, 51.51, -0.12. The first pair must be the SW corner of the box$$ *($$List$$, default: `$$$$`)* +$$track$$:: $$Specifies keywords to track.$$ *($$List$$, default: `$$$$`)* + +=== twitter.stream + +$$type$$:: $$$$ *($$StreamType$$, default: `$$$$`, possible values: `sample`,`filter`,`firehose`,`link`)* //end::configuration-properties[] //end::ref-doc[] diff --git a/applications/source/websocket-source/README.adoc b/applications/source/websocket-source/README.adoc index c72cbcf4..3df4f069 100644 --- a/applications/source/websocket-source/README.adoc +++ b/applications/source/websocket-source/README.adoc @@ -5,9 +5,17 @@ The `Websocket` source that produces messages through web socket. == Options //tag::configuration-properties[] -$$websocket.supplier.allowed-origins$$:: $$The allowed origins.$$ *($$String$$, default: `$$*$$`)* -$$websocket.supplier.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: `$$false$$`)* +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: `$$/websocket$$`)* + +=== websocket.supplier.sock-js + +$$enable$$:: $$Enable SockJS service on the server. Default is 'false'$$ *($$Boolean$$, default: `$$false$$`)* //end::configuration-properties[] == Examples diff --git a/applications/stream-applications-core/pom.xml b/applications/stream-applications-core/pom.xml index f8be1a2a..ad8f00a1 100644 --- a/applications/stream-applications-core/pom.xml +++ b/applications/stream-applications-core/pom.xml @@ -25,7 +25,7 @@ Horsham.BUILD-SNAPSHOT 3.0.9.BUILD-SNAPSHOT 1.0.0-SNAPSHOT - 1.0.0-M1 + 1.0.0-SNAPSHOT 2.1.2.RELEASE 1.2.1 Hoxton.SR7