forked from helidon-io/helidon
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathall-config-meta.json
More file actions
5804 lines (5804 loc) · 361 KB
/
Copy pathall-config-meta.json
File metadata and controls
5804 lines (5804 loc) · 361 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
[
{
"module": "io.helidon.webclient.http1",
"types": [
{
"annotatedType": "io.helidon.webclient.http1.Http1ClientProtocolConfig",
"type": "io.helidon.webclient.http1.Http1ClientProtocolConfig",
"producers": [
"io.helidon.webclient.http1.Http1ClientProtocolConfig#create(io.helidon.common.config.Config)",
"io.helidon.webclient.http1.Http1ClientProtocolConfig#builder()"
],
"options": [
{
"defaultValue": "true",
"description": "Sets whether the response header format is validated or not.\n <p>\n Defaults to `true`.\n </p>\n\n @return whether response header validation should be enabled",
"key": "validate-response-headers",
"method": "io.helidon.webclient.http1.Http1ClientProtocolConfig.Builder#validateResponseHeaders(boolean)",
"type": "java.lang.Boolean"
},
{
"defaultValue": "256",
"description": "Configure the maximum allowed length of the status line from the response.\n\n @return maximum status line length",
"key": "max-status-line-length",
"method": "io.helidon.webclient.http1.Http1ClientProtocolConfig.Builder#maxStatusLineLength(int)",
"type": "java.lang.Integer"
},
{
"defaultValue": "false",
"description": "Sets whether the request header format is validated or not.\n <p>\n Defaults to `false` as user has control on the header creation.\n </p>\n\n @return whether request header validation should be enabled",
"key": "validate-request-headers",
"method": "io.helidon.webclient.http1.Http1ClientProtocolConfig.Builder#validateRequestHeaders(boolean)",
"type": "java.lang.Boolean"
},
{
"defaultValue": "http_1_1",
"description": "",
"key": "name",
"method": "io.helidon.webclient.http1.Http1ClientProtocolConfig.Builder#name(java.lang.String)"
},
{
"defaultValue": "16384",
"description": "Configure the maximum allowed header size of the response.\n\n @return maximum header size",
"key": "max-header-size",
"method": "io.helidon.webclient.http1.Http1ClientProtocolConfig.Builder#maxHeaderSize(int)",
"type": "java.lang.Integer"
},
{
"defaultValue": "true",
"description": "Whether to use keep alive by default.\n\n @return `true` for keeping connections alive and re-using them for multiple requests (default), `false`\n to create a new connection for each request",
"key": "default-keep-alive",
"method": "io.helidon.webclient.http1.Http1ClientProtocolConfig.Builder#defaultKeepAlive(boolean)",
"type": "java.lang.Boolean"
}
]
}
]
}
]
[
{
"module": "io.helidon.webclient.websocket",
"types": [
{
"annotatedType": "io.helidon.webclient.websocket.WsClientProtocolConfig",
"type": "io.helidon.webclient.websocket.WsClientProtocolConfig",
"producers": [
"io.helidon.webclient.websocket.WsClientProtocolConfig#create(io.helidon.common.config.Config)",
"io.helidon.webclient.websocket.WsClientProtocolConfig#builder()"
],
"options": [
{
"description": "",
"key": "sub-protocols",
"kind": "LIST",
"method": "io.helidon.webclient.websocket.WsClientProtocolConfig.Builder#subProtocols(java.util.List<java.lang.String>)"
},
{
"defaultValue": "websocket",
"description": "",
"key": "name",
"method": "io.helidon.webclient.websocket.WsClientProtocolConfig.Builder#name(java.lang.String)"
}
]
},
{
"annotatedType": "io.helidon.webclient.websocket.WsClientConfig",
"type": "io.helidon.webclient.websocket.WsClient",
"producers": [
"io.helidon.webclient.websocket.WsClientConfig#create(io.helidon.common.config.Config)",
"io.helidon.webclient.websocket.WsClientConfig#builder()",
"io.helidon.webclient.websocket.WsClient#create(io.helidon.webclient.websocket.WsClientConfig)"
],
"options": [
{
"defaultValue": "create()",
"description": "WebSocket specific configuration.\n\n @return protocol specific configuration",
"key": "protocol-config",
"method": "io.helidon.webclient.websocket.WsClientConfig.Builder#protocolConfig(io.helidon.webclient.websocket.WsClientProtocolConfig)",
"type": "io.helidon.webclient.websocket.WsClientProtocolConfig"
}
]
}
]
}
]
[
{
"module": "io.helidon.webclient.http2",
"types": [
{
"annotatedType": "io.helidon.webclient.http2.Http2ClientProtocolConfig",
"type": "io.helidon.webclient.http2.Http2ClientProtocolConfig",
"producers": [
"io.helidon.webclient.http2.Http2ClientProtocolConfig#create(io.helidon.common.config.Config)",
"io.helidon.webclient.http2.Http2ClientProtocolConfig#builder()"
],
"options": [
{
"defaultValue": "false",
"description": "Prior knowledge of HTTP/2 capabilities of the server. If server we are connecting to does not\n support HTTP/2 and prior knowledge is set to `false`, only features supported by HTTP/1 will be available\n and attempts to use HTTP/2 specific will throw an UnsupportedOperationException.\n <h4>Plain text connection</h4>\n If prior knowledge is set to `true`, we will not attempt an upgrade of connection and use prior knowledge.\n If prior knowledge is set to `false`, we will initiate an HTTP/1 connection and upgrade it to HTTP/2,\n if supported by the server.\n plaintext connection (`h2c`).\n <h4>TLS protected connection</h4>\n If prior knowledge is set to `true`, we will negotiate protocol using HTTP/2 only, failing if not supported.\n if prior knowledge is set to `false`, we will negotiate protocol using both HTTP/2 and HTTP/1, using the protocol\n supported by server.\n\n @return whether to use prior knowledge of HTTP/2",
"key": "prior-knowledge",
"method": "io.helidon.webclient.http2.Http2ClientProtocolConfig.Builder#priorKnowledge(boolean)",
"type": "java.lang.Boolean"
},
{
"defaultValue": "PT0.1S",
"description": "Timeout for blocking between windows size check iterations.\n\n @return timeout",
"key": "flow-control-block-timeout",
"method": "io.helidon.webclient.http2.Http2ClientProtocolConfig.Builder#flowControlBlockTimeout(java.time.Duration)",
"type": "java.time.Duration"
},
{
"defaultValue": "PT0.5S",
"description": "Timeout for ping probe used for checking healthiness of cached connections.\n Defaults to `PT0.5S`, which means 500 milliseconds.\n\n @return timeout",
"key": "ping-timeout",
"method": "io.helidon.webclient.http2.Http2ClientProtocolConfig.Builder#pingTimeout(java.time.Duration)",
"type": "java.time.Duration"
},
{
"defaultValue": "16384",
"description": "Configure initial MAX_FRAME_SIZE setting for new HTTP/2 connections.\n Maximum size of data frames in bytes the client is prepared to accept from the server.\n Default value is 2^14(16_384).\n\n @return data frame size in bytes between 2^14(16_384) and 2^24-1(16_777_215)",
"key": "max-frame-size",
"method": "io.helidon.webclient.http2.Http2ClientProtocolConfig.Builder#maxFrameSize(int)",
"type": "java.lang.Integer"
},
{
"defaultValue": "false",
"description": "Check healthiness of cached connections with HTTP/2.0 ping frame.\n Defaults to `false`.\n\n @return use ping if true",
"key": "ping",
"method": "io.helidon.webclient.http2.Http2ClientProtocolConfig.Builder#ping(boolean)",
"type": "java.lang.Boolean"
},
{
"defaultValue": "-1",
"description": "Configure initial MAX_HEADER_LIST_SIZE setting for new HTTP/2 connections.\n Sends to the server the maximum header field section size client is prepared to accept.\n Defaults to `-1`, which means \"unconfigured\".\n\n @return units of octets",
"key": "max-header-list-size",
"method": "io.helidon.webclient.http2.Http2ClientProtocolConfig.Builder#maxHeaderListSize(long)",
"type": "java.lang.Long"
},
{
"defaultValue": "h2",
"description": "",
"key": "name",
"method": "io.helidon.webclient.http2.Http2ClientProtocolConfig.Builder#name(java.lang.String)"
},
{
"defaultValue": "65535",
"description": "Configure INITIAL_WINDOW_SIZE setting for new HTTP/2 connections.\n Sends to the server the size of the largest frame payload client is willing to receive.\n Defaults to {@value io.helidon.http.http2.WindowSize#DEFAULT_WIN_SIZE}.\n\n @return units of octets",
"key": "initial-window-size",
"method": "io.helidon.webclient.http2.Http2ClientProtocolConfig.Builder#initialWindowSize(int)",
"type": "java.lang.Integer"
}
]
}
]
}
]
[
{
"module": "io.helidon.webclient.api",
"types": [
{
"annotatedType": "io.helidon.webclient.api.WebClientConfig",
"prefix": "clients",
"type": "io.helidon.webclient.api.WebClient",
"standalone": true,
"inherits": [
"io.helidon.webclient.api.HttpClientConfig"
],
"producers": [
"io.helidon.webclient.api.WebClientConfig#create(io.helidon.common.config.Config)",
"io.helidon.webclient.api.WebClientConfig#builder()",
"io.helidon.webclient.api.WebClient#create(io.helidon.webclient.api.WebClientConfig)"
],
"options": [
{
"description": "Configuration of client protocols.\n\n @return client protocol configurations",
"key": "protocol-configs",
"kind": "LIST",
"method": "io.helidon.webclient.api.WebClientConfig.Builder#protocolConfigs(java.util.List<io.helidon.webclient.spi.ProtocolConfig>)",
"providerType": "io.helidon.webclient.spi.ProtocolConfigProvider",
"type": "io.helidon.webclient.spi.ProtocolConfig",
"provider": true
}
]
},
{
"annotatedType": "io.helidon.webclient.api.HttpClientConfig",
"type": "io.helidon.webclient.api.HttpClientConfig",
"inherits": [
"io.helidon.webclient.api.HttpConfigBase"
],
"producers": [
"io.helidon.webclient.api.HttpClientConfig#create(io.helidon.common.config.Config)",
"io.helidon.webclient.api.HttpClientConfig#builder()"
],
"options": [
{
"defaultValue": "false",
"description": "Can be set to `true` to force the use of relative URIs in all requests,\n regardless of the presence or absence of proxies or no-proxy lists.\n\n @return relative URIs flag",
"key": "relative-uris",
"method": "io.helidon.webclient.api.HttpClientConfig.Builder#relativeUris(boolean)",
"type": "java.lang.Boolean"
},
{
"description": "Default headers to be used in every request from configuration.\n\n @return default headers",
"key": "default-headers",
"kind": "MAP",
"method": "io.helidon.webclient.api.HttpClientConfig.Builder#defaultHeadersMap(java.util.Map<java.lang.String, java.lang.String>)"
},
{
"description": "Configure the listener specific io.helidon.http.encoding.ContentEncodingContext.\n This method discards all previously registered ContentEncodingContext.\n If no content encoding context is registered, default encoding context is used.\n\n @return content encoding context",
"key": "content-encoding",
"method": "io.helidon.webclient.api.HttpClientConfig.Builder#contentEncoding(io.helidon.http.encoding.ContentEncodingContext)",
"type": "io.helidon.http.encoding.ContentEncodingContext"
},
{
"defaultValue": "256",
"description": "Maximal size of the connection cache.\n For most HTTP protocols, we may cache connections to various endpoints for keep alive (or stream reuse in case of HTTP/2).\n This option limits the size. Setting this number lower than the \"usual\" number of target services will cause connections\n to be closed and reopened frequently.",
"key": "connection-cache-size",
"method": "io.helidon.webclient.api.HttpClientConfig.Builder#connectionCacheSize(int)",
"type": "java.lang.Integer"
},
{
"description": "WebClient services.\n\n @return services to use with this web client",
"key": "services",
"kind": "LIST",
"method": "io.helidon.webclient.api.HttpClientConfig.Builder#services(java.util.List<io.helidon.webclient.spi.WebClientService>)",
"providerType": "io.helidon.webclient.spi.WebClientServiceProvider",
"type": "io.helidon.webclient.spi.WebClientService",
"provider": true
},
{
"defaultValue": "create()",
"description": "Configure the listener specific io.helidon.http.media.MediaContext.\n This method discards all previously registered MediaContext.\n If no media context is registered, default media context is used.\n\n @return media context",
"key": "media-context",
"method": "io.helidon.webclient.api.HttpClientConfig.Builder#mediaContext(io.helidon.http.media.MediaContext)",
"type": "io.helidon.http.media.MediaContext"
},
{
"description": "WebClient cookie manager.\n\n @return cookie manager to use",
"key": "cookie-manager",
"method": "io.helidon.webclient.api.HttpClientConfig.Builder#cookieManager(java.util.Optional<io.helidon.webclient.api.WebClientCookieManager>)",
"type": "io.helidon.webclient.api.WebClientCookieManager"
},
{
"defaultValue": "131072",
"description": "If the entity is expected to be smaller that this number of bytes, it would be buffered in memory to optimize performance.\n If bigger, streaming will be used.\n <p>\n Note that for some entity types we cannot use streaming, as they are already fully in memory (String, byte[]), for such\n cases, this option is ignored. Default is 128Kb.\n\n @return maximal number of bytes to buffer in memory for supported writers",
"key": "max-in-memory-entity",
"method": "io.helidon.webclient.api.HttpClientConfig.Builder#maxInMemoryEntity(int)",
"type": "java.lang.Integer"
},
{
"defaultValue": "true",
"description": "Whether Expect-100-Continue header is sent to verify server availability before sending an entity.\n <p>\n Defaults to `true`.\n </p>\n\n @return whether Expect:100-Continue header should be sent on streamed transfers",
"key": "send-expect-continue",
"method": "io.helidon.webclient.api.HttpClientConfig.Builder#sendExpectContinue(boolean)",
"type": "java.lang.Boolean"
},
{
"description": "Socket options for connections opened by this client.\n If there is a value explicitly configured on this type and on the socket options,\n the one configured on this type's builder will win:\n <ul>\n <li>#readTimeout()</li>\n <li>#connectTimeout()</li>\n </ul>\n\n @return socket options",
"key": "socket-options",
"method": "io.helidon.webclient.api.HttpClientConfig.Builder#socketOptions(io.helidon.common.socket.SocketOptions)",
"type": "io.helidon.common.socket.SocketOptions"
},
{
"defaultValue": "true",
"description": "Whether to share connection cache between all the WebClient instances in JVM.\n\n @return true if connection cache is shared",
"key": "share-connection-cache",
"method": "io.helidon.webclient.api.HttpClientConfig.Builder#shareConnectionCache(boolean)",
"type": "java.lang.Boolean"
},
{
"defaultValue": "STRICT",
"description": "Configure media type parsing mode for HTTP `Content-Type` header.\n\n @return media type parsing mode",
"key": "media-type-parser-mode",
"method": "io.helidon.webclient.api.HttpClientConfig.Builder#mediaTypeParserMode(io.helidon.common.media.type.ParserMode)",
"type": "io.helidon.common.media.type.ParserMode",
"allowedValues": [
{
"description": "",
"value": "STRICT"
},
{
"description": "",
"value": "RELAXED"
}
]
},
{
"description": "Base uri used by the client in all requests.\n\n @return base uri of the client requests",
"key": "base-uri",
"method": "io.helidon.webclient.api.HttpClientConfig.Builder#baseUri(java.util.Optional<io.helidon.webclient.api.ClientUri>)",
"type": "io.helidon.webclient.api.ClientUri"
},
{
"defaultValue": "PT1S",
"description": "Socket 100-Continue read timeout. Default is 1 second.\n This read timeout is used when 100-Continue is sent by the client, before it sends an entity.\n\n @return read 100-Continue timeout duration",
"key": "read-continue-timeout",
"method": "io.helidon.webclient.api.HttpClientConfig.Builder#readContinueTimeout(java.time.Duration)",
"type": "java.time.Duration"
}
]
},
{
"annotatedType": "io.helidon.webclient.api.WebClientCookieManagerConfig",
"type": "io.helidon.webclient.api.WebClientCookieManager",
"producers": [
"io.helidon.webclient.api.WebClientCookieManagerConfig#create(io.helidon.common.config.Config)",
"io.helidon.webclient.api.WebClientCookieManagerConfig#builder()",
"io.helidon.webclient.api.WebClientCookieManager#create(io.helidon.webclient.api.WebClientCookieManagerConfig)"
],
"options": [
{
"defaultValue": "false",
"description": "Whether automatic cookie store is enabled or not.\n\n @return status of cookie store",
"key": "automatic-store-enabled",
"method": "io.helidon.webclient.api.WebClientCookieManagerConfig.Builder#automaticStoreEnabled(boolean)",
"type": "java.lang.Boolean"
},
{
"defaultValue": "java.net.CookiePolicy.ACCEPT_ORIGINAL_SERVER",
"description": "Current cookie policy for this client.\n\n @return the cookie policy",
"key": "cookie-policy",
"method": "io.helidon.webclient.api.WebClientCookieManagerConfig.Builder#cookiePolicy(java.net.CookiePolicy)",
"type": "java.net.CookiePolicy"
},
{
"description": "Map of default cookies to include in all requests if cookies enabled.\n\n @return map of default cookies",
"key": "default-cookies",
"kind": "MAP",
"method": "io.helidon.webclient.api.WebClientCookieManagerConfig.Builder#defaultCookies(java.util.Map<java.lang.String, java.lang.String>)"
}
]
},
{
"annotatedType": "io.helidon.webclient.api.HttpConfigBase",
"type": "io.helidon.webclient.api.HttpConfigBase",
"producers": [
"io.helidon.webclient.api.HttpConfigBase#create(io.helidon.common.config.Config)",
"io.helidon.webclient.api.HttpConfigBase#builder()"
],
"options": [
{
"description": "Read timeout.\n\n @return read timeout\n @see io.helidon.common.socket.SocketOptions#readTimeout()",
"key": "read-timeout",
"method": "io.helidon.webclient.api.HttpConfigBase.Builder#readTimeout(java.util.Optional<java.time.Duration>)",
"type": "java.time.Duration"
},
{
"defaultValue": "true",
"description": "Determines if connection keep alive is enabled (NOT socket keep alive, but HTTP connection keep alive, to re-use\n the same connection for multiple requests).\n\n @return keep alive for this connection\n @see io.helidon.common.socket.SocketOptions#socketKeepAlive()",
"key": "keep-alive",
"method": "io.helidon.webclient.api.HttpConfigBase.Builder#keepAlive(boolean)",
"type": "java.lang.Boolean"
},
{
"description": "Proxy configuration to be used for requests.\n\n @return proxy to use, defaults to Proxy#noProxy()",
"key": "proxy",
"method": "io.helidon.webclient.api.HttpConfigBase.Builder#proxy(io.helidon.webclient.api.Proxy)",
"type": "io.helidon.webclient.api.Proxy"
},
{
"defaultValue": "true",
"description": "Whether to follow redirects.\n\n @return whether to follow redirects",
"key": "follow-redirects",
"method": "io.helidon.webclient.api.HttpConfigBase.Builder#followRedirects(boolean)",
"type": "java.lang.Boolean"
},
{
"description": "Connect timeout.\n\n @return connect timeout\n @see io.helidon.common.socket.SocketOptions#connectTimeout()",
"key": "connect-timeout",
"method": "io.helidon.webclient.api.HttpConfigBase.Builder#connectTimeout(java.util.Optional<java.time.Duration>)",
"type": "java.time.Duration"
},
{
"defaultValue": "10",
"description": "Max number of followed redirects.\n This is ignored if #followRedirects() option is `false`.\n\n @return max number of followed redirects",
"key": "max-redirects",
"method": "io.helidon.webclient.api.HttpConfigBase.Builder#maxRedirects(int)",
"type": "java.lang.Integer"
},
{
"description": "TLS configuration for any TLS request from this client.\n TLS can also be configured per request.\n TLS is used when the protocol is set to `https`.\n\n @return TLS configuration to use",
"key": "tls",
"method": "io.helidon.webclient.api.HttpConfigBase.Builder#tls(io.helidon.common.tls.Tls)",
"type": "io.helidon.common.tls.Tls"
},
{
"description": "Properties configured for this client. These properties are propagated through client request, to be used by\n services (and possibly for other purposes).\n\n @return map of client properties",
"key": "properties",
"kind": "MAP",
"method": "io.helidon.webclient.api.HttpConfigBase.Builder#properties(java.util.Map<java.lang.String, java.lang.String>)"
}
]
},
{
"annotatedType": "io.helidon.webclient.api.Proxy.Builder",
"type": "io.helidon.webclient.api.Proxy",
"producers": [
"io.helidon.webclient.api.Proxy.Builder#build()",
"io.helidon.webclient.api.Proxy#create(io.helidon.common.config.Config)"
],
"options": [
{
"description": "Sets a new password for the proxy.",
"key": "password",
"method": "io.helidon.webclient.api.Proxy.Builder#password(char[])"
},
{
"description": "Sets a port value.",
"key": "port",
"method": "io.helidon.webclient.api.Proxy.Builder#port(int)",
"type": "java.lang.Integer"
},
{
"description": "Sets a new host value.",
"key": "host",
"method": "io.helidon.webclient.api.Proxy.Builder#host(java.lang.String)"
},
{
"description": "Sets a new username for the proxy.",
"key": "username",
"method": "io.helidon.webclient.api.Proxy.Builder#username(java.lang.String)"
},
{
"defaultValue": "HTTP",
"description": "Sets a new proxy type.",
"key": "type",
"method": "io.helidon.webclient.api.Proxy.Builder#type(io.helidon.webclient.api.Proxy.ProxyType)",
"type": "io.helidon.webclient.api.Proxy.ProxyType",
"allowedValues": [
{
"description": "No proxy.",
"value": "NONE"
},
{
"description": "Proxy obtained from system.",
"value": "SYSTEM"
},
{
"description": "HTTP proxy.",
"value": "HTTP"
}
]
},
{
"description": "Configure a host pattern that is not going through a proxy.\n <p>\n Options are:\n <ul>\n <li>IP Address, such as `192.168.1.1`</li>\n <li>IP V6 Address, such as `[2001:db8:85a3:8d3:1319:8a2e:370:7348]`</li>\n <li>Hostname, such as `localhost`</li>\n <li>Domain name, such as `helidon.io`</li>\n <li>Domain name and all sub-domains, such as `.helidon.io` (leading dot)</li>\n <li>Combination of all options from above with a port, such as `.helidon.io:80`</li>\n </ul>",
"key": "no-proxy",
"kind": "LIST",
"method": "io.helidon.webclient.api.Proxy.Builder#addNoProxy(java.lang.String)"
}
]
}
]
}
]
[
{
"module": "io.helidon.metrics.api",
"types": [
{
"annotatedType": "io.helidon.metrics.api.KeyPerformanceIndicatorMetricsConfig",
"type": "io.helidon.metrics.api.KeyPerformanceIndicatorMetricsConfig",
"producers": [
"io.helidon.metrics.api.KeyPerformanceIndicatorMetricsConfig#create(io.helidon.common.config.Config)",
"io.helidon.metrics.api.KeyPerformanceIndicatorMetricsConfig#builder()"
],
"options": [
{
"defaultValue": "PT10S",
"description": "Threshold in ms that characterizes whether a request is long running.\n\n @return threshold in ms indicating a long-running request",
"key": "long-running-requests.threshold",
"method": "io.helidon.metrics.api.KeyPerformanceIndicatorMetricsConfig.Builder#longRunningRequestThreshold(java.time.Duration)",
"type": "java.time.Duration"
},
{
"defaultValue": "false",
"description": "Whether KPI extended metrics are enabled.\n\n @return true if KPI extended metrics are enabled; false otherwise",
"key": "extended",
"method": "io.helidon.metrics.api.KeyPerformanceIndicatorMetricsConfig.Builder#extended(boolean)",
"type": "java.lang.Boolean"
}
]
},
{
"annotatedType": "io.helidon.metrics.api.ScopingConfig",
"type": "io.helidon.metrics.api.ScopingConfig",
"producers": [
"io.helidon.metrics.api.ScopingConfig#create(io.helidon.common.config.Config)",
"io.helidon.metrics.api.ScopingConfig#builder()"
],
"options": [
{
"defaultValue": "application",
"description": "Default scope value to associate with meters that are registered without an explicit setting; no setting means meters\n are assigned scope {@value io.helidon.metrics.api.Meter.Scope#DEFAULT}.\n\n @return default scope value",
"key": "default",
"method": "io.helidon.metrics.api.ScopingConfig.Builder#defaultValue(java.util.Optional<java.lang.String>)"
},
{
"defaultValue": "scope",
"description": "Tag name for storing meter scope values in the underlying implementation meter registry.\n\n @return tag name for storing scope values",
"key": "tag-name",
"method": "io.helidon.metrics.api.ScopingConfig.Builder#tagName(java.util.Optional<java.lang.String>)"
},
{
"description": "Settings for individual scopes.\n\n @return scope settings",
"key": "scopes",
"kind": "MAP",
"method": "io.helidon.metrics.api.ScopingConfig.Builder#scopes(java.util.Map<java.lang.String, io.helidon.metrics.api.ScopeConfig>)",
"type": "io.helidon.metrics.api.ScopeConfig"
}
]
},
{
"annotatedType": "io.helidon.metrics.api.MetricsConfig",
"prefix": "metrics",
"type": "io.helidon.metrics.api.MetricsConfig",
"standalone": true,
"producers": [
"io.helidon.metrics.api.MetricsConfig#create(io.helidon.common.config.Config)",
"io.helidon.metrics.api.MetricsConfig#builder()"
],
"options": [
{
"description": "Whether automatic REST request metrics should be measured.\n\n @return true/false",
"key": "rest-request-enabled",
"method": "io.helidon.metrics.api.MetricsConfig.Builder#restRequestEnabled(boolean)",
"type": "java.lang.Boolean"
},
{
"description": "Name for the application tag to be added to each meter ID.\n\n @return application tag name",
"key": "app-tag-name",
"method": "io.helidon.metrics.api.MetricsConfig.Builder#appTagName(java.util.Optional<java.lang.String>)"
},
{
"defaultValue": "observe",
"description": "Hints for role names the user is expected to be in.\n\n @return list of hints",
"key": "roles",
"kind": "LIST",
"method": "io.helidon.metrics.api.MetricsConfig.Builder#roles(java.util.List<java.lang.String>)"
},
{
"description": "Key performance indicator metrics settings.\n\n @return key performance indicator metrics settings",
"key": "key-performance-indicators",
"method": "io.helidon.metrics.api.MetricsConfig.Builder#keyPerformanceIndicatorMetricsConfig(io.helidon.metrics.api.KeyPerformanceIndicatorMetricsConfig)",
"type": "io.helidon.metrics.api.KeyPerformanceIndicatorMetricsConfig"
},
{
"defaultValue": "true",
"description": "Whether to allow anybody to access the endpoint.\n\n @return whether to permit access to metrics endpoint to anybody, defaults to `true`\n @see #roles()",
"key": "permit-all",
"method": "io.helidon.metrics.api.MetricsConfig.Builder#permitAll(boolean)",
"type": "java.lang.Boolean"
},
{
"description": "Settings related to scoping management.\n\n @return scoping settings",
"key": "scoping",
"method": "io.helidon.metrics.api.MetricsConfig.Builder#scoping(io.helidon.metrics.api.ScopingConfig)",
"type": "io.helidon.metrics.api.ScopingConfig"
},
{
"description": "Global tags.\n\n @return name/value pairs for global tags",
"key": "tags",
"kind": "LIST",
"method": "io.helidon.metrics.api.MetricsConfig.Builder#tags(java.util.List<io.helidon.metrics.api.Tag>)",
"type": "io.helidon.metrics.api.Tag"
},
{
"description": "Value for the application tag to be added to each meter ID.\n\n @return application tag value",
"key": "app-name",
"method": "io.helidon.metrics.api.MetricsConfig.Builder#appName(java.util.Optional<java.lang.String>)"
},
{
"defaultValue": "true",
"description": "Whether metrics functionality is enabled.\n\n @return if metrics are configured to be enabled",
"key": "enabled",
"method": "io.helidon.metrics.api.MetricsConfig.Builder#enabled(boolean)",
"type": "java.lang.Boolean"
}
]
},
{
"annotatedType": "io.helidon.metrics.api.ScopeConfig",
"type": "io.helidon.metrics.api.ScopeConfig",
"producers": [
"io.helidon.metrics.api.ScopeConfig#create(io.helidon.common.config.Config)",
"io.helidon.metrics.api.ScopeConfig#builder()"
],
"options": [
{
"description": "Regular expression for meter names to include.\n\n @return include expression",
"key": "filter.include",
"method": "io.helidon.metrics.api.ScopeConfig.Builder#include(java.util.Optional<java.util.regex.Pattern>)",
"type": "java.util.regex.Pattern"
},
{
"description": "Name of the scope to which the configuration applies.\n\n @return scope name",
"key": "name",
"method": "io.helidon.metrics.api.ScopeConfig.Builder#name(java.lang.String)"
},
{
"description": "Regular expression for meter names to exclude.\n\n @return exclude expression",
"key": "filter.exclude",
"method": "io.helidon.metrics.api.ScopeConfig.Builder#exclude(java.util.Optional<java.util.regex.Pattern>)",
"type": "java.util.regex.Pattern"
},
{
"defaultValue": "true",
"description": "Whether the scope is enabled.\n\n @return if the scope is enabled",
"key": "enabled",
"method": "io.helidon.metrics.api.ScopeConfig.Builder#enabled(boolean)",
"type": "java.lang.Boolean"
}
]
},
{
"annotatedType": "io.helidon.metrics.api.ComponentMetricsSettings.Builder",
"prefix": "metrics",
"type": "io.helidon.metrics.api.ComponentMetricsSettings.Builder",
"options": [
{
"description": "Sets whether metrics should be enabled for the component.",
"key": "enabled",
"method": "io.helidon.metrics.api.ComponentMetricsSettings.Builder#enabled(boolean)",
"type": "java.lang.Boolean"
}
]
},
{
"annotatedType": "io.helidon.metrics.api.Tag",
"type": "io.helidon.metrics.api.Tag",
"options": []
}
]
}
]
[
{
"module": "io.helidon.metrics.api",
"types": [
{
"annotatedType": "io.helidon.metrics.api.KeyPerformanceIndicatorMetricsConfig",
"type": "io.helidon.metrics.api.KeyPerformanceIndicatorMetricsConfig",
"producers": [
"io.helidon.metrics.api.KeyPerformanceIndicatorMetricsConfig#create(io.helidon.common.config.Config)",
"io.helidon.metrics.api.KeyPerformanceIndicatorMetricsConfig#builder()"
],
"options": [
{
"defaultValue": "PT10S",
"description": "Threshold in ms that characterizes whether a request is long running.\n\n @return threshold in ms indicating a long-running request",
"key": "long-running-requests.threshold",
"method": "io.helidon.metrics.api.KeyPerformanceIndicatorMetricsConfig.Builder#longRunningRequestThreshold(java.time.Duration)",
"type": "java.time.Duration"
},
{
"defaultValue": "false",
"description": "Whether KPI extended metrics are enabled.\n\n @return true if KPI extended metrics are enabled; false otherwise",
"key": "extended",
"method": "io.helidon.metrics.api.KeyPerformanceIndicatorMetricsConfig.Builder#extended(boolean)",
"type": "java.lang.Boolean"
}
]
},
{
"annotatedType": "io.helidon.metrics.api.ScopingConfig",
"type": "io.helidon.metrics.api.ScopingConfig",
"producers": [
"io.helidon.metrics.api.ScopingConfig#create(io.helidon.common.config.Config)",
"io.helidon.metrics.api.ScopingConfig#builder()"
],
"options": [
{
"defaultValue": "application",
"description": "Default scope value to associate with meters that are registered without an explicit setting; no setting means meters\n are assigned scope {@value io.helidon.metrics.api.Meter.Scope#DEFAULT}.\n\n @return default scope value",
"key": "default",
"method": "io.helidon.metrics.api.ScopingConfig.Builder#defaultValue(java.util.Optional<java.lang.String>)"
},
{
"defaultValue": "scope",
"description": "Tag name for storing meter scope values in the underlying implementation meter registry.\n\n @return tag name for storing scope values",
"key": "tag-name",
"method": "io.helidon.metrics.api.ScopingConfig.Builder#tagName(java.util.Optional<java.lang.String>)"
},
{
"description": "Settings for individual scopes.\n\n @return scope settings",
"key": "scopes",
"kind": "MAP",
"method": "io.helidon.metrics.api.ScopingConfig.Builder#scopes(java.util.Map<java.lang.String, io.helidon.metrics.api.ScopeConfig>)",
"type": "io.helidon.metrics.api.ScopeConfig"
}
]
},
{
"annotatedType": "io.helidon.metrics.api.MetricsConfig",
"prefix": "metrics",
"type": "io.helidon.metrics.api.MetricsConfig",
"standalone": true,
"producers": [
"io.helidon.metrics.api.MetricsConfig#create(io.helidon.common.config.Config)",
"io.helidon.metrics.api.MetricsConfig#builder()"
],
"options": [
{
"description": "Whether automatic REST request metrics should be measured.\n\n @return true/false",
"key": "rest-request-enabled",
"method": "io.helidon.metrics.api.MetricsConfig.Builder#restRequestEnabled(boolean)",
"type": "java.lang.Boolean"
},
{
"description": "Name for the application tag to be added to each meter ID.\n\n @return application tag name",
"key": "app-tag-name",
"method": "io.helidon.metrics.api.MetricsConfig.Builder#appTagName(java.util.Optional<java.lang.String>)"
},
{
"defaultValue": "observe",
"description": "Hints for role names the user is expected to be in.\n\n @return list of hints",
"key": "roles",
"kind": "LIST",
"method": "io.helidon.metrics.api.MetricsConfig.Builder#roles(java.util.List<java.lang.String>)"
},
{
"description": "Key performance indicator metrics settings.\n\n @return key performance indicator metrics settings",
"key": "key-performance-indicators",
"method": "io.helidon.metrics.api.MetricsConfig.Builder#keyPerformanceIndicatorMetricsConfig(io.helidon.metrics.api.KeyPerformanceIndicatorMetricsConfig)",
"type": "io.helidon.metrics.api.KeyPerformanceIndicatorMetricsConfig"
},
{
"defaultValue": "true",
"description": "Whether to allow anybody to access the endpoint.\n\n @return whether to permit access to metrics endpoint to anybody, defaults to `true`\n @see #roles()",
"key": "permit-all",
"method": "io.helidon.metrics.api.MetricsConfig.Builder#permitAll(boolean)",
"type": "java.lang.Boolean"
},
{
"description": "Settings related to scoping management.\n\n @return scoping settings",
"key": "scoping",
"method": "io.helidon.metrics.api.MetricsConfig.Builder#scoping(io.helidon.metrics.api.ScopingConfig)",
"type": "io.helidon.metrics.api.ScopingConfig"
},
{
"description": "Global tags.\n\n @return name/value pairs for global tags",
"key": "tags",
"kind": "LIST",
"method": "io.helidon.metrics.api.MetricsConfig.Builder#tags(java.util.List<io.helidon.metrics.api.Tag>)",
"type": "io.helidon.metrics.api.Tag"
},
{
"description": "Value for the application tag to be added to each meter ID.\n\n @return application tag value",
"key": "app-name",
"method": "io.helidon.metrics.api.MetricsConfig.Builder#appName(java.util.Optional<java.lang.String>)"
},
{
"defaultValue": "true",
"description": "Whether metrics functionality is enabled.\n\n @return if metrics are configured to be enabled",
"key": "enabled",
"method": "io.helidon.metrics.api.MetricsConfig.Builder#enabled(boolean)",
"type": "java.lang.Boolean"
}
]
},
{
"annotatedType": "io.helidon.metrics.api.ScopeConfig",
"type": "io.helidon.metrics.api.ScopeConfig",
"producers": [
"io.helidon.metrics.api.ScopeConfig#create(io.helidon.common.config.Config)",
"io.helidon.metrics.api.ScopeConfig#builder()"
],
"options": [
{
"description": "Regular expression for meter names to include.\n\n @return include expression",
"key": "filter.include",
"method": "io.helidon.metrics.api.ScopeConfig.Builder#include(java.util.Optional<java.util.regex.Pattern>)",
"type": "java.util.regex.Pattern"
},
{
"description": "Name of the scope to which the configuration applies.\n\n @return scope name",
"key": "name",
"method": "io.helidon.metrics.api.ScopeConfig.Builder#name(java.lang.String)"
},
{
"description": "Regular expression for meter names to exclude.\n\n @return exclude expression",
"key": "filter.exclude",
"method": "io.helidon.metrics.api.ScopeConfig.Builder#exclude(java.util.Optional<java.util.regex.Pattern>)",
"type": "java.util.regex.Pattern"
},
{
"defaultValue": "true",
"description": "Whether the scope is enabled.\n\n @return if the scope is enabled",
"key": "enabled",
"method": "io.helidon.metrics.api.ScopeConfig.Builder#enabled(boolean)",
"type": "java.lang.Boolean"
}
]
},
{
"annotatedType": "io.helidon.metrics.api.ComponentMetricsSettings.Builder",
"prefix": "metrics",
"type": "io.helidon.metrics.api.ComponentMetricsSettings.Builder",
"options": [
{
"description": "Sets whether metrics should be enabled for the component.",
"key": "enabled",
"method": "io.helidon.metrics.api.ComponentMetricsSettings.Builder#enabled(boolean)",
"type": "java.lang.Boolean"
}
]
},
{
"annotatedType": "io.helidon.metrics.api.Tag",
"type": "io.helidon.metrics.api.Tag",
"options": []
}
]
}
]
[
{
"module": "io.helidon.tracing",
"types": [
{
"annotatedType": "io.helidon.tracing.TracerBuilder",
"description": "Tracer configuration.",
"type": "io.helidon.tracing.TracerBuilder",
"producers": [
"io.helidon.tracing.TracerBuilder#create(io.helidon.common.config.Config)"
],
"options": []
}
]
}
]
[
{
"module": "io.helidon.tracing.providers.opentracing",
"types": [
{
"annotatedType": "io.helidon.tracing.providers.opentracing.OpenTracingTracerBuilder",
"description": "OpenTracing tracer configuration.",
"type": "io.helidon.tracing.providers.opentracing.OpenTracingTracerBuilder",
"producers": [
"io.helidon.tracing.providers.opentracing.OpenTracingTracerBuilder#create(io.helidon.common.config.Config)"
],
"options": []
}
]
}
]
[
{
"module": "io.helidon.tracing",
"types": [
{
"annotatedType": "io.helidon.tracing.providers.jaeger.JaegerTracerBuilder",
"description": "Jaeger tracer configuration.",
"prefix": "tracing",
"type": "io.helidon.tracing.Tracer",
"standalone": true,
"inherits": [
"io.helidon.tracing.TracerBuilder"
],
"producers": [
"io.helidon.tracing.providers.jaeger.JaegerTracerBuilder#build()"
],
"options": [
{
"defaultValue": "512",
"description": "Maximum Export Batch Size of exporter requests.",
"key": "max-export-batch-size",
"method": "io.helidon.tracing.providers.jaeger.JaegerTracerBuilder#maxExportBatchSize(int)",
"type": "java.lang.Integer"
},
{
"defaultValue": "PT5S",
"description": "Schedule Delay of exporter requests.",
"key": "schedule-delay",
"method": "io.helidon.tracing.providers.jaeger.JaegerTracerBuilder#scheduleDelay(java.time.Duration)",
"type": "java.time.Duration"
},
{
"defaultValue": "JAEGER",
"description": "Add propagation format to use.",
"key": "propagation",
"kind": "LIST",
"method": "io.helidon.tracing.providers.jaeger.JaegerTracerBuilder#addPropagation(io.helidon.tracing.providers.jaeger.JaegerTracerBuilder.PropagationFormat)",
"type": "io.helidon.tracing.providers.jaeger.JaegerTracerBuilder.PropagationFormat",
"allowedValues": [
{
"description": "The Zipkin B3 trace context propagation format using multiple headers.",
"value": "B3"
},
{
"description": "B3 trace context propagation using a single header.",
"value": "B3_SINGLE"
},
{
"description": "The Jaeger trace context propagation format.",
"value": "JAEGER"
},
{
"description": "The W3C trace context propagation format.",
"value": "W3C"
}
]
},
{
"description": "Private key in PEM format.",
"key": "private-key-pem",
"method": "io.helidon.tracing.providers.jaeger.JaegerTracerBuilder#privateKey(io.helidon.common.configurable.Resource)",
"type": "io.helidon.common.configurable.Resource"
},
{
"defaultValue": "PT10S",
"description": "Timeout of exporter requests.",
"key": "exporter-timeout",
"method": "io.helidon.tracing.providers.jaeger.JaegerTracerBuilder#exporterTimeout(java.time.Duration)",
"type": "java.time.Duration"
},
{
"defaultValue": "CONSTANT",
"description": "Sampler type.\n <p>\n See <a href=\"https://www.jaegertracing.io/docs/latest/sampling/#client-sampling-configuration\">Sampler types</a>.",
"key": "sampler-type",
"method": "io.helidon.tracing.providers.jaeger.JaegerTracerBuilder#samplerType(io.helidon.tracing.providers.jaeger.JaegerTracerBuilder.SamplerType)",
"type": "io.helidon.tracing.providers.jaeger.JaegerTracerBuilder.SamplerType",
"allowedValues": [
{
"description": "Constant sampler always makes the same decision for all traces.\n It either samples all traces `1` or none of them `0`.",
"value": "CONSTANT"
},
{
"description": "Ratio of the requests to sample, double value.",
"value": "RATIO"
}
]
},
{
"description": "Trusted certificates in PEM format.",
"key": "trusted-cert-pem",
"method": "io.helidon.tracing.providers.jaeger.JaegerTracerBuilder#trustedCertificates(io.helidon.common.configurable.Resource)",
"type": "io.helidon.common.configurable.Resource"
},
{
"defaultValue": "batch",
"description": "Span Processor type used.",
"key": "span-processor-type",
"method": "io.helidon.tracing.providers.jaeger.JaegerTracerBuilder#spanProcessorType(io.helidon.tracing.providers.jaeger.JaegerTracerBuilder.SpanProcessorType)",
"type": "io.helidon.tracing.providers.jaeger.JaegerTracerBuilder.SpanProcessorType",
"allowedValues": [
{
"description": "Simple Span Processor.",
"value": "SIMPLE"
},
{
"description": "Batch Span Processor.",
"value": "BATCH"
}
]
},
{
"defaultValue": "1",
"description": "The sampler parameter (number).",
"key": "sampler-param",
"method": "io.helidon.tracing.providers.jaeger.JaegerTracerBuilder#samplerParam(java.lang.Number)",
"type": "java.lang.Number"
},
{
"description": "Certificate of client in PEM format.",
"key": "client-cert-pem",
"method": "io.helidon.tracing.providers.jaeger.JaegerTracerBuilder#clientCertificate(io.helidon.common.configurable.Resource)",
"type": "io.helidon.common.configurable.Resource"
},
{
"defaultValue": "2048",
"description": "Maximum Queue Size of exporter requests.",
"key": "max-queue-size",
"method": "io.helidon.tracing.providers.jaeger.JaegerTracerBuilder#maxQueueSize(int)",
"type": "java.lang.Integer"
}
]