Skip to content

Commit 5aed0fd

Browse files
actions-useractions-user
committed
Sync documentation of main branch
1 parent d19e2e2 commit 5aed0fd

14 files changed

+387
-56
lines changed

‎_generated-doc/main/config/quarkus-all-config.adoc‎

Lines changed: 81 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2012,7 +2012,7 @@ endif::add-copy-button-to-config-props[]
20122012

20132013
[.description]
20142014
--
2015-
Cache type.
2015+
Default cache type (backend provider). If no explicit type is defined for a cache, this type will be used.
20162016

20172017

20182018
ifdef::add-copy-button-to-env-var[]
@@ -2046,6 +2046,32 @@ endif::add-copy-button-to-env-var[]
20462046
|boolean
20472047
|`+++true+++`
20482048

2049+
h|[[quarkus-cache_section_quarkus-cache]] [.section-name.section-level0]##link:#quarkus-cache_section_quarkus-cache[Configuration that allows customizing cache names to use a different type]##
2050+
h|Type
2051+
h|Default
2052+
2053+
a|icon:lock[title=Fixed at build time] [[quarkus-cache_quarkus-cache-cache-name-type]] [.property-path]##link:#quarkus-cache_quarkus-cache-cache-name-type[`quarkus.cache."cache-name".type`]##
2054+
ifdef::add-copy-button-to-config-props[]
2055+
config_property_copy_button:+++quarkus.cache."cache-name".type+++[]
2056+
endif::add-copy-button-to-config-props[]
2057+
2058+
2059+
[.description]
2060+
--
2061+
Cache type to be used for the cache name.
2062+
2063+
2064+
ifdef::add-copy-button-to-env-var[]
2065+
Environment variable: env_var_with_copy_button:+++QUARKUS_CACHE__CACHE_NAME__TYPE+++[]
2066+
endif::add-copy-button-to-env-var[]
2067+
ifndef::add-copy-button-to-env-var[]
2068+
Environment variable: `+++QUARKUS_CACHE__CACHE_NAME__TYPE+++`
2069+
endif::add-copy-button-to-env-var[]
2070+
--
2071+
|string
2072+
|`+++caffeine+++`
2073+
2074+
20492075
h|[[quarkus-cache_section_quarkus-cache-caffeine]] [.section-name.section-level0]##link:#quarkus-cache_section_quarkus-cache-caffeine[Default configuration applied to all Caffeine caches (lowest precedence)]##
20502076
h|Type
20512077
h|Default
@@ -29353,7 +29379,7 @@ Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_ACTIVE+++`
2935329379
endif::add-copy-button-to-env-var[]
2935429380
--
2935529381
|boolean
29356-
|`+++'true' if Hibernate Search is enabled; 'false' otherwise+++`
29382+
|`+++'true' if Hibernate Search is enabled and the persistence unit is active; 'false' otherwise+++`
2935729383

2935829384
a| [[quarkus-hibernate-search-orm-elasticsearch_quarkus-hibernate-search-orm-schema-management-strategy]] [.property-path]##link:#quarkus-hibernate-search-orm-elasticsearch_quarkus-hibernate-search-orm-schema-management-strategy[`quarkus.hibernate-search-orm.schema-management.strategy`]##
2935929385
ifdef::add-copy-button-to-config-props[]
@@ -84665,6 +84691,31 @@ endif::add-copy-button-to-env-var[]
8466584691
|string
8466684692
|
8466784693

84694+
a| [[quarkus-rest-client-config_quarkus-rest-client-proxy-connect-timeout]] [.property-path]##link:#quarkus-rest-client-config_quarkus-rest-client-proxy-connect-timeout[`quarkus.rest-client.proxy-connect-timeout`]##
84695+
ifdef::add-copy-button-to-config-props[]
84696+
config_property_copy_button:+++quarkus.rest-client.proxy-connect-timeout+++[]
84697+
endif::add-copy-button-to-config-props[]
84698+
84699+
84700+
[.description]
84701+
--
84702+
Proxy connection timeout
84703+
84704+
Can be overwritten by client-specific settings.
84705+
84706+
This property is not applicable to the RESTEasy Client.
84707+
84708+
84709+
ifdef::add-copy-button-to-env-var[]
84710+
Environment variable: env_var_with_copy_button:+++QUARKUS_REST_CLIENT_PROXY_CONNECT_TIMEOUT+++[]
84711+
endif::add-copy-button-to-env-var[]
84712+
ifndef::add-copy-button-to-env-var[]
84713+
Environment variable: `+++QUARKUS_REST_CLIENT_PROXY_CONNECT_TIMEOUT+++`
84714+
endif::add-copy-button-to-env-var[]
84715+
--
84716+
|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]]
84717+
|`+++10s+++`
84718+
8466884719
a| [[quarkus-rest-client-config_quarkus-rest-client-connect-timeout]] [.property-path]##link:#quarkus-rest-client-config_quarkus-rest-client-connect-timeout[`quarkus.rest-client.connect-timeout`]##
8466984720
ifdef::add-copy-button-to-config-props[]
8467084721
config_property_copy_button:+++quarkus.rest-client.connect-timeout+++[]
@@ -85311,7 +85362,7 @@ The possible values are:
8531185362
- `all` - enables logging requests and responses and lower-level logging
8531285363
- `none` - no additional logging
8531385364

85314-
This property is applicable to reactive REST clients only.
85365+
This property is not applicable to the Quarkus RESTEasy client (provided by the quarkus-resteasy-client dependency).
8531585366

8531685367

8531785368
ifdef::add-copy-button-to-env-var[]
@@ -85336,7 +85387,7 @@ How many characters of the body should be logged. Message body can be large and
8533685387

8533785388
By default, set to 100.
8533885389

85339-
This property is applicable to reactive REST clients only.
85390+
This property is not applicable to the Quarkus RESTEasy client (provided by the quarkus-resteasy-client dependency).
8534085391

8534185392

8534285393
ifdef::add-copy-button-to-env-var[]
@@ -85495,7 +85546,7 @@ endif::add-copy-button-to-config-props[]
8549585546
--
8549685547
This property is only meant to be set by advanced configurations to override whatever value was set for the uri or url. The override is done using the REST Client class name configuration syntax.
8549785548

85498-
This property is not applicable to the RESTEasy Client, only the Quarkus Rest client (formerly RESTEasy Reactive client).
85549+
This property is not applicable to the Quarkus RESTEasy client (provided by the quarkus-resteasy-client dependency).
8549985550

8550085551

8550185552
ifdef::add-copy-button-to-env-var[]
@@ -85709,6 +85760,29 @@ endif::add-copy-button-to-env-var[]
8570985760
|string
8571085761
|
8571185762

85763+
a| [[quarkus-rest-client-config_quarkus-rest-client-client-proxy-connect-timeout]] [.property-path]##link:#quarkus-rest-client-config_quarkus-rest-client-client-proxy-connect-timeout[`quarkus.rest-client."client".proxy-connect-timeout`]##
85764+
ifdef::add-copy-button-to-config-props[]
85765+
config_property_copy_button:+++quarkus.rest-client."client".proxy-connect-timeout+++[]
85766+
endif::add-copy-button-to-config-props[]
85767+
85768+
85769+
[.description]
85770+
--
85771+
Proxy connection timeout
85772+
85773+
This property is not applicable to the RESTEasy Client.
85774+
85775+
85776+
ifdef::add-copy-button-to-env-var[]
85777+
Environment variable: env_var_with_copy_button:+++QUARKUS_REST_CLIENT__CLIENT__PROXY_CONNECT_TIMEOUT+++[]
85778+
endif::add-copy-button-to-env-var[]
85779+
ifndef::add-copy-button-to-env-var[]
85780+
Environment variable: `+++QUARKUS_REST_CLIENT__CLIENT__PROXY_CONNECT_TIMEOUT+++`
85781+
endif::add-copy-button-to-env-var[]
85782+
--
85783+
|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-all-config[icon:question-circle[title=More information about the Duration format]]
85784+
|`+++10s+++`
85785+
8571285786
a| [[quarkus-rest-client-config_quarkus-rest-client-client-query-param-style]] [.property-path]##link:#quarkus-rest-client-config_quarkus-rest-client-client-query-param-style[`quarkus.rest-client."client".query-param-style`]##
8571385787
ifdef::add-copy-button-to-config-props[]
8571485788
config_property_copy_button:+++quarkus.rest-client."client".query-param-style+++[]
@@ -86277,7 +86351,7 @@ The possible values are:
8627786351
- `all` - enables logging requests and responses and lower-level logging
8627886352
- `none` - no additional logging
8627986353

86280-
This property is applicable to reactive REST clients only.
86354+
This property is not applicable to the Quarkus RESTEasy client (provided by the quarkus-resteasy-client dependency).
8628186355

8628286356

8628386357
ifdef::add-copy-button-to-env-var[]
@@ -86302,7 +86376,7 @@ How many characters of the body should be logged. Message body can be large and
8630286376

8630386377
By default, set to 100.
8630486378

86305-
This property is applicable to reactive REST clients only.
86379+
This property is not applicable to the Quarkus RESTEasy client (provided by the quarkus-resteasy-client dependency).
8630686380

8630786381

8630886382
ifdef::add-copy-button-to-env-var[]

‎_generated-doc/main/config/quarkus-cache.adoc‎

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ endif::add-copy-button-to-config-props[]
1515

1616
[.description]
1717
--
18-
Cache type.
18+
Default cache type (backend provider). If no explicit type is defined for a cache, this type will be used.
1919

2020

2121
ifdef::add-copy-button-to-env-var[]
@@ -49,6 +49,32 @@ endif::add-copy-button-to-env-var[]
4949
|boolean
5050
|`+++true+++`
5151

52+
h|[[quarkus-cache_section_quarkus-cache]] [.section-name.section-level0]##link:#quarkus-cache_section_quarkus-cache[Configuration that allows customizing cache names to use a different type]##
53+
h|Type
54+
h|Default
55+
56+
a|icon:lock[title=Fixed at build time] [[quarkus-cache_quarkus-cache-cache-name-type]] [.property-path]##link:#quarkus-cache_quarkus-cache-cache-name-type[`quarkus.cache."cache-name".type`]##
57+
ifdef::add-copy-button-to-config-props[]
58+
config_property_copy_button:+++quarkus.cache."cache-name".type+++[]
59+
endif::add-copy-button-to-config-props[]
60+
61+
62+
[.description]
63+
--
64+
Cache type to be used for the cache name.
65+
66+
67+
ifdef::add-copy-button-to-env-var[]
68+
Environment variable: env_var_with_copy_button:+++QUARKUS_CACHE__CACHE_NAME__TYPE+++[]
69+
endif::add-copy-button-to-env-var[]
70+
ifndef::add-copy-button-to-env-var[]
71+
Environment variable: `+++QUARKUS_CACHE__CACHE_NAME__TYPE+++`
72+
endif::add-copy-button-to-env-var[]
73+
--
74+
|string
75+
|`+++caffeine+++`
76+
77+
5278
h|[[quarkus-cache_section_quarkus-cache-caffeine]] [.section-name.section-level0]##link:#quarkus-cache_section_quarkus-cache-caffeine[Default configuration applied to all Caffeine caches (lowest precedence)]##
5379
h|Type
5480
h|Default

‎_generated-doc/main/config/quarkus-cache_quarkus.cache.adoc‎

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ endif::add-copy-button-to-config-props[]
1515

1616
[.description]
1717
--
18-
Cache type.
18+
Default cache type (backend provider). If no explicit type is defined for a cache, this type will be used.
1919

2020

2121
ifdef::add-copy-button-to-env-var[]
@@ -49,6 +49,32 @@ endif::add-copy-button-to-env-var[]
4949
|boolean
5050
|`+++true+++`
5151

52+
h|[[quarkus-cache_section_quarkus-cache]] [.section-name.section-level0]##link:#quarkus-cache_section_quarkus-cache[Configuration that allows customizing cache names to use a different type]##
53+
h|Type
54+
h|Default
55+
56+
a|icon:lock[title=Fixed at build time] [[quarkus-cache_quarkus-cache-cache-name-type]] [.property-path]##link:#quarkus-cache_quarkus-cache-cache-name-type[`quarkus.cache."cache-name".type`]##
57+
ifdef::add-copy-button-to-config-props[]
58+
config_property_copy_button:+++quarkus.cache."cache-name".type+++[]
59+
endif::add-copy-button-to-config-props[]
60+
61+
62+
[.description]
63+
--
64+
Cache type to be used for the cache name.
65+
66+
67+
ifdef::add-copy-button-to-env-var[]
68+
Environment variable: env_var_with_copy_button:+++QUARKUS_CACHE__CACHE_NAME__TYPE+++[]
69+
endif::add-copy-button-to-env-var[]
70+
ifndef::add-copy-button-to-env-var[]
71+
Environment variable: `+++QUARKUS_CACHE__CACHE_NAME__TYPE+++`
72+
endif::add-copy-button-to-env-var[]
73+
--
74+
|string
75+
|`+++caffeine+++`
76+
77+
5278
h|[[quarkus-cache_section_quarkus-cache-caffeine]] [.section-name.section-level0]##link:#quarkus-cache_section_quarkus-cache-caffeine[Default configuration applied to all Caffeine caches (lowest precedence)]##
5379
h|Type
5480
h|Default

‎_generated-doc/main/config/quarkus-hibernate-search-orm-elasticsearch.adoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -181,7 +181,7 @@ Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_ACTIVE+++`
181181
endif::add-copy-button-to-env-var[]
182182
--
183183
|boolean
184-
|`+++'true' if Hibernate Search is enabled; 'false' otherwise+++`
184+
|`+++'true' if Hibernate Search is enabled and the persistence unit is active; 'false' otherwise+++`
185185

186186
a| [[quarkus-hibernate-search-orm-elasticsearch_quarkus-hibernate-search-orm-schema-management-strategy]] [.property-path]##link:#quarkus-hibernate-search-orm-elasticsearch_quarkus-hibernate-search-orm-schema-management-strategy[`quarkus.hibernate-search-orm.schema-management.strategy`]##
187187
ifdef::add-copy-button-to-config-props[]

‎_generated-doc/main/config/quarkus-hibernate-search-orm-elasticsearch_quarkus.hibernate-search-orm.adoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -181,7 +181,7 @@ Environment variable: `+++QUARKUS_HIBERNATE_SEARCH_ORM_ACTIVE+++`
181181
endif::add-copy-button-to-env-var[]
182182
--
183183
|boolean
184-
|`+++'true' if Hibernate Search is enabled; 'false' otherwise+++`
184+
|`+++'true' if Hibernate Search is enabled and the persistence unit is active; 'false' otherwise+++`
185185

186186
a| [[quarkus-hibernate-search-orm-elasticsearch_quarkus-hibernate-search-orm-schema-management-strategy]] [.property-path]##link:#quarkus-hibernate-search-orm-elasticsearch_quarkus-hibernate-search-orm-schema-management-strategy[`quarkus.hibernate-search-orm.schema-management.strategy`]##
187187
ifdef::add-copy-button-to-config-props[]

‎_generated-doc/main/config/quarkus-rest-client-config.adoc‎

Lines changed: 72 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -172,6 +172,31 @@ endif::add-copy-button-to-env-var[]
172172
|string
173173
|
174174

175+
a| [[quarkus-rest-client-config_quarkus-rest-client-proxy-connect-timeout]] [.property-path]##link:#quarkus-rest-client-config_quarkus-rest-client-proxy-connect-timeout[`quarkus.rest-client.proxy-connect-timeout`]##
176+
ifdef::add-copy-button-to-config-props[]
177+
config_property_copy_button:+++quarkus.rest-client.proxy-connect-timeout+++[]
178+
endif::add-copy-button-to-config-props[]
179+
180+
181+
[.description]
182+
--
183+
Proxy connection timeout
184+
185+
Can be overwritten by client-specific settings.
186+
187+
This property is not applicable to the RESTEasy Client.
188+
189+
190+
ifdef::add-copy-button-to-env-var[]
191+
Environment variable: env_var_with_copy_button:+++QUARKUS_REST_CLIENT_PROXY_CONNECT_TIMEOUT+++[]
192+
endif::add-copy-button-to-env-var[]
193+
ifndef::add-copy-button-to-env-var[]
194+
Environment variable: `+++QUARKUS_REST_CLIENT_PROXY_CONNECT_TIMEOUT+++`
195+
endif::add-copy-button-to-env-var[]
196+
--
197+
|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-rest-client-config_quarkus-rest-client[icon:question-circle[title=More information about the Duration format]]
198+
|`+++10s+++`
199+
175200
a| [[quarkus-rest-client-config_quarkus-rest-client-connect-timeout]] [.property-path]##link:#quarkus-rest-client-config_quarkus-rest-client-connect-timeout[`quarkus.rest-client.connect-timeout`]##
176201
ifdef::add-copy-button-to-config-props[]
177202
config_property_copy_button:+++quarkus.rest-client.connect-timeout+++[]
@@ -818,7 +843,7 @@ The possible values are:
818843
- `all` - enables logging requests and responses and lower-level logging
819844
- `none` - no additional logging
820845

821-
This property is applicable to reactive REST clients only.
846+
This property is not applicable to the Quarkus RESTEasy client (provided by the quarkus-resteasy-client dependency).
822847

823848

824849
ifdef::add-copy-button-to-env-var[]
@@ -843,7 +868,7 @@ How many characters of the body should be logged. Message body can be large and
843868

844869
By default, set to 100.
845870

846-
This property is applicable to reactive REST clients only.
871+
This property is not applicable to the Quarkus RESTEasy client (provided by the quarkus-resteasy-client dependency).
847872

848873

849874
ifdef::add-copy-button-to-env-var[]
@@ -1002,7 +1027,7 @@ endif::add-copy-button-to-config-props[]
10021027
--
10031028
This property is only meant to be set by advanced configurations to override whatever value was set for the uri or url. The override is done using the REST Client class name configuration syntax.
10041029

1005-
This property is not applicable to the RESTEasy Client, only the Quarkus Rest client (formerly RESTEasy Reactive client).
1030+
This property is not applicable to the Quarkus RESTEasy client (provided by the quarkus-resteasy-client dependency).
10061031

10071032

10081033
ifdef::add-copy-button-to-env-var[]
@@ -1216,6 +1241,29 @@ endif::add-copy-button-to-env-var[]
12161241
|string
12171242
|
12181243

1244+
a| [[quarkus-rest-client-config_quarkus-rest-client-client-proxy-connect-timeout]] [.property-path]##link:#quarkus-rest-client-config_quarkus-rest-client-client-proxy-connect-timeout[`quarkus.rest-client."client".proxy-connect-timeout`]##
1245+
ifdef::add-copy-button-to-config-props[]
1246+
config_property_copy_button:+++quarkus.rest-client."client".proxy-connect-timeout+++[]
1247+
endif::add-copy-button-to-config-props[]
1248+
1249+
1250+
[.description]
1251+
--
1252+
Proxy connection timeout
1253+
1254+
This property is not applicable to the RESTEasy Client.
1255+
1256+
1257+
ifdef::add-copy-button-to-env-var[]
1258+
Environment variable: env_var_with_copy_button:+++QUARKUS_REST_CLIENT__CLIENT__PROXY_CONNECT_TIMEOUT+++[]
1259+
endif::add-copy-button-to-env-var[]
1260+
ifndef::add-copy-button-to-env-var[]
1261+
Environment variable: `+++QUARKUS_REST_CLIENT__CLIENT__PROXY_CONNECT_TIMEOUT+++`
1262+
endif::add-copy-button-to-env-var[]
1263+
--
1264+
|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-quarkus-rest-client-config_quarkus-rest-client[icon:question-circle[title=More information about the Duration format]]
1265+
|`+++10s+++`
1266+
12191267
a| [[quarkus-rest-client-config_quarkus-rest-client-client-query-param-style]] [.property-path]##link:#quarkus-rest-client-config_quarkus-rest-client-client-query-param-style[`quarkus.rest-client."client".query-param-style`]##
12201268
ifdef::add-copy-button-to-config-props[]
12211269
config_property_copy_button:+++quarkus.rest-client."client".query-param-style+++[]
@@ -1784,7 +1832,7 @@ The possible values are:
17841832
- `all` - enables logging requests and responses and lower-level logging
17851833
- `none` - no additional logging
17861834

1787-
This property is applicable to reactive REST clients only.
1835+
This property is not applicable to the Quarkus RESTEasy client (provided by the quarkus-resteasy-client dependency).
17881836

17891837

17901838
ifdef::add-copy-button-to-env-var[]
@@ -1809,7 +1857,7 @@ How many characters of the body should be logged. Message body can be large and
18091857

18101858
By default, set to 100.
18111859

1812-
This property is applicable to reactive REST clients only.
1860+
This property is not applicable to the Quarkus RESTEasy client (provided by the quarkus-resteasy-client dependency).
18131861

18141862

18151863
ifdef::add-copy-button-to-env-var[]
@@ -1824,6 +1872,25 @@ endif::add-copy-button-to-env-var[]
18241872

18251873
|===
18261874

1875+
ifndef::no-duration-note[]
1876+
[NOTE]
1877+
[id=duration-note-anchor-quarkus-rest-client-config_quarkus-rest-client]
1878+
.About the Duration format
1879+
====
1880+
To write duration values, use the standard `java.time.Duration` format.
1881+
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.
1882+
1883+
You can also use a simplified format, starting with a number:
1884+
1885+
* If the value is only a number, it represents time in seconds.
1886+
* If the value is a number followed by `ms`, it represents time in milliseconds.
1887+
1888+
In other cases, the simplified format is translated to the `java.time.Duration` format for parsing:
1889+
1890+
* If the value is a number followed by `h`, `m`, or `s`, it is prefixed with `PT`.
1891+
* If the value is a number followed by `d`, it is prefixed with `P`.
1892+
====
1893+
endif::no-duration-note[]
18271894
ifndef::no-memory-size-note[]
18281895
[NOTE]
18291896
[id=memory-size-note-anchor-quarkus-rest-client-config_quarkus-rest-client]

0 commit comments

Comments
 (0)