7487dc8f61
Prior to this commit, each app documented its available config props in its README.adoc. Now that the functions have been moved to the function catalog, these inline docs are replaced w/ a link to the respective function catalog docs. See #524
26 lines
1.3 KiB
Plaintext
26 lines
1.3 KiB
Plaintext
//tag::ref-doc[]
|
|
= Time Source
|
|
|
|
The time source will simply emit a String with the current time every so often.
|
|
|
|
== Options
|
|
|
|
The **$$time$$** $$source$$ has the following options:
|
|
|
|
=== spring.integration.poller
|
|
|
|
$$cron$$:: $$Cron expression for polling. Mutually exclusive with 'fixedDelay' and 'fixedRate'.$$ *($$String$$, default: `$$<none>$$`)*
|
|
$$fixed-delay$$:: $$Polling delay period. Mutually exclusive with 'cron' and 'fixedRate'.$$ *($$Duration$$, default: `$$<none>$$`)*
|
|
$$fixed-rate$$:: $$Polling rate period. Mutually exclusive with 'fixedDelay' and 'cron'.$$ *($$Duration$$, default: `$$<none>$$`)*
|
|
$$initial-delay$$:: $$Polling initial delay. Applied for 'fixedDelay' and 'fixedRate'; ignored for 'cron'.$$ *($$Duration$$, default: `$$<none>$$`)*
|
|
$$max-messages-per-poll$$:: $$Maximum number of messages to poll per polling cycle.$$ *($$Integer$$, default: `$$<none>$$`)*
|
|
$$receive-timeout$$:: $$How long to wait for messages on poll.$$ *($$Duration$$, default: `$$1s$$`)*
|
|
|
|
|
|
=== time
|
|
//tag::configuration-properties[link-to-catalog=true,group=false]
|
|
https://github.com/spring-cloud/spring-functions-catalog/tree/main/supplier/spring-time-supplier#configuration-options[See Spring Functions Catalog for configuration options].
|
|
//end::configuration-properties[]
|
|
|
|
//end::ref-doc[]
|