Skip to content

Commit

Permalink
Sync documentation of main branch
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Aug 1, 2024
1 parent 8711a6b commit 489e1c7
Show file tree
Hide file tree
Showing 8 changed files with 180 additions and 33 deletions.
Original file line number Diff line number Diff line change
@@ -1 +1 @@
[{"configDocKey":{"type":"com.cronutils.model.CronType","key":"quarkus.scheduler.cron-type","additionalKeys":[],"configDoc":"The syntax used in CRON expressions.","withinAMap":false,"defaultValue":"quartz","javaDocSiteLink":"","docMapKey":"cron-type","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":["`cron4j`","`quartz`","`unix`","`spring`","`spring53`"],"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.scheduler","since":null,"environmentVariable":"QUARKUS_SCHEDULER_CRON_TYPE","enum":true}},{"configDocKey":{"type":"boolean","key":"quarkus.scheduler.metrics.enabled","additionalKeys":[],"configDoc":"Scheduled task metrics will be enabled if a metrics extension is present and this value is true.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"metrics-enabled","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.scheduler","since":null,"environmentVariable":"QUARKUS_SCHEDULER_METRICS_ENABLED","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.scheduler.tracing.enabled","additionalKeys":[],"configDoc":"Controls whether tracing is enabled. If set to true and the OpenTelemetry extension is present, tracing will be enabled, creating automatic Spans for each scheduled task.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"tracing-enabled","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.scheduler","since":null,"environmentVariable":"QUARKUS_SCHEDULER_TRACING_ENABLED","enum":false}}]
[{"configDocKey":{"type":"com.cronutils.model.CronType","key":"quarkus.scheduler.cron-type","additionalKeys":[],"configDoc":"The syntax used in CRON expressions.","withinAMap":false,"defaultValue":"quartz","javaDocSiteLink":"","docMapKey":"cron-type","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":["`cron4j`","`quartz`","`unix`","`spring`","`spring53`"],"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.scheduler","since":null,"environmentVariable":"QUARKUS_SCHEDULER_CRON_TYPE","enum":true}},{"configDocKey":{"type":"boolean","key":"quarkus.scheduler.metrics.enabled","additionalKeys":[],"configDoc":"Scheduled task metrics will be enabled if a metrics extension is present and this value is true.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"metrics-enabled","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.scheduler","since":null,"environmentVariable":"QUARKUS_SCHEDULER_METRICS_ENABLED","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.scheduler.tracing.enabled","additionalKeys":[],"configDoc":"Controls whether tracing is enabled. If set to true and the OpenTelemetry extension is present, tracing will be enabled, creating automatic Spans for each scheduled task.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"tracing-enabled","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.scheduler","since":null,"environmentVariable":"QUARKUS_SCHEDULER_TRACING_ENABLED","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.scheduler.use-composite-scheduler","additionalKeys":[],"configDoc":"By default, only one `Scheduler` implementation is used. If set to `true` then a composite `Scheduler` that delegates to all running implementations is used.\n\nScheduler implementations will be started depending on the value of `quarkus.scheduler.start-mode`, i.e. the scheduler is not started unless a relevant `io.quarkus.scheduler.Scheduled` business method is found.","withinAMap":false,"defaultValue":"false","javaDocSiteLink":"","docMapKey":"use-composite-scheduler","configPhase":"BUILD_AND_RUN_TIME_FIXED","acceptedValues":null,"optional":false,"list":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.scheduler","since":null,"environmentVariable":"QUARKUS_SCHEDULER_USE_COMPOSITE_SCHEDULER","enum":false}}]
39 changes: 39 additions & 0 deletions _generated-doc/main/config/quarkus-all-build-items.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7491,12 +7491,51 @@ h|Attributes



a| https://github.com/quarkusio/quarkus/blob/main/extensions/scheduler/deployment/src/main/java/io/quarkus/scheduler/deployment/DiscoveredImplementationsBuildItem.java[`io.quarkus.scheduler.deployment.DiscoveredImplementationsBuildItem`, window="_blank"]
[.description]
--
This build item holds all discovered `io.quarkus.scheduler.Scheduler` implementations sorted by priority. Higher priority goes first.
-- a|`java.lang.String autoImplementation`
_No Javadoc found_

`java.util.Set<String> implementations`

_No Javadoc found_

`boolean useCompositeScheduler`

_No Javadoc found_




a| https://github.com/quarkusio/quarkus/blob/main/extensions/scheduler/deployment/src/main/java/io/quarkus/scheduler/deployment/ForceStartSchedulerBuildItem.java[`io.quarkus.scheduler.deployment.ForceStartSchedulerBuildItem`, window="_blank"]
[.description]
--
A marker item which forces Quarkus Scheduler initialization regardless of presence of any `io.quarkus.scheduler.Scheduled` methods.
This option is similar to using scheduler subsystem configuration option `quarkus.scheduler.start-mode=forced` .
-- a|None
a| https://github.com/quarkusio/quarkus/blob/main/extensions/scheduler/deployment/src/main/java/io/quarkus/scheduler/deployment/SchedulerImplementationBuildItem.java[`io.quarkus.scheduler.deployment.SchedulerImplementationBuildItem`, window="_blank"]
[.description]
--
An extension that provides an implementation of `Scheduler` must produce this build item.
If multiple extensions produce this build item with the same `#implementation` value then the build fails.
-- a|`java.lang.String implementation`
_No Javadoc found_

`org.jboss.jandex.DotName schedulerBeanClass`

_No Javadoc found_

`int priority`

_No Javadoc found_


|===
== Security
[.configuration-reference,cols=2*]
Expand Down
19 changes: 19 additions & 0 deletions _generated-doc/main/config/quarkus-all-config.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -68446,6 +68446,25 @@ endif::add-copy-button-to-env-var[]
|`false`


a|icon:lock[title=Fixed at build time] [[quarkus-scheduler_quarkus-scheduler-use-composite-scheduler]]`link:#quarkus-scheduler_quarkus-scheduler-use-composite-scheduler[quarkus.scheduler.use-composite-scheduler]`


[.description]
--
By default, only one `Scheduler` implementation is used. If set to `true` then a composite `Scheduler` that delegates to all running implementations is used.

Scheduler implementations will be started depending on the value of `quarkus.scheduler.start-mode`, i.e. the scheduler is not started unless a relevant `io.quarkus.scheduler.Scheduled` business method is found.

ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_SCHEDULER_USE_COMPOSITE_SCHEDULER+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_SCHEDULER_USE_COMPOSITE_SCHEDULER+++`
endif::add-copy-button-to-env-var[]
--|boolean
|`false`


a| [[quarkus-scheduler_quarkus-scheduler-enabled]]`link:#quarkus-scheduler_quarkus-scheduler-enabled[quarkus.scheduler.enabled]`


Expand Down
19 changes: 19 additions & 0 deletions _generated-doc/main/config/quarkus-scheduler-scheduler-config.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -61,4 +61,23 @@ endif::add-copy-button-to-env-var[]
--|boolean
|`false`


a|icon:lock[title=Fixed at build time] [[quarkus-scheduler-scheduler-config_quarkus-scheduler-use-composite-scheduler]]`link:#quarkus-scheduler-scheduler-config_quarkus-scheduler-use-composite-scheduler[quarkus.scheduler.use-composite-scheduler]`


[.description]
--
By default, only one `Scheduler` implementation is used. If set to `true` then a composite `Scheduler` that delegates to all running implementations is used.

Scheduler implementations will be started depending on the value of `quarkus.scheduler.start-mode`, i.e. the scheduler is not started unless a relevant `io.quarkus.scheduler.Scheduled` business method is found.

ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_SCHEDULER_USE_COMPOSITE_SCHEDULER+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_SCHEDULER_USE_COMPOSITE_SCHEDULER+++`
endif::add-copy-button-to-env-var[]
--|boolean
|`false`

|===
19 changes: 19 additions & 0 deletions _generated-doc/main/config/quarkus-scheduler.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,25 @@ endif::add-copy-button-to-env-var[]
|`false`


a|icon:lock[title=Fixed at build time] [[quarkus-scheduler_quarkus-scheduler-use-composite-scheduler]]`link:#quarkus-scheduler_quarkus-scheduler-use-composite-scheduler[quarkus.scheduler.use-composite-scheduler]`


[.description]
--
By default, only one `Scheduler` implementation is used. If set to `true` then a composite `Scheduler` that delegates to all running implementations is used.

Scheduler implementations will be started depending on the value of `quarkus.scheduler.start-mode`, i.e. the scheduler is not started unless a relevant `io.quarkus.scheduler.Scheduled` business method is found.

ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_SCHEDULER_USE_COMPOSITE_SCHEDULER+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_SCHEDULER_USE_COMPOSITE_SCHEDULER+++`
endif::add-copy-button-to-env-var[]
--|boolean
|`false`


a| [[quarkus-scheduler_quarkus-scheduler-enabled]]`link:#quarkus-scheduler_quarkus-scheduler-enabled[quarkus.scheduler.enabled]`


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ Create a file called `src/main/resources/json-schema.json` with the schema for o
"type": "string",
"description": "The movie's title."
},
"yeay": {
"year": {
"type": "integer",
"description": "The movie's year."
}
Expand Down
Loading

0 comments on commit 489e1c7

Please sign in to comment.