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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
// This file is @generated by prost-build.
/// Message type for extension configuration.
/// \[#next-major-version: revisit all existing typed_config that doesn't use this wrapper.\].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct TypedExtensionConfig {
/// The name of an extension. This is not used to select the extension, instead
/// it serves the role of an opaque identifier.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// The typed config for the extension. The type URL will be used to identify
/// the extension. In the case that the type URL is ``xds.type.v3.TypedStruct``
/// (or, for historical reasons, ``udpa.type.v1.TypedStruct``), the inner type
/// URL of ``TypedStruct`` will be utilized. See the
/// :ref:`extension configuration overview
/// <config_overview_extension_configuration>` for further details.
#[prost(message, optional, tag = "2")]
pub typed_config: ::core::option::Option<
super::super::super::super::google::protobuf::Any,
>,
}
impl ::prost::Name for TypedExtensionConfig {
const NAME: &'static str = "TypedExtensionConfig";
const PACKAGE: &'static str = "envoy.config.core.v3";
fn full_name() -> ::prost::alloc::string::String {
"envoy.config.core.v3.TypedExtensionConfig".into()
}
fn type_url() -> ::prost::alloc::string::String {
"type.googleapis.com/envoy.config.core.v3.TypedExtensionConfig".into()
}
}
/// Generic socket option message. This would be used to set socket options that
/// might not exist in upstream kernels or precompiled Envoy binaries.
///
/// For example:
///
/// .. code-block:: json
///
/// {
/// "description": "support tcp keep alive",
/// "state": 0,
/// "level": 1,
/// "name": 9,
/// "int_value": 1,
/// }
///
/// 1 means SOL_SOCKET and 9 means SO_KEEPALIVE on Linux.
/// With the above configuration, `TCP Keep-Alives <<https://www.freesoft.org/CIE/RFC/1122/114.htm>`_>
/// can be enabled in socket with Linux, which can be used in
/// :ref:`listener's<envoy_v3_api_field_config.listener.v3.Listener.socket_options>` or
/// :ref:`admin's <envoy_v3_api_field_config.bootstrap.v3.Admin.socket_options>` socket_options etc.
///
/// It should be noted that the name or level may have different values on different platforms.
/// \[#next-free-field: 7\]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct SocketOption {
/// An optional name to give this socket option for debugging, etc.
/// Uniqueness is not required and no special meaning is assumed.
#[prost(string, tag = "1")]
pub description: ::prost::alloc::string::String,
/// Corresponding to the level value passed to setsockopt, such as IPPROTO_TCP
#[prost(int64, tag = "2")]
pub level: i64,
/// The numeric name as passed to setsockopt
#[prost(int64, tag = "3")]
pub name: i64,
/// The state in which the option will be applied. When used in BindConfig
/// STATE_PREBIND is currently the only valid value.
#[prost(enumeration = "socket_option::SocketState", tag = "6")]
pub state: i32,
#[prost(oneof = "socket_option::Value", tags = "4, 5")]
pub value: ::core::option::Option<socket_option::Value>,
}
/// Nested message and enum types in `SocketOption`.
pub mod socket_option {
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum SocketState {
/// Socket options are applied after socket creation but before binding the socket to a port
StatePrebind = 0,
/// Socket options are applied after binding the socket to a port but before calling listen()
StateBound = 1,
/// Socket options are applied after calling listen()
StateListening = 2,
}
impl SocketState {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
Self::StatePrebind => "STATE_PREBIND",
Self::StateBound => "STATE_BOUND",
Self::StateListening => "STATE_LISTENING",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"STATE_PREBIND" => Some(Self::StatePrebind),
"STATE_BOUND" => Some(Self::StateBound),
"STATE_LISTENING" => Some(Self::StateListening),
_ => None,
}
}
}
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum Value {
/// Because many sockopts take an int value.
#[prost(int64, tag = "4")]
IntValue(i64),
/// Otherwise it's a byte buffer.
#[prost(bytes, tag = "5")]
BufValue(::prost::alloc::vec::Vec<u8>),
}
}
impl ::prost::Name for SocketOption {
const NAME: &'static str = "SocketOption";
const PACKAGE: &'static str = "envoy.config.core.v3";
fn full_name() -> ::prost::alloc::string::String {
"envoy.config.core.v3.SocketOption".into()
}
fn type_url() -> ::prost::alloc::string::String {
"type.googleapis.com/envoy.config.core.v3.SocketOption".into()
}
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct SocketOptionsOverride {
#[prost(message, repeated, tag = "1")]
pub socket_options: ::prost::alloc::vec::Vec<SocketOption>,
}
impl ::prost::Name for SocketOptionsOverride {
const NAME: &'static str = "SocketOptionsOverride";
const PACKAGE: &'static str = "envoy.config.core.v3";
fn full_name() -> ::prost::alloc::string::String {
"envoy.config.core.v3.SocketOptionsOverride".into()
}
fn type_url() -> ::prost::alloc::string::String {
"type.googleapis.com/envoy.config.core.v3.SocketOptionsOverride".into()
}
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Pipe {
/// Unix Domain Socket path. On Linux, paths starting with '@' will use the
/// abstract namespace. The starting '@' is replaced by a null byte by Envoy.
/// Paths starting with '@' will result in an error in environments other than
/// Linux.
#[prost(string, tag = "1")]
pub path: ::prost::alloc::string::String,
/// The mode for the Pipe. Not applicable for abstract sockets.
#[prost(uint32, tag = "2")]
pub mode: u32,
}
impl ::prost::Name for Pipe {
const NAME: &'static str = "Pipe";
const PACKAGE: &'static str = "envoy.config.core.v3";
fn full_name() -> ::prost::alloc::string::String {
"envoy.config.core.v3.Pipe".into()
}
fn type_url() -> ::prost::alloc::string::String {
"type.googleapis.com/envoy.config.core.v3.Pipe".into()
}
}
/// The address represents an envoy internal listener.
/// \[#comment: TODO(asraa): When address available, remove workaround from test/server/server_fuzz_test.cc:30.\]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct EnvoyInternalAddress {
/// Specifies an endpoint identifier to distinguish between multiple endpoints for the same internal listener in a
/// single upstream pool. Only used in the upstream addresses for tracking changes to individual endpoints. This, for
/// example, may be set to the final destination IP for the target internal listener.
#[prost(string, tag = "2")]
pub endpoint_id: ::prost::alloc::string::String,
#[prost(oneof = "envoy_internal_address::AddressNameSpecifier", tags = "1")]
pub address_name_specifier: ::core::option::Option<
envoy_internal_address::AddressNameSpecifier,
>,
}
/// Nested message and enum types in `EnvoyInternalAddress`.
pub mod envoy_internal_address {
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum AddressNameSpecifier {
/// Specifies the :ref:`name <envoy_v3_api_field_config.listener.v3.Listener.name>` of the
/// internal listener.
#[prost(string, tag = "1")]
ServerListenerName(::prost::alloc::string::String),
}
}
impl ::prost::Name for EnvoyInternalAddress {
const NAME: &'static str = "EnvoyInternalAddress";
const PACKAGE: &'static str = "envoy.config.core.v3";
fn full_name() -> ::prost::alloc::string::String {
"envoy.config.core.v3.EnvoyInternalAddress".into()
}
fn type_url() -> ::prost::alloc::string::String {
"type.googleapis.com/envoy.config.core.v3.EnvoyInternalAddress".into()
}
}
/// \[#next-free-field: 7\]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct SocketAddress {
#[prost(enumeration = "socket_address::Protocol", tag = "1")]
pub protocol: i32,
/// The address for this socket. :ref:`Listeners <config_listeners>` will bind
/// to the address. An empty address is not allowed. Specify ``0.0.0.0`` or ``::``
/// to bind to any address. [#comment:TODO(zuercher) reinstate when implemented:
/// It is possible to distinguish a Listener address via the prefix/suffix matching
/// in :ref:`FilterChainMatch <envoy_v3_api_msg_config.listener.v3.FilterChainMatch>`.] When used
/// within an upstream :ref:`BindConfig <envoy_v3_api_msg_config.core.v3.BindConfig>`, the address
/// controls the source address of outbound connections. For :ref:`clusters
/// <envoy_v3_api_msg_config.cluster.v3.Cluster>`, the cluster type determines whether the
/// address must be an IP (``STATIC`` or ``EDS`` clusters) or a hostname resolved by DNS
/// (``STRICT_DNS`` or ``LOGICAL_DNS`` clusters). Address resolution can be customized
/// via :ref:`resolver_name <envoy_v3_api_field_config.core.v3.SocketAddress.resolver_name>`.
#[prost(string, tag = "2")]
pub address: ::prost::alloc::string::String,
/// The name of the custom resolver. This must have been registered with Envoy. If
/// this is empty, a context dependent default applies. If the address is a concrete
/// IP address, no resolution will occur. If address is a hostname this
/// should be set for resolution other than DNS. Specifying a custom resolver with
/// ``STRICT_DNS`` or ``LOGICAL_DNS`` will generate an error at runtime.
#[prost(string, tag = "5")]
pub resolver_name: ::prost::alloc::string::String,
/// When binding to an IPv6 address above, this enables `IPv4 compatibility
/// <<https://tools.ietf.org/html/rfc3493#page-11>`_.> Binding to ``::`` will
/// allow both IPv4 and IPv6 connections, with peer IPv4 addresses mapped into
/// IPv6 space as ``::FFFF:<IPv4-address>``.
#[prost(bool, tag = "6")]
pub ipv4_compat: bool,
#[prost(oneof = "socket_address::PortSpecifier", tags = "3, 4")]
pub port_specifier: ::core::option::Option<socket_address::PortSpecifier>,
}
/// Nested message and enum types in `SocketAddress`.
pub mod socket_address {
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum Protocol {
Tcp = 0,
Udp = 1,
}
impl Protocol {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
Self::Tcp => "TCP",
Self::Udp => "UDP",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"TCP" => Some(Self::Tcp),
"UDP" => Some(Self::Udp),
_ => None,
}
}
}
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum PortSpecifier {
#[prost(uint32, tag = "3")]
PortValue(u32),
/// This is only valid if :ref:`resolver_name
/// <envoy_v3_api_field_config.core.v3.SocketAddress.resolver_name>` is specified below and the
/// named resolver is capable of named port resolution.
#[prost(string, tag = "4")]
NamedPort(::prost::alloc::string::String),
}
}
impl ::prost::Name for SocketAddress {
const NAME: &'static str = "SocketAddress";
const PACKAGE: &'static str = "envoy.config.core.v3";
fn full_name() -> ::prost::alloc::string::String {
"envoy.config.core.v3.SocketAddress".into()
}
fn type_url() -> ::prost::alloc::string::String {
"type.googleapis.com/envoy.config.core.v3.SocketAddress".into()
}
}
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct TcpKeepalive {
/// Maximum number of keepalive probes to send without response before deciding
/// the connection is dead. Default is to use the OS level configuration (unless
/// overridden, Linux defaults to 9.)
#[prost(message, optional, tag = "1")]
pub keepalive_probes: ::core::option::Option<
super::super::super::super::google::protobuf::UInt32Value,
>,
/// The number of seconds a connection needs to be idle before keep-alive probes
/// start being sent. Default is to use the OS level configuration (unless
/// overridden, Linux defaults to 7200s (i.e., 2 hours.)
#[prost(message, optional, tag = "2")]
pub keepalive_time: ::core::option::Option<
super::super::super::super::google::protobuf::UInt32Value,
>,
/// The number of seconds between keep-alive probes. Default is to use the OS
/// level configuration (unless overridden, Linux defaults to 75s.)
#[prost(message, optional, tag = "3")]
pub keepalive_interval: ::core::option::Option<
super::super::super::super::google::protobuf::UInt32Value,
>,
}
impl ::prost::Name for TcpKeepalive {
const NAME: &'static str = "TcpKeepalive";
const PACKAGE: &'static str = "envoy.config.core.v3";
fn full_name() -> ::prost::alloc::string::String {
"envoy.config.core.v3.TcpKeepalive".into()
}
fn type_url() -> ::prost::alloc::string::String {
"type.googleapis.com/envoy.config.core.v3.TcpKeepalive".into()
}
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ExtraSourceAddress {
/// The additional address to bind.
#[prost(message, optional, tag = "1")]
pub address: ::core::option::Option<SocketAddress>,
/// Additional socket options that may not be present in Envoy source code or
/// precompiled binaries. If specified, this will override the
/// :ref:`socket_options <envoy_v3_api_field_config.core.v3.BindConfig.socket_options>`
/// in the BindConfig. If specified with no
/// :ref:`socket_options <envoy_v3_api_field_config.core.v3.SocketOptionsOverride.socket_options>`
/// or an empty list of :ref:`socket_options <envoy_v3_api_field_config.core.v3.SocketOptionsOverride.socket_options>`,
/// it means no socket option will apply.
#[prost(message, optional, tag = "2")]
pub socket_options: ::core::option::Option<SocketOptionsOverride>,
}
impl ::prost::Name for ExtraSourceAddress {
const NAME: &'static str = "ExtraSourceAddress";
const PACKAGE: &'static str = "envoy.config.core.v3";
fn full_name() -> ::prost::alloc::string::String {
"envoy.config.core.v3.ExtraSourceAddress".into()
}
fn type_url() -> ::prost::alloc::string::String {
"type.googleapis.com/envoy.config.core.v3.ExtraSourceAddress".into()
}
}
/// \[#next-free-field: 7\]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct BindConfig {
/// The address to bind to when creating a socket.
#[prost(message, optional, tag = "1")]
pub source_address: ::core::option::Option<SocketAddress>,
/// Whether to set the ``IP_FREEBIND`` option when creating the socket. When this
/// flag is set to true, allows the :ref:`source_address
/// <envoy_v3_api_field_config.core.v3.BindConfig.source_address>` to be an IP address
/// that is not configured on the system running Envoy. When this flag is set
/// to false, the option ``IP_FREEBIND`` is disabled on the socket. When this
/// flag is not set (default), the socket is not modified, i.e. the option is
/// neither enabled nor disabled.
#[prost(message, optional, tag = "2")]
pub freebind: ::core::option::Option<
super::super::super::super::google::protobuf::BoolValue,
>,
/// Additional socket options that may not be present in Envoy source code or
/// precompiled binaries.
#[prost(message, repeated, tag = "3")]
pub socket_options: ::prost::alloc::vec::Vec<SocketOption>,
/// Extra source addresses appended to the address specified in the ``source_address``
/// field. This enables to specify multiple source addresses.
/// The source address selection is determined by :ref:`local_address_selector
/// <envoy_v3_api_field_config.core.v3.BindConfig.local_address_selector>`.
#[prost(message, repeated, tag = "5")]
pub extra_source_addresses: ::prost::alloc::vec::Vec<ExtraSourceAddress>,
/// Deprecated by
/// :ref:`extra_source_addresses <envoy_v3_api_field_config.core.v3.BindConfig.extra_source_addresses>`
#[deprecated]
#[prost(message, repeated, tag = "4")]
pub additional_source_addresses: ::prost::alloc::vec::Vec<SocketAddress>,
/// Custom local address selector to override the default (i.e.
/// :ref:`DefaultLocalAddressSelector
/// <envoy_v3_api_msg_config.upstream.local_address_selector.v3.DefaultLocalAddressSelector>`).
/// \[#extension-category: envoy.upstream.local_address_selector\]
#[prost(message, optional, tag = "6")]
pub local_address_selector: ::core::option::Option<TypedExtensionConfig>,
}
impl ::prost::Name for BindConfig {
const NAME: &'static str = "BindConfig";
const PACKAGE: &'static str = "envoy.config.core.v3";
fn full_name() -> ::prost::alloc::string::String {
"envoy.config.core.v3.BindConfig".into()
}
fn type_url() -> ::prost::alloc::string::String {
"type.googleapis.com/envoy.config.core.v3.BindConfig".into()
}
}
/// Addresses specify either a logical or physical address and port, which are
/// used to tell Envoy where to bind/listen, connect to upstream and find
/// management servers.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Address {
#[prost(oneof = "address::Address", tags = "1, 2, 3")]
pub address: ::core::option::Option<address::Address>,
}
/// Nested message and enum types in `Address`.
pub mod address {
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum Address {
#[prost(message, tag = "1")]
SocketAddress(super::SocketAddress),
#[prost(message, tag = "2")]
Pipe(super::Pipe),
/// Specifies a user-space address handled by :ref:`internal listeners
/// <envoy_v3_api_field_config.listener.v3.Listener.internal_listener>`.
#[prost(message, tag = "3")]
EnvoyInternalAddress(super::EnvoyInternalAddress),
}
}
impl ::prost::Name for Address {
const NAME: &'static str = "Address";
const PACKAGE: &'static str = "envoy.config.core.v3";
fn full_name() -> ::prost::alloc::string::String {
"envoy.config.core.v3.Address".into()
}
fn type_url() -> ::prost::alloc::string::String {
"type.googleapis.com/envoy.config.core.v3.Address".into()
}
}
/// CidrRange specifies an IP Address and a prefix length to construct
/// the subnet mask for a `CIDR <<https://tools.ietf.org/html/rfc4632>`_> range.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CidrRange {
/// IPv4 or IPv6 address, e.g. ``192.0.0.0`` or ``2001:db8::``.
#[prost(string, tag = "1")]
pub address_prefix: ::prost::alloc::string::String,
/// Length of prefix, e.g. 0, 32. Defaults to 0 when unset.
#[prost(message, optional, tag = "2")]
pub prefix_len: ::core::option::Option<
super::super::super::super::google::protobuf::UInt32Value,
>,
}
impl ::prost::Name for CidrRange {
const NAME: &'static str = "CidrRange";
const PACKAGE: &'static str = "envoy.config.core.v3";
fn full_name() -> ::prost::alloc::string::String {
"envoy.config.core.v3.CidrRange".into()
}
fn type_url() -> ::prost::alloc::string::String {
"type.googleapis.com/envoy.config.core.v3.CidrRange".into()
}
}
/// Configuration defining a jittered exponential back off strategy.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct BackoffStrategy {
/// The base interval to be used for the next back off computation. It should
/// be greater than zero and less than or equal to :ref:`max_interval
/// <envoy_v3_api_field_config.core.v3.BackoffStrategy.max_interval>`.
#[prost(message, optional, tag = "1")]
pub base_interval: ::core::option::Option<
super::super::super::super::google::protobuf::Duration,
>,
/// Specifies the maximum interval between retries. This parameter is optional,
/// but must be greater than or equal to the :ref:`base_interval
/// <envoy_v3_api_field_config.core.v3.BackoffStrategy.base_interval>` if set. The default
/// is 10 times the :ref:`base_interval
/// <envoy_v3_api_field_config.core.v3.BackoffStrategy.base_interval>`.
#[prost(message, optional, tag = "2")]
pub max_interval: ::core::option::Option<
super::super::super::super::google::protobuf::Duration,
>,
}
impl ::prost::Name for BackoffStrategy {
const NAME: &'static str = "BackoffStrategy";
const PACKAGE: &'static str = "envoy.config.core.v3";
fn full_name() -> ::prost::alloc::string::String {
"envoy.config.core.v3.BackoffStrategy".into()
}
fn type_url() -> ::prost::alloc::string::String {
"type.googleapis.com/envoy.config.core.v3.BackoffStrategy".into()
}
}
/// Envoy external URI descriptor
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct HttpUri {
/// The HTTP server URI. It should be a full FQDN with protocol, host and path.
///
/// Example:
///
/// .. code-block:: yaml
///
/// uri: <https://www.googleapis.com/oauth2/v1/certs>
///
#[prost(string, tag = "1")]
pub uri: ::prost::alloc::string::String,
/// Sets the maximum duration in milliseconds that a response can take to arrive upon request.
#[prost(message, optional, tag = "3")]
pub timeout: ::core::option::Option<
super::super::super::super::google::protobuf::Duration,
>,
/// Specify how ``uri`` is to be fetched. Today, this requires an explicit
/// cluster, but in the future we may support dynamic cluster creation or
/// inline DNS resolution. See `issue
/// <<https://github.com/envoyproxy/envoy/issues/1606>`_.>
#[prost(oneof = "http_uri::HttpUpstreamType", tags = "2")]
pub http_upstream_type: ::core::option::Option<http_uri::HttpUpstreamType>,
}
/// Nested message and enum types in `HttpUri`.
pub mod http_uri {
/// Specify how ``uri`` is to be fetched. Today, this requires an explicit
/// cluster, but in the future we may support dynamic cluster creation or
/// inline DNS resolution. See `issue
/// <<https://github.com/envoyproxy/envoy/issues/1606>`_.>
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum HttpUpstreamType {
/// A cluster is created in the Envoy "cluster_manager" config
/// section. This field specifies the cluster name.
///
/// Example:
///
/// .. code-block:: yaml
///
/// cluster: jwks_cluster
///
#[prost(string, tag = "2")]
Cluster(::prost::alloc::string::String),
}
}
impl ::prost::Name for HttpUri {
const NAME: &'static str = "HttpUri";
const PACKAGE: &'static str = "envoy.config.core.v3";
fn full_name() -> ::prost::alloc::string::String {
"envoy.config.core.v3.HttpUri".into()
}
fn type_url() -> ::prost::alloc::string::String {
"type.googleapis.com/envoy.config.core.v3.HttpUri".into()
}
}
/// Identifies location of where either Envoy runs or where upstream hosts run.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Locality {
/// Region this :ref:`zone <envoy_v3_api_field_config.core.v3.Locality.zone>` belongs to.
#[prost(string, tag = "1")]
pub region: ::prost::alloc::string::String,
/// Defines the local service zone where Envoy is running. Though optional, it
/// should be set if discovery service routing is used and the discovery
/// service exposes :ref:`zone data <envoy_v3_api_field_config.endpoint.v3.LocalityLbEndpoints.locality>`,
/// either in this message or via :option:`--service-zone`. The meaning of zone
/// is context dependent, e.g. `Availability Zone (AZ)
/// <<https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html>`_>
/// on AWS, `Zone <<https://cloud.google.com/compute/docs/regions-zones/>`_> on
/// GCP, etc.
#[prost(string, tag = "2")]
pub zone: ::prost::alloc::string::String,
/// When used for locality of upstream hosts, this field further splits zone
/// into smaller chunks of sub-zones so they can be load balanced
/// independently.
#[prost(string, tag = "3")]
pub sub_zone: ::prost::alloc::string::String,
}
impl ::prost::Name for Locality {
const NAME: &'static str = "Locality";
const PACKAGE: &'static str = "envoy.config.core.v3";
fn full_name() -> ::prost::alloc::string::String {
"envoy.config.core.v3.Locality".into()
}
fn type_url() -> ::prost::alloc::string::String {
"type.googleapis.com/envoy.config.core.v3.Locality".into()
}
}
/// BuildVersion combines SemVer version of extension with free-form build information
/// (i.e. 'alpha', 'private-build') as a set of strings.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct BuildVersion {
/// SemVer version of extension.
#[prost(message, optional, tag = "1")]
pub version: ::core::option::Option<
super::super::super::r#type::v3::SemanticVersion,
>,
/// Free-form build information.
/// Envoy defines several well known keys in the source/common/version/version.h file
#[prost(message, optional, tag = "2")]
pub metadata: ::core::option::Option<
super::super::super::super::google::protobuf::Struct,
>,
}
impl ::prost::Name for BuildVersion {
const NAME: &'static str = "BuildVersion";
const PACKAGE: &'static str = "envoy.config.core.v3";
fn full_name() -> ::prost::alloc::string::String {
"envoy.config.core.v3.BuildVersion".into()
}
fn type_url() -> ::prost::alloc::string::String {
"type.googleapis.com/envoy.config.core.v3.BuildVersion".into()
}
}
/// Version and identification for an Envoy extension.
/// \[#next-free-field: 7\]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Extension {
/// This is the name of the Envoy filter as specified in the Envoy
/// configuration, e.g. envoy.filters.http.router, com.acme.widget.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Category of the extension.
/// Extension category names use reverse DNS notation. For instance "envoy.filters.listener"
/// for Envoy's built-in listener filters or "com.acme.filters.http" for HTTP filters from
/// acme.com vendor.
/// \[#comment:TODO(yanavlasov): Link to the doc with existing envoy category names.\]
#[prost(string, tag = "2")]
pub category: ::prost::alloc::string::String,
/// \[#not-implemented-hide:\] Type descriptor of extension configuration proto.
/// \[#comment:TODO(yanavlasov): Link to the doc with existing configuration protos.\]
/// \[#comment:TODO(yanavlasov): Add tests when PR #9391 lands.\]
#[deprecated]
#[prost(string, tag = "3")]
pub type_descriptor: ::prost::alloc::string::String,
/// The version is a property of the extension and maintained independently
/// of other extensions and the Envoy API.
/// This field is not set when extension did not provide version information.
#[prost(message, optional, tag = "4")]
pub version: ::core::option::Option<BuildVersion>,
/// Indicates that the extension is present but was disabled via dynamic configuration.
#[prost(bool, tag = "5")]
pub disabled: bool,
/// Type URLs of extension configuration protos.
#[prost(string, repeated, tag = "6")]
pub type_urls: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
}
impl ::prost::Name for Extension {
const NAME: &'static str = "Extension";
const PACKAGE: &'static str = "envoy.config.core.v3";
fn full_name() -> ::prost::alloc::string::String {
"envoy.config.core.v3.Extension".into()
}
fn type_url() -> ::prost::alloc::string::String {
"type.googleapis.com/envoy.config.core.v3.Extension".into()
}
}
/// Identifies a specific Envoy instance. The node identifier is presented to the
/// management server, which may use this identifier to distinguish per Envoy
/// configuration for serving.
/// \[#next-free-field: 13\]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Node {
/// An opaque node identifier for the Envoy node. This also provides the local
/// service node name. It should be set if any of the following features are
/// used: :ref:`statsd <arch_overview_statistics>`, :ref:`CDS
/// <config_cluster_manager_cds>`, and :ref:`HTTP tracing
/// <arch_overview_tracing>`, either in this message or via
/// :option:`--service-node`.
#[prost(string, tag = "1")]
pub id: ::prost::alloc::string::String,
/// Defines the local service cluster name where Envoy is running. Though
/// optional, it should be set if any of the following features are used:
/// :ref:`statsd <arch_overview_statistics>`, :ref:`health check cluster
/// verification
/// <envoy_v3_api_field_config.core.v3.HealthCheck.HttpHealthCheck.service_name_matcher>`,
/// :ref:`runtime override directory <envoy_v3_api_msg_config.bootstrap.v3.Runtime>`,
/// :ref:`user agent addition
/// <envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.HttpConnectionManager.add_user_agent>`,
/// :ref:`HTTP global rate limiting <config_http_filters_rate_limit>`,
/// :ref:`CDS <config_cluster_manager_cds>`, and :ref:`HTTP tracing
/// <arch_overview_tracing>`, either in this message or via
/// :option:`--service-cluster`.
#[prost(string, tag = "2")]
pub cluster: ::prost::alloc::string::String,
/// Opaque metadata extending the node identifier. Envoy will pass this
/// directly to the management server.
#[prost(message, optional, tag = "3")]
pub metadata: ::core::option::Option<
super::super::super::super::google::protobuf::Struct,
>,
/// Map from xDS resource type URL to dynamic context parameters. These may vary at runtime (unlike
/// other fields in this message). For example, the xDS client may have a shard identifier that
/// changes during the lifetime of the xDS client. In Envoy, this would be achieved by updating the
/// dynamic context on the Server::Instance's LocalInfo context provider. The shard ID dynamic
/// parameter then appears in this field during future discovery requests.
#[prost(map = "string, message", tag = "12")]
pub dynamic_parameters: ::std::collections::HashMap<
::prost::alloc::string::String,
super::super::super::super::xds::core::v3::ContextParams,
>,
/// Locality specifying where the Envoy instance is running.
#[prost(message, optional, tag = "4")]
pub locality: ::core::option::Option<Locality>,
/// Free-form string that identifies the entity requesting config.
/// E.g. "envoy" or "grpc"
#[prost(string, tag = "6")]
pub user_agent_name: ::prost::alloc::string::String,
/// List of extensions and their versions supported by the node.
#[prost(message, repeated, tag = "9")]
pub extensions: ::prost::alloc::vec::Vec<Extension>,
/// Client feature support list. These are well known features described
/// in the Envoy API repository for a given major version of an API. Client features
/// use reverse DNS naming scheme, for example ``com.acme.feature``.
/// See :ref:`the list of features <client_features>` that xDS client may
/// support.
#[prost(string, repeated, tag = "10")]
pub client_features: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
/// Known listening ports on the node as a generic hint to the management server
/// for filtering :ref:`listeners <config_listeners>` to be returned. For example,
/// if there is a listener bound to port 80, the list can optionally contain the
/// SocketAddress ``(0.0.0.0,80)``. The field is optional and just a hint.
#[deprecated]
#[prost(message, repeated, tag = "11")]
pub listening_addresses: ::prost::alloc::vec::Vec<Address>,
#[prost(oneof = "node::UserAgentVersionType", tags = "7, 8")]
pub user_agent_version_type: ::core::option::Option<node::UserAgentVersionType>,
}
/// Nested message and enum types in `Node`.
pub mod node {
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum UserAgentVersionType {
/// Free-form string that identifies the version of the entity requesting config.
/// E.g. "1.12.2" or "abcd1234", or "SpecialEnvoyBuild"
#[prost(string, tag = "7")]
UserAgentVersion(::prost::alloc::string::String),
/// Structured version of the entity requesting config.
#[prost(message, tag = "8")]
UserAgentBuildVersion(super::BuildVersion),
}
}
impl ::prost::Name for Node {
const NAME: &'static str = "Node";
const PACKAGE: &'static str = "envoy.config.core.v3";
fn full_name() -> ::prost::alloc::string::String {
"envoy.config.core.v3.Node".into()
}
fn type_url() -> ::prost::alloc::string::String {
"type.googleapis.com/envoy.config.core.v3.Node".into()
}
}
/// Metadata provides additional inputs to filters based on matched listeners,
/// filter chains, routes and endpoints. It is structured as a map, usually from
/// filter name (in reverse DNS format) to metadata specific to the filter. Metadata
/// key-values for a filter are merged as connection and request handling occurs,
/// with later values for the same key overriding earlier values.
///
/// An example use of metadata is providing additional values to
/// http_connection_manager in the envoy.http_connection_manager.access_log
/// namespace.
///
/// Another example use of metadata is to per service config info in cluster metadata, which may get
/// consumed by multiple filters.
///
/// For load balancing, Metadata provides a means to subset cluster endpoints.
/// Endpoints have a Metadata object associated and routes contain a Metadata
/// object to match against. There are some well defined metadata used today for
/// this purpose:
///
/// * ``{"envoy.lb": {"canary": <bool> }}`` This indicates the canary status of an
/// endpoint and is also used during header processing
/// (x-envoy-upstream-canary) and for stats purposes.
/// \[#next-major-version: move to type/metadata/v2\]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Metadata {
/// Key is the reverse DNS filter name, e.g. com.acme.widget. The ``envoy.*``
/// namespace is reserved for Envoy's built-in filters.
/// If both ``filter_metadata`` and
/// :ref:`typed_filter_metadata <envoy_v3_api_field_config.core.v3.Metadata.typed_filter_metadata>`
/// fields are present in the metadata with same keys,
/// only ``typed_filter_metadata`` field will be parsed.
#[prost(map = "string, message", tag = "1")]
pub filter_metadata: ::std::collections::HashMap<
::prost::alloc::string::String,
super::super::super::super::google::protobuf::Struct,
>,
/// Key is the reverse DNS filter name, e.g. com.acme.widget. The ``envoy.*``
/// namespace is reserved for Envoy's built-in filters.
/// The value is encoded as google.protobuf.Any.
/// If both :ref:`filter_metadata <envoy_v3_api_field_config.core.v3.Metadata.filter_metadata>`
/// and ``typed_filter_metadata`` fields are present in the metadata with same keys,
/// only ``typed_filter_metadata`` field will be parsed.
#[prost(map = "string, message", tag = "2")]
pub typed_filter_metadata: ::std::collections::HashMap<
::prost::alloc::string::String,
super::super::super::super::google::protobuf::Any,
>,
}
impl ::prost::Name for Metadata {
const NAME: &'static str = "Metadata";
const PACKAGE: &'static str = "envoy.config.core.v3";
fn full_name() -> ::prost::alloc::string::String {
"envoy.config.core.v3.Metadata".into()
}
fn type_url() -> ::prost::alloc::string::String {
"type.googleapis.com/envoy.config.core.v3.Metadata".into()
}
}
/// Runtime derived uint32 with a default when not specified.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct RuntimeUInt32 {
/// Default value if runtime value is not available.
#[prost(uint32, tag = "2")]
pub default_value: u32,
/// Runtime key to get value for comparison. This value is used if defined.
#[prost(string, tag = "3")]
pub runtime_key: ::prost::alloc::string::String,
}
impl ::prost::Name for RuntimeUInt32 {
const NAME: &'static str = "RuntimeUInt32";
const PACKAGE: &'static str = "envoy.config.core.v3";
fn full_name() -> ::prost::alloc::string::String {
"envoy.config.core.v3.RuntimeUInt32".into()
}
fn type_url() -> ::prost::alloc::string::String {
"type.googleapis.com/envoy.config.core.v3.RuntimeUInt32".into()
}
}
/// Runtime derived percentage with a default when not specified.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct RuntimePercent {
/// Default value if runtime value is not available.
#[prost(message, optional, tag = "1")]
pub default_value: ::core::option::Option<super::super::super::r#type::v3::Percent>,
/// Runtime key to get value for comparison. This value is used if defined.
#[prost(string, tag = "2")]
pub runtime_key: ::prost::alloc::string::String,
}
impl ::prost::Name for RuntimePercent {
const NAME: &'static str = "RuntimePercent";
const PACKAGE: &'static str = "envoy.config.core.v3";
fn full_name() -> ::prost::alloc::string::String {
"envoy.config.core.v3.RuntimePercent".into()
}
fn type_url() -> ::prost::alloc::string::String {
"type.googleapis.com/envoy.config.core.v3.RuntimePercent".into()
}
}
/// Runtime derived double with a default when not specified.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct RuntimeDouble {
/// Default value if runtime value is not available.
#[prost(double, tag = "1")]
pub default_value: f64,
/// Runtime key to get value for comparison. This value is used if defined.
#[prost(string, tag = "2")]
pub runtime_key: ::prost::alloc::string::String,
}
impl ::prost::Name for RuntimeDouble {
const NAME: &'static str = "RuntimeDouble";
const PACKAGE: &'static str = "envoy.config.core.v3";
fn full_name() -> ::prost::alloc::string::String {
"envoy.config.core.v3.RuntimeDouble".into()
}
fn type_url() -> ::prost::alloc::string::String {
"type.googleapis.com/envoy.config.core.v3.RuntimeDouble".into()
}
}
/// Runtime derived bool with a default when not specified.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct RuntimeFeatureFlag {
/// Default value if runtime value is not available.
#[prost(message, optional, tag = "1")]
pub default_value: ::core::option::Option<
super::super::super::super::google::protobuf::BoolValue,
>,
/// Runtime key to get value for comparison. This value is used if defined. The boolean value must
/// be represented via its
/// `canonical JSON encoding <<https://developers.google.com/protocol-buffers/docs/proto3#json>`_.>
#[prost(string, tag = "2")]
pub runtime_key: ::prost::alloc::string::String,
}
impl ::prost::Name for RuntimeFeatureFlag {
const NAME: &'static str = "RuntimeFeatureFlag";
const PACKAGE: &'static str = "envoy.config.core.v3";
fn full_name() -> ::prost::alloc::string::String {
"envoy.config.core.v3.RuntimeFeatureFlag".into()
}
fn type_url() -> ::prost::alloc::string::String {
"type.googleapis.com/envoy.config.core.v3.RuntimeFeatureFlag".into()
}
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct KeyValue {
/// The key of the key/value pair.
#[prost(string, tag = "1")]
pub key: ::prost::alloc::string::String,
/// The value of the key/value pair.
#[prost(bytes = "vec", tag = "2")]
pub value: ::prost::alloc::vec::Vec<u8>,
}
impl ::prost::Name for KeyValue {
const NAME: &'static str = "KeyValue";
const PACKAGE: &'static str = "envoy.config.core.v3";
fn full_name() -> ::prost::alloc::string::String {
"envoy.config.core.v3.KeyValue".into()
}
fn type_url() -> ::prost::alloc::string::String {
"type.googleapis.com/envoy.config.core.v3.KeyValue".into()
}
}
/// Key/value pair plus option to control append behavior. This is used to specify
/// key/value pairs that should be appended to a set of existing key/value pairs.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct KeyValueAppend {
/// Key/value pair entry that this option to append or overwrite.
#[prost(message, optional, tag = "1")]
pub entry: ::core::option::Option<KeyValue>,
/// Describes the action taken to append/overwrite the given value for an existing
/// key or to only add this key if it's absent.
#[prost(enumeration = "key_value_append::KeyValueAppendAction", tag = "2")]
pub action: i32,
}
/// Nested message and enum types in `KeyValueAppend`.
pub mod key_value_append {
/// Describes the supported actions types for key/value pair append action.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum KeyValueAppendAction {
/// If the key already exists, this action will result in the following behavior:
///
/// - Comma-concatenated value if multiple values are not allowed.
/// - New value added to the list of values if multiple values are allowed.
///
/// If the key doesn't exist then this will add pair with specified key and value.
AppendIfExistsOrAdd = 0,
/// This action will add the key/value pair if it doesn't already exist. If the
/// key already exists then this will be a no-op.
AddIfAbsent = 1,
/// This action will overwrite the specified value by discarding any existing
/// values if the key already exists. If the key doesn't exist then this will add
/// the pair with specified key and value.
OverwriteIfExistsOrAdd = 2,
/// This action will overwrite the specified value by discarding any existing
/// values if the key already exists. If the key doesn't exist then this will
/// be no-op.
OverwriteIfExists = 3,
}
impl KeyValueAppendAction {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
Self::AppendIfExistsOrAdd => "APPEND_IF_EXISTS_OR_ADD",
Self::AddIfAbsent => "ADD_IF_ABSENT",
Self::OverwriteIfExistsOrAdd => "OVERWRITE_IF_EXISTS_OR_ADD",
Self::OverwriteIfExists => "OVERWRITE_IF_EXISTS",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"APPEND_IF_EXISTS_OR_ADD" => Some(Self::AppendIfExistsOrAdd),
"ADD_IF_ABSENT" => Some(Self::AddIfAbsent),
"OVERWRITE_IF_EXISTS_OR_ADD" => Some(Self::OverwriteIfExistsOrAdd),
"OVERWRITE_IF_EXISTS" => Some(Self::OverwriteIfExists),
_ => None,
}
}
}
}
impl ::prost::Name for KeyValueAppend {
const NAME: &'static str = "KeyValueAppend";
const PACKAGE: &'static str = "envoy.config.core.v3";
fn full_name() -> ::prost::alloc::string::String {
"envoy.config.core.v3.KeyValueAppend".into()
}
fn type_url() -> ::prost::alloc::string::String {
"type.googleapis.com/envoy.config.core.v3.KeyValueAppend".into()
}
}
/// Key/value pair to append or remove.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct KeyValueMutation {
/// Key/value pair to append or overwrite. Only one of ``append`` or ``remove`` can be set.
#[prost(message, optional, tag = "1")]
pub append: ::core::option::Option<KeyValueAppend>,
/// Key to remove. Only one of ``append`` or ``remove`` can be set.
#[prost(string, tag = "2")]
pub remove: ::prost::alloc::string::String,
}
impl ::prost::Name for KeyValueMutation {
const NAME: &'static str = "KeyValueMutation";
const PACKAGE: &'static str = "envoy.config.core.v3";
fn full_name() -> ::prost::alloc::string::String {
"envoy.config.core.v3.KeyValueMutation".into()
}
fn type_url() -> ::prost::alloc::string::String {
"type.googleapis.com/envoy.config.core.v3.KeyValueMutation".into()
}
}
/// Query parameter name/value pair.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct QueryParameter {
/// The key of the query parameter. Case sensitive.
#[prost(string, tag = "1")]
pub key: ::prost::alloc::string::String,
/// The value of the query parameter.
#[prost(string, tag = "2")]
pub value: ::prost::alloc::string::String,
}
impl ::prost::Name for QueryParameter {
const NAME: &'static str = "QueryParameter";
const PACKAGE: &'static str = "envoy.config.core.v3";
fn full_name() -> ::prost::alloc::string::String {
"envoy.config.core.v3.QueryParameter".into()
}
fn type_url() -> ::prost::alloc::string::String {
"type.googleapis.com/envoy.config.core.v3.QueryParameter".into()
}
}
/// Header name/value pair.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct HeaderValue {
/// Header name.
#[prost(string, tag = "1")]
pub key: ::prost::alloc::string::String,
/// Header value.
///
/// The same :ref:`format specifier <config_access_log_format>` as used for
/// :ref:`HTTP access logging <config_access_log>` applies here, however
/// unknown header values are replaced with the empty string instead of ``-``.
/// Header value is encoded as string. This does not work for non-utf8 characters.
/// Only one of ``value`` or ``raw_value`` can be set.
#[prost(string, tag = "2")]
pub value: ::prost::alloc::string::String,
/// Header value is encoded as bytes which can support non-utf8 characters.
/// Only one of ``value`` or ``raw_value`` can be set.
#[prost(bytes = "vec", tag = "3")]
pub raw_value: ::prost::alloc::vec::Vec<u8>,
}
impl ::prost::Name for HeaderValue {
const NAME: &'static str = "HeaderValue";
const PACKAGE: &'static str = "envoy.config.core.v3";
fn full_name() -> ::prost::alloc::string::String {
"envoy.config.core.v3.HeaderValue".into()
}
fn type_url() -> ::prost::alloc::string::String {
"type.googleapis.com/envoy.config.core.v3.HeaderValue".into()
}
}
/// Header name/value pair plus option to control append behavior.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct HeaderValueOption {
/// Header name/value pair that this option applies to.
#[prost(message, optional, tag = "1")]
pub header: ::core::option::Option<HeaderValue>,
/// Should the value be appended? If true (default), the value is appended to
/// existing values. Otherwise it replaces any existing values.
/// This field is deprecated and please use
/// :ref:`append_action <envoy_v3_api_field_config.core.v3.HeaderValueOption.append_action>` as replacement.
///
/// .. note::
/// The :ref:`external authorization service <envoy_v3_api_msg_service.auth.v3.CheckResponse>` and
/// :ref:`external processor service <envoy_v3_api_msg_service.ext_proc.v3.ProcessingResponse>` have
/// default value (``false``) for this field.
#[deprecated]
#[prost(message, optional, tag = "2")]
pub append: ::core::option::Option<
super::super::super::super::google::protobuf::BoolValue,
>,
/// Describes the action taken to append/overwrite the given value for an existing header
/// or to only add this header if it's absent.
/// Value defaults to :ref:`APPEND_IF_EXISTS_OR_ADD
/// <envoy_v3_api_enum_value_config.core.v3.HeaderValueOption.HeaderAppendAction.APPEND_IF_EXISTS_OR_ADD>`.
#[prost(enumeration = "header_value_option::HeaderAppendAction", tag = "3")]
pub append_action: i32,
/// Is the header value allowed to be empty? If false (default), custom headers with empty values are dropped,
/// otherwise they are added.
#[prost(bool, tag = "4")]
pub keep_empty_value: bool,
}
/// Nested message and enum types in `HeaderValueOption`.
pub mod header_value_option {
/// Describes the supported actions types for header append action.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum HeaderAppendAction {
/// If the header already exists, this action will result in:
///
/// - Comma-concatenated for predefined inline headers.
/// - Duplicate header added in the ``HeaderMap`` for other headers.
///
/// If the header doesn't exist then this will add new header with specified key and value.
AppendIfExistsOrAdd = 0,
/// This action will add the header if it doesn't already exist. If the header
/// already exists then this will be a no-op.
AddIfAbsent = 1,
/// This action will overwrite the specified value by discarding any existing values if
/// the header already exists. If the header doesn't exist then this will add the header
/// with specified key and value.
OverwriteIfExistsOrAdd = 2,
/// This action will overwrite the specified value by discarding any existing values if
/// the header already exists. If the header doesn't exist then this will be no-op.
OverwriteIfExists = 3,
}
impl HeaderAppendAction {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
Self::AppendIfExistsOrAdd => "APPEND_IF_EXISTS_OR_ADD",
Self::AddIfAbsent => "ADD_IF_ABSENT",
Self::OverwriteIfExistsOrAdd => "OVERWRITE_IF_EXISTS_OR_ADD",
Self::OverwriteIfExists => "OVERWRITE_IF_EXISTS",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"APPEND_IF_EXISTS_OR_ADD" => Some(Self::AppendIfExistsOrAdd),
"ADD_IF_ABSENT" => Some(Self::AddIfAbsent),
"OVERWRITE_IF_EXISTS_OR_ADD" => Some(Self::OverwriteIfExistsOrAdd),
"OVERWRITE_IF_EXISTS" => Some(Self::OverwriteIfExists),
_ => None,
}
}
}
}
impl ::prost::Name for HeaderValueOption {
const NAME: &'static str = "HeaderValueOption";
const PACKAGE: &'static str = "envoy.config.core.v3";
fn full_name() -> ::prost::alloc::string::String {
"envoy.config.core.v3.HeaderValueOption".into()
}
fn type_url() -> ::prost::alloc::string::String {
"type.googleapis.com/envoy.config.core.v3.HeaderValueOption".into()
}
}
/// Wrapper for a set of headers.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct HeaderMap {
#[prost(message, repeated, tag = "1")]
pub headers: ::prost::alloc::vec::Vec<HeaderValue>,
}
impl ::prost::Name for HeaderMap {
const NAME: &'static str = "HeaderMap";
const PACKAGE: &'static str = "envoy.config.core.v3";
fn full_name() -> ::prost::alloc::string::String {
"envoy.config.core.v3.HeaderMap".into()
}
fn type_url() -> ::prost::alloc::string::String {
"type.googleapis.com/envoy.config.core.v3.HeaderMap".into()
}
}
/// A directory that is watched for changes, e.g. by inotify on Linux. Move/rename
/// events inside this directory trigger the watch.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct WatchedDirectory {
/// Directory path to watch.
#[prost(string, tag = "1")]
pub path: ::prost::alloc::string::String,
}
impl ::prost::Name for WatchedDirectory {
const NAME: &'static str = "WatchedDirectory";
const PACKAGE: &'static str = "envoy.config.core.v3";
fn full_name() -> ::prost::alloc::string::String {
"envoy.config.core.v3.WatchedDirectory".into()
}
fn type_url() -> ::prost::alloc::string::String {
"type.googleapis.com/envoy.config.core.v3.WatchedDirectory".into()
}
}
/// Data source consisting of a file, an inline value, or an environment variable.
/// \[#next-free-field: 6\]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DataSource {
/// Watched directory that is watched for file changes. If this is set explicitly, the file
/// specified in the ``filename`` field will be reloaded when relevant file move events occur.
///
/// .. note::
/// This field only makes sense when the ``filename`` field is set.
///
/// .. note::
/// Envoy only updates when the file is replaced by a file move, and not when the file is
/// edited in place.
///
/// .. note::
/// Not all use cases of ``DataSource`` support watching directories. It depends on the
/// specific usage of the ``DataSource``. See the documentation of the parent message for
/// details.
#[prost(message, optional, tag = "5")]
pub watched_directory: ::core::option::Option<WatchedDirectory>,
#[prost(oneof = "data_source::Specifier", tags = "1, 2, 3, 4")]
pub specifier: ::core::option::Option<data_source::Specifier>,
}
/// Nested message and enum types in `DataSource`.
pub mod data_source {
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum Specifier {
/// Local filesystem data source.
#[prost(string, tag = "1")]
Filename(::prost::alloc::string::String),
/// Bytes inlined in the configuration.
#[prost(bytes, tag = "2")]
InlineBytes(::prost::alloc::vec::Vec<u8>),
/// String inlined in the configuration.
#[prost(string, tag = "3")]
InlineString(::prost::alloc::string::String),
/// Environment variable data source.
#[prost(string, tag = "4")]
EnvironmentVariable(::prost::alloc::string::String),
}
}
impl ::prost::Name for DataSource {
const NAME: &'static str = "DataSource";
const PACKAGE: &'static str = "envoy.config.core.v3";
fn full_name() -> ::prost::alloc::string::String {
"envoy.config.core.v3.DataSource".into()
}
fn type_url() -> ::prost::alloc::string::String {
"type.googleapis.com/envoy.config.core.v3.DataSource".into()
}
}
/// The message specifies the retry policy of remote data source when fetching fails.
/// \[#next-free-field: 7\]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct RetryPolicy {
/// Specifies parameters that control :ref:`retry backoff strategy <envoy_v3_api_msg_config.core.v3.BackoffStrategy>`.
/// This parameter is optional, in which case the default base interval is 1000 milliseconds. The
/// default maximum interval is 10 times the base interval.
#[prost(message, optional, tag = "1")]
pub retry_back_off: ::core::option::Option<BackoffStrategy>,
/// Specifies the allowed number of retries. This parameter is optional and
/// defaults to 1.
#[prost(message, optional, tag = "2")]
pub num_retries: ::core::option::Option<
super::super::super::super::google::protobuf::UInt32Value,
>,
/// For details, see :ref:`retry_on <envoy_v3_api_field_config.route.v3.RetryPolicy.retry_on>`.
#[prost(string, tag = "3")]
pub retry_on: ::prost::alloc::string::String,
/// For details, see :ref:`retry_priority <envoy_v3_api_field_config.route.v3.RetryPolicy.retry_priority>`.
#[prost(message, optional, tag = "4")]
pub retry_priority: ::core::option::Option<retry_policy::RetryPriority>,
/// For details, see :ref:`RetryHostPredicate <envoy_v3_api_field_config.route.v3.RetryPolicy.retry_host_predicate>`.
#[prost(message, repeated, tag = "5")]
pub retry_host_predicate: ::prost::alloc::vec::Vec<retry_policy::RetryHostPredicate>,
/// For details, see :ref:`host_selection_retry_max_attempts <envoy_v3_api_field_config.route.v3.RetryPolicy.host_selection_retry_max_attempts>`.
#[prost(int64, tag = "6")]
pub host_selection_retry_max_attempts: i64,
}
/// Nested message and enum types in `RetryPolicy`.
pub mod retry_policy {
/// See :ref:`RetryPriority <envoy_v3_api_field_config.route.v3.RetryPolicy.retry_priority>`.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct RetryPriority {
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
#[prost(oneof = "retry_priority::ConfigType", tags = "2")]
pub config_type: ::core::option::Option<retry_priority::ConfigType>,
}
/// Nested message and enum types in `RetryPriority`.
pub mod retry_priority {
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum ConfigType {
#[prost(message, tag = "2")]
TypedConfig(super::super::super::super::super::super::google::protobuf::Any),
}
}
impl ::prost::Name for RetryPriority {
const NAME: &'static str = "RetryPriority";
const PACKAGE: &'static str = "envoy.config.core.v3";
fn full_name() -> ::prost::alloc::string::String {
"envoy.config.core.v3.RetryPolicy.RetryPriority".into()
}
fn type_url() -> ::prost::alloc::string::String {
"type.googleapis.com/envoy.config.core.v3.RetryPolicy.RetryPriority".into()
}
}
/// See :ref:`RetryHostPredicate <envoy_v3_api_field_config.route.v3.RetryPolicy.retry_host_predicate>`.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct RetryHostPredicate {
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
#[prost(oneof = "retry_host_predicate::ConfigType", tags = "2")]
pub config_type: ::core::option::Option<retry_host_predicate::ConfigType>,
}
/// Nested message and enum types in `RetryHostPredicate`.
pub mod retry_host_predicate {
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum ConfigType {
#[prost(message, tag = "2")]
TypedConfig(super::super::super::super::super::super::google::protobuf::Any),
}
}
impl ::prost::Name for RetryHostPredicate {
const NAME: &'static str = "RetryHostPredicate";
const PACKAGE: &'static str = "envoy.config.core.v3";
fn full_name() -> ::prost::alloc::string::String {
"envoy.config.core.v3.RetryPolicy.RetryHostPredicate".into()
}
fn type_url() -> ::prost::alloc::string::String {
"type.googleapis.com/envoy.config.core.v3.RetryPolicy.RetryHostPredicate"
.into()
}
}
}
impl ::prost::Name for RetryPolicy {
const NAME: &'static str = "RetryPolicy";
const PACKAGE: &'static str = "envoy.config.core.v3";
fn full_name() -> ::prost::alloc::string::String {
"envoy.config.core.v3.RetryPolicy".into()
}
fn type_url() -> ::prost::alloc::string::String {
"type.googleapis.com/envoy.config.core.v3.RetryPolicy".into()
}
}
/// The message specifies how to fetch data from remote and how to verify it.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct RemoteDataSource {
/// The HTTP URI to fetch the remote data.
#[prost(message, optional, tag = "1")]
pub http_uri: ::core::option::Option<HttpUri>,
/// SHA256 string for verifying data.
#[prost(string, tag = "2")]
pub sha256: ::prost::alloc::string::String,
/// Retry policy for fetching remote data.
#[prost(message, optional, tag = "3")]
pub retry_policy: ::core::option::Option<RetryPolicy>,
}
impl ::prost::Name for RemoteDataSource {
const NAME: &'static str = "RemoteDataSource";
const PACKAGE: &'static str = "envoy.config.core.v3";
fn full_name() -> ::prost::alloc::string::String {
"envoy.config.core.v3.RemoteDataSource".into()
}
fn type_url() -> ::prost::alloc::string::String {
"type.googleapis.com/envoy.config.core.v3.RemoteDataSource".into()
}
}
/// Async data source which support async data fetch.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct AsyncDataSource {
#[prost(oneof = "async_data_source::Specifier", tags = "1, 2")]
pub specifier: ::core::option::Option<async_data_source::Specifier>,
}
/// Nested message and enum types in `AsyncDataSource`.
pub mod async_data_source {
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum Specifier {
/// Local async data source.
#[prost(message, tag = "1")]
Local(super::DataSource),
/// Remote async data source.
#[prost(message, tag = "2")]
Remote(super::RemoteDataSource),
}
}
impl ::prost::Name for AsyncDataSource {
const NAME: &'static str = "AsyncDataSource";
const PACKAGE: &'static str = "envoy.config.core.v3";
fn full_name() -> ::prost::alloc::string::String {
"envoy.config.core.v3.AsyncDataSource".into()
}
fn type_url() -> ::prost::alloc::string::String {
"type.googleapis.com/envoy.config.core.v3.AsyncDataSource".into()
}
}
/// Configuration for transport socket in :ref:`listeners <config_listeners>` and
/// :ref:`clusters <envoy_v3_api_msg_config.cluster.v3.Cluster>`. If the configuration is
/// empty, a default transport socket implementation and configuration will be
/// chosen based on the platform and existence of tls_context.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct TransportSocket {
/// The name of the transport socket to instantiate. The name must match a supported transport
/// socket implementation.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Implementation specific configuration which depends on the implementation being instantiated.
/// See the supported transport socket implementations for further documentation.
#[prost(oneof = "transport_socket::ConfigType", tags = "3")]
pub config_type: ::core::option::Option<transport_socket::ConfigType>,
}
/// Nested message and enum types in `TransportSocket`.
pub mod transport_socket {
/// Implementation specific configuration which depends on the implementation being instantiated.
/// See the supported transport socket implementations for further documentation.
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum ConfigType {
#[prost(message, tag = "3")]
TypedConfig(super::super::super::super::super::google::protobuf::Any),
}
}
impl ::prost::Name for TransportSocket {
const NAME: &'static str = "TransportSocket";
const PACKAGE: &'static str = "envoy.config.core.v3";
fn full_name() -> ::prost::alloc::string::String {
"envoy.config.core.v3.TransportSocket".into()
}
fn type_url() -> ::prost::alloc::string::String {
"type.googleapis.com/envoy.config.core.v3.TransportSocket".into()
}
}
/// Runtime derived FractionalPercent with defaults for when the numerator or denominator is not
/// specified via a runtime key.
///
/// .. note::
///
/// Parsing of the runtime key's data is implemented such that it may be represented as a
/// :ref:`FractionalPercent <envoy_v3_api_msg_type.v3.FractionalPercent>` proto represented as JSON/YAML
/// and may also be represented as an integer with the assumption that the value is an integral
/// percentage out of 100. For instance, a runtime key lookup returning the value "42" would parse
/// as a ``FractionalPercent`` whose numerator is 42 and denominator is HUNDRED.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct RuntimeFractionalPercent {
/// Default value if the runtime value's for the numerator/denominator keys are not available.
#[prost(message, optional, tag = "1")]
pub default_value: ::core::option::Option<
super::super::super::r#type::v3::FractionalPercent,
>,
/// Runtime key for a YAML representation of a FractionalPercent.
#[prost(string, tag = "2")]
pub runtime_key: ::prost::alloc::string::String,
}
impl ::prost::Name for RuntimeFractionalPercent {
const NAME: &'static str = "RuntimeFractionalPercent";
const PACKAGE: &'static str = "envoy.config.core.v3";
fn full_name() -> ::prost::alloc::string::String {
"envoy.config.core.v3.RuntimeFractionalPercent".into()
}
fn type_url() -> ::prost::alloc::string::String {
"type.googleapis.com/envoy.config.core.v3.RuntimeFractionalPercent".into()
}
}
/// Identifies a specific ControlPlane instance that Envoy is connected to.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ControlPlane {
/// An opaque control plane identifier that uniquely identifies an instance
/// of control plane. This can be used to identify which control plane instance,
/// the Envoy is connected to.
#[prost(string, tag = "1")]
pub identifier: ::prost::alloc::string::String,
}
impl ::prost::Name for ControlPlane {
const NAME: &'static str = "ControlPlane";
const PACKAGE: &'static str = "envoy.config.core.v3";
fn full_name() -> ::prost::alloc::string::String {
"envoy.config.core.v3.ControlPlane".into()
}
fn type_url() -> ::prost::alloc::string::String {
"type.googleapis.com/envoy.config.core.v3.ControlPlane".into()
}
}
/// Envoy supports :ref:`upstream priority routing
/// <arch_overview_http_routing_priority>` both at the route and the virtual
/// cluster level. The current priority implementation uses different connection
/// pool and circuit breaking settings for each priority level. This means that
/// even for HTTP/2 requests, two physical connections will be used to an
/// upstream host. In the future Envoy will likely support true HTTP/2 priority
/// over a single upstream connection.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum RoutingPriority {
Default = 0,
High = 1,
}
impl RoutingPriority {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
Self::Default => "DEFAULT",
Self::High => "HIGH",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"DEFAULT" => Some(Self::Default),
"HIGH" => Some(Self::High),
_ => None,
}
}
}
/// HTTP request method.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum RequestMethod {
MethodUnspecified = 0,
Get = 1,
Head = 2,
Post = 3,
Put = 4,
Delete = 5,
Connect = 6,
Options = 7,
Trace = 8,
Patch = 9,
}
impl RequestMethod {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
Self::MethodUnspecified => "METHOD_UNSPECIFIED",
Self::Get => "GET",
Self::Head => "HEAD",
Self::Post => "POST",
Self::Put => "PUT",
Self::Delete => "DELETE",
Self::Connect => "CONNECT",
Self::Options => "OPTIONS",
Self::Trace => "TRACE",
Self::Patch => "PATCH",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"METHOD_UNSPECIFIED" => Some(Self::MethodUnspecified),
"GET" => Some(Self::Get),
"HEAD" => Some(Self::Head),
"POST" => Some(Self::Post),
"PUT" => Some(Self::Put),
"DELETE" => Some(Self::Delete),
"CONNECT" => Some(Self::Connect),
"OPTIONS" => Some(Self::Options),
"TRACE" => Some(Self::Trace),
"PATCH" => Some(Self::Patch),
_ => None,
}
}
}
/// Identifies the direction of the traffic relative to the local Envoy.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum TrafficDirection {
/// Default option is unspecified.
Unspecified = 0,
/// The transport is used for incoming traffic.
Inbound = 1,
/// The transport is used for outgoing traffic.
Outbound = 2,
}
impl TrafficDirection {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
Self::Unspecified => "UNSPECIFIED",
Self::Inbound => "INBOUND",
Self::Outbound => "OUTBOUND",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"UNSPECIFIED" => Some(Self::Unspecified),
"INBOUND" => Some(Self::Inbound),
"OUTBOUND" => Some(Self::Outbound),
_ => None,
}
}
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ProxyProtocolPassThroughTlVs {
/// The strategy to pass through TLVs. Default is INCLUDE_ALL.
/// If INCLUDE_ALL is set, all TLVs will be passed through no matter the tlv_type field.
#[prost(
enumeration = "proxy_protocol_pass_through_tl_vs::PassTlVsMatchType",
tag = "1"
)]
pub match_type: i32,
/// The TLV types that are applied based on match_type.
/// TLV type is defined as uint8_t in proxy protocol. See `the spec
/// <<https://www.haproxy.org/download/2.1/doc/proxy-protocol.txt>`_> for details.
#[prost(uint32, repeated, packed = "false", tag = "2")]
pub tlv_type: ::prost::alloc::vec::Vec<u32>,
}
/// Nested message and enum types in `ProxyProtocolPassThroughTLVs`.
pub mod proxy_protocol_pass_through_tl_vs {
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum PassTlVsMatchType {
/// Pass all TLVs.
IncludeAll = 0,
/// Pass specific TLVs defined in tlv_type.
Include = 1,
}
impl PassTlVsMatchType {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
Self::IncludeAll => "INCLUDE_ALL",
Self::Include => "INCLUDE",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"INCLUDE_ALL" => Some(Self::IncludeAll),
"INCLUDE" => Some(Self::Include),
_ => None,
}
}
}
}
impl ::prost::Name for ProxyProtocolPassThroughTlVs {
const NAME: &'static str = "ProxyProtocolPassThroughTLVs";
const PACKAGE: &'static str = "envoy.config.core.v3";
fn full_name() -> ::prost::alloc::string::String {
"envoy.config.core.v3.ProxyProtocolPassThroughTLVs".into()
}
fn type_url() -> ::prost::alloc::string::String {
"type.googleapis.com/envoy.config.core.v3.ProxyProtocolPassThroughTLVs".into()
}
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ProxyProtocolConfig {
/// The PROXY protocol version to use. See <https://www.haproxy.org/download/2.1/doc/proxy-protocol.txt> for details
#[prost(enumeration = "proxy_protocol_config::Version", tag = "1")]
pub version: i32,
/// This config controls which TLVs can be passed to upstream if it is Proxy Protocol
/// V2 header. If there is no setting for this field, no TLVs will be passed through.
#[prost(message, optional, tag = "2")]
pub pass_through_tlvs: ::core::option::Option<ProxyProtocolPassThroughTlVs>,
}
/// Nested message and enum types in `ProxyProtocolConfig`.
pub mod proxy_protocol_config {
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum Version {
/// PROXY protocol version 1. Human readable format.
V1 = 0,
/// PROXY protocol version 2. Binary format.
V2 = 1,
}
impl Version {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
Self::V1 => "V1",
Self::V2 => "V2",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"V1" => Some(Self::V1),
"V2" => Some(Self::V2),
_ => None,
}
}
}
}
impl ::prost::Name for ProxyProtocolConfig {
const NAME: &'static str = "ProxyProtocolConfig";
const PACKAGE: &'static str = "envoy.config.core.v3";
fn full_name() -> ::prost::alloc::string::String {
"envoy.config.core.v3.ProxyProtocolConfig".into()
}
fn type_url() -> ::prost::alloc::string::String {
"type.googleapis.com/envoy.config.core.v3.ProxyProtocolConfig".into()
}
}
/// gRPC service configuration. This is used by :ref:`ApiConfigSource
/// <envoy_v3_api_msg_config.core.v3.ApiConfigSource>` and filter configurations.
/// \[#next-free-field: 7\]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GrpcService {
/// The timeout for the gRPC request. This is the timeout for a specific
/// request.
#[prost(message, optional, tag = "3")]
pub timeout: ::core::option::Option<
super::super::super::super::google::protobuf::Duration,
>,
/// Additional metadata to include in streams initiated to the GrpcService. This can be used for
/// scenarios in which additional ad hoc authorization headers (e.g. ``x-foo-bar: baz-key``) are to
/// be injected. For more information, including details on header value syntax, see the
/// documentation on :ref:`custom request headers
/// <config_http_conn_man_headers_custom_request_headers>`.
#[prost(message, repeated, tag = "5")]
pub initial_metadata: ::prost::alloc::vec::Vec<HeaderValue>,
/// Optional default retry policy for streams toward the service.
/// If an async stream doesn't have retry policy configured in its stream options, this retry policy is used.
#[prost(message, optional, tag = "6")]
pub retry_policy: ::core::option::Option<RetryPolicy>,
#[prost(oneof = "grpc_service::TargetSpecifier", tags = "1, 2")]
pub target_specifier: ::core::option::Option<grpc_service::TargetSpecifier>,
}
/// Nested message and enum types in `GrpcService`.
pub mod grpc_service {
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct EnvoyGrpc {
/// The name of the upstream gRPC cluster. SSL credentials will be supplied
/// in the :ref:`Cluster <envoy_v3_api_msg_config.cluster.v3.Cluster>` :ref:`transport_socket
/// <envoy_v3_api_field_config.cluster.v3.Cluster.transport_socket>`.
#[prost(string, tag = "1")]
pub cluster_name: ::prost::alloc::string::String,
/// The ``:authority`` header in the grpc request. If this field is not set, the authority header value will be ``cluster_name``.
/// Note that this authority does not override the SNI. The SNI is provided by the transport socket of the cluster.
#[prost(string, tag = "2")]
pub authority: ::prost::alloc::string::String,
/// Indicates the retry policy for re-establishing the gRPC stream
/// This field is optional. If max interval is not provided, it will be set to ten times the provided base interval.
/// Currently only supported for xDS gRPC streams.
/// If not set, xDS gRPC streams default base interval:500ms, maximum interval:30s will be applied.
#[prost(message, optional, tag = "3")]
pub retry_policy: ::core::option::Option<super::RetryPolicy>,
/// Maximum gRPC message size that is allowed to be received.
/// If a message over this limit is received, the gRPC stream is terminated with the RESOURCE_EXHAUSTED error.
/// This limit is applied to individual messages in the streaming response and not the total size of streaming response.
/// Defaults to 0, which means unlimited.
#[prost(message, optional, tag = "4")]
pub max_receive_message_length: ::core::option::Option<
super::super::super::super::super::google::protobuf::UInt32Value,
>,
}
impl ::prost::Name for EnvoyGrpc {
const NAME: &'static str = "EnvoyGrpc";
const PACKAGE: &'static str = "envoy.config.core.v3";
fn full_name() -> ::prost::alloc::string::String {
"envoy.config.core.v3.GrpcService.EnvoyGrpc".into()
}
fn type_url() -> ::prost::alloc::string::String {
"type.googleapis.com/envoy.config.core.v3.GrpcService.EnvoyGrpc".into()
}
}
/// \[#next-free-field: 9\]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GoogleGrpc {
/// The target URI when using the `Google C++ gRPC client
/// <<https://github.com/grpc/grpc>`_.> SSL credentials will be supplied in
/// :ref:`channel_credentials <envoy_v3_api_field_config.core.v3.GrpcService.GoogleGrpc.channel_credentials>`.
#[prost(string, tag = "1")]
pub target_uri: ::prost::alloc::string::String,
#[prost(message, optional, tag = "2")]
pub channel_credentials: ::core::option::Option<google_grpc::ChannelCredentials>,
/// A set of call credentials that can be composed with `channel credentials
/// <<https://grpc.io/docs/guides/auth.html#credential-types>`_.>
#[prost(message, repeated, tag = "3")]
pub call_credentials: ::prost::alloc::vec::Vec<google_grpc::CallCredentials>,
/// The human readable prefix to use when emitting statistics for the gRPC
/// service.
///
/// .. csv-table::
/// :header: Name, Type, Description
/// :widths: 1, 1, 2
///
/// streams_total, Counter, Total number of streams opened
/// streams_closed_<gRPC status code>, Counter, Total streams closed with <gRPC status code>
#[prost(string, tag = "4")]
pub stat_prefix: ::prost::alloc::string::String,
/// The name of the Google gRPC credentials factory to use. This must have been registered with
/// Envoy. If this is empty, a default credentials factory will be used that sets up channel
/// credentials based on other configuration parameters.
#[prost(string, tag = "5")]
pub credentials_factory_name: ::prost::alloc::string::String,
/// Additional configuration for site-specific customizations of the Google
/// gRPC library.
#[prost(message, optional, tag = "6")]
pub config: ::core::option::Option<
super::super::super::super::super::google::protobuf::Struct,
>,
/// How many bytes each stream can buffer internally.
/// If not set an implementation defined default is applied (1MiB).
#[prost(message, optional, tag = "7")]
pub per_stream_buffer_limit_bytes: ::core::option::Option<
super::super::super::super::super::google::protobuf::UInt32Value,
>,
/// Custom channels args.
#[prost(message, optional, tag = "8")]
pub channel_args: ::core::option::Option<google_grpc::ChannelArgs>,
}
/// Nested message and enum types in `GoogleGrpc`.
pub mod google_grpc {
/// See <https://grpc.io/grpc/cpp/structgrpc_1_1_ssl_credentials_options.html.>
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct SslCredentials {
/// PEM encoded server root certificates.
#[prost(message, optional, tag = "1")]
pub root_certs: ::core::option::Option<super::super::DataSource>,
/// PEM encoded client private key.
#[prost(message, optional, tag = "2")]
pub private_key: ::core::option::Option<super::super::DataSource>,
/// PEM encoded client certificate chain.
#[prost(message, optional, tag = "3")]
pub cert_chain: ::core::option::Option<super::super::DataSource>,
}
impl ::prost::Name for SslCredentials {
const NAME: &'static str = "SslCredentials";
const PACKAGE: &'static str = "envoy.config.core.v3";
fn full_name() -> ::prost::alloc::string::String {
"envoy.config.core.v3.GrpcService.GoogleGrpc.SslCredentials".into()
}
fn type_url() -> ::prost::alloc::string::String {
"type.googleapis.com/envoy.config.core.v3.GrpcService.GoogleGrpc.SslCredentials"
.into()
}
}
/// Local channel credentials. Only UDS is supported for now.
/// See <https://github.com/grpc/grpc/pull/15909.>
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct GoogleLocalCredentials {}
impl ::prost::Name for GoogleLocalCredentials {
const NAME: &'static str = "GoogleLocalCredentials";
const PACKAGE: &'static str = "envoy.config.core.v3";
fn full_name() -> ::prost::alloc::string::String {
"envoy.config.core.v3.GrpcService.GoogleGrpc.GoogleLocalCredentials"
.into()
}
fn type_url() -> ::prost::alloc::string::String {
"type.googleapis.com/envoy.config.core.v3.GrpcService.GoogleGrpc.GoogleLocalCredentials"
.into()
}
}
/// See <https://grpc.io/docs/guides/auth.html#credential-types> to understand Channel and Call
/// credential types.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ChannelCredentials {
#[prost(
oneof = "channel_credentials::CredentialSpecifier",
tags = "1, 2, 3"
)]
pub credential_specifier: ::core::option::Option<
channel_credentials::CredentialSpecifier,
>,
}
/// Nested message and enum types in `ChannelCredentials`.
pub mod channel_credentials {
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum CredentialSpecifier {
#[prost(message, tag = "1")]
SslCredentials(super::SslCredentials),
/// <https://grpc.io/grpc/cpp/namespacegrpc.html#a6beb3ac70ff94bd2ebbd89b8f21d1f61>
#[prost(message, tag = "2")]
GoogleDefault(
super::super::super::super::super::super::super::google::protobuf::Empty,
),
#[prost(message, tag = "3")]
LocalCredentials(super::GoogleLocalCredentials),
}
}
impl ::prost::Name for ChannelCredentials {
const NAME: &'static str = "ChannelCredentials";
const PACKAGE: &'static str = "envoy.config.core.v3";
fn full_name() -> ::prost::alloc::string::String {
"envoy.config.core.v3.GrpcService.GoogleGrpc.ChannelCredentials".into()
}
fn type_url() -> ::prost::alloc::string::String {
"type.googleapis.com/envoy.config.core.v3.GrpcService.GoogleGrpc.ChannelCredentials"
.into()
}
}
/// \[#next-free-field: 8\]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CallCredentials {
#[prost(
oneof = "call_credentials::CredentialSpecifier",
tags = "1, 2, 3, 4, 5, 6, 7"
)]
pub credential_specifier: ::core::option::Option<
call_credentials::CredentialSpecifier,
>,
}
/// Nested message and enum types in `CallCredentials`.
pub mod call_credentials {
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ServiceAccountJwtAccessCredentials {
#[prost(string, tag = "1")]
pub json_key: ::prost::alloc::string::String,
#[prost(uint64, tag = "2")]
pub token_lifetime_seconds: u64,
}
impl ::prost::Name for ServiceAccountJwtAccessCredentials {
const NAME: &'static str = "ServiceAccountJWTAccessCredentials";
const PACKAGE: &'static str = "envoy.config.core.v3";
fn full_name() -> ::prost::alloc::string::String {
"envoy.config.core.v3.GrpcService.GoogleGrpc.CallCredentials.ServiceAccountJWTAccessCredentials"
.into()
}
fn type_url() -> ::prost::alloc::string::String {
"type.googleapis.com/envoy.config.core.v3.GrpcService.GoogleGrpc.CallCredentials.ServiceAccountJWTAccessCredentials"
.into()
}
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GoogleIamCredentials {
#[prost(string, tag = "1")]
pub authorization_token: ::prost::alloc::string::String,
#[prost(string, tag = "2")]
pub authority_selector: ::prost::alloc::string::String,
}
impl ::prost::Name for GoogleIamCredentials {
const NAME: &'static str = "GoogleIAMCredentials";
const PACKAGE: &'static str = "envoy.config.core.v3";
fn full_name() -> ::prost::alloc::string::String {
"envoy.config.core.v3.GrpcService.GoogleGrpc.CallCredentials.GoogleIAMCredentials"
.into()
}
fn type_url() -> ::prost::alloc::string::String {
"type.googleapis.com/envoy.config.core.v3.GrpcService.GoogleGrpc.CallCredentials.GoogleIAMCredentials"
.into()
}
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct MetadataCredentialsFromPlugin {
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// \[#extension-category: envoy.grpc_credentials\]
#[prost(
oneof = "metadata_credentials_from_plugin::ConfigType",
tags = "3"
)]
pub config_type: ::core::option::Option<
metadata_credentials_from_plugin::ConfigType,
>,
}
/// Nested message and enum types in `MetadataCredentialsFromPlugin`.
pub mod metadata_credentials_from_plugin {
/// \[#extension-category: envoy.grpc_credentials\]
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum ConfigType {
#[prost(message, tag = "3")]
TypedConfig(
super::super::super::super::super::super::super::super::google::protobuf::Any,
),
}
}
impl ::prost::Name for MetadataCredentialsFromPlugin {
const NAME: &'static str = "MetadataCredentialsFromPlugin";
const PACKAGE: &'static str = "envoy.config.core.v3";
fn full_name() -> ::prost::alloc::string::String {
"envoy.config.core.v3.GrpcService.GoogleGrpc.CallCredentials.MetadataCredentialsFromPlugin"
.into()
}
fn type_url() -> ::prost::alloc::string::String {
"type.googleapis.com/envoy.config.core.v3.GrpcService.GoogleGrpc.CallCredentials.MetadataCredentialsFromPlugin"
.into()
}
}
/// Security token service configuration that allows Google gRPC to
/// fetch security token from an OAuth 2.0 authorization server.
/// See <https://tools.ietf.org/html/draft-ietf-oauth-token-exchange-16> and
/// <https://github.com/grpc/grpc/pull/19587.>
/// \[#next-free-field: 10\]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct StsService {
/// URI of the token exchange service that handles token exchange requests.
/// [#comment:TODO(asraa): Add URI validation when implemented. Tracked by
/// <https://github.com/bufbuild/protoc-gen-validate/issues/303]>
#[prost(string, tag = "1")]
pub token_exchange_service_uri: ::prost::alloc::string::String,
/// Location of the target service or resource where the client
/// intends to use the requested security token.
#[prost(string, tag = "2")]
pub resource: ::prost::alloc::string::String,
/// Logical name of the target service where the client intends to
/// use the requested security token.
#[prost(string, tag = "3")]
pub audience: ::prost::alloc::string::String,
/// The desired scope of the requested security token in the
/// context of the service or resource where the token will be used.
#[prost(string, tag = "4")]
pub scope: ::prost::alloc::string::String,
/// Type of the requested security token.
#[prost(string, tag = "5")]
pub requested_token_type: ::prost::alloc::string::String,
/// The path of subject token, a security token that represents the
/// identity of the party on behalf of whom the request is being made.
#[prost(string, tag = "6")]
pub subject_token_path: ::prost::alloc::string::String,
/// Type of the subject token.
#[prost(string, tag = "7")]
pub subject_token_type: ::prost::alloc::string::String,
/// The path of actor token, a security token that represents the identity
/// of the acting party. The acting party is authorized to use the
/// requested security token and act on behalf of the subject.
#[prost(string, tag = "8")]
pub actor_token_path: ::prost::alloc::string::String,
/// Type of the actor token.
#[prost(string, tag = "9")]
pub actor_token_type: ::prost::alloc::string::String,
}
impl ::prost::Name for StsService {
const NAME: &'static str = "StsService";
const PACKAGE: &'static str = "envoy.config.core.v3";
fn full_name() -> ::prost::alloc::string::String {
"envoy.config.core.v3.GrpcService.GoogleGrpc.CallCredentials.StsService"
.into()
}
fn type_url() -> ::prost::alloc::string::String {
"type.googleapis.com/envoy.config.core.v3.GrpcService.GoogleGrpc.CallCredentials.StsService"
.into()
}
}
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum CredentialSpecifier {
/// Access token credentials.
/// <https://grpc.io/grpc/cpp/namespacegrpc.html#ad3a80da696ffdaea943f0f858d7a360d.>
#[prost(string, tag = "1")]
AccessToken(::prost::alloc::string::String),
/// Google Compute Engine credentials.
/// <https://grpc.io/grpc/cpp/namespacegrpc.html#a6beb3ac70ff94bd2ebbd89b8f21d1f61>
#[prost(message, tag = "2")]
GoogleComputeEngine(
super::super::super::super::super::super::super::google::protobuf::Empty,
),
/// Google refresh token credentials.
/// <https://grpc.io/grpc/cpp/namespacegrpc.html#a96901c997b91bc6513b08491e0dca37c.>
#[prost(string, tag = "3")]
GoogleRefreshToken(::prost::alloc::string::String),
/// Service Account JWT Access credentials.
/// <https://grpc.io/grpc/cpp/namespacegrpc.html#a92a9f959d6102461f66ee973d8e9d3aa.>
#[prost(message, tag = "4")]
ServiceAccountJwtAccess(ServiceAccountJwtAccessCredentials),
/// Google IAM credentials.
/// <https://grpc.io/grpc/cpp/namespacegrpc.html#a9fc1fc101b41e680d47028166e76f9d0.>
#[prost(message, tag = "5")]
GoogleIam(GoogleIamCredentials),
/// Custom authenticator credentials.
/// <https://grpc.io/grpc/cpp/namespacegrpc.html#a823c6a4b19ffc71fb33e90154ee2ad07.>
/// <https://grpc.io/docs/guides/auth.html#extending-grpc-to-support-other-authentication-mechanisms.>
#[prost(message, tag = "6")]
FromPlugin(MetadataCredentialsFromPlugin),
/// Custom security token service which implements OAuth 2.0 token exchange.
/// <https://tools.ietf.org/html/draft-ietf-oauth-token-exchange-16>
/// See <https://github.com/grpc/grpc/pull/19587.>
#[prost(message, tag = "7")]
StsService(StsService),
}
}
impl ::prost::Name for CallCredentials {
const NAME: &'static str = "CallCredentials";
const PACKAGE: &'static str = "envoy.config.core.v3";
fn full_name() -> ::prost::alloc::string::String {
"envoy.config.core.v3.GrpcService.GoogleGrpc.CallCredentials".into()
}
fn type_url() -> ::prost::alloc::string::String {
"type.googleapis.com/envoy.config.core.v3.GrpcService.GoogleGrpc.CallCredentials"
.into()
}
}
/// Channel arguments.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ChannelArgs {
/// See grpc_types.h GRPC_ARG #defines for keys that work here.
#[prost(map = "string, message", tag = "1")]
pub args: ::std::collections::HashMap<
::prost::alloc::string::String,
channel_args::Value,
>,
}
/// Nested message and enum types in `ChannelArgs`.
pub mod channel_args {
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Value {
/// Pointer values are not supported, since they don't make any sense when
/// delivered via the API.
#[prost(oneof = "value::ValueSpecifier", tags = "1, 2")]
pub value_specifier: ::core::option::Option<value::ValueSpecifier>,
}
/// Nested message and enum types in `Value`.
pub mod value {
/// Pointer values are not supported, since they don't make any sense when
/// delivered via the API.
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum ValueSpecifier {
#[prost(string, tag = "1")]
StringValue(::prost::alloc::string::String),
#[prost(int64, tag = "2")]
IntValue(i64),
}
}
impl ::prost::Name for Value {
const NAME: &'static str = "Value";
const PACKAGE: &'static str = "envoy.config.core.v3";
fn full_name() -> ::prost::alloc::string::String {
"envoy.config.core.v3.GrpcService.GoogleGrpc.ChannelArgs.Value"
.into()
}
fn type_url() -> ::prost::alloc::string::String {
"type.googleapis.com/envoy.config.core.v3.GrpcService.GoogleGrpc.ChannelArgs.Value"
.into()
}
}
}
impl ::prost::Name for ChannelArgs {
const NAME: &'static str = "ChannelArgs";
const PACKAGE: &'static str = "envoy.config.core.v3";
fn full_name() -> ::prost::alloc::string::String {
"envoy.config.core.v3.GrpcService.GoogleGrpc.ChannelArgs".into()
}
fn type_url() -> ::prost::alloc::string::String {
"type.googleapis.com/envoy.config.core.v3.GrpcService.GoogleGrpc.ChannelArgs"
.into()
}
}
}
impl ::prost::Name for GoogleGrpc {
const NAME: &'static str = "GoogleGrpc";
const PACKAGE: &'static str = "envoy.config.core.v3";
fn full_name() -> ::prost::alloc::string::String {
"envoy.config.core.v3.GrpcService.GoogleGrpc".into()
}
fn type_url() -> ::prost::alloc::string::String {
"type.googleapis.com/envoy.config.core.v3.GrpcService.GoogleGrpc".into()
}
}
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum TargetSpecifier {
/// Envoy's in-built gRPC client.
/// See the :ref:`gRPC services overview <arch_overview_grpc_services>`
/// documentation for discussion on gRPC client selection.
#[prost(message, tag = "1")]
EnvoyGrpc(EnvoyGrpc),
/// `Google C++ gRPC client <<https://github.com/grpc/grpc>`_>
/// See the :ref:`gRPC services overview <arch_overview_grpc_services>`
/// documentation for discussion on gRPC client selection.
#[prost(message, tag = "2")]
GoogleGrpc(GoogleGrpc),
}
}
impl ::prost::Name for GrpcService {
const NAME: &'static str = "GrpcService";
const PACKAGE: &'static str = "envoy.config.core.v3";
fn full_name() -> ::prost::alloc::string::String {
"envoy.config.core.v3.GrpcService".into()
}
fn type_url() -> ::prost::alloc::string::String {
"type.googleapis.com/envoy.config.core.v3.GrpcService".into()
}
}
/// API configuration source. This identifies the API type and cluster that Envoy
/// will use to fetch an xDS API.
/// \[#next-free-field: 10\]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ApiConfigSource {
/// API type (gRPC, REST, delta gRPC)
#[prost(enumeration = "api_config_source::ApiType", tag = "1")]
pub api_type: i32,
/// API version for xDS transport protocol. This describes the xDS gRPC/REST
/// endpoint and version of \[Delta\]DiscoveryRequest/Response used on the wire.
#[prost(enumeration = "ApiVersion", tag = "8")]
pub transport_api_version: i32,
/// Cluster names should be used only with REST. If > 1
/// cluster is defined, clusters will be cycled through if any kind of failure
/// occurs.
///
/// .. note::
///
/// The cluster with name ``cluster_name`` must be statically defined and its
/// type must not be ``EDS``.
#[prost(string, repeated, tag = "2")]
pub cluster_names: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
/// Multiple gRPC services be provided for GRPC. If > 1 cluster is defined,
/// services will be cycled through if any kind of failure occurs.
#[prost(message, repeated, tag = "4")]
pub grpc_services: ::prost::alloc::vec::Vec<GrpcService>,
/// For REST APIs, the delay between successive polls.
#[prost(message, optional, tag = "3")]
pub refresh_delay: ::core::option::Option<
super::super::super::super::google::protobuf::Duration,
>,
/// For REST APIs, the request timeout. If not set, a default value of 1s will be used.
#[prost(message, optional, tag = "5")]
pub request_timeout: ::core::option::Option<
super::super::super::super::google::protobuf::Duration,
>,
/// For GRPC APIs, the rate limit settings. If present, discovery requests made by Envoy will be
/// rate limited.
#[prost(message, optional, tag = "6")]
pub rate_limit_settings: ::core::option::Option<RateLimitSettings>,
/// Skip the node identifier in subsequent discovery requests for streaming gRPC config types.
#[prost(bool, tag = "7")]
pub set_node_on_first_message_only: bool,
/// A list of config validators that will be executed when a new update is
/// received from the ApiConfigSource. Note that each validator handles a
/// specific xDS service type, and only the validators corresponding to the
/// type url (in ``:ref: DiscoveryResponse`` or ``:ref: DeltaDiscoveryResponse``)
/// will be invoked.
/// If the validator returns false or throws an exception, the config will be rejected by
/// the client, and a NACK will be sent.
/// \[#extension-category: envoy.config.validators\]
#[prost(message, repeated, tag = "9")]
pub config_validators: ::prost::alloc::vec::Vec<TypedExtensionConfig>,
}
/// Nested message and enum types in `ApiConfigSource`.
pub mod api_config_source {
/// APIs may be fetched via either REST or gRPC.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum ApiType {
/// Ideally this would be 'reserved 0' but one can't reserve the default
/// value. Instead we throw an exception if this is ever used.
DeprecatedAndUnavailableDoNotUse = 0,
/// REST-JSON v2 API. The `canonical JSON encoding
/// <<https://developers.google.com/protocol-buffers/docs/proto3#json>`_> for
/// the v2 protos is used.
Rest = 1,
/// SotW gRPC service.
Grpc = 2,
/// Using the delta xDS gRPC service, i.e. DeltaDiscovery{Request,Response}
/// rather than Discovery{Request,Response}. Rather than sending Envoy the entire state
/// with every update, the xDS server only sends what has changed since the last update.
DeltaGrpc = 3,
/// SotW xDS gRPC with ADS. All resources which resolve to this configuration source will be
/// multiplexed on a single connection to an ADS endpoint.
/// \[#not-implemented-hide:\]
AggregatedGrpc = 5,
/// Delta xDS gRPC with ADS. All resources which resolve to this configuration source will be
/// multiplexed on a single connection to an ADS endpoint.
/// \[#not-implemented-hide:\]
AggregatedDeltaGrpc = 6,
}
impl ApiType {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
Self::DeprecatedAndUnavailableDoNotUse => {
"DEPRECATED_AND_UNAVAILABLE_DO_NOT_USE"
}
Self::Rest => "REST",
Self::Grpc => "GRPC",
Self::DeltaGrpc => "DELTA_GRPC",
Self::AggregatedGrpc => "AGGREGATED_GRPC",
Self::AggregatedDeltaGrpc => "AGGREGATED_DELTA_GRPC",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"DEPRECATED_AND_UNAVAILABLE_DO_NOT_USE" => {
Some(Self::DeprecatedAndUnavailableDoNotUse)
}
"REST" => Some(Self::Rest),
"GRPC" => Some(Self::Grpc),
"DELTA_GRPC" => Some(Self::DeltaGrpc),
"AGGREGATED_GRPC" => Some(Self::AggregatedGrpc),
"AGGREGATED_DELTA_GRPC" => Some(Self::AggregatedDeltaGrpc),
_ => None,
}
}
}
}
impl ::prost::Name for ApiConfigSource {
const NAME: &'static str = "ApiConfigSource";
const PACKAGE: &'static str = "envoy.config.core.v3";
fn full_name() -> ::prost::alloc::string::String {
"envoy.config.core.v3.ApiConfigSource".into()
}
fn type_url() -> ::prost::alloc::string::String {
"type.googleapis.com/envoy.config.core.v3.ApiConfigSource".into()
}
}
/// Aggregated Discovery Service (ADS) options. This is currently empty, but when
/// set in :ref:`ConfigSource <envoy_v3_api_msg_config.core.v3.ConfigSource>` can be used to
/// specify that ADS is to be used.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct AggregatedConfigSource {}
impl ::prost::Name for AggregatedConfigSource {
const NAME: &'static str = "AggregatedConfigSource";
const PACKAGE: &'static str = "envoy.config.core.v3";
fn full_name() -> ::prost::alloc::string::String {
"envoy.config.core.v3.AggregatedConfigSource".into()
}
fn type_url() -> ::prost::alloc::string::String {
"type.googleapis.com/envoy.config.core.v3.AggregatedConfigSource".into()
}
}
/// \[#not-implemented-hide:\]
/// Self-referencing config source options. This is currently empty, but when
/// set in :ref:`ConfigSource <envoy_v3_api_msg_config.core.v3.ConfigSource>` can be used to
/// specify that other data can be obtained from the same server.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct SelfConfigSource {
/// API version for xDS transport protocol. This describes the xDS gRPC/REST
/// endpoint and version of \[Delta\]DiscoveryRequest/Response used on the wire.
#[prost(enumeration = "ApiVersion", tag = "1")]
pub transport_api_version: i32,
}
impl ::prost::Name for SelfConfigSource {
const NAME: &'static str = "SelfConfigSource";
const PACKAGE: &'static str = "envoy.config.core.v3";
fn full_name() -> ::prost::alloc::string::String {
"envoy.config.core.v3.SelfConfigSource".into()
}
fn type_url() -> ::prost::alloc::string::String {
"type.googleapis.com/envoy.config.core.v3.SelfConfigSource".into()
}
}
/// Rate Limit settings to be applied for discovery requests made by Envoy.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct RateLimitSettings {
/// Maximum number of tokens to be used for rate limiting discovery request calls. If not set, a
/// default value of 100 will be used.
#[prost(message, optional, tag = "1")]
pub max_tokens: ::core::option::Option<
super::super::super::super::google::protobuf::UInt32Value,
>,
/// Rate at which tokens will be filled per second. If not set, a default fill rate of 10 tokens
/// per second will be used. The minimal fill rate is once per year. Lower
/// fill rates will be set to once per year.
#[prost(message, optional, tag = "2")]
pub fill_rate: ::core::option::Option<
super::super::super::super::google::protobuf::DoubleValue,
>,
}
impl ::prost::Name for RateLimitSettings {
const NAME: &'static str = "RateLimitSettings";
const PACKAGE: &'static str = "envoy.config.core.v3";
fn full_name() -> ::prost::alloc::string::String {
"envoy.config.core.v3.RateLimitSettings".into()
}
fn type_url() -> ::prost::alloc::string::String {
"type.googleapis.com/envoy.config.core.v3.RateLimitSettings".into()
}
}
/// Local filesystem path configuration source.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct PathConfigSource {
/// Path on the filesystem to source and watch for configuration updates.
/// When sourcing configuration for a :ref:`secret <envoy_v3_api_msg_extensions.transport_sockets.tls.v3.Secret>`,
/// the certificate and key files are also watched for updates.
///
/// .. note::
///
/// The path to the source must exist at config load time.
///
/// .. note::
///
/// If ``watched_directory`` is *not* configured, Envoy will watch the file path for *moves*.
/// This is because in general only moves are atomic. The same method of swapping files as is
/// demonstrated in the :ref:`runtime documentation <config_runtime_symbolic_link_swap>` can be
/// used here also. If ``watched_directory`` is configured, no watch will be placed directly on
/// this path. Instead, the configured ``watched_directory`` will be used to trigger reloads of
/// this path. This is required in certain deployment scenarios. See below for more information.
#[prost(string, tag = "1")]
pub path: ::prost::alloc::string::String,
/// If configured, this directory will be watched for *moves*. When an entry in this directory is
/// moved to, the ``path`` will be reloaded. This is required in certain deployment scenarios.
///
/// Specifically, if trying to load an xDS resource using a
/// `Kubernetes ConfigMap <<https://kubernetes.io/docs/concepts/configuration/configmap/>`_,> the
/// following configuration might be used:
/// 1. Store xds.yaml inside a ConfigMap.
/// 2. Mount the ConfigMap to ``/config_map/xds``
/// 3. Configure path ``/config_map/xds/xds.yaml``
/// 4. Configure watched directory ``/config_map/xds``
///
/// The above configuration will ensure that Envoy watches the owning directory for moves which is
/// required due to how Kubernetes manages ConfigMap symbolic links during atomic updates.
#[prost(message, optional, tag = "2")]
pub watched_directory: ::core::option::Option<WatchedDirectory>,
}
impl ::prost::Name for PathConfigSource {
const NAME: &'static str = "PathConfigSource";
const PACKAGE: &'static str = "envoy.config.core.v3";
fn full_name() -> ::prost::alloc::string::String {
"envoy.config.core.v3.PathConfigSource".into()
}
fn type_url() -> ::prost::alloc::string::String {
"type.googleapis.com/envoy.config.core.v3.PathConfigSource".into()
}
}
/// Configuration for :ref:`listeners <config_listeners>`, :ref:`clusters
/// <config_cluster_manager>`, :ref:`routes
/// <envoy_v3_api_msg_config.route.v3.RouteConfiguration>`, :ref:`endpoints
/// <arch_overview_service_discovery>` etc. may either be sourced from the
/// filesystem or from an xDS API source. Filesystem configs are watched with
/// inotify for updates.
/// \[#next-free-field: 9\]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ConfigSource {
/// Authorities that this config source may be used for. An authority specified in a xdstp:// URL
/// is resolved to a ``ConfigSource`` prior to configuration fetch. This field provides the
/// association between authority name and configuration source.
/// \[#not-implemented-hide:\]
#[prost(message, repeated, tag = "7")]
pub authorities: ::prost::alloc::vec::Vec<
super::super::super::super::xds::core::v3::Authority,
>,
/// When this timeout is specified, Envoy will wait no longer than the specified time for first
/// config response on this xDS subscription during the :ref:`initialization process
/// <arch_overview_initialization>`. After reaching the timeout, Envoy will move to the next
/// initialization phase, even if the first config is not delivered yet. The timer is activated
/// when the xDS API subscription starts, and is disarmed on first config update or on error. 0
/// means no timeout - Envoy will wait indefinitely for the first xDS config (unless another
/// timeout applies). The default is 15s.
#[prost(message, optional, tag = "4")]
pub initial_fetch_timeout: ::core::option::Option<
super::super::super::super::google::protobuf::Duration,
>,
/// API version for xDS resources. This implies the type URLs that the client
/// will request for resources and the resource type that the client will in
/// turn expect to be delivered.
#[prost(enumeration = "ApiVersion", tag = "6")]
pub resource_api_version: i32,
#[prost(oneof = "config_source::ConfigSourceSpecifier", tags = "1, 8, 2, 3, 5")]
pub config_source_specifier: ::core::option::Option<
config_source::ConfigSourceSpecifier,
>,
}
/// Nested message and enum types in `ConfigSource`.
pub mod config_source {
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum ConfigSourceSpecifier {
/// Deprecated in favor of ``path_config_source``. Use that field instead.
#[prost(string, tag = "1")]
Path(::prost::alloc::string::String),
/// Local filesystem path configuration source.
#[prost(message, tag = "8")]
PathConfigSource(super::PathConfigSource),
/// API configuration source.
#[prost(message, tag = "2")]
ApiConfigSource(super::ApiConfigSource),
/// When set, ADS will be used to fetch resources. The ADS API configuration
/// source in the bootstrap configuration is used.
#[prost(message, tag = "3")]
Ads(super::AggregatedConfigSource),
/// \[#not-implemented-hide:\]
/// When set, the client will access the resources from the same server it got the
/// ConfigSource from, although not necessarily from the same stream. This is similar to the
/// :ref:`ads<envoy_v3_api_field.ConfigSource.ads>` field, except that the client may use a
/// different stream to the same server. As a result, this field can be used for things
/// like LRS that cannot be sent on an ADS stream. It can also be used to link from (e.g.)
/// LDS to RDS on the same server without requiring the management server to know its name
/// or required credentials.
/// [#next-major-version: In xDS v3, consider replacing the ads field with this one, since
/// this field can implicitly mean to use the same stream in the case where the ConfigSource
/// is provided via ADS and the specified data can also be obtained via ADS.]
#[prost(message, tag = "5")]
Self_(super::SelfConfigSource),
}
}
impl ::prost::Name for ConfigSource {
const NAME: &'static str = "ConfigSource";
const PACKAGE: &'static str = "envoy.config.core.v3";
fn full_name() -> ::prost::alloc::string::String {
"envoy.config.core.v3.ConfigSource".into()
}
fn type_url() -> ::prost::alloc::string::String {
"type.googleapis.com/envoy.config.core.v3.ConfigSource".into()
}
}
/// Configuration source specifier for a late-bound extension configuration. The
/// parent resource is warmed until all the initial extension configurations are
/// received, unless the flag to apply the default configuration is set.
/// Subsequent extension updates are atomic on a per-worker basis. Once an
/// extension configuration is applied to a request or a connection, it remains
/// constant for the duration of processing. If the initial delivery of the
/// extension configuration fails, due to a timeout for example, the optional
/// default configuration is applied. Without a default configuration, the
/// extension is disabled, until an extension configuration is received. The
/// behavior of a disabled extension depends on the context. For example, a
/// filter chain with a disabled extension filter rejects all incoming streams.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ExtensionConfigSource {
#[prost(message, optional, tag = "1")]
pub config_source: ::core::option::Option<ConfigSource>,
/// Optional default configuration to use as the initial configuration if
/// there is a failure to receive the initial extension configuration or if
/// ``apply_default_config_without_warming`` flag is set.
#[prost(message, optional, tag = "2")]
pub default_config: ::core::option::Option<
super::super::super::super::google::protobuf::Any,
>,
/// Use the default config as the initial configuration without warming and
/// waiting for the first discovery response. Requires the default configuration
/// to be supplied.
#[prost(bool, tag = "3")]
pub apply_default_config_without_warming: bool,
/// A set of permitted extension type URLs. Extension configuration updates are rejected
/// if they do not match any type URL in the set.
#[prost(string, repeated, tag = "4")]
pub type_urls: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
}
impl ::prost::Name for ExtensionConfigSource {
const NAME: &'static str = "ExtensionConfigSource";
const PACKAGE: &'static str = "envoy.config.core.v3";
fn full_name() -> ::prost::alloc::string::String {
"envoy.config.core.v3.ExtensionConfigSource".into()
}
fn type_url() -> ::prost::alloc::string::String {
"type.googleapis.com/envoy.config.core.v3.ExtensionConfigSource".into()
}
}
/// xDS API and non-xDS services version. This is used to describe both resource and transport
/// protocol versions (in distinct configuration fields).
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum ApiVersion {
/// When not specified, we assume v3; it is the only supported version.
Auto = 0,
/// Use xDS v2 API. This is no longer supported.
V2 = 1,
/// Use xDS v3 API.
V3 = 2,
}
impl ApiVersion {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
Self::Auto => "AUTO",
Self::V2 => "V2",
Self::V3 => "V3",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"AUTO" => Some(Self::Auto),
"V2" => Some(Self::V2),
"V3" => Some(Self::V3),
_ => None,
}
}
}
/// \[#not-implemented-hide:\]
/// Configuration of the event reporting service endpoint.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct EventServiceConfig {
#[prost(oneof = "event_service_config::ConfigSourceSpecifier", tags = "1")]
pub config_source_specifier: ::core::option::Option<
event_service_config::ConfigSourceSpecifier,
>,
}
/// Nested message and enum types in `EventServiceConfig`.
pub mod event_service_config {
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum ConfigSourceSpecifier {
/// Specifies the gRPC service that hosts the event reporting service.
#[prost(message, tag = "1")]
GrpcService(super::GrpcService),
}
}
impl ::prost::Name for EventServiceConfig {
const NAME: &'static str = "EventServiceConfig";
const PACKAGE: &'static str = "envoy.config.core.v3";
fn full_name() -> ::prost::alloc::string::String {
"envoy.config.core.v3.EventServiceConfig".into()
}
fn type_url() -> ::prost::alloc::string::String {
"type.googleapis.com/envoy.config.core.v3.EventServiceConfig".into()
}
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct HealthStatusSet {
/// An order-independent set of health status.
#[prost(enumeration = "HealthStatus", repeated, packed = "false", tag = "1")]
pub statuses: ::prost::alloc::vec::Vec<i32>,
}
impl ::prost::Name for HealthStatusSet {
const NAME: &'static str = "HealthStatusSet";
const PACKAGE: &'static str = "envoy.config.core.v3";
fn full_name() -> ::prost::alloc::string::String {
"envoy.config.core.v3.HealthStatusSet".into()
}
fn type_url() -> ::prost::alloc::string::String {
"type.googleapis.com/envoy.config.core.v3.HealthStatusSet".into()
}
}
/// \[#next-free-field: 27\]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct HealthCheck {
/// The time to wait for a health check response. If the timeout is reached the
/// health check attempt will be considered a failure.
#[prost(message, optional, tag = "1")]
pub timeout: ::core::option::Option<
super::super::super::super::google::protobuf::Duration,
>,
/// The interval between health checks.
#[prost(message, optional, tag = "2")]
pub interval: ::core::option::Option<
super::super::super::super::google::protobuf::Duration,
>,
/// An optional jitter amount in milliseconds. If specified, Envoy will start health
/// checking after for a random time in ms between 0 and initial_jitter. This only
/// applies to the first health check.
#[prost(message, optional, tag = "20")]
pub initial_jitter: ::core::option::Option<
super::super::super::super::google::protobuf::Duration,
>,
/// An optional jitter amount in milliseconds. If specified, during every
/// interval Envoy will add interval_jitter to the wait time.
#[prost(message, optional, tag = "3")]
pub interval_jitter: ::core::option::Option<
super::super::super::super::google::protobuf::Duration,
>,
/// An optional jitter amount as a percentage of interval_ms. If specified,
/// during every interval Envoy will add ``interval_ms`` *
/// ``interval_jitter_percent`` / 100 to the wait time.
///
/// If interval_jitter_ms and interval_jitter_percent are both set, both of
/// them will be used to increase the wait time.
#[prost(uint32, tag = "18")]
pub interval_jitter_percent: u32,
/// The number of unhealthy health checks required before a host is marked
/// unhealthy. Note that for ``http`` health checking if a host responds with a code not in
/// :ref:`expected_statuses <envoy_v3_api_field_config.core.v3.HealthCheck.HttpHealthCheck.expected_statuses>`
/// or :ref:`retriable_statuses <envoy_v3_api_field_config.core.v3.HealthCheck.HttpHealthCheck.retriable_statuses>`,
/// this threshold is ignored and the host is considered immediately unhealthy.
#[prost(message, optional, tag = "4")]
pub unhealthy_threshold: ::core::option::Option<
super::super::super::super::google::protobuf::UInt32Value,
>,
/// The number of healthy health checks required before a host is marked
/// healthy. Note that during startup, only a single successful health check is
/// required to mark a host healthy.
#[prost(message, optional, tag = "5")]
pub healthy_threshold: ::core::option::Option<
super::super::super::super::google::protobuf::UInt32Value,
>,
/// \[#not-implemented-hide:\] Non-serving port for health checking.
#[prost(message, optional, tag = "6")]
pub alt_port: ::core::option::Option<
super::super::super::super::google::protobuf::UInt32Value,
>,
/// Reuse health check connection between health checks. Default is true.
#[prost(message, optional, tag = "7")]
pub reuse_connection: ::core::option::Option<
super::super::super::super::google::protobuf::BoolValue,
>,
/// The "no traffic interval" is a special health check interval that is used when a cluster has
/// never had traffic routed to it. This lower interval allows cluster information to be kept up to
/// date, without sending a potentially large amount of active health checking traffic for no
/// reason. Once a cluster has been used for traffic routing, Envoy will shift back to using the
/// standard health check interval that is defined. Note that this interval takes precedence over
/// any other.
///
/// The default value for "no traffic interval" is 60 seconds.
#[prost(message, optional, tag = "12")]
pub no_traffic_interval: ::core::option::Option<
super::super::super::super::google::protobuf::Duration,
>,
/// The "no traffic healthy interval" is a special health check interval that
/// is used for hosts that are currently passing active health checking
/// (including new hosts) when the cluster has received no traffic.
///
/// This is useful for when we want to send frequent health checks with
/// ``no_traffic_interval`` but then revert to lower frequency ``no_traffic_healthy_interval`` once
/// a host in the cluster is marked as healthy.
///
/// Once a cluster has been used for traffic routing, Envoy will shift back to using the
/// standard health check interval that is defined.
///
/// If no_traffic_healthy_interval is not set, it will default to the
/// no traffic interval and send that interval regardless of health state.
#[prost(message, optional, tag = "24")]
pub no_traffic_healthy_interval: ::core::option::Option<
super::super::super::super::google::protobuf::Duration,
>,
/// The "unhealthy interval" is a health check interval that is used for hosts that are marked as
/// unhealthy. As soon as the host is marked as healthy, Envoy will shift back to using the
/// standard health check interval that is defined.
///
/// The default value for "unhealthy interval" is the same as "interval".
#[prost(message, optional, tag = "14")]
pub unhealthy_interval: ::core::option::Option<
super::super::super::super::google::protobuf::Duration,
>,
/// The "unhealthy edge interval" is a special health check interval that is used for the first
/// health check right after a host is marked as unhealthy. For subsequent health checks
/// Envoy will shift back to using either "unhealthy interval" if present or the standard health
/// check interval that is defined.
///
/// The default value for "unhealthy edge interval" is the same as "unhealthy interval".
#[prost(message, optional, tag = "15")]
pub unhealthy_edge_interval: ::core::option::Option<
super::super::super::super::google::protobuf::Duration,
>,
/// The "healthy edge interval" is a special health check interval that is used for the first
/// health check right after a host is marked as healthy. For subsequent health checks
/// Envoy will shift back to using the standard health check interval that is defined.
///
/// The default value for "healthy edge interval" is the same as the default interval.
#[prost(message, optional, tag = "16")]
pub healthy_edge_interval: ::core::option::Option<
super::super::super::super::google::protobuf::Duration,
>,
/// .. attention::
/// This field is deprecated in favor of the extension
/// :ref:`event_logger <envoy_v3_api_field_config.core.v3.HealthCheck.event_logger>` and
/// :ref:`event_log_path <envoy_v3_api_field_extensions.health_check.event_sinks.file.v3.HealthCheckEventFileSink.event_log_path>`
/// in the file sink extension.
///
/// Specifies the path to the :ref:`health check event log <arch_overview_health_check_logging>`.
#[deprecated]
#[prost(string, tag = "17")]
pub event_log_path: ::prost::alloc::string::String,
/// A list of event log sinks to process the health check event.
/// \[#extension-category: envoy.health_check.event_sinks\]
#[prost(message, repeated, tag = "25")]
pub event_logger: ::prost::alloc::vec::Vec<TypedExtensionConfig>,
/// \[#not-implemented-hide:\]
/// The gRPC service for the health check event service.
/// If empty, health check events won't be sent to a remote endpoint.
#[prost(message, optional, tag = "22")]
pub event_service: ::core::option::Option<EventServiceConfig>,
/// If set to true, health check failure events will always be logged. If set to false, only the
/// initial health check failure event will be logged.
/// The default value is false.
#[prost(bool, tag = "19")]
pub always_log_health_check_failures: bool,
/// If set to true, health check success events will always be logged. If set to false, only host addition event will be logged
/// if it is the first successful health check, or if the healthy threshold is reached.
/// The default value is false.
#[prost(bool, tag = "26")]
pub always_log_health_check_success: bool,
/// This allows overriding the cluster TLS settings, just for health check connections.
#[prost(message, optional, tag = "21")]
pub tls_options: ::core::option::Option<health_check::TlsOptions>,
/// Optional key/value pairs that will be used to match a transport socket from those specified in the cluster's
/// :ref:`tranport socket matches <envoy_v3_api_field_config.cluster.v3.Cluster.transport_socket_matches>`.
/// For example, the following match criteria
///
/// .. code-block:: yaml
///
/// transport_socket_match_criteria:
/// useMTLS: true
///
/// Will match the following :ref:`cluster socket match <envoy_v3_api_msg_config.cluster.v3.Cluster.TransportSocketMatch>`
///
/// .. code-block:: yaml
///
/// transport_socket_matches:
/// - name: "useMTLS"
/// match:
/// useMTLS: true
/// transport_socket:
/// name: envoy.transport_sockets.tls
/// config: { ... } # tls socket configuration
///
/// If this field is set, then for health checks it will supersede an entry of ``envoy.transport_socket`` in the
/// :ref:`LbEndpoint.Metadata <envoy_v3_api_field_config.endpoint.v3.LbEndpoint.metadata>`.
/// This allows using different transport socket capabilities for health checking versus proxying to the
/// endpoint.
///
/// If the key/values pairs specified do not match any
/// :ref:`transport socket matches <envoy_v3_api_field_config.cluster.v3.Cluster.transport_socket_matches>`,
/// the cluster's :ref:`transport socket <envoy_v3_api_field_config.cluster.v3.Cluster.transport_socket>`
/// will be used for health check socket configuration.
#[prost(message, optional, tag = "23")]
pub transport_socket_match_criteria: ::core::option::Option<
super::super::super::super::google::protobuf::Struct,
>,
#[prost(oneof = "health_check::HealthChecker", tags = "8, 9, 11, 13")]
pub health_checker: ::core::option::Option<health_check::HealthChecker>,
}
/// Nested message and enum types in `HealthCheck`.
pub mod health_check {
/// Describes the encoding of the payload bytes in the payload.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Payload {
#[prost(oneof = "payload::Payload", tags = "1, 2")]
pub payload: ::core::option::Option<payload::Payload>,
}
/// Nested message and enum types in `Payload`.
pub mod payload {
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum Payload {
/// Hex encoded payload. E.g., "000000FF".
#[prost(string, tag = "1")]
Text(::prost::alloc::string::String),
/// Binary payload.
#[prost(bytes, tag = "2")]
Binary(::prost::alloc::vec::Vec<u8>),
}
}
impl ::prost::Name for Payload {
const NAME: &'static str = "Payload";
const PACKAGE: &'static str = "envoy.config.core.v3";
fn full_name() -> ::prost::alloc::string::String {
"envoy.config.core.v3.HealthCheck.Payload".into()
}
fn type_url() -> ::prost::alloc::string::String {
"type.googleapis.com/envoy.config.core.v3.HealthCheck.Payload".into()
}
}
/// \[#next-free-field: 15\]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct HttpHealthCheck {
/// The value of the host header in the HTTP health check request. If
/// left empty (default value), the name of the cluster this health check is associated
/// with will be used. The host header can be customized for a specific endpoint by setting the
/// :ref:`hostname <envoy_v3_api_field_config.endpoint.v3.Endpoint.HealthCheckConfig.hostname>` field.
#[prost(string, tag = "1")]
pub host: ::prost::alloc::string::String,
/// Specifies the HTTP path that will be requested during health checking. For example
/// ``/healthcheck``.
#[prost(string, tag = "2")]
pub path: ::prost::alloc::string::String,
/// \[#not-implemented-hide:\] HTTP specific payload.
#[prost(message, optional, tag = "3")]
pub send: ::core::option::Option<Payload>,
/// Specifies a list of HTTP expected responses to match in the first ``response_buffer_size`` bytes of the response body.
/// If it is set, both the expected response check and status code determine the health check.
/// When checking the response, “fuzzy” matching is performed such that each payload block must be found,
/// and in the order specified, but not necessarily contiguous.
///
/// .. note::
///
/// It is recommended to set ``response_buffer_size`` based on the total Payload size for efficiency.
/// The default buffer size is 1024 bytes when it is not set.
#[prost(message, repeated, tag = "4")]
pub receive: ::prost::alloc::vec::Vec<Payload>,
/// Specifies the size of response buffer in bytes that is used to Payload match.
/// The default value is 1024. Setting to 0 implies that the Payload will be matched against the entire response.
#[prost(message, optional, tag = "14")]
pub response_buffer_size: ::core::option::Option<
super::super::super::super::super::google::protobuf::UInt64Value,
>,
/// Specifies a list of HTTP headers that should be added to each request that is sent to the
/// health checked cluster. For more information, including details on header value syntax, see
/// the documentation on :ref:`custom request headers
/// <config_http_conn_man_headers_custom_request_headers>`.
#[prost(message, repeated, tag = "6")]
pub request_headers_to_add: ::prost::alloc::vec::Vec<super::HeaderValueOption>,
/// Specifies a list of HTTP headers that should be removed from each request that is sent to the
/// health checked cluster.
#[prost(string, repeated, tag = "8")]
pub request_headers_to_remove: ::prost::alloc::vec::Vec<
::prost::alloc::string::String,
>,
/// Specifies a list of HTTP response statuses considered healthy. If provided, replaces default
/// 200-only policy - 200 must be included explicitly as needed. Ranges follow half-open
/// semantics of :ref:`Int64Range <envoy_v3_api_msg_type.v3.Int64Range>`. The start and end of each
/// range are required. Only statuses in the range [100, 600) are allowed.
#[prost(message, repeated, tag = "9")]
pub expected_statuses: ::prost::alloc::vec::Vec<
super::super::super::super::r#type::v3::Int64Range,
>,
/// Specifies a list of HTTP response statuses considered retriable. If provided, responses in this range
/// will count towards the configured :ref:`unhealthy_threshold <envoy_v3_api_field_config.core.v3.HealthCheck.unhealthy_threshold>`,
/// but will not result in the host being considered immediately unhealthy. Ranges follow half-open semantics of
/// :ref:`Int64Range <envoy_v3_api_msg_type.v3.Int64Range>`. The start and end of each range are required.
/// Only statuses in the range [100, 600) are allowed. The :ref:`expected_statuses <envoy_v3_api_field_config.core.v3.HealthCheck.HttpHealthCheck.expected_statuses>`
/// field takes precedence for any range overlaps with this field i.e. if status code 200 is both retriable and expected, a 200 response will
/// be considered a successful health check. By default all responses not in
/// :ref:`expected_statuses <envoy_v3_api_field_config.core.v3.HealthCheck.HttpHealthCheck.expected_statuses>` will result in
/// the host being considered immediately unhealthy i.e. if status code 200 is expected and there are no configured retriable statuses, any
/// non-200 response will result in the host being marked unhealthy.
#[prost(message, repeated, tag = "12")]
pub retriable_statuses: ::prost::alloc::vec::Vec<
super::super::super::super::r#type::v3::Int64Range,
>,
/// Use specified application protocol for health checks.
#[prost(
enumeration = "super::super::super::super::r#type::v3::CodecClientType",
tag = "10"
)]
pub codec_client_type: i32,
/// An optional service name parameter which is used to validate the identity of
/// the health checked cluster using a :ref:`StringMatcher
/// <envoy_v3_api_msg_type.matcher.v3.StringMatcher>`. See the :ref:`architecture overview
/// <arch_overview_health_checking_identity>` for more information.
#[prost(message, optional, tag = "11")]
pub service_name_matcher: ::core::option::Option<
super::super::super::super::r#type::matcher::v3::StringMatcher,
>,
/// HTTP Method that will be used for health checking, default is "GET".
/// GET, HEAD, POST, PUT, DELETE, OPTIONS, TRACE, PATCH methods are supported, but making request body is not supported.
/// CONNECT method is disallowed because it is not appropriate for health check request.
/// If a non-200 response is expected by the method, it needs to be set in :ref:`expected_statuses <envoy_v3_api_field_config.core.v3.HealthCheck.HttpHealthCheck.expected_statuses>`.
#[prost(enumeration = "super::RequestMethod", tag = "13")]
pub method: i32,
}
impl ::prost::Name for HttpHealthCheck {
const NAME: &'static str = "HttpHealthCheck";
const PACKAGE: &'static str = "envoy.config.core.v3";
fn full_name() -> ::prost::alloc::string::String {
"envoy.config.core.v3.HealthCheck.HttpHealthCheck".into()
}
fn type_url() -> ::prost::alloc::string::String {
"type.googleapis.com/envoy.config.core.v3.HealthCheck.HttpHealthCheck".into()
}
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct TcpHealthCheck {
/// Empty payloads imply a connect-only health check.
#[prost(message, optional, tag = "1")]
pub send: ::core::option::Option<Payload>,
/// When checking the response, “fuzzy” matching is performed such that each
/// payload block must be found, and in the order specified, but not
/// necessarily contiguous.
#[prost(message, repeated, tag = "2")]
pub receive: ::prost::alloc::vec::Vec<Payload>,
/// When setting this value, it tries to attempt health check request with ProxyProtocol.
/// When ``send`` is presented, they are sent after preceding ProxyProtocol header.
/// Only ProxyProtocol header is sent when ``send`` is not presented.
/// It allows to use both ProxyProtocol V1 and V2. In V1, it presents L3/L4. In V2, it includes
/// LOCAL command and doesn't include L3/L4.
#[prost(message, optional, tag = "3")]
pub proxy_protocol_config: ::core::option::Option<super::ProxyProtocolConfig>,
}
impl ::prost::Name for TcpHealthCheck {
const NAME: &'static str = "TcpHealthCheck";
const PACKAGE: &'static str = "envoy.config.core.v3";
fn full_name() -> ::prost::alloc::string::String {
"envoy.config.core.v3.HealthCheck.TcpHealthCheck".into()
}
fn type_url() -> ::prost::alloc::string::String {
"type.googleapis.com/envoy.config.core.v3.HealthCheck.TcpHealthCheck".into()
}
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct RedisHealthCheck {
/// If set, optionally perform ``EXISTS <key>`` instead of ``PING``. A return value
/// from Redis of 0 (does not exist) is considered a passing healthcheck. A return value other
/// than 0 is considered a failure. This allows the user to mark a Redis instance for maintenance
/// by setting the specified key to any value and waiting for traffic to drain.
#[prost(string, tag = "1")]
pub key: ::prost::alloc::string::String,
}
impl ::prost::Name for RedisHealthCheck {
const NAME: &'static str = "RedisHealthCheck";
const PACKAGE: &'static str = "envoy.config.core.v3";
fn full_name() -> ::prost::alloc::string::String {
"envoy.config.core.v3.HealthCheck.RedisHealthCheck".into()
}
fn type_url() -> ::prost::alloc::string::String {
"type.googleapis.com/envoy.config.core.v3.HealthCheck.RedisHealthCheck"
.into()
}
}
/// `grpc.health.v1.Health
/// <<https://github.com/grpc/grpc/blob/master/src/proto/grpc/health/v1/health.proto>`_-based>
/// healthcheck. See `gRPC doc <<https://github.com/grpc/grpc/blob/master/doc/health-checking.md>`_>
/// for details.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GrpcHealthCheck {
/// An optional service name parameter which will be sent to gRPC service in
/// `grpc.health.v1.HealthCheckRequest
/// <<https://github.com/grpc/grpc/blob/master/src/proto/grpc/health/v1/health.proto#L20>`_.>
/// message. See `gRPC health-checking overview
/// <<https://github.com/grpc/grpc/blob/master/doc/health-checking.md>`_> for more information.
#[prost(string, tag = "1")]
pub service_name: ::prost::alloc::string::String,
/// The value of the :authority header in the gRPC health check request. If
/// left empty (default value), the name of the cluster this health check is associated
/// with will be used. The authority header can be customized for a specific endpoint by setting
/// the :ref:`hostname <envoy_v3_api_field_config.endpoint.v3.Endpoint.HealthCheckConfig.hostname>` field.
#[prost(string, tag = "2")]
pub authority: ::prost::alloc::string::String,
/// Specifies a list of key-value pairs that should be added to the metadata of each GRPC call
/// that is sent to the health checked cluster. For more information, including details on header value syntax,
/// see the documentation on :ref:`custom request headers
/// <config_http_conn_man_headers_custom_request_headers>`.
#[prost(message, repeated, tag = "3")]
pub initial_metadata: ::prost::alloc::vec::Vec<super::HeaderValueOption>,
}
impl ::prost::Name for GrpcHealthCheck {
const NAME: &'static str = "GrpcHealthCheck";
const PACKAGE: &'static str = "envoy.config.core.v3";
fn full_name() -> ::prost::alloc::string::String {
"envoy.config.core.v3.HealthCheck.GrpcHealthCheck".into()
}
fn type_url() -> ::prost::alloc::string::String {
"type.googleapis.com/envoy.config.core.v3.HealthCheck.GrpcHealthCheck".into()
}
}
/// Custom health check.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CustomHealthCheck {
/// The registered name of the custom health checker.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// A custom health checker specific configuration which depends on the custom health checker
/// being instantiated. See :api:`envoy/config/health_checker` for reference.
/// \[#extension-category: envoy.health_checkers\]
#[prost(oneof = "custom_health_check::ConfigType", tags = "3")]
pub config_type: ::core::option::Option<custom_health_check::ConfigType>,
}
/// Nested message and enum types in `CustomHealthCheck`.
pub mod custom_health_check {
/// A custom health checker specific configuration which depends on the custom health checker
/// being instantiated. See :api:`envoy/config/health_checker` for reference.
/// \[#extension-category: envoy.health_checkers\]
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum ConfigType {
#[prost(message, tag = "3")]
TypedConfig(super::super::super::super::super::super::google::protobuf::Any),
}
}
impl ::prost::Name for CustomHealthCheck {
const NAME: &'static str = "CustomHealthCheck";
const PACKAGE: &'static str = "envoy.config.core.v3";
fn full_name() -> ::prost::alloc::string::String {
"envoy.config.core.v3.HealthCheck.CustomHealthCheck".into()
}
fn type_url() -> ::prost::alloc::string::String {
"type.googleapis.com/envoy.config.core.v3.HealthCheck.CustomHealthCheck"
.into()
}
}
/// Health checks occur over the transport socket specified for the cluster. This implies that if a
/// cluster is using a TLS-enabled transport socket, the health check will also occur over TLS.
///
/// This allows overriding the cluster TLS settings, just for health check connections.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct TlsOptions {
/// Specifies the ALPN protocols for health check connections. This is useful if the
/// corresponding upstream is using ALPN-based :ref:`FilterChainMatch
/// <envoy_v3_api_msg_config.listener.v3.FilterChainMatch>` along with different protocols for health checks
/// versus data connections. If empty, no ALPN protocols will be set on health check connections.
#[prost(string, repeated, tag = "1")]
pub alpn_protocols: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
}
impl ::prost::Name for TlsOptions {
const NAME: &'static str = "TlsOptions";
const PACKAGE: &'static str = "envoy.config.core.v3";
fn full_name() -> ::prost::alloc::string::String {
"envoy.config.core.v3.HealthCheck.TlsOptions".into()
}
fn type_url() -> ::prost::alloc::string::String {
"type.googleapis.com/envoy.config.core.v3.HealthCheck.TlsOptions".into()
}
}
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum HealthChecker {
/// HTTP health check.
#[prost(message, tag = "8")]
HttpHealthCheck(HttpHealthCheck),
/// TCP health check.
#[prost(message, tag = "9")]
TcpHealthCheck(TcpHealthCheck),
/// gRPC health check.
#[prost(message, tag = "11")]
GrpcHealthCheck(GrpcHealthCheck),
/// Custom health check.
#[prost(message, tag = "13")]
CustomHealthCheck(CustomHealthCheck),
}
}
impl ::prost::Name for HealthCheck {
const NAME: &'static str = "HealthCheck";
const PACKAGE: &'static str = "envoy.config.core.v3";
fn full_name() -> ::prost::alloc::string::String {
"envoy.config.core.v3.HealthCheck".into()
}
fn type_url() -> ::prost::alloc::string::String {
"type.googleapis.com/envoy.config.core.v3.HealthCheck".into()
}
}
/// Endpoint health status.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum HealthStatus {
/// The health status is not known. This is interpreted by Envoy as ``HEALTHY``.
Unknown = 0,
/// Healthy.
Healthy = 1,
/// Unhealthy.
Unhealthy = 2,
/// Connection draining in progress. E.g.,
/// `<<https://aws.amazon.com/blogs/aws/elb-connection-draining-remove-instances-from-service-with-care/>`_>
/// or
/// `<<https://cloud.google.com/compute/docs/load-balancing/enabling-connection-draining>`_.>
/// This is interpreted by Envoy as ``UNHEALTHY``.
Draining = 3,
/// Health check timed out. This is part of HDS and is interpreted by Envoy as
/// ``UNHEALTHY``.
Timeout = 4,
/// Degraded.
Degraded = 5,
}
impl HealthStatus {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
Self::Unknown => "UNKNOWN",
Self::Healthy => "HEALTHY",
Self::Unhealthy => "UNHEALTHY",
Self::Draining => "DRAINING",
Self::Timeout => "TIMEOUT",
Self::Degraded => "DEGRADED",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"UNKNOWN" => Some(Self::Unknown),
"HEALTHY" => Some(Self::Healthy),
"UNHEALTHY" => Some(Self::Unhealthy),
"DRAINING" => Some(Self::Draining),
"TIMEOUT" => Some(Self::Timeout),
"DEGRADED" => Some(Self::Degraded),
_ => None,
}
}
}
/// \[#not-implemented-hide:\]
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct TcpProtocolOptions {}
impl ::prost::Name for TcpProtocolOptions {
const NAME: &'static str = "TcpProtocolOptions";
const PACKAGE: &'static str = "envoy.config.core.v3";
fn full_name() -> ::prost::alloc::string::String {
"envoy.config.core.v3.TcpProtocolOptions".into()
}
fn type_url() -> ::prost::alloc::string::String {
"type.googleapis.com/envoy.config.core.v3.TcpProtocolOptions".into()
}
}
/// Config for keepalive probes in a QUIC connection.
/// Note that QUIC keep-alive probing packets work differently from HTTP/2 keep-alive PINGs in a sense that the probing packet
/// itself doesn't timeout waiting for a probing response. Quic has a shorter idle timeout than TCP, so it doesn't rely on such probing to discover dead connections. If the peer fails to respond, the connection will idle timeout eventually. Thus, they are configured differently from :ref:`connection_keepalive <envoy_v3_api_field_config.core.v3.Http2ProtocolOptions.connection_keepalive>`.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct QuicKeepAliveSettings {
/// The max interval for a connection to send keep-alive probing packets (with PING or PATH_RESPONSE). The value should be smaller than :ref:`connection idle_timeout <envoy_v3_api_field_config.listener.v3.QuicProtocolOptions.idle_timeout>` to prevent idle timeout while not less than 1s to avoid throttling the connection or flooding the peer with probes.
///
/// If :ref:`initial_interval <envoy_v3_api_field_config.core.v3.QuicKeepAliveSettings.initial_interval>` is absent or zero, a client connection will use this value to start probing.
///
/// If zero, disable keepalive probing.
/// If absent, use the QUICHE default interval to probe.
#[prost(message, optional, tag = "1")]
pub max_interval: ::core::option::Option<
super::super::super::super::google::protobuf::Duration,
>,
/// The interval to send the first few keep-alive probing packets to prevent connection from hitting the idle timeout. Subsequent probes will be sent, each one with an interval exponentially longer than previous one, till it reaches :ref:`max_interval <envoy_v3_api_field_config.core.v3.QuicKeepAliveSettings.max_interval>`. And the probes afterwards will always use :ref:`max_interval <envoy_v3_api_field_config.core.v3.QuicKeepAliveSettings.max_interval>`.
///
/// The value should be smaller than :ref:`connection idle_timeout <envoy_v3_api_field_config.listener.v3.QuicProtocolOptions.idle_timeout>` to prevent idle timeout and smaller than max_interval to take effect.
///
/// If absent or zero, disable keepalive probing for a server connection. For a client connection, if :ref:`max_interval <envoy_v3_api_field_config.core.v3.QuicKeepAliveSettings.max_interval>` is also zero, do not keepalive, otherwise use max_interval or QUICHE default to probe all the time.
#[prost(message, optional, tag = "2")]
pub initial_interval: ::core::option::Option<
super::super::super::super::google::protobuf::Duration,
>,
}
impl ::prost::Name for QuicKeepAliveSettings {
const NAME: &'static str = "QuicKeepAliveSettings";
const PACKAGE: &'static str = "envoy.config.core.v3";
fn full_name() -> ::prost::alloc::string::String {
"envoy.config.core.v3.QuicKeepAliveSettings".into()
}
fn type_url() -> ::prost::alloc::string::String {
"type.googleapis.com/envoy.config.core.v3.QuicKeepAliveSettings".into()
}
}
/// QUIC protocol options which apply to both downstream and upstream connections.
/// \[#next-free-field: 9\]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct QuicProtocolOptions {
/// Maximum number of streams that the client can negotiate per connection. 100
/// if not specified.
#[prost(message, optional, tag = "1")]
pub max_concurrent_streams: ::core::option::Option<
super::super::super::super::google::protobuf::UInt32Value,
>,
/// `Initial stream-level flow-control receive window
/// <<https://tools.ietf.org/html/draft-ietf-quic-transport-34#section-4.1>`_> size. Valid values range from
/// 1 to 16777216 (2^24, maximum supported by QUICHE) and defaults to 16777216 (16 * 1024 * 1024).
///
/// NOTE: 16384 (2^14) is the minimum window size supported in Google QUIC. If configured smaller than it, we will use 16384 instead.
/// QUICHE IETF Quic implementation supports 1 bytes window. We only support increasing the default window size now, so it's also the minimum.
///
/// This field also acts as a soft limit on the number of bytes Envoy will buffer per-stream in the
/// QUIC stream send and receive buffers. Once the buffer reaches this pointer, watermark callbacks will fire to
/// stop the flow of data to the stream buffers.
#[prost(message, optional, tag = "2")]
pub initial_stream_window_size: ::core::option::Option<
super::super::super::super::google::protobuf::UInt32Value,
>,
/// Similar to ``initial_stream_window_size``, but for connection-level
/// flow-control. Valid values rage from 1 to 25165824 (24MB, maximum supported by QUICHE) and defaults
/// to 25165824 (24 * 1024 * 1024).
///
/// NOTE: 16384 (2^14) is the minimum window size supported in Google QUIC. We only support increasing the default
/// window size now, so it's also the minimum.
#[prost(message, optional, tag = "3")]
pub initial_connection_window_size: ::core::option::Option<
super::super::super::super::google::protobuf::UInt32Value,
>,
/// The number of timeouts that can occur before port migration is triggered for QUIC clients.
/// This defaults to 4. If set to 0, port migration will not occur on path degrading.
/// Timeout here refers to QUIC internal path degrading timeout mechanism, such as PTO.
/// This has no effect on server sessions.
#[prost(message, optional, tag = "4")]
pub num_timeouts_to_trigger_port_migration: ::core::option::Option<
super::super::super::super::google::protobuf::UInt32Value,
>,
/// Probes the peer at the configured interval to solicit traffic, i.e. ACK or PATH_RESPONSE, from the peer to push back connection idle timeout.
/// If absent, use the default keepalive behavior of which a client connection sends PINGs every 15s, and a server connection doesn't do anything.
#[prost(message, optional, tag = "5")]
pub connection_keepalive: ::core::option::Option<QuicKeepAliveSettings>,
/// A comma-separated list of strings representing QUIC connection options defined in
/// `QUICHE <<https://github.com/google/quiche/blob/main/quiche/quic/core/crypto/crypto_protocol.h>`_> and to be sent by upstream connections.
#[prost(string, tag = "6")]
pub connection_options: ::prost::alloc::string::String,
/// A comma-separated list of strings representing QUIC client connection options defined in
/// `QUICHE <<https://github.com/google/quiche/blob/main/quiche/quic/core/crypto/crypto_protocol.h>`_> and to be sent by upstream connections.
#[prost(string, tag = "7")]
pub client_connection_options: ::prost::alloc::string::String,
/// The duration that a QUIC connection stays idle before it closes itself. If this field is not present, QUICHE
/// default 600s will be applied.
/// For internal corporate network, a long timeout is often fine.
/// But for client facing network, 30s is usually a good choice.
#[prost(message, optional, tag = "8")]
pub idle_network_timeout: ::core::option::Option<
super::super::super::super::google::protobuf::Duration,
>,
}
impl ::prost::Name for QuicProtocolOptions {
const NAME: &'static str = "QuicProtocolOptions";
const PACKAGE: &'static str = "envoy.config.core.v3";
fn full_name() -> ::prost::alloc::string::String {
"envoy.config.core.v3.QuicProtocolOptions".into()
}
fn type_url() -> ::prost::alloc::string::String {
"type.googleapis.com/envoy.config.core.v3.QuicProtocolOptions".into()
}
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct UpstreamHttpProtocolOptions {
/// Set transport socket `SNI <<https://en.wikipedia.org/wiki/Server_Name_Indication>`_> for new
/// upstream connections based on the downstream HTTP host/authority header or any other arbitrary
/// header when :ref:`override_auto_sni_header <envoy_v3_api_field_config.core.v3.UpstreamHttpProtocolOptions.override_auto_sni_header>`
/// is set, as seen by the :ref:`router filter <config_http_filters_router>`.
/// Does nothing if a filter before the http router filter sets the corresponding metadata.
#[prost(bool, tag = "1")]
pub auto_sni: bool,
/// Automatic validate upstream presented certificate for new upstream connections based on the
/// downstream HTTP host/authority header or any other arbitrary header when :ref:`override_auto_sni_header <envoy_v3_api_field_config.core.v3.UpstreamHttpProtocolOptions.override_auto_sni_header>`
/// is set, as seen by the :ref:`router filter <config_http_filters_router>`.
/// This field is intended to be set with ``auto_sni`` field.
/// Does nothing if a filter before the http router filter sets the corresponding metadata.
#[prost(bool, tag = "2")]
pub auto_san_validation: bool,
/// An optional alternative to the host/authority header to be used for setting the SNI value.
/// It should be a valid downstream HTTP header, as seen by the
/// :ref:`router filter <config_http_filters_router>`.
/// If unset, host/authority header will be used for populating the SNI. If the specified header
/// is not found or the value is empty, host/authority header will be used instead.
/// This field is intended to be set with ``auto_sni`` and/or ``auto_san_validation`` fields.
/// If none of these fields are set then setting this would be a no-op.
/// Does nothing if a filter before the http router filter sets the corresponding metadata.
#[prost(string, tag = "3")]
pub override_auto_sni_header: ::prost::alloc::string::String,
}
impl ::prost::Name for UpstreamHttpProtocolOptions {
const NAME: &'static str = "UpstreamHttpProtocolOptions";
const PACKAGE: &'static str = "envoy.config.core.v3";
fn full_name() -> ::prost::alloc::string::String {
"envoy.config.core.v3.UpstreamHttpProtocolOptions".into()
}
fn type_url() -> ::prost::alloc::string::String {
"type.googleapis.com/envoy.config.core.v3.UpstreamHttpProtocolOptions".into()
}
}
/// Configures the alternate protocols cache which tracks alternate protocols that can be used to
/// make an HTTP connection to an origin server. See <https://tools.ietf.org/html/rfc7838> for
/// HTTP Alternative Services and <https://datatracker.ietf.org/doc/html/draft-ietf-dnsop-svcb-https-04>
/// for the "HTTPS" DNS resource record.
/// \[#next-free-field: 6\]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct AlternateProtocolsCacheOptions {
/// The name of the cache. Multiple named caches allow independent alternate protocols cache
/// configurations to operate within a single Envoy process using different configurations. All
/// alternate protocols cache options with the same name *must* be equal in all fields when
/// referenced from different configuration components. Configuration will fail to load if this is
/// not the case.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// The maximum number of entries that the cache will hold. If not specified defaults to 1024.
///
/// .. note:
///
/// The implementation is approximate and enforced independently on each worker thread, thus
/// it is possible for the maximum entries in the cache to go slightly above the configured
/// value depending on timing. This is similar to how other circuit breakers work.
#[prost(message, optional, tag = "2")]
pub max_entries: ::core::option::Option<
super::super::super::super::google::protobuf::UInt32Value,
>,
/// Allows configuring a persistent
/// :ref:`key value store <envoy_v3_api_msg_config.common.key_value.v3.KeyValueStoreConfig>` to flush
/// alternate protocols entries to disk.
/// This function is currently only supported if concurrency is 1
/// Cached entries will take precedence over pre-populated entries below.
#[prost(message, optional, tag = "3")]
pub key_value_store_config: ::core::option::Option<TypedExtensionConfig>,
/// Allows pre-populating the cache with entries, as described above.
#[prost(message, repeated, tag = "4")]
pub prepopulated_entries: ::prost::alloc::vec::Vec<
alternate_protocols_cache_options::AlternateProtocolsCacheEntry,
>,
/// Optional list of hostnames suffixes for which Alt-Svc entries can be shared. For example, if
/// this list contained the value ``.c.example.com``, then an Alt-Svc entry for ``foo.c.example.com``
/// could be shared with ``bar.c.example.com`` but would not be shared with ``baz.example.com``. On
/// the other hand, if the list contained the value ``.example.com`` then all three hosts could share
/// Alt-Svc entries. Each entry must start with ``.``. If a hostname matches multiple suffixes, the
/// first listed suffix will be used.
///
/// Since lookup in this list is O(n), it is recommended that the number of suffixes be limited.
/// \[#not-implemented-hide:\]
#[prost(string, repeated, tag = "5")]
pub canonical_suffixes: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
}
/// Nested message and enum types in `AlternateProtocolsCacheOptions`.
pub mod alternate_protocols_cache_options {
/// Allows pre-populating the cache with HTTP/3 alternate protocols entries with a 7 day lifetime.
/// This will cause Envoy to attempt HTTP/3 to those upstreams, even if the upstreams have not
/// advertised HTTP/3 support. These entries will be overwritten by alt-svc
/// response headers or cached values.
/// As with regular cached entries, if the origin response would result in clearing an existing
/// alternate protocol cache entry, pre-populated entries will also be cleared.
/// Adding a cache entry with hostname=foo.com port=123 is the equivalent of getting
/// response headers
/// alt-svc: h3=:"123"; ma=86400" in a response to a request to foo.com:123
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct AlternateProtocolsCacheEntry {
/// The host name for the alternate protocol entry.
#[prost(string, tag = "1")]
pub hostname: ::prost::alloc::string::String,
/// The port for the alternate protocol entry.
#[prost(uint32, tag = "2")]
pub port: u32,
}
impl ::prost::Name for AlternateProtocolsCacheEntry {
const NAME: &'static str = "AlternateProtocolsCacheEntry";
const PACKAGE: &'static str = "envoy.config.core.v3";
fn full_name() -> ::prost::alloc::string::String {
"envoy.config.core.v3.AlternateProtocolsCacheOptions.AlternateProtocolsCacheEntry"
.into()
}
fn type_url() -> ::prost::alloc::string::String {
"type.googleapis.com/envoy.config.core.v3.AlternateProtocolsCacheOptions.AlternateProtocolsCacheEntry"
.into()
}
}
}
impl ::prost::Name for AlternateProtocolsCacheOptions {
const NAME: &'static str = "AlternateProtocolsCacheOptions";
const PACKAGE: &'static str = "envoy.config.core.v3";
fn full_name() -> ::prost::alloc::string::String {
"envoy.config.core.v3.AlternateProtocolsCacheOptions".into()
}
fn type_url() -> ::prost::alloc::string::String {
"type.googleapis.com/envoy.config.core.v3.AlternateProtocolsCacheOptions".into()
}
}
/// \[#next-free-field: 7\]
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct HttpProtocolOptions {
/// The idle timeout for connections. The idle timeout is defined as the
/// period in which there are no active requests. When the
/// idle timeout is reached the connection will be closed. If the connection is an HTTP/2
/// downstream connection a drain sequence will occur prior to closing the connection, see
/// :ref:`drain_timeout
/// <envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.HttpConnectionManager.drain_timeout>`.
/// Note that request based timeouts mean that HTTP/2 PINGs will not keep the connection alive.
/// If not specified, this defaults to 1 hour. To disable idle timeouts explicitly set this to 0.
///
/// .. warning::
/// Disabling this timeout has a highly likelihood of yielding connection leaks due to lost TCP
/// FIN packets, etc.
///
/// If the :ref:`overload action <config_overload_manager_overload_actions>` "envoy.overload_actions.reduce_timeouts"
/// is configured, this timeout is scaled for downstream connections according to the value for
/// :ref:`HTTP_DOWNSTREAM_CONNECTION_IDLE <envoy_v3_api_enum_value_config.overload.v3.ScaleTimersOverloadActionConfig.TimerType.HTTP_DOWNSTREAM_CONNECTION_IDLE>`.
#[prost(message, optional, tag = "1")]
pub idle_timeout: ::core::option::Option<
super::super::super::super::google::protobuf::Duration,
>,
/// The maximum duration of a connection. The duration is defined as a period since a connection
/// was established. If not set, there is no max duration. When max_connection_duration is reached
/// and if there are no active streams, the connection will be closed. If the connection is a
/// downstream connection and there are any active streams, the drain sequence will kick-in,
/// and the connection will be force-closed after the drain period. See :ref:`drain_timeout
/// <envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.HttpConnectionManager.drain_timeout>`.
#[prost(message, optional, tag = "3")]
pub max_connection_duration: ::core::option::Option<
super::super::super::super::google::protobuf::Duration,
>,
/// The maximum number of headers. If unconfigured, the default
/// maximum number of request headers allowed is 100. Requests that exceed this limit will receive
/// a 431 response for HTTP/1.x and cause a stream reset for HTTP/2.
#[prost(message, optional, tag = "2")]
pub max_headers_count: ::core::option::Option<
super::super::super::super::google::protobuf::UInt32Value,
>,
/// Total duration to keep alive an HTTP request/response stream. If the time limit is reached the stream will be
/// reset independent of any other timeouts. If not specified, this value is not set.
#[prost(message, optional, tag = "4")]
pub max_stream_duration: ::core::option::Option<
super::super::super::super::google::protobuf::Duration,
>,
/// Action to take when a client request with a header name containing underscore characters is received.
/// If this setting is not specified, the value defaults to ALLOW.
/// Note: upstream responses are not affected by this setting.
/// Note: this only affects client headers. It does not affect headers added
/// by Envoy filters and does not have any impact if added to cluster config.
#[prost(
enumeration = "http_protocol_options::HeadersWithUnderscoresAction",
tag = "5"
)]
pub headers_with_underscores_action: i32,
/// Optional maximum requests for both upstream and downstream connections.
/// If not specified, there is no limit.
/// Setting this parameter to 1 will effectively disable keep alive.
/// For HTTP/2 and HTTP/3, due to concurrent stream processing, the limit is approximate.
#[prost(message, optional, tag = "6")]
pub max_requests_per_connection: ::core::option::Option<
super::super::super::super::google::protobuf::UInt32Value,
>,
}
/// Nested message and enum types in `HttpProtocolOptions`.
pub mod http_protocol_options {
/// Action to take when Envoy receives client request with header names containing underscore
/// characters.
/// Underscore character is allowed in header names by the RFC-7230 and this behavior is implemented
/// as a security measure due to systems that treat '_' and '-' as interchangeable. Envoy by default allows client request headers with underscore
/// characters.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum HeadersWithUnderscoresAction {
/// Allow headers with underscores. This is the default behavior.
Allow = 0,
/// Reject client request. HTTP/1 requests are rejected with the 400 status. HTTP/2 requests
/// end with the stream reset. The "httpN.requests_rejected_with_underscores_in_headers" counter
/// is incremented for each rejected request.
RejectRequest = 1,
/// Drop the client header with name containing underscores. The header is dropped before the filter chain is
/// invoked and as such filters will not see dropped headers. The
/// "httpN.dropped_headers_with_underscores" is incremented for each dropped header.
DropHeader = 2,
}
impl HeadersWithUnderscoresAction {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
Self::Allow => "ALLOW",
Self::RejectRequest => "REJECT_REQUEST",
Self::DropHeader => "DROP_HEADER",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"ALLOW" => Some(Self::Allow),
"REJECT_REQUEST" => Some(Self::RejectRequest),
"DROP_HEADER" => Some(Self::DropHeader),
_ => None,
}
}
}
}
impl ::prost::Name for HttpProtocolOptions {
const NAME: &'static str = "HttpProtocolOptions";
const PACKAGE: &'static str = "envoy.config.core.v3";
fn full_name() -> ::prost::alloc::string::String {
"envoy.config.core.v3.HttpProtocolOptions".into()
}
fn type_url() -> ::prost::alloc::string::String {
"type.googleapis.com/envoy.config.core.v3.HttpProtocolOptions".into()
}
}
/// \[#next-free-field: 11\]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Http1ProtocolOptions {
/// Handle HTTP requests with absolute URLs in the requests. These requests
/// are generally sent by clients to forward/explicit proxies. This allows clients to configure
/// envoy as their HTTP proxy. In Unix, for example, this is typically done by setting the
/// ``http_proxy`` environment variable.
#[prost(message, optional, tag = "1")]
pub allow_absolute_url: ::core::option::Option<
super::super::super::super::google::protobuf::BoolValue,
>,
/// Handle incoming HTTP/1.0 and HTTP 0.9 requests.
/// This is off by default, and not fully standards compliant. There is support for pre-HTTP/1.1
/// style connect logic, dechunking, and handling lack of client host iff
/// ``default_host_for_http_10`` is configured.
#[prost(bool, tag = "2")]
pub accept_http_10: bool,
/// A default host for HTTP/1.0 requests. This is highly suggested if ``accept_http_10`` is true as
/// Envoy does not otherwise support HTTP/1.0 without a Host header.
/// This is a no-op if ``accept_http_10`` is not true.
#[prost(string, tag = "3")]
pub default_host_for_http_10: ::prost::alloc::string::String,
/// Describes how the keys for response headers should be formatted. By default, all header keys
/// are lower cased.
#[prost(message, optional, tag = "4")]
pub header_key_format: ::core::option::Option<
http1_protocol_options::HeaderKeyFormat,
>,
/// Enables trailers for HTTP/1. By default the HTTP/1 codec drops proxied trailers.
///
/// .. attention::
///
/// Note that this only happens when Envoy is chunk encoding which occurs when:
/// - The request is HTTP/1.1.
/// - Is neither a HEAD only request nor a HTTP Upgrade.
/// - Not a response to a HEAD request.
/// - The content length header is not present.
#[prost(bool, tag = "5")]
pub enable_trailers: bool,
/// Allows Envoy to process requests/responses with both ``Content-Length`` and ``Transfer-Encoding``
/// headers set. By default such messages are rejected, but if option is enabled - Envoy will
/// remove Content-Length header and process message.
/// See `RFC7230, sec. 3.3.3 <<https://tools.ietf.org/html/rfc7230#section-3.3.3>`_> for details.
///
/// .. attention::
/// Enabling this option might lead to request smuggling vulnerability, especially if traffic
/// is proxied via multiple layers of proxies.
/// [#comment:TODO: This field is ignored when the
/// :ref:`header validation configuration <envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.HttpConnectionManager.typed_header_validation_config>`
/// is present.]
#[prost(bool, tag = "6")]
pub allow_chunked_length: bool,
/// Allows invalid HTTP messaging. When this option is false, then Envoy will terminate
/// HTTP/1.1 connections upon receiving an invalid HTTP message. However,
/// when this option is true, then Envoy will leave the HTTP/1.1 connection
/// open where possible.
/// If set, this overrides any HCM :ref:`stream_error_on_invalid_http_messaging
/// <envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.HttpConnectionManager.stream_error_on_invalid_http_message>`.
#[prost(message, optional, tag = "7")]
pub override_stream_error_on_invalid_http_message: ::core::option::Option<
super::super::super::super::google::protobuf::BoolValue,
>,
/// Allows sending fully qualified URLs when proxying the first line of the
/// response. By default, Envoy will only send the path components in the first line.
/// If this is true, Envoy will create a fully qualified URI composing scheme
/// (inferred if not present), host (from the host/:authority header) and path
/// (from first line or :path header).
#[prost(bool, tag = "8")]
pub send_fully_qualified_url: bool,
/// \[#not-implemented-hide:\] Hiding so that field can be removed after BalsaParser is rolled out.
/// If set, force HTTP/1 parser: BalsaParser if true, http-parser if false.
/// If unset, HTTP/1 parser is selected based on
/// envoy.reloadable_features.http1_use_balsa_parser.
/// See issue #21245.
#[prost(message, optional, tag = "9")]
pub use_balsa_parser: ::core::option::Option<
super::super::super::super::google::protobuf::BoolValue,
>,
/// \[#not-implemented-hide:\] Hiding so that field can be removed.
/// If true, and BalsaParser is used (either `use_balsa_parser` above is true,
/// or `envoy.reloadable_features.http1_use_balsa_parser` is true and
/// `use_balsa_parser` is unset), then every non-empty method with only valid
/// characters is accepted. Otherwise, methods not on the hard-coded list are
/// rejected.
/// Once UHV is enabled, this field should be removed, and BalsaParser should
/// allow any method. UHV validates the method, rejecting empty string or
/// invalid characters, and provides :ref:`restrict_http_methods
/// <envoy_v3_api_field_extensions.http.header_validators.envoy_default.v3.HeaderValidatorConfig.restrict_http_methods>`
/// to reject custom methods.
#[prost(bool, tag = "10")]
pub allow_custom_methods: bool,
}
/// Nested message and enum types in `Http1ProtocolOptions`.
pub mod http1_protocol_options {
/// \[#next-free-field: 9\]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct HeaderKeyFormat {
#[prost(oneof = "header_key_format::HeaderFormat", tags = "1, 8")]
pub header_format: ::core::option::Option<header_key_format::HeaderFormat>,
}
/// Nested message and enum types in `HeaderKeyFormat`.
pub mod header_key_format {
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct ProperCaseWords {}
impl ::prost::Name for ProperCaseWords {
const NAME: &'static str = "ProperCaseWords";
const PACKAGE: &'static str = "envoy.config.core.v3";
fn full_name() -> ::prost::alloc::string::String {
"envoy.config.core.v3.Http1ProtocolOptions.HeaderKeyFormat.ProperCaseWords"
.into()
}
fn type_url() -> ::prost::alloc::string::String {
"type.googleapis.com/envoy.config.core.v3.Http1ProtocolOptions.HeaderKeyFormat.ProperCaseWords"
.into()
}
}
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum HeaderFormat {
/// Formats the header by proper casing words: the first character and any character following
/// a special character will be capitalized if it's an alpha character. For example,
/// "content-type" becomes "Content-Type", and "foo$b#$are" becomes "Foo$B#$Are".
/// Note that while this results in most headers following conventional casing, certain headers
/// are not covered. For example, the "TE" header will be formatted as "Te".
#[prost(message, tag = "1")]
ProperCaseWords(ProperCaseWords),
/// Configuration for stateful formatter extensions that allow using received headers to
/// affect the output of encoding headers. E.g., preserving case during proxying.
/// \[#extension-category: envoy.http.stateful_header_formatters\]
#[prost(message, tag = "8")]
StatefulFormatter(super::super::TypedExtensionConfig),
}
}
impl ::prost::Name for HeaderKeyFormat {
const NAME: &'static str = "HeaderKeyFormat";
const PACKAGE: &'static str = "envoy.config.core.v3";
fn full_name() -> ::prost::alloc::string::String {
"envoy.config.core.v3.Http1ProtocolOptions.HeaderKeyFormat".into()
}
fn type_url() -> ::prost::alloc::string::String {
"type.googleapis.com/envoy.config.core.v3.Http1ProtocolOptions.HeaderKeyFormat"
.into()
}
}
}
impl ::prost::Name for Http1ProtocolOptions {
const NAME: &'static str = "Http1ProtocolOptions";
const PACKAGE: &'static str = "envoy.config.core.v3";
fn full_name() -> ::prost::alloc::string::String {
"envoy.config.core.v3.Http1ProtocolOptions".into()
}
fn type_url() -> ::prost::alloc::string::String {
"type.googleapis.com/envoy.config.core.v3.Http1ProtocolOptions".into()
}
}
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct KeepaliveSettings {
/// Send HTTP/2 PING frames at this period, in order to test that the connection is still alive.
/// If this is zero, interval PINGs will not be sent.
#[prost(message, optional, tag = "1")]
pub interval: ::core::option::Option<
super::super::super::super::google::protobuf::Duration,
>,
/// How long to wait for a response to a keepalive PING. If a response is not received within this
/// time period, the connection will be aborted. Note that in order to prevent the influence of
/// Head-of-line (HOL) blocking the timeout period is extended when *any* frame is received on
/// the connection, under the assumption that if a frame is received the connection is healthy.
#[prost(message, optional, tag = "2")]
pub timeout: ::core::option::Option<
super::super::super::super::google::protobuf::Duration,
>,
/// A random jitter amount as a percentage of interval that will be added to each interval.
/// A value of zero means there will be no jitter.
/// The default value is 15%.
#[prost(message, optional, tag = "3")]
pub interval_jitter: ::core::option::Option<
super::super::super::r#type::v3::Percent,
>,
/// If the connection has been idle for this duration, send a HTTP/2 ping ahead
/// of new stream creation, to quickly detect dead connections.
/// If this is zero, this type of PING will not be sent.
/// If an interval ping is outstanding, a second ping will not be sent as the
/// interval ping will determine if the connection is dead.
///
/// The same feature for HTTP/3 is given by inheritance from QUICHE which uses :ref:`connection idle_timeout <envoy_v3_api_field_config.listener.v3.QuicProtocolOptions.idle_timeout>` and the current PTO of the connection to decide whether to probe before sending a new request.
#[prost(message, optional, tag = "4")]
pub connection_idle_interval: ::core::option::Option<
super::super::super::super::google::protobuf::Duration,
>,
}
impl ::prost::Name for KeepaliveSettings {
const NAME: &'static str = "KeepaliveSettings";
const PACKAGE: &'static str = "envoy.config.core.v3";
fn full_name() -> ::prost::alloc::string::String {
"envoy.config.core.v3.KeepaliveSettings".into()
}
fn type_url() -> ::prost::alloc::string::String {
"type.googleapis.com/envoy.config.core.v3.KeepaliveSettings".into()
}
}
/// \[#next-free-field: 17\]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Http2ProtocolOptions {
/// `Maximum table size <<https://httpwg.org/specs/rfc7541.html#rfc.section.4.2>`_>
/// (in octets) that the encoder is permitted to use for the dynamic HPACK table. Valid values
/// range from 0 to 4294967295 (2^32 - 1) and defaults to 4096. 0 effectively disables header
/// compression.
#[prost(message, optional, tag = "1")]
pub hpack_table_size: ::core::option::Option<
super::super::super::super::google::protobuf::UInt32Value,
>,
/// `Maximum concurrent streams <<https://httpwg.org/specs/rfc7540.html#rfc.section.5.1.2>`_>
/// allowed for peer on one HTTP/2 connection. Valid values range from 1 to 2147483647 (2^31 - 1)
/// and defaults to 2147483647.
///
/// For upstream connections, this also limits how many streams Envoy will initiate concurrently
/// on a single connection. If the limit is reached, Envoy may queue requests or establish
/// additional connections (as allowed per circuit breaker limits).
///
/// This acts as an upper bound: Envoy will lower the max concurrent streams allowed on a given
/// connection based on upstream settings. Config dumps will reflect the configured upper bound,
/// not the per-connection negotiated limits.
#[prost(message, optional, tag = "2")]
pub max_concurrent_streams: ::core::option::Option<
super::super::super::super::google::protobuf::UInt32Value,
>,
/// `Initial stream-level flow-control window
/// <<https://httpwg.org/specs/rfc7540.html#rfc.section.6.9.2>`_> size. Valid values range from 65535
/// (2^16 - 1, HTTP/2 default) to 2147483647 (2^31 - 1, HTTP/2 maximum) and defaults to 268435456
/// (256 * 1024 * 1024).
///
/// NOTE: 65535 is the initial window size from HTTP/2 spec. We only support increasing the default
/// window size now, so it's also the minimum.
///
/// This field also acts as a soft limit on the number of bytes Envoy will buffer per-stream in the
/// HTTP/2 codec buffers. Once the buffer reaches this pointer, watermark callbacks will fire to
/// stop the flow of data to the codec buffers.
#[prost(message, optional, tag = "3")]
pub initial_stream_window_size: ::core::option::Option<
super::super::super::super::google::protobuf::UInt32Value,
>,
/// Similar to ``initial_stream_window_size``, but for connection-level flow-control
/// window. Currently, this has the same minimum/maximum/default as ``initial_stream_window_size``.
#[prost(message, optional, tag = "4")]
pub initial_connection_window_size: ::core::option::Option<
super::super::super::super::google::protobuf::UInt32Value,
>,
/// Allows proxying Websocket and other upgrades over H2 connect.
#[prost(bool, tag = "5")]
pub allow_connect: bool,
/// \[#not-implemented-hide:\] Hiding until Envoy has full metadata support.
/// Still under implementation. DO NOT USE.
///
/// Allows sending and receiving HTTP/2 METADATA frames. See [metadata
/// docs](<https://github.com/envoyproxy/envoy/blob/main/source/docs/h2_metadata.md>) for more
/// information.
#[prost(bool, tag = "6")]
pub allow_metadata: bool,
/// Limit the number of pending outbound downstream frames of all types (frames that are waiting to
/// be written into the socket). Exceeding this limit triggers flood mitigation and connection is
/// terminated. The ``http2.outbound_flood`` stat tracks the number of terminated connections due
/// to flood mitigation. The default limit is 10000.
#[prost(message, optional, tag = "7")]
pub max_outbound_frames: ::core::option::Option<
super::super::super::super::google::protobuf::UInt32Value,
>,
/// Limit the number of pending outbound downstream frames of types PING, SETTINGS and RST_STREAM,
/// preventing high memory utilization when receiving continuous stream of these frames. Exceeding
/// this limit triggers flood mitigation and connection is terminated. The
/// ``http2.outbound_control_flood`` stat tracks the number of terminated connections due to flood
/// mitigation. The default limit is 1000.
#[prost(message, optional, tag = "8")]
pub max_outbound_control_frames: ::core::option::Option<
super::super::super::super::google::protobuf::UInt32Value,
>,
/// Limit the number of consecutive inbound frames of types HEADERS, CONTINUATION and DATA with an
/// empty payload and no end stream flag. Those frames have no legitimate use and are abusive, but
/// might be a result of a broken HTTP/2 implementation. The `http2.inbound_empty_frames_flood``
/// stat tracks the number of connections terminated due to flood mitigation.
/// Setting this to 0 will terminate connection upon receiving first frame with an empty payload
/// and no end stream flag. The default limit is 1.
#[prost(message, optional, tag = "9")]
pub max_consecutive_inbound_frames_with_empty_payload: ::core::option::Option<
super::super::super::super::google::protobuf::UInt32Value,
>,
/// Limit the number of inbound PRIORITY frames allowed per each opened stream. If the number
/// of PRIORITY frames received over the lifetime of connection exceeds the value calculated
/// using this formula::
///
/// ``max_inbound_priority_frames_per_stream`` * (1 + ``opened_streams``)
///
/// the connection is terminated. For downstream connections the ``opened_streams`` is incremented when
/// Envoy receives complete response headers from the upstream server. For upstream connection the
/// ``opened_streams`` is incremented when Envoy send the HEADERS frame for a new stream. The
/// ``http2.inbound_priority_frames_flood`` stat tracks
/// the number of connections terminated due to flood mitigation. The default limit is 100.
#[prost(message, optional, tag = "10")]
pub max_inbound_priority_frames_per_stream: ::core::option::Option<
super::super::super::super::google::protobuf::UInt32Value,
>,
/// Limit the number of inbound WINDOW_UPDATE frames allowed per DATA frame sent. If the number
/// of WINDOW_UPDATE frames received over the lifetime of connection exceeds the value calculated
/// using this formula::
///
/// 5 + 2 * (``opened_streams`` +
/// ``max_inbound_window_update_frames_per_data_frame_sent`` * ``outbound_data_frames``)
///
/// the connection is terminated. For downstream connections the ``opened_streams`` is incremented when
/// Envoy receives complete response headers from the upstream server. For upstream connections the
/// ``opened_streams`` is incremented when Envoy sends the HEADERS frame for a new stream. The
/// ``http2.inbound_priority_frames_flood`` stat tracks the number of connections terminated due to
/// flood mitigation. The default max_inbound_window_update_frames_per_data_frame_sent value is 10.
/// Setting this to 1 should be enough to support HTTP/2 implementations with basic flow control,
/// but more complex implementations that try to estimate available bandwidth require at least 2.
#[prost(message, optional, tag = "11")]
pub max_inbound_window_update_frames_per_data_frame_sent: ::core::option::Option<
super::super::super::super::google::protobuf::UInt32Value,
>,
/// Allows invalid HTTP messaging and headers. When this option is disabled (default), then
/// the whole HTTP/2 connection is terminated upon receiving invalid HEADERS frame. However,
/// when this option is enabled, only the offending stream is terminated.
///
/// This is overridden by HCM :ref:`stream_error_on_invalid_http_messaging
/// <envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.HttpConnectionManager.stream_error_on_invalid_http_message>`
/// iff present.
///
/// This is deprecated in favor of :ref:`override_stream_error_on_invalid_http_message
/// <envoy_v3_api_field_config.core.v3.Http2ProtocolOptions.override_stream_error_on_invalid_http_message>`
///
/// See `RFC7540, sec. 8.1 <<https://tools.ietf.org/html/rfc7540#section-8.1>`_> for details.
#[deprecated]
#[prost(bool, tag = "12")]
pub stream_error_on_invalid_http_messaging: bool,
/// Allows invalid HTTP messaging and headers. When this option is disabled (default), then
/// the whole HTTP/2 connection is terminated upon receiving invalid HEADERS frame. However,
/// when this option is enabled, only the offending stream is terminated.
///
/// This overrides any HCM :ref:`stream_error_on_invalid_http_messaging
/// <envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.HttpConnectionManager.stream_error_on_invalid_http_message>`
///
/// See `RFC7540, sec. 8.1 <<https://tools.ietf.org/html/rfc7540#section-8.1>`_> for details.
#[prost(message, optional, tag = "14")]
pub override_stream_error_on_invalid_http_message: ::core::option::Option<
super::super::super::super::google::protobuf::BoolValue,
>,
/// \[#not-implemented-hide:\]
/// Specifies SETTINGS frame parameters to be sent to the peer, with two exceptions:
///
/// 1. SETTINGS_ENABLE_PUSH (0x2) is not configurable as HTTP/2 server push is not supported by
/// Envoy.
///
/// 2. SETTINGS_ENABLE_CONNECT_PROTOCOL (0x8) is only configurable through the named field
/// 'allow_connect'.
///
/// Note that custom parameters specified through this field can not also be set in the
/// corresponding named parameters:
///
/// .. code-block:: text
///
/// ID Field Name
/// ----------------
/// 0x1 hpack_table_size
/// 0x3 max_concurrent_streams
/// 0x4 initial_stream_window_size
///
/// Collisions will trigger config validation failure on load/update. Likewise, inconsistencies
/// between custom parameters with the same identifier will trigger a failure.
///
/// See `IANA HTTP/2 Settings
/// <<https://www.iana.org/assignments/http2-parameters/http2-parameters.xhtml#settings>`_> for
/// standardized identifiers.
#[prost(message, repeated, tag = "13")]
pub custom_settings_parameters: ::prost::alloc::vec::Vec<
http2_protocol_options::SettingsParameter,
>,
/// Send HTTP/2 PING frames to verify that the connection is still healthy. If the remote peer
/// does not respond within the configured timeout, the connection will be aborted.
#[prost(message, optional, tag = "15")]
pub connection_keepalive: ::core::option::Option<KeepaliveSettings>,
/// \[#not-implemented-hide:\] Hiding so that the field can be removed after oghttp2 is rolled out.
/// If set, force use of a particular HTTP/2 codec: oghttp2 if true, nghttp2 if false.
/// If unset, HTTP/2 codec is selected based on envoy.reloadable_features.http2_use_oghttp2.
#[prost(message, optional, tag = "16")]
pub use_oghttp2_codec: ::core::option::Option<
super::super::super::super::google::protobuf::BoolValue,
>,
}
/// Nested message and enum types in `Http2ProtocolOptions`.
pub mod http2_protocol_options {
/// Defines a parameter to be sent in the SETTINGS frame.
/// See `RFC7540, sec. 6.5.1 <<https://tools.ietf.org/html/rfc7540#section-6.5.1>`_> for details.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct SettingsParameter {
/// The 16 bit parameter identifier.
#[prost(message, optional, tag = "1")]
pub identifier: ::core::option::Option<
super::super::super::super::super::google::protobuf::UInt32Value,
>,
/// The 32 bit parameter value.
#[prost(message, optional, tag = "2")]
pub value: ::core::option::Option<
super::super::super::super::super::google::protobuf::UInt32Value,
>,
}
impl ::prost::Name for SettingsParameter {
const NAME: &'static str = "SettingsParameter";
const PACKAGE: &'static str = "envoy.config.core.v3";
fn full_name() -> ::prost::alloc::string::String {
"envoy.config.core.v3.Http2ProtocolOptions.SettingsParameter".into()
}
fn type_url() -> ::prost::alloc::string::String {
"type.googleapis.com/envoy.config.core.v3.Http2ProtocolOptions.SettingsParameter"
.into()
}
}
}
impl ::prost::Name for Http2ProtocolOptions {
const NAME: &'static str = "Http2ProtocolOptions";
const PACKAGE: &'static str = "envoy.config.core.v3";
fn full_name() -> ::prost::alloc::string::String {
"envoy.config.core.v3.Http2ProtocolOptions".into()
}
fn type_url() -> ::prost::alloc::string::String {
"type.googleapis.com/envoy.config.core.v3.Http2ProtocolOptions".into()
}
}
/// \[#not-implemented-hide:\]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GrpcProtocolOptions {
#[prost(message, optional, tag = "1")]
pub http2_protocol_options: ::core::option::Option<Http2ProtocolOptions>,
}
impl ::prost::Name for GrpcProtocolOptions {
const NAME: &'static str = "GrpcProtocolOptions";
const PACKAGE: &'static str = "envoy.config.core.v3";
fn full_name() -> ::prost::alloc::string::String {
"envoy.config.core.v3.GrpcProtocolOptions".into()
}
fn type_url() -> ::prost::alloc::string::String {
"type.googleapis.com/envoy.config.core.v3.GrpcProtocolOptions".into()
}
}
/// A message which allows using HTTP/3.
/// \[#next-free-field: 7\]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Http3ProtocolOptions {
#[prost(message, optional, tag = "1")]
pub quic_protocol_options: ::core::option::Option<QuicProtocolOptions>,
/// Allows invalid HTTP messaging and headers. When this option is disabled (default), then
/// the whole HTTP/3 connection is terminated upon receiving invalid HEADERS frame. However,
/// when this option is enabled, only the offending stream is terminated.
///
/// If set, this overrides any HCM :ref:`stream_error_on_invalid_http_messaging
/// <envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.HttpConnectionManager.stream_error_on_invalid_http_message>`.
#[prost(message, optional, tag = "2")]
pub override_stream_error_on_invalid_http_message: ::core::option::Option<
super::super::super::super::google::protobuf::BoolValue,
>,
/// Allows proxying Websocket and other upgrades over HTTP/3 CONNECT using
/// the header mechanisms from the `HTTP/2 extended connect RFC
/// <<https://datatracker.ietf.org/doc/html/rfc8441>`_>
/// and settings `proposed for HTTP/3
/// <<https://datatracker.ietf.org/doc/draft-ietf-httpbis-h3-websockets/>`_>
/// Note that HTTP/3 CONNECT is not yet an RFC.
#[prost(bool, tag = "5")]
pub allow_extended_connect: bool,
/// \[#not-implemented-hide:\] Hiding until Envoy has full metadata support.
/// Still under implementation. DO NOT USE.
///
/// Allows sending and receiving HTTP/3 METADATA frames. See [metadata
/// docs](<https://github.com/envoyproxy/envoy/blob/main/source/docs/h2_metadata.md>) for more
/// information.
#[prost(bool, tag = "6")]
pub allow_metadata: bool,
}
impl ::prost::Name for Http3ProtocolOptions {
const NAME: &'static str = "Http3ProtocolOptions";
const PACKAGE: &'static str = "envoy.config.core.v3";
fn full_name() -> ::prost::alloc::string::String {
"envoy.config.core.v3.Http3ProtocolOptions".into()
}
fn type_url() -> ::prost::alloc::string::String {
"type.googleapis.com/envoy.config.core.v3.Http3ProtocolOptions".into()
}
}
/// A message to control transformations to the :scheme header
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct SchemeHeaderTransformation {
/// Set the Scheme header to match the upstream transport protocol. For example, should a
/// request be sent to the upstream over TLS, the scheme header will be set to "https". Should the
/// request be sent over plaintext, the scheme header will be set to "http".
/// If scheme_to_overwrite is set, this field is not used.
#[prost(bool, tag = "2")]
pub match_upstream: bool,
#[prost(oneof = "scheme_header_transformation::Transformation", tags = "1")]
pub transformation: ::core::option::Option<
scheme_header_transformation::Transformation,
>,
}
/// Nested message and enum types in `SchemeHeaderTransformation`.
pub mod scheme_header_transformation {
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum Transformation {
/// Overwrite any Scheme header with the contents of this string.
/// If set, takes precedence over match_upstream.
#[prost(string, tag = "1")]
SchemeToOverwrite(::prost::alloc::string::String),
}
}
impl ::prost::Name for SchemeHeaderTransformation {
const NAME: &'static str = "SchemeHeaderTransformation";
const PACKAGE: &'static str = "envoy.config.core.v3";
fn full_name() -> ::prost::alloc::string::String {
"envoy.config.core.v3.SchemeHeaderTransformation".into()
}
fn type_url() -> ::prost::alloc::string::String {
"type.googleapis.com/envoy.config.core.v3.SchemeHeaderTransformation".into()
}
}
/// Configuration of DNS resolver option flags which control the behavior of the DNS resolver.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct DnsResolverOptions {
/// Use TCP for all DNS queries instead of the default protocol UDP.
#[prost(bool, tag = "1")]
pub use_tcp_for_dns_lookups: bool,
/// Do not use the default search domains; only query hostnames as-is or as aliases.
#[prost(bool, tag = "2")]
pub no_default_search_domain: bool,
}
impl ::prost::Name for DnsResolverOptions {
const NAME: &'static str = "DnsResolverOptions";
const PACKAGE: &'static str = "envoy.config.core.v3";
fn full_name() -> ::prost::alloc::string::String {
"envoy.config.core.v3.DnsResolverOptions".into()
}
fn type_url() -> ::prost::alloc::string::String {
"type.googleapis.com/envoy.config.core.v3.DnsResolverOptions".into()
}
}
/// DNS resolution configuration which includes the underlying dns resolver addresses and options.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DnsResolutionConfig {
/// A list of dns resolver addresses. If specified, the DNS client library will perform resolution
/// via the underlying DNS resolvers. Otherwise, the default system resolvers
/// (e.g., /etc/resolv.conf) will be used.
#[prost(message, repeated, tag = "1")]
pub resolvers: ::prost::alloc::vec::Vec<Address>,
/// Configuration of DNS resolver option flags which control the behavior of the DNS resolver.
#[prost(message, optional, tag = "2")]
pub dns_resolver_options: ::core::option::Option<DnsResolverOptions>,
}
impl ::prost::Name for DnsResolutionConfig {
const NAME: &'static str = "DnsResolutionConfig";
const PACKAGE: &'static str = "envoy.config.core.v3";
fn full_name() -> ::prost::alloc::string::String {
"envoy.config.core.v3.DnsResolutionConfig".into()
}
fn type_url() -> ::prost::alloc::string::String {
"type.googleapis.com/envoy.config.core.v3.DnsResolutionConfig".into()
}
}
/// Generic UDP socket configuration.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct UdpSocketConfig {
/// The maximum size of received UDP datagrams. Using a larger size will cause Envoy to allocate
/// more memory per socket. Received datagrams above this size will be dropped. If not set
/// defaults to 1500 bytes.
#[prost(message, optional, tag = "1")]
pub max_rx_datagram_size: ::core::option::Option<
super::super::super::super::google::protobuf::UInt64Value,
>,
/// Configures whether Generic Receive Offload (GRO)
/// <<https://en.wikipedia.org/wiki/Large_receive_offload>_> is preferred when reading from the
/// UDP socket. The default is context dependent and is documented where UdpSocketConfig is used.
/// This option affects performance but not functionality. If GRO is not supported by the operating
/// system, non-GRO receive will be used.
#[prost(message, optional, tag = "2")]
pub prefer_gro: ::core::option::Option<
super::super::super::super::google::protobuf::BoolValue,
>,
}
impl ::prost::Name for UdpSocketConfig {
const NAME: &'static str = "UdpSocketConfig";
const PACKAGE: &'static str = "envoy.config.core.v3";
fn full_name() -> ::prost::alloc::string::String {
"envoy.config.core.v3.UdpSocketConfig".into()
}
fn type_url() -> ::prost::alloc::string::String {
"type.googleapis.com/envoy.config.core.v3.UdpSocketConfig".into()
}
}
/// A list of gRPC methods which can be used as an allowlist, for example.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GrpcMethodList {
#[prost(message, repeated, tag = "1")]
pub services: ::prost::alloc::vec::Vec<grpc_method_list::Service>,
}
/// Nested message and enum types in `GrpcMethodList`.
pub mod grpc_method_list {
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Service {
/// The name of the gRPC service.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// The names of the gRPC methods in this service.
#[prost(string, repeated, tag = "2")]
pub method_names: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
}
impl ::prost::Name for Service {
const NAME: &'static str = "Service";
const PACKAGE: &'static str = "envoy.config.core.v3";
fn full_name() -> ::prost::alloc::string::String {
"envoy.config.core.v3.GrpcMethodList.Service".into()
}
fn type_url() -> ::prost::alloc::string::String {
"type.googleapis.com/envoy.config.core.v3.GrpcMethodList.Service".into()
}
}
}
impl ::prost::Name for GrpcMethodList {
const NAME: &'static str = "GrpcMethodList";
const PACKAGE: &'static str = "envoy.config.core.v3";
fn full_name() -> ::prost::alloc::string::String {
"envoy.config.core.v3.GrpcMethodList".into()
}
fn type_url() -> ::prost::alloc::string::String {
"type.googleapis.com/envoy.config.core.v3.GrpcMethodList".into()
}
}
/// HTTP service configuration.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct HttpService {
/// The service's HTTP URI. For example:
///
/// .. code-block:: yaml
///
/// http_uri:
/// uri: <https://www.myserviceapi.com/v1/data>
/// cluster: www.myserviceapi.com|443
///
#[prost(message, optional, tag = "1")]
pub http_uri: ::core::option::Option<HttpUri>,
/// Specifies a list of HTTP headers that should be added to each request
/// handled by this virtual host.
#[prost(message, repeated, tag = "2")]
pub request_headers_to_add: ::prost::alloc::vec::Vec<HeaderValueOption>,
}
impl ::prost::Name for HttpService {
const NAME: &'static str = "HttpService";
const PACKAGE: &'static str = "envoy.config.core.v3";
fn full_name() -> ::prost::alloc::string::String {
"envoy.config.core.v3.HttpService".into()
}
fn type_url() -> ::prost::alloc::string::String {
"type.googleapis.com/envoy.config.core.v3.HttpService".into()
}
}
/// Optional configuration options to be used with json_format.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct JsonFormatOptions {
/// The output JSON string properties will be sorted.
#[prost(bool, tag = "1")]
pub sort_properties: bool,
}
impl ::prost::Name for JsonFormatOptions {
const NAME: &'static str = "JsonFormatOptions";
const PACKAGE: &'static str = "envoy.config.core.v3";
fn full_name() -> ::prost::alloc::string::String {
"envoy.config.core.v3.JsonFormatOptions".into()
}
fn type_url() -> ::prost::alloc::string::String {
"type.googleapis.com/envoy.config.core.v3.JsonFormatOptions".into()
}
}
/// Configuration to use multiple :ref:`command operators <config_access_log_command_operators>`
/// to generate a new string in either plain text or JSON format.
/// \[#next-free-field: 8\]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct SubstitutionFormatString {
/// If set to true, when command operators are evaluated to null,
///
/// * for ``text_format``, the output of the empty operator is changed from ``-`` to an
/// empty string, so that empty values are omitted entirely.
/// * for ``json_format`` the keys with null values are omitted in the output structure.
#[prost(bool, tag = "3")]
pub omit_empty_values: bool,
/// Specify a ``content_type`` field.
/// If this field is not set then ``text/plain`` is used for ``text_format`` and
/// ``application/json`` is used for ``json_format``.
///
/// .. validated-code-block:: yaml
/// :type-name: envoy.config.core.v3.SubstitutionFormatString
///
/// content_type: "text/html; charset=UTF-8"
///
#[prost(string, tag = "4")]
pub content_type: ::prost::alloc::string::String,
/// Specifies a collection of Formatter plugins that can be called from the access log configuration.
/// See the formatters extensions documentation for details.
/// \[#extension-category: envoy.formatter\]
#[prost(message, repeated, tag = "6")]
pub formatters: ::prost::alloc::vec::Vec<TypedExtensionConfig>,
/// If json_format is used, the options will be applied to the output JSON string.
#[prost(message, optional, tag = "7")]
pub json_format_options: ::core::option::Option<JsonFormatOptions>,
#[prost(oneof = "substitution_format_string::Format", tags = "1, 2, 5")]
pub format: ::core::option::Option<substitution_format_string::Format>,
}
/// Nested message and enum types in `SubstitutionFormatString`.
pub mod substitution_format_string {
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum Format {
/// Specify a format with command operators to form a text string.
/// Its details is described in :ref:`format string<config_access_log_format_strings>`.
///
/// For example, setting ``text_format`` like below,
///
/// .. validated-code-block:: yaml
/// :type-name: envoy.config.core.v3.SubstitutionFormatString
///
/// text_format: "%LOCAL_REPLY_BODY%:%RESPONSE_CODE%:path=%REQ(:path)%\n"
///
/// generates plain text similar to:
///
/// .. code-block:: text
///
/// upstream connect error:503:path=/foo
///
/// Deprecated in favor of :ref:`text_format_source <envoy_v3_api_field_config.core.v3.SubstitutionFormatString.text_format_source>`. To migrate text format strings, use the :ref:`inline_string <envoy_v3_api_field_config.core.v3.DataSource.inline_string>` field.
#[prost(string, tag = "1")]
TextFormat(::prost::alloc::string::String),
/// Specify a format with command operators to form a JSON string.
/// Its details is described in :ref:`format dictionary<config_access_log_format_dictionaries>`.
/// Values are rendered as strings, numbers, or boolean values as appropriate.
/// Nested JSON objects may be produced by some command operators (e.g. FILTER_STATE or DYNAMIC_METADATA).
/// See the documentation for a specific command operator for details.
///
/// .. validated-code-block:: yaml
/// :type-name: envoy.config.core.v3.SubstitutionFormatString
///
/// json_format:
/// status: "%RESPONSE_CODE%"
/// message: "%LOCAL_REPLY_BODY%"
///
/// The following JSON object would be created:
///
/// .. code-block:: json
///
/// {
/// "status": 500,
/// "message": "My error message"
/// }
///
#[prost(message, tag = "2")]
JsonFormat(super::super::super::super::super::google::protobuf::Struct),
/// Specify a format with command operators to form a text string.
/// Its details is described in :ref:`format string<config_access_log_format_strings>`.
///
/// For example, setting ``text_format`` like below,
///
/// .. validated-code-block:: yaml
/// :type-name: envoy.config.core.v3.SubstitutionFormatString
///
/// text_format_source:
/// inline_string: "%LOCAL_REPLY_BODY%:%RESPONSE_CODE%:path=%REQ(:path)%\n"
///
/// generates plain text similar to:
///
/// .. code-block:: text
///
/// upstream connect error:503:path=/foo
///
#[prost(message, tag = "5")]
TextFormatSource(super::DataSource),
}
}
impl ::prost::Name for SubstitutionFormatString {
const NAME: &'static str = "SubstitutionFormatString";
const PACKAGE: &'static str = "envoy.config.core.v3";
fn full_name() -> ::prost::alloc::string::String {
"envoy.config.core.v3.SubstitutionFormatString".into()
}
fn type_url() -> ::prost::alloc::string::String {
"type.googleapis.com/envoy.config.core.v3.SubstitutionFormatString".into()
}
}