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 Apr 5, 2024
1 parent b6dab5c commit 2991afb
Show file tree
Hide file tree
Showing 35 changed files with 3,311 additions and 2,502 deletions.
4 changes: 3 additions & 1 deletion _data/versioned/main/index/quarkus.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -318,14 +318,16 @@ types:
id: virtual-threads
type: reference
url: /guides/virtual-threads
- title: WebSockets-Next extension reference guide
- title: WebSockets Next extension reference guide
filename: websockets-next-reference.adoc
summary: The websockets-next extension provides an experimental API to define WebSocket endpoints declaratively.
categories: web
topics:
- web
- websockets
extensions:
- io.quarkus:quarkus-websockets-next
id: websockets-next-reference-guide
type: reference
url: /guides/websockets-next-reference
- title: gRPC code generation reference guide
Expand Down
10 changes: 5 additions & 5 deletions _data/versioned/main/index/relations.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6963,7 +6963,7 @@
url: /guides/websockets
type: guide
matches: 1
- title: WebSockets-Next extension reference guide
- title: WebSockets Next extension reference guide
url: /guides/websockets-next-reference
type: reference
matches: 1
Expand Down Expand Up @@ -11065,7 +11065,7 @@
url: /guides/websockets
type: guide
matches: 1
- title: WebSockets-Next extension reference guide
- title: WebSockets Next extension reference guide
url: /guides/websockets-next-reference
type: reference
matches: 1
Expand Down Expand Up @@ -19403,7 +19403,7 @@
url: /guides/websockets-next-tutorial
type: tutorial
matches: 2
- title: WebSockets-Next extension reference guide
- title: WebSockets Next extension reference guide
url: /guides/websockets-next-reference
type: reference
matches: 2
Expand Down Expand Up @@ -19444,7 +19444,7 @@
url: /guides/websockets
type: guide
matches: 2
- title: WebSockets-Next extension reference guide
- title: WebSockets Next extension reference guide
url: /guides/websockets-next-reference
type: reference
matches: 2
Expand All @@ -19457,7 +19457,7 @@
type: guide
matches: 1
sameExtensions:
- title: WebSockets-Next extension reference guide
- title: WebSockets Next extension reference guide
url: /guides/websockets-next-reference
type: reference
matches: 1
Expand Down
Original file line number Diff line number Diff line change
@@ -1 +1 @@
[{"configDocKey":{"type":"boolean","key":".vertx-http","additionalKeys":[],"configDoc":"Enables instrumentation for Vert.x HTTP.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"vertx-http","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_VERTX_HTTP","enum":false}},{"configDocKey":{"type":"boolean","key":".vertx-event-bus","additionalKeys":[],"configDoc":"Enables instrumentation for Vert.x Event Bus.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"vertx-event-bus","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_VERTX_EVENT_BUS","enum":false}},{"configDocKey":{"type":"boolean","key":".vertx-sql-client","additionalKeys":[],"configDoc":"Enables instrumentation for Vert.x SQL Client.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"vertx-sql-client","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_VERTX_SQL_CLIENT","enum":false}}]
[{"configDocKey":{"type":"boolean","key":".vertx-http","additionalKeys":[],"configDoc":"Enables instrumentation for Vert.x HTTP.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"vertx-http","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_VERTX_HTTP","enum":false}},{"configDocKey":{"type":"boolean","key":".vertx-event-bus","additionalKeys":[],"configDoc":"Enables instrumentation for Vert.x Event Bus.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"vertx-event-bus","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_VERTX_EVENT_BUS","enum":false}},{"configDocKey":{"type":"boolean","key":".vertx-sql-client","additionalKeys":[],"configDoc":"Enables instrumentation for Vert.x SQL Client.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"vertx-sql-client","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_VERTX_SQL_CLIENT","enum":false}},{"configDocKey":{"type":"boolean","key":".vertx-redis-client","additionalKeys":[],"configDoc":"Enables instrumentation for Vert.x Redis Client.","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"vertx-redis-client","configPhase":"BUILD_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":true,"topLevelGrouping":"","since":null,"environmentVariable":"_VERTX_REDIS_CLIENT","enum":false}}]

Large diffs are not rendered by default.

4 changes: 3 additions & 1 deletion _generated-doc/main/config/quarkus-all-build-items.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2564,13 +2564,15 @@ a| `RuntimeValue info` :: +++<i>No Javadoc found</i>+++
|===
|Class Name |Attributes
a| https://github.com/quarkusio/quarkus/blob/main/extensions/websockets-next/server/deployment/src/main/java/io/quarkus/websockets/next/deployment/GeneratedEndpointBuildItem.java[`io.quarkus.websockets.next.deployment.GeneratedEndpointBuildItem`, window="_blank"] :: +++A generated representation of a .+++
a| `String endpointClassName` :: +++<i>No Javadoc found</i>+++
a| `String endpointId` :: +++<i>No Javadoc found</i>+++
`String endpointClassName` :: +++<i>No Javadoc found</i>+++
`String generatedClassName` :: +++<i>No Javadoc found</i>+++
`String path` :: +++<i>No Javadoc found</i>+++
a| https://github.com/quarkusio/quarkus/blob/main/extensions/websockets-next/server/deployment/src/main/java/io/quarkus/websockets/next/deployment/WebSocketEndpointBuildItem.java[`io.quarkus.websockets.next.deployment.WebSocketEndpointBuildItem`, window="_blank"] :: +++This build item represents a WebSocket endpoint class.+++
a| `BeanInfo bean` :: +++<i>No Javadoc found</i>+++
`String path` :: +++<i>No Javadoc found</i>+++
`String endpointId` :: +++<i>No Javadoc found</i>+++
`WebSocket.ExecutionMode executionMode` :: +++<i>No Javadoc found</i>+++
`Callback onOpen` :: +++<i>No Javadoc found</i>+++
`Callback onTextMessage` :: +++<i>No Javadoc found</i>+++
Expand Down
17 changes: 17 additions & 0 deletions _generated-doc/main/config/quarkus-all-config.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -52763,6 +52763,23 @@ endif::add-copy-button-to-env-var[]
|`true`


a| [[quarkus-opentelemetry_quarkus-otel-instrument-vertx-redis-client]]`link:#quarkus-opentelemetry_quarkus-otel-instrument-vertx-redis-client[quarkus.otel.instrument.vertx-redis-client]`


[.description]
--
Enables instrumentation for Vert.x Redis Client.

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


a| [[quarkus-opentelemetry_quarkus-otel-semconv-stability-opt-in]]`link:#quarkus-opentelemetry_quarkus-otel-semconv-stability-opt-in[quarkus.otel.semconv-stability.opt-in]`


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -82,93 +82,4 @@ endif::add-copy-button-to-env-var[]
--|string
|


a| [[quarkus-cache-redis-config-group-redis-cache-build-time-config_quarkus-cache-redis-cache-name-expire-after-write]]`link:#quarkus-cache-redis-config-group-redis-cache-build-time-config_quarkus-cache-redis-cache-name-expire-after-write[quarkus.cache.redis."cache-name".expire-after-write]`


[.description]
--
Specifies that each entry should be automatically removed from the cache once a fixed duration has elapsed after the entry's creation, or the most recent replacement of its value.

ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_CACHE_REDIS__CACHE_NAME__EXPIRE_AFTER_WRITE+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_CACHE_REDIS__CACHE_NAME__EXPIRE_AFTER_WRITE+++`
endif::add-copy-button-to-env-var[]
--|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration]
link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]]
|


a| [[quarkus-cache-redis-config-group-redis-cache-build-time-config_quarkus-cache-redis-cache-name-expire-after-access]]`link:#quarkus-cache-redis-config-group-redis-cache-build-time-config_quarkus-cache-redis-cache-name-expire-after-access[quarkus.cache.redis."cache-name".expire-after-access]`


[.description]
--
Specifies that each entry should be automatically removed from the cache once a fixed duration has elapsed after the last access of its value.

ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_CACHE_REDIS__CACHE_NAME__EXPIRE_AFTER_ACCESS+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_CACHE_REDIS__CACHE_NAME__EXPIRE_AFTER_ACCESS+++`
endif::add-copy-button-to-env-var[]
--|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration]
link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]]
|


a| [[quarkus-cache-redis-config-group-redis-cache-build-time-config_quarkus-cache-redis-cache-name-prefix]]`link:#quarkus-cache-redis-config-group-redis-cache-build-time-config_quarkus-cache-redis-cache-name-prefix[quarkus.cache.redis."cache-name".prefix]`


[.description]
--
the key prefix allowing to identify the keys belonging to the cache. If not set, use "cache:$cache-name"

ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_CACHE_REDIS__CACHE_NAME__PREFIX+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_CACHE_REDIS__CACHE_NAME__PREFIX+++`
endif::add-copy-button-to-env-var[]
--|string
|


a| [[quarkus-cache-redis-config-group-redis-cache-build-time-config_quarkus-cache-redis-cache-name-use-optimistic-locking]]`link:#quarkus-cache-redis-config-group-redis-cache-build-time-config_quarkus-cache-redis-cache-name-use-optimistic-locking[quarkus.cache.redis."cache-name".use-optimistic-locking]`


[.description]
--
Whether the access to the cache should be using optimistic locking. See link:https://redis.io/docs/manual/transactions/#optimistic-locking-using-check-and-set[Redis Optimistic Locking] for details. Default is `false`.

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

|===
ifndef::no-duration-note[]
[NOTE]
[id='duration-note-anchor-{summaryTableId}']
.About the Duration format
====
To write duration values, use the standard `java.time.Duration` format.
See the link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html#parse(java.lang.CharSequence)[Duration#parse() Java API documentation] for more information.

You can also use a simplified format, starting with a number:

* If the value is only a number, it represents time in seconds.
* If the value is a number followed by `ms`, it represents time in milliseconds.
In other cases, the simplified format is translated to the `java.time.Duration` format for parsing:

* If the value is a number followed by `h`, `m`, or `s`, it is prefixed with `PT`.
* If the value is a number followed by `d`, it is prefixed with `P`.
====
endif::no-duration-note[]
|===
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,40 @@ h|[[quarkus-cache-redis-config-group-redis-cache-runtime-config_quarkus-cache-re
h|Type
h|Default

a|icon:lock[title=Fixed at build time] [[quarkus-cache-redis-config-group-redis-cache-runtime-config_quarkus-cache-redis-cache-name-value-type]]`link:#quarkus-cache-redis-config-group-redis-cache-runtime-config_quarkus-cache-redis-cache-name-value-type[quarkus.cache.redis."cache-name".value-type]`


[.description]
--
The default type of the value stored in the cache.

ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_CACHE_REDIS__CACHE_NAME__VALUE_TYPE+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_CACHE_REDIS__CACHE_NAME__VALUE_TYPE+++`
endif::add-copy-button-to-env-var[]
--|string
|


a|icon:lock[title=Fixed at build time] [[quarkus-cache-redis-config-group-redis-cache-runtime-config_quarkus-cache-redis-cache-name-key-type]]`link:#quarkus-cache-redis-config-group-redis-cache-runtime-config_quarkus-cache-redis-cache-name-key-type[quarkus.cache.redis."cache-name".key-type]`


[.description]
--
The key type, `String` by default.

ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_CACHE_REDIS__CACHE_NAME__KEY_TYPE+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_CACHE_REDIS__CACHE_NAME__KEY_TYPE+++`
endif::add-copy-button-to-env-var[]
--|string
|


a| [[quarkus-cache-redis-config-group-redis-cache-runtime-config_quarkus-cache-redis-cache-name-expire-after-write]]`link:#quarkus-cache-redis-config-group-redis-cache-runtime-config_quarkus-cache-redis-cache-name-expire-after-write[quarkus.cache.redis."cache-name".expire-after-write]`


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -99,93 +99,4 @@ endif::add-copy-button-to-env-var[]
--|string
|


a| [[quarkus-cache-redis-redis-caches-build-time-config_quarkus-cache-redis-cache-name-expire-after-write]]`link:#quarkus-cache-redis-redis-caches-build-time-config_quarkus-cache-redis-cache-name-expire-after-write[quarkus.cache.redis."cache-name".expire-after-write]`


[.description]
--
Specifies that each entry should be automatically removed from the cache once a fixed duration has elapsed after the entry's creation, or the most recent replacement of its value.

ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_CACHE_REDIS__CACHE_NAME__EXPIRE_AFTER_WRITE+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_CACHE_REDIS__CACHE_NAME__EXPIRE_AFTER_WRITE+++`
endif::add-copy-button-to-env-var[]
--|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration]
link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]]
|


a| [[quarkus-cache-redis-redis-caches-build-time-config_quarkus-cache-redis-cache-name-expire-after-access]]`link:#quarkus-cache-redis-redis-caches-build-time-config_quarkus-cache-redis-cache-name-expire-after-access[quarkus.cache.redis."cache-name".expire-after-access]`


[.description]
--
Specifies that each entry should be automatically removed from the cache once a fixed duration has elapsed after the last access of its value.

ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_CACHE_REDIS__CACHE_NAME__EXPIRE_AFTER_ACCESS+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_CACHE_REDIS__CACHE_NAME__EXPIRE_AFTER_ACCESS+++`
endif::add-copy-button-to-env-var[]
--|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration]
link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]]
|


a| [[quarkus-cache-redis-redis-caches-build-time-config_quarkus-cache-redis-cache-name-prefix]]`link:#quarkus-cache-redis-redis-caches-build-time-config_quarkus-cache-redis-cache-name-prefix[quarkus.cache.redis."cache-name".prefix]`


[.description]
--
the key prefix allowing to identify the keys belonging to the cache. If not set, use "cache:$cache-name"

ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_CACHE_REDIS__CACHE_NAME__PREFIX+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_CACHE_REDIS__CACHE_NAME__PREFIX+++`
endif::add-copy-button-to-env-var[]
--|string
|


a| [[quarkus-cache-redis-redis-caches-build-time-config_quarkus-cache-redis-cache-name-use-optimistic-locking]]`link:#quarkus-cache-redis-redis-caches-build-time-config_quarkus-cache-redis-cache-name-use-optimistic-locking[quarkus.cache.redis."cache-name".use-optimistic-locking]`


[.description]
--
Whether the access to the cache should be using optimistic locking. See link:https://redis.io/docs/manual/transactions/#optimistic-locking-using-check-and-set[Redis Optimistic Locking] for details. Default is `false`.

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

|===
ifndef::no-duration-note[]
[NOTE]
[id='duration-note-anchor-{summaryTableId}']
.About the Duration format
====
To write duration values, use the standard `java.time.Duration` format.
See the link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html#parse(java.lang.CharSequence)[Duration#parse() Java API documentation] for more information.

You can also use a simplified format, starting with a number:

* If the value is only a number, it represents time in seconds.
* If the value is a number followed by `ms`, it represents time in milliseconds.
In other cases, the simplified format is translated to the `java.time.Duration` format for parsing:

* If the value is a number followed by `h`, `m`, or `s`, it is prefixed with `PT`.
* If the value is a number followed by `d`, it is prefixed with `P`.
====
endif::no-duration-note[]
|===
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,40 @@ h|[[quarkus-cache-redis-redis-caches-config_quarkus-cache-redis-caches-config-ad
h|Type
h|Default

a|icon:lock[title=Fixed at build time] [[quarkus-cache-redis-redis-caches-config_quarkus-cache-redis-cache-name-value-type]]`link:#quarkus-cache-redis-redis-caches-config_quarkus-cache-redis-cache-name-value-type[quarkus.cache.redis."cache-name".value-type]`


[.description]
--
The default type of the value stored in the cache.

ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_CACHE_REDIS__CACHE_NAME__VALUE_TYPE+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_CACHE_REDIS__CACHE_NAME__VALUE_TYPE+++`
endif::add-copy-button-to-env-var[]
--|string
|


a|icon:lock[title=Fixed at build time] [[quarkus-cache-redis-redis-caches-config_quarkus-cache-redis-cache-name-key-type]]`link:#quarkus-cache-redis-redis-caches-config_quarkus-cache-redis-cache-name-key-type[quarkus.cache.redis."cache-name".key-type]`


[.description]
--
The key type, `String` by default.

ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_CACHE_REDIS__CACHE_NAME__KEY_TYPE+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_CACHE_REDIS__CACHE_NAME__KEY_TYPE+++`
endif::add-copy-button-to-env-var[]
--|string
|


a| [[quarkus-cache-redis-redis-caches-config_quarkus-cache-redis-cache-name-expire-after-write]]`link:#quarkus-cache-redis-redis-caches-config_quarkus-cache-redis-cache-name-expire-after-write[quarkus.cache.redis."cache-name".expire-after-write]`


Expand Down
Loading

0 comments on commit 2991afb

Please sign in to comment.