v1beta.d.ts
113 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
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
/**
* Copyright 2019 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { GaxiosPromise } from 'gaxios';
import { Compute, JWT, OAuth2Client, UserRefreshClient } from 'google-auth-library';
import { APIRequestContext, BodyResponseCallback, GlobalOptions, GoogleConfigurable, MethodOptions } from 'googleapis-common';
export declare namespace servicenetworking_v1beta {
interface Options extends GlobalOptions {
version: 'v1beta';
}
interface StandardParameters {
/**
* V1 error format.
*/
'$.xgafv'?: string;
/**
* OAuth access token.
*/
access_token?: string;
/**
* Data format for response.
*/
alt?: string;
/**
* JSONP
*/
callback?: string;
/**
* Selector specifying which fields to include in a partial response.
*/
fields?: string;
/**
* API key. Your API key identifies your project and provides you with API
* access, quota, and reports. Required unless you provide an OAuth 2.0
* token.
*/
key?: string;
/**
* OAuth 2.0 token for the current user.
*/
oauth_token?: string;
/**
* Returns response with indentations and line breaks.
*/
prettyPrint?: boolean;
/**
* Available to use for quota purposes for server-side applications. Can be
* any arbitrary string assigned to a user, but should not exceed 40
* characters.
*/
quotaUser?: string;
/**
* Legacy upload protocol for media (e.g. "media", "multipart").
*/
uploadType?: string;
/**
* Upload protocol for media (e.g. "raw", "multipart").
*/
upload_protocol?: string;
}
/**
* Service Networking API
*
* Provides automatic management of network configurations necessary for
* certain services.
*
* @example
* const {google} = require('googleapis');
* const servicenetworking = google.servicenetworking('v1beta');
*
* @namespace servicenetworking
* @type {Function}
* @version v1beta
* @variation v1beta
* @param {object=} options Options for Servicenetworking
*/
class Servicenetworking {
context: APIRequestContext;
operations: Resource$Operations;
services: Resource$Services;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* Request to create a subnetwork in a previously peered service network.
*/
interface Schema$AddSubnetworkRequest {
/**
* Required. A resource that represents the service consumer, such as
* `projects/123456`. The project number can be different from the value in
* the consumer network parameter. For example, the network might be part of
* a Shared VPC network. In those cases, Service Networking validates that
* this resource belongs to that Shared VPC.
*/
consumer?: string;
/**
* Required. The name of the service consumer's VPC network. The network
* must have an existing private connection that was provisioned through the
* connections.create method. The name must be in the following format:
* `projects/{project}/global/networks/{network}`, where {project} is a
* project number, such as `12345`. {network} is the name of a VPC network
* in the project.
*/
consumerNetwork?: string;
/**
* An optional description of the subnet.
*/
description?: string;
/**
* Required. The prefix length of the subnet's IP address range. Use
* CIDR range notation, such as `30` to provision a subnet with an
* `x.x.x.x/30` CIDR range. The IP address range is drawn from a pool of
* available ranges in the service consumer's allocated range.
*/
ipPrefixLength?: number;
/**
* Required. The name of a [region](/compute/docs/regions-zones) for the
* subnet, such `europe-west1`.
*/
region?: string;
/**
* Optional. The starting address of a range. The address must be a valid
* IPv4 address in the x.x.x.x format. This value combined with the IP
* prefix range is the CIDR range for the subnet. The range must be within
* the allocated range that is assigned to the private connection. If the
* CIDR range isn't available, the call fails.
*/
requestedAddress?: string;
/**
* Required. A name for the new subnet. For information about the naming
* requirements, see
* [subnetwork](/compute/docs/reference/rest/v1/subnetworks) in the Compute
* API documentation.
*/
subnetwork?: string;
/**
* A list of members that are granted the `compute.networkUser` role on the
* subnet.
*/
subnetworkUsers?: string[];
}
/**
* Api is a light-weight descriptor for an API Interface. Interfaces are also
* described as "protocol buffer services" in some contexts, such as
* by the "service" keyword in a .proto file, but they are different
* from API Services, which represent a concrete implementation of an
* interface as opposed to simply a description of methods and bindings. They
* are also sometimes simply referred to as "APIs" in other
* contexts, such as the name of this message itself. See
* https://cloud.google.com/apis/design/glossary for detailed terminology.
*/
interface Schema$Api {
/**
* The methods of this interface, in unspecified order.
*/
methods?: Schema$Method[];
/**
* Included interfaces. See Mixin.
*/
mixins?: Schema$Mixin[];
/**
* The fully qualified name of this interface, including package name
* followed by the interface's simple name.
*/
name?: string;
/**
* Any metadata attached to the interface.
*/
options?: Schema$Option[];
/**
* Source context for the protocol buffer service represented by this
* message.
*/
sourceContext?: Schema$SourceContext;
/**
* The source syntax of the service.
*/
syntax?: string;
/**
* A version string for this interface. If specified, must have the form
* `major-version.minor-version`, as in `1.10`. If the minor version is
* omitted, it defaults to zero. If the entire version field is empty, the
* major version is derived from the package name, as outlined below. If the
* field is not empty, the version in the package name will be verified to
* be consistent with what is provided here. The versioning schema uses
* [semantic versioning](http://semver.org) where the major version number
* indicates a breaking change and the minor version an additive,
* non-breaking change. Both version numbers are signals to users what to
* expect from different versions, and should be carefully chosen based on
* the product plan. The major version is also reflected in the package
* name of the interface, which must end in `v<major-version>`, as in
* `google.feature.v1`. For major versions 0 and 1, the suffix can be
* omitted. Zero major versions must only be used for experimental, non-GA
* interfaces.
*/
version?: string;
}
/**
* `Authentication` defines the authentication configuration for an API.
* Example for an API targeted for external use: name:
* calendar.googleapis.com authentication: providers: - id:
* google_calendar_auth jwks_uri:
* https://www.googleapis.com/oauth2/v1/certs issuer:
* https://securetoken.google.com rules: - selector: "*"
* requirements: provider_id: google_calendar_auth
*/
interface Schema$Authentication {
/**
* Defines a set of authentication providers that a service supports.
*/
providers?: Schema$AuthProvider[];
/**
* A list of authentication rules that apply to individual API methods.
* **NOTE:** All service configuration rules follow "last one
* wins" order.
*/
rules?: Schema$AuthenticationRule[];
}
/**
* Authentication rules for the service. By default, if a method has any
* authentication requirements, every request must include a valid credential
* matching one of the requirements. It's an error to include more than
* one kind of credential in a single request. If a method doesn't have
* any auth requirements, request credentials will be ignored.
*/
interface Schema$AuthenticationRule {
/**
* If true, the service accepts API keys without any other credential.
*/
allowWithoutCredential?: boolean;
/**
* The requirements for OAuth credentials.
*/
oauth?: Schema$OAuthRequirements;
/**
* Requirements for additional authentication providers.
*/
requirements?: Schema$AuthRequirement[];
/**
* Selects the methods to which this rule applies. Refer to selector for
* syntax details.
*/
selector?: string;
}
/**
* Configuration of authorization. This section determines the authorization
* provider, if unspecified, then no authorization check will be done.
* Example: experimental: authorization: provider:
* firebaserules.googleapis.com
*/
interface Schema$AuthorizationConfig {
/**
* The name of the authorization provider, such as
* firebaserules.googleapis.com.
*/
provider?: string;
}
/**
* Configuration for an anthentication provider, including support for [JSON
* Web Token
* (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).
*/
interface Schema$AuthProvider {
/**
* The list of JWT
* [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3).
* that are allowed to access. A JWT containing any of these audiences will
* be accepted. When this setting is absent, only JWTs with audience
* "https://Service_name/API_name" will be accepted. For example,
* if no audiences are in the setting, LibraryService API will only accept
* JWTs with the following audience
* "https://library-example.googleapis.com/google.example.library.v1.LibraryService".
* Example: audiences: bookstore_android.apps.googleusercontent.com,
* bookstore_web.apps.googleusercontent.com
*/
audiences?: string;
/**
* Redirect URL if JWT token is required but not present or is expired.
* Implement authorizationUrl of securityDefinitions in OpenAPI spec.
*/
authorizationUrl?: string;
/**
* The unique identifier of the auth provider. It will be referred to by
* `AuthRequirement.provider_id`. Example: "bookstore_auth".
*/
id?: string;
/**
* Identifies the principal that issued the JWT. See
* https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1
* Usually a URL or an email address. Example:
* https://securetoken.google.com Example:
* 1234567-compute@developer.gserviceaccount.com
*/
issuer?: string;
/**
* URL of the provider's public key set to validate signature of the
* JWT. See [OpenID
* Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata).
* Optional if the key set document: - can be retrieved from [OpenID
* Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html of
* the issuer. - can be inferred from the email domain of the issuer (e.g.
* a Google service account). Example:
* https://www.googleapis.com/oauth2/v1/certs
*/
jwksUri?: string;
}
/**
* User-defined authentication requirements, including support for [JSON Web
* Token
* (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).
*/
interface Schema$AuthRequirement {
/**
* NOTE: This will be deprecated soon, once AuthProvider.audiences is
* implemented and accepted in all the runtime components. The list of JWT
* [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3).
* that are allowed to access. A JWT containing any of these audiences will
* be accepted. When this setting is absent, only JWTs with audience
* "https://Service_name/API_name" will be accepted. For example,
* if no audiences are in the setting, LibraryService API will only accept
* JWTs with the following audience
* "https://library-example.googleapis.com/google.example.library.v1.LibraryService".
* Example: audiences: bookstore_android.apps.googleusercontent.com,
* bookstore_web.apps.googleusercontent.com
*/
audiences?: string;
/**
* id from authentication provider. Example: provider_id:
* bookstore_auth
*/
providerId?: string;
}
/**
* `Backend` defines the backend configuration for a service.
*/
interface Schema$Backend {
/**
* A list of API backend rules that apply to individual API methods.
* **NOTE:** All service configuration rules follow "last one
* wins" order.
*/
rules?: Schema$BackendRule[];
}
/**
* A backend rule provides configuration for an individual API element.
*/
interface Schema$BackendRule {
/**
* The address of the API backend.
*/
address?: string;
/**
* The number of seconds to wait for a response from a request. The default
* deadline for gRPC is infinite (no deadline) and HTTP requests is 5
* seconds.
*/
deadline?: number;
/**
* The JWT audience is used when generating a JWT id token for the backend.
*/
jwtAudience?: string;
/**
* Minimum deadline in seconds needed for this method. Calls having deadline
* value lower than this will be rejected.
*/
minDeadline?: number;
/**
* The number of seconds to wait for the completion of a long running
* operation. The default is no deadline.
*/
operationDeadline?: number;
pathTranslation?: string;
/**
* Selects the methods to which this rule applies. Refer to selector for
* syntax details.
*/
selector?: string;
}
/**
* Billing related configuration of the service. The following example shows
* how to configure monitored resources and metrics for billing:
* monitored_resources: - type: library.googleapis.com/branch labels: -
* key: /city description: The city where the library branch is
* located in. - key: /name description: The name of the branch.
* metrics: - name: library.googleapis.com/book/borrowed_count
* metric_kind: DELTA value_type: INT64 billing:
* consumer_destinations: - monitored_resource:
* library.googleapis.com/branch metrics: -
* library.googleapis.com/book/borrowed_count
*/
interface Schema$Billing {
/**
* Billing configurations for sending metrics to the consumer project. There
* can be multiple consumer destinations per service, each one must have a
* different monitored resource type. A metric can be used in at most one
* consumer destination.
*/
consumerDestinations?: Schema$BillingDestination[];
}
/**
* Configuration of a specific billing destination (Currently only support
* bill against consumer project).
*/
interface Schema$BillingDestination {
/**
* Names of the metrics to report to this billing destination. Each name
* must be defined in Service.metrics section.
*/
metrics?: string[];
/**
* The monitored resource type. The type must be defined in
* Service.monitored_resources section.
*/
monitoredResource?: string;
}
/**
* Represents a private connection resource. A private connection is
* implemented as a VPC Network Peering connection between a service
* producer's VPC network and a service consumer's VPC network.
*/
interface Schema$Connection {
/**
* The name of service consumer's VPC network that's connected with
* service producer network, in the following format:
* `projects/{project}/global/networks/{network}`. `{project}` is a project
* number, such as in `12345` that includes the VPC service consumer's
* VPC network. `{network}` is the name of the service consumer's VPC
* network.
*/
network?: string;
/**
* Output only. The name of the VPC Network Peering connection that was
* created by the service producer.
*/
peering?: string;
/**
* The name of one or more allocated IP address ranges for this service
* producer of type `PEERING`. Note that invoking this method with a
* different range when connection is already established will not modify
* already provisioned service producer subnetworks.
*/
reservedPeeringRanges?: string[];
/**
* Output only. The name of the peering service that's associated with
* this connection, in the following format: `services/{service name}`.
*/
service?: string;
}
/**
* `Context` defines which contexts an API requests. Example: context:
* rules: - selector: "*" requested: -
* google.rpc.context.ProjectContext -
* google.rpc.context.OriginContext The above specifies that all methods in
* the API request `google.rpc.context.ProjectContext` and
* `google.rpc.context.OriginContext`. Available context types are defined in
* package `google.rpc.context`. This also provides mechanism to whitelist
* any protobuf message extension that can be sent in grpc metadata using
* “x-goog-ext-<extension_id>-bin” and
* “x-goog-ext-<extension_id>-jspb” format. For example, list any
* service specific protobuf types that can appear in grpc metadata as follows
* in your yaml file: Example: context: rules: - selector:
* "google.example.library.v1.LibraryService.CreateBook"
* allowed_request_extensions: - google.foo.v1.NewExtension
* allowed_response_extensions: - google.foo.v1.NewExtension You can
* also specify extension ID instead of fully qualified extension name here.
*/
interface Schema$Context {
/**
* A list of RPC context rules that apply to individual API methods.
* **NOTE:** All service configuration rules follow "last one
* wins" order.
*/
rules?: Schema$ContextRule[];
}
/**
* A context rule provides information about the context for an individual API
* element.
*/
interface Schema$ContextRule {
/**
* A list of full type names or extension IDs of extensions allowed in grpc
* side channel from client to backend.
*/
allowedRequestExtensions?: string[];
/**
* A list of full type names or extension IDs of extensions allowed in grpc
* side channel from backend to client.
*/
allowedResponseExtensions?: string[];
/**
* A list of full type names of provided contexts.
*/
provided?: string[];
/**
* A list of full type names of requested contexts.
*/
requested?: string[];
/**
* Selects the methods to which this rule applies. Refer to selector for
* syntax details.
*/
selector?: string;
}
/**
* Selects and configures the service controller used by the service. The
* service controller handles features like abuse, quota, billing, logging,
* monitoring, etc.
*/
interface Schema$Control {
/**
* The service control environment to use. If empty, no control plane
* feature (like quota and billing) will be enabled.
*/
environment?: string;
}
/**
* Customize service error responses. For example, list any service specific
* protobuf types that can appear in error detail lists of error responses.
* Example: custom_error: types: - google.foo.v1.CustomError
* - google.foo.v1.AnotherError
*/
interface Schema$CustomError {
/**
* The list of custom error rules that apply to individual API messages.
* **NOTE:** All service configuration rules follow "last one
* wins" order.
*/
rules?: Schema$CustomErrorRule[];
/**
* The list of custom error detail types, e.g.
* 'google.foo.v1.CustomError'.
*/
types?: string[];
}
/**
* A custom error rule.
*/
interface Schema$CustomErrorRule {
/**
* Mark this message as possible payload in error response. Otherwise,
* objects of this type will be filtered when they appear in error payload.
*/
isErrorType?: boolean;
/**
* Selects messages to which this rule applies. Refer to selector for
* syntax details.
*/
selector?: string;
}
/**
* A custom pattern is used for defining custom HTTP verb.
*/
interface Schema$CustomHttpPattern {
/**
* The name of this custom HTTP verb.
*/
kind?: string;
/**
* The path matched by this custom verb.
*/
path?: string;
}
/**
* `Documentation` provides the information for describing a service. Example:
* <pre><code>documentation: summary: > The Google
* Calendar API gives access to most calendar features. pages: - name:
* Overview content: &#40;== include google/foo/overview.md
* ==&#41; - name: Tutorial content: &#40;== include
* google/foo/tutorial.md ==&#41; subpages; - name: Java content:
* &#40;== include google/foo/tutorial_java.md ==&#41; rules: -
* selector: google.calendar.Calendar.Get description: > ... -
* selector: google.calendar.Calendar.Put description: > ...
* </code></pre> Documentation is provided in markdown syntax. In
* addition to standard markdown features, definition lists, tables and fenced
* code blocks are supported. Section headers can be provided and are
* interpreted relative to the section nesting of the context where a
* documentation fragment is embedded. Documentation from the IDL is merged
* with documentation defined via the config at normalization time, where
* documentation provided by config rules overrides IDL provided. A number of
* constructs specific to the API platform are supported in documentation
* text. In order to reference a proto element, the following notation can be
* used:
* <pre><code>&#91;fully.qualified.proto.name]&#91;]</code></pre>
* To override the display text used for the link, this can be used:
* <pre><code>&#91;display
* text]&#91;fully.qualified.proto.name]</code></pre> Text can
* be excluded from doc using the following notation:
* <pre><code>&#40;-- internal comment
* --&#41;</code></pre> A few directives are available in
* documentation. Note that directives must appear on a single line to be
* properly identified. The `include` directive includes a markdown file from
* an external source: <pre><code>&#40;== include path/to/file
* ==&#41;</code></pre> The `resource_for` directive marks a
* message to be the resource of a collection in REST view. If it is not
* specified, tools attempt to infer the resource from the operations in a
* collection: <pre><code>&#40;== resource_for
* v1.shelves.books ==&#41;</code></pre> The directive
* `suppress_warning` does not directly affect documentation and is documented
* together with service config validation.
*/
interface Schema$Documentation {
/**
* The URL to the root of documentation.
*/
documentationRootUrl?: string;
/**
* Declares a single overview page. For example:
* <pre><code>documentation: summary: ... overview:
* &#40;== include overview.md ==&#41; </code></pre>
* This is a shortcut for the following declaration (using pages style):
* <pre><code>documentation: summary: ... pages: - name:
* Overview content: &#40;== include overview.md ==&#41;
* </code></pre> Note: you cannot specify both `overview` field
* and `pages` field.
*/
overview?: string;
/**
* The top level pages for the documentation set.
*/
pages?: Schema$Page[];
/**
* A list of documentation rules that apply to individual API elements.
* **NOTE:** All service configuration rules follow "last one
* wins" order.
*/
rules?: Schema$DocumentationRule[];
/**
* A short summary of what the service does. Can only be provided by plain
* text.
*/
summary?: string;
}
/**
* A documentation rule provides information about individual API elements.
*/
interface Schema$DocumentationRule {
/**
* Deprecation description of the selected element(s). It can be provided if
* an element is marked as `deprecated`.
*/
deprecationDescription?: string;
/**
* Description of the selected API(s).
*/
description?: string;
/**
* The selector is a comma-separated list of patterns. Each pattern is a
* qualified name of the element which may end in "*", indicating
* a wildcard. Wildcards are only allowed at the end and for a whole
* component of the qualified name, i.e. "foo.*" is ok, but not
* "foo.b*" or "foo.*.bar". A wildcard will match one or
* more components. To specify a default for all applicable elements, the
* whole pattern "*" is used.
*/
selector?: string;
}
/**
* `Endpoint` describes a network endpoint that serves a set of APIs. A
* service may expose any number of endpoints, and all endpoints share the
* same service configuration, such as quota configuration and monitoring
* configuration. Example service configuration: name:
* library-example.googleapis.com endpoints: # Below entry makes
* 'google.example.library.v1.Library' # API be served from
* endpoint address library-example.googleapis.com. # It also allows
* HTTP OPTIONS calls to be passed to the backend, for # it to decide
* whether the subsequent cross-origin request is # allowed to proceed.
* - name: library-example.googleapis.com allow_cors: true
*/
interface Schema$Endpoint {
/**
* DEPRECATED: This field is no longer supported. Instead of using aliases,
* please specify multiple google.api.Endpoint for each of the intended
* aliases. Additional names that this endpoint will be hosted on.
*/
aliases?: string[];
/**
* Allowing
* [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka
* cross-domain traffic, would allow the backends served from this endpoint
* to receive and respond to HTTP OPTIONS requests. The response will be
* used by the browser to determine whether the subsequent cross-origin
* request is allowed to proceed.
*/
allowCors?: boolean;
/**
* The list of features enabled on this endpoint.
*/
features?: string[];
/**
* The canonical name of this endpoint.
*/
name?: string;
/**
* The specification of an Internet routable address of API frontend that
* will handle requests to this [API
* Endpoint](https://cloud.google.com/apis/design/glossary). It should be
* either a valid IPv4 address or a fully-qualified domain name. For
* example, "8.8.8.8" or "myservice.appspot.com".
*/
target?: string;
}
/**
* Enum type definition.
*/
interface Schema$Enum {
/**
* Enum value definitions.
*/
enumvalue?: Schema$EnumValue[];
/**
* Enum type name.
*/
name?: string;
/**
* Protocol buffer options.
*/
options?: Schema$Option[];
/**
* The source context.
*/
sourceContext?: Schema$SourceContext;
/**
* The source syntax.
*/
syntax?: string;
}
/**
* Enum value definition.
*/
interface Schema$EnumValue {
/**
* Enum value name.
*/
name?: string;
/**
* Enum value number.
*/
number?: number;
/**
* Protocol buffer options.
*/
options?: Schema$Option[];
}
/**
* Experimental service configuration. These configuration options can only be
* used by whitelisted users.
*/
interface Schema$Experimental {
/**
* Authorization configuration.
*/
authorization?: Schema$AuthorizationConfig;
}
/**
* A single field of a message type.
*/
interface Schema$Field {
/**
* The field cardinality.
*/
cardinality?: string;
/**
* The string value of the default value of this field. Proto2 syntax only.
*/
defaultValue?: string;
/**
* The field JSON name.
*/
jsonName?: string;
/**
* The field type.
*/
kind?: string;
/**
* The field name.
*/
name?: string;
/**
* The field number.
*/
number?: number;
/**
* The index of the field type in `Type.oneofs`, for message or enumeration
* types. The first type has index 1; zero means the type is not in the
* list.
*/
oneofIndex?: number;
/**
* The protocol buffer options.
*/
options?: Schema$Option[];
/**
* Whether to use alternative packed wire representation.
*/
packed?: boolean;
/**
* The field type URL, without the scheme, for message or enumeration types.
* Example: `"type.googleapis.com/google.protobuf.Timestamp"`.
*/
typeUrl?: string;
}
/**
* Represents a subnet that was created or discovered by a private access
* management service.
*/
interface Schema$GoogleCloudServicenetworkingV1betaSubnetwork {
/**
* Subnetwork CIDR range in `10.x.x.x/y` format.
*/
ipCidrRange?: string;
/**
* Subnetwork name. See https://cloud.google.com/compute/docs/vpc/
*/
name?: string;
/**
* In the Shared VPC host project, the VPC network that's peered with
* the consumer network. For example:
* `projects/1234321/global/networks/host-network`
*/
network?: string;
/**
* This is a discovered subnet that is not within the current consumer
* allocated ranges.
*/
outsideAllocation?: boolean;
}
/**
* Defines the HTTP configuration for an API service. It contains a list of
* HttpRule, each specifying the mapping of an RPC method to one or more HTTP
* REST API methods.
*/
interface Schema$Http {
/**
* When set to true, URL path parameters will be fully URI-decoded except in
* cases of single segment matches in reserved expansion, where
* "%2F" will be left encoded. The default behavior is to not
* decode RFC 6570 reserved characters in multi segment matches.
*/
fullyDecodeReservedExpansion?: boolean;
/**
* A list of HTTP configuration rules that apply to individual API methods.
* **NOTE:** All service configuration rules follow "last one
* wins" order.
*/
rules?: Schema$HttpRule[];
}
/**
* # gRPC Transcoding gRPC Transcoding is a feature for mapping between a
* gRPC method and one or more HTTP REST endpoints. It allows developers to
* build a single API service that supports both gRPC APIs and REST APIs. Many
* systems, including [Google APIs](https://github.com/googleapis/googleapis),
* [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC
* Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and
* [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and
* use it for large scale production services. `HttpRule` defines the schema
* of the gRPC/REST mapping. The mapping specifies how different portions of
* the gRPC request message are mapped to the URL path, URL query parameters,
* and HTTP request body. It also controls how the gRPC response message is
* mapped to the HTTP response body. `HttpRule` is typically specified as an
* `google.api.http` annotation on the gRPC method. Each mapping specifies a
* URL path template and an HTTP method. The path template may refer to one or
* more fields in the gRPC request message, as long as each field is a
* non-repeated field with a primitive (non-message) type. The path template
* controls how fields of the request message are mapped to the URL path.
* Example: service Messaging { rpc GetMessage(GetMessageRequest)
* returns (Message) { option (google.api.http) = { get:
* "/v1/{name=messages/*}" }; } } message
* GetMessageRequest { string name = 1; // Mapped to URL path. }
* message Message { string text = 1; // The resource content. }
* This enables an HTTP REST to gRPC mapping as below: HTTP | gRPC
* -----|----- `GET /v1/messages/123456` | `GetMessage(name:
* "messages/123456")` Any fields in the request message which are
* not bound by the path template automatically become HTTP query parameters
* if there is no HTTP request body. For example: service Messaging { rpc
* GetMessage(GetMessageRequest) returns (Message) { option
* (google.api.http) = { get:"/v1/messages/{message_id}"
* }; } } message GetMessageRequest { message SubMessage {
* string subfield = 1; } string message_id = 1; // Mapped to URL
* path. int64 revision = 2; // Mapped to URL query parameter
* `revision`. SubMessage sub = 3; // Mapped to URL query parameter
* `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below:
* HTTP | gRPC -----|----- `GET
* /v1/messages/123456?revision=2&sub.subfield=foo` |
* `GetMessage(message_id: "123456" revision: 2 sub:
* SubMessage(subfield: "foo"))` Note that fields which are mapped
* to URL query parameters must have a primitive type or a repeated primitive
* type or a non-repeated message type. In the case of a repeated type, the
* parameter can be repeated in the URL as `...?param=A&param=B`. In the
* case of a message type, each field of the message is mapped to a separate
* parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods
* that allow a request body, the `body` field specifies the mapping. Consider
* a REST update method on the message resource collection: service
* Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message)
* { option (google.api.http) = { patch:
* "/v1/messages/{message_id}" body: "message"
* }; } } message UpdateMessageRequest { string message_id
* = 1; // mapped to the URL Message message = 2; // mapped to the
* body } The following HTTP JSON to RPC mapping is enabled, where the
* representation of the JSON in the request body is determined by protos JSON
* encoding: HTTP | gRPC -----|----- `PATCH /v1/messages/123456 {
* "text": "Hi!" }` | `UpdateMessage(message_id:
* "123456" message { text: "Hi!" })` The special name
* `*` can be used in the body mapping to define that every field not bound by
* the path template should be mapped to the request body. This enables the
* following alternative definition of the update method: service
* Messaging { rpc UpdateMessage(Message) returns (Message) { option
* (google.api.http) = { patch:
* "/v1/messages/{message_id}" body: "*" }; } }
* message Message { string message_id = 1; string text = 2; }
* The following HTTP JSON to RPC mapping is enabled: HTTP | gRPC -----|-----
* `PATCH /v1/messages/123456 { "text": "Hi!" }` |
* `UpdateMessage(message_id: "123456" text: "Hi!")` Note
* that when using `*` in the body mapping, it is not possible to have HTTP
* parameters, as all fields not bound by the path end in the body. This makes
* this option more rarely used in practice when defining REST APIs. The
* common usage of `*` is in custom methods which don't use the URL at all
* for transferring data. It is possible to define multiple HTTP methods for
* one RPC by using the `additional_bindings` option. Example: service
* Messaging { rpc GetMessage(GetMessageRequest) returns (Message) {
* option (google.api.http) = { get:
* "/v1/messages/{message_id}" additional_bindings { get:
* "/v1/users/{user_id}/messages/{message_id}" } }; } }
* message GetMessageRequest { string message_id = 1; string
* user_id = 2; } This enables the following two alternative HTTP JSON to
* RPC mappings: HTTP | gRPC -----|----- `GET /v1/messages/123456` |
* `GetMessage(message_id: "123456")` `GET
* /v1/users/me/messages/123456` | `GetMessage(user_id: "me"
* message_id: "123456")` ## Rules for HTTP mapping 1. Leaf
* request fields (recursive expansion nested messages in the request message)
* are classified into three categories: - Fields referred by the path
* template. They are passed via the URL path. - Fields referred by the
* HttpRule.body. They are passed via the HTTP request body. - All
* other fields are passed via the URL query parameters, and the parameter
* name is the field path in the request message. A repeated field can be
* represented as multiple query parameters under the same name. 2. If
* HttpRule.body is "*", there is no URL query parameter, all fields
* are passed via URL path and HTTP request body. 3. If HttpRule.body is
* omitted, there is no HTTP request body, all fields are passed via URL
* path and URL query parameters. ### Path template syntax Template =
* "/" Segments [ Verb ] ; Segments = Segment { "/"
* Segment } ; Segment = "*" | "**" | LITERAL |
* Variable ; Variable = "{" FieldPath [ "=" Segments
* ] "}" ; FieldPath = IDENT { "." IDENT } ; Verb
* = ":" LITERAL ; The syntax `*` matches a single URL path
* segment. The syntax `**` matches zero or more URL path segments, which must
* be the last part of the URL path except the `Verb`. The syntax `Variable`
* matches part of the URL path as specified by its template. A variable
* template must not contain other variables. If a variable matches a single
* path segment, its template may be omitted, e.g. `{var}` is equivalent to
* `{var=*}`. The syntax `LITERAL` matches literal text in the URL path. If
* the `LITERAL` contains any reserved character, such characters should be
* percent-encoded before the matching. If a variable contains exactly one
* path segment, such as `"{var}"` or `"{var=*}"`, when
* such a variable is expanded into a URL path on the client side, all
* characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side
* does the reverse decoding. Such variables show up in the [Discovery
* Document](https://developers.google.com/discovery/v1/reference/apis) as
* `{var}`. If a variable contains multiple path segments, such as
* `"{var=foo/*}"` or `"{var=**}"`, when such a variable
* is expanded into a URL path on the client side, all characters except
* `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse
* decoding, except "%2F" and "%2f" are left unchanged.
* Such variables show up in the [Discovery
* Document](https://developers.google.com/discovery/v1/reference/apis) as
* `{+var}`. ## Using gRPC API Service Configuration gRPC API Service
* Configuration (service config) is a configuration language for configuring
* a gRPC service to become a user-facing product. The service config is
* simply the YAML representation of the `google.api.Service` proto message.
* As an alternative to annotating your proto file, you can configure gRPC
* transcoding in your service config YAML files. You do this by specifying a
* `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same
* effect as the proto annotation. This can be particularly useful if you have
* a proto that is reused in multiple services. Note that any transcoding
* specified in the service config will override any matching transcoding
* configuration in the proto. Example: http: rules: #
* Selects a gRPC method and applies HttpRule to it. - selector:
* example.v1.Messaging.GetMessage get:
* /v1/messages/{message_id}/{sub.subfield} ## Special notes When gRPC
* Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON
* conversion must follow the [proto3
* specification](https://developers.google.com/protocol-buffers/docs/proto3#json).
* While the single segment variable follows the semantics of [RFC
* 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String
* Expansion, the multi segment variable **does not** follow RFC 6570
* Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion
* does not expand special characters like `?` and `#`, which would lead to
* invalid URLs. As the result, gRPC Transcoding uses a custom encoding for
* multi segment variables. The path variables **must not** refer to any
* repeated or mapped field, because client libraries are not capable of
* handling such variable expansion. The path variables **must not** capture
* the leading "/" character. The reason is that the most common use
* case "{var}" does not capture the leading "/"
* character. For consistency, all path variables must share the same
* behavior. Repeated message fields must not be mapped to URL query
* parameters, because no client library can support such complicated mapping.
* If an API needs to use a JSON array for request or response body, it can
* map the request or response body to a repeated field. However, some gRPC
* Transcoding implementations may not support this feature.
*/
interface Schema$HttpRule {
/**
* Additional HTTP bindings for the selector. Nested bindings must not
* contain an `additional_bindings` field themselves (that is, the nesting
* may only be one level deep).
*/
additionalBindings?: Schema$HttpRule[];
/**
* The name of the request field whose value is mapped to the HTTP request
* body, or `*` for mapping all request fields not captured by the path
* pattern to the HTTP body, or omitted for not having any HTTP request
* body. NOTE: the referred field must be present at the top-level of the
* request message type.
*/
body?: string;
/**
* The custom pattern is used for specifying an HTTP method that is not
* included in the `pattern` field, such as HEAD, or "*" to leave
* the HTTP method unspecified for this rule. The wild-card rule is useful
* for services that provide content to Web (HTML) clients.
*/
custom?: Schema$CustomHttpPattern;
/**
* Maps to HTTP DELETE. Used for deleting a resource.
*/
delete?: string;
/**
* Maps to HTTP GET. Used for listing and getting information about
* resources.
*/
get?: string;
/**
* Maps to HTTP PATCH. Used for updating a resource.
*/
patch?: string;
/**
* Maps to HTTP POST. Used for creating a resource or performing an action.
*/
post?: string;
/**
* Maps to HTTP PUT. Used for replacing a resource.
*/
put?: string;
/**
* Optional. The name of the response field whose value is mapped to the
* HTTP response body. When omitted, the entire response message will be
* used as the HTTP response body. NOTE: The referred field must be present
* at the top-level of the response message type.
*/
responseBody?: string;
/**
* Selects a method to which this rule applies. Refer to selector for
* syntax details.
*/
selector?: string;
}
/**
* A description of a label.
*/
interface Schema$LabelDescriptor {
/**
* A human-readable description for the label.
*/
description?: string;
/**
* The label key.
*/
key?: string;
/**
* The type of data that can be assigned to the label.
*/
valueType?: string;
}
/**
* ListConnectionsResponse is the response to list peering states for the
* given service and consumer project.
*/
interface Schema$ListConnectionsResponse {
/**
* The list of Connections.
*/
connections?: Schema$Connection[];
}
/**
* A description of a log type. Example in YAML format: - name:
* library.googleapis.com/activity_history description: The history of
* borrowing and returning library items. display_name: Activity labels:
* - key: /customer_id description: Identifier of a library customer
*/
interface Schema$LogDescriptor {
/**
* A human-readable description of this log. This information appears in the
* documentation and can contain details.
*/
description?: string;
/**
* The human-readable name for this log. This information appears on the
* user interface and should be concise.
*/
displayName?: string;
/**
* The set of labels that are available to describe a specific log entry.
* Runtime requests that contain labels not specified here are considered
* invalid.
*/
labels?: Schema$LabelDescriptor[];
/**
* The name of the log. It must be less than 512 characters long and can
* include the following characters: upper- and lower-case alphanumeric
* characters [A-Za-z0-9], and punctuation characters including slash,
* underscore, hyphen, period [/_-.].
*/
name?: string;
}
/**
* Logging configuration of the service. The following example shows how to
* configure logs to be sent to the producer and consumer projects. In the
* example, the `activity_history` log is sent to both the producer and
* consumer projects, whereas the `purchase_history` log is only sent to the
* producer project. monitored_resources: - type:
* library.googleapis.com/branch labels: - key: /city description:
* The city where the library branch is located in. - key: /name
* description: The name of the branch. logs: - name: activity_history
* labels: - key: /customer_id - name: purchase_history logging:
* producer_destinations: - monitored_resource:
* library.googleapis.com/branch logs: - activity_history -
* purchase_history consumer_destinations: - monitored_resource:
* library.googleapis.com/branch logs: - activity_history
*/
interface Schema$Logging {
/**
* Logging configurations for sending logs to the consumer project. There
* can be multiple consumer destinations, each one must have a different
* monitored resource type. A log can be used in at most one consumer
* destination.
*/
consumerDestinations?: Schema$LoggingDestination[];
/**
* Logging configurations for sending logs to the producer project. There
* can be multiple producer destinations, each one must have a different
* monitored resource type. A log can be used in at most one producer
* destination.
*/
producerDestinations?: Schema$LoggingDestination[];
}
/**
* Configuration of a specific logging destination (the producer project or
* the consumer project).
*/
interface Schema$LoggingDestination {
/**
* Names of the logs to be sent to this destination. Each name must be
* defined in the Service.logs section. If the log name is not a domain
* scoped name, it will be automatically prefixed with the service name
* followed by "/".
*/
logs?: string[];
/**
* The monitored resource type. The type must be defined in the
* Service.monitored_resources section.
*/
monitoredResource?: string;
}
/**
* Method represents a method of an API interface.
*/
interface Schema$Method {
/**
* The simple name of this method.
*/
name?: string;
/**
* Any metadata attached to the method.
*/
options?: Schema$Option[];
/**
* If true, the request is streamed.
*/
requestStreaming?: boolean;
/**
* A URL of the input message type.
*/
requestTypeUrl?: string;
/**
* If true, the response is streamed.
*/
responseStreaming?: boolean;
/**
* The URL of the output message type.
*/
responseTypeUrl?: string;
/**
* The source syntax of this method.
*/
syntax?: string;
}
/**
* Defines a metric type and its schema. Once a metric descriptor is created,
* deleting or altering it stops data collection and makes the metric
* type's existing data unusable.
*/
interface Schema$MetricDescriptor {
/**
* A detailed description of the metric, which can be used in documentation.
*/
description?: string;
/**
* A concise name for the metric, which can be displayed in user interfaces.
* Use sentence case without an ending period, for example "Request
* count". This field is optional but it is recommended to be set for
* any metrics associated with user-visible concepts, such as Quota.
*/
displayName?: string;
/**
* The set of labels that can be used to describe a specific instance of
* this metric type. For example, the
* `appengine.googleapis.com/http/server/response_latencies` metric type has
* a label for the HTTP response code, `response_code`, so you can look at
* latencies for successful responses or just for responses that failed.
*/
labels?: Schema$LabelDescriptor[];
/**
* Optional. Metadata which can be used to guide usage of the metric.
*/
metadata?: Schema$MetricDescriptorMetadata;
/**
* Whether the metric records instantaneous values, changes to a value, etc.
* Some combinations of `metric_kind` and `value_type` might not be
* supported.
*/
metricKind?: string;
/**
* The resource name of the metric descriptor.
*/
name?: string;
/**
* The metric type, including its DNS name prefix. The type is not
* URL-encoded. All user-defined metric types have the DNS name
* `custom.googleapis.com` or `external.googleapis.com`. Metric types
* should use a natural hierarchical grouping. For example:
* "custom.googleapis.com/invoice/paid/amount"
* "external.googleapis.com/prometheus/up"
* "appengine.googleapis.com/http/server/response_latencies"
*/
type?: string;
/**
* The unit in which the metric value is reported. It is only applicable if
* the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The supported
* units are a subset of [The Unified Code for Units of
* Measure](http://unitsofmeasure.org/ucum.html) standard: **Basic units
* (UNIT)** * `bit` bit * `By` byte * `s` second * `min` minute
* * `h` hour * `d` day **Prefixes (PREFIX)** * `k` kilo
* (10**3) * `M` mega (10**6) * `G` giga (10**9) * `T` tera
* (10**12) * `P` peta (10**15) * `E` exa (10**18) * `Z`
* zetta (10**21) * `Y` yotta (10**24) * `m` milli (10**-3) *
* `u` micro (10**-6) * `n` nano (10**-9) * `p` pico
* (10**-12) * `f` femto (10**-15) * `a` atto (10**-18) * `z`
* zepto (10**-21) * `y` yocto (10**-24) * `Ki` kibi (2**10) *
* `Mi` mebi (2**20) * `Gi` gibi (2**30) * `Ti` tebi (2**40)
* **Grammar** The grammar also includes these connectors: * `/` division
* (as an infix operator, e.g. `1/s`). * `.` multiplication (as an infix
* operator, e.g. `GBy.d`) The grammar for a unit is as follows: Expression
* = Component { "." Component } { "/" Component } ;
* Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] |
* Annotation | "1" ; Annotation
* = "{" NAME "}" ; Notes: * `Annotation` is just a
* comment if it follows a `UNIT` and is equivalent to `1` if it is used
* alone. For examples, `{requests}/s == 1/s`, `By{transmitted}/s ==
* By/s`. * `NAME` is a sequence of non-blank printable ASCII characters not
* containing '{' or '}'. * `1` represents dimensionless
* value 1, such as in `1/s`. * `%` represents dimensionless value 1/100,
* and annotates values giving a percentage.
*/
unit?: string;
/**
* Whether the measurement is an integer, a floating-point number, etc. Some
* combinations of `metric_kind` and `value_type` might not be supported.
*/
valueType?: string;
}
/**
* Additional annotations that can be used to guide the usage of a metric.
*/
interface Schema$MetricDescriptorMetadata {
/**
* The delay of data points caused by ingestion. Data points older than this
* age are guaranteed to be ingested and available to be read, excluding
* data loss due to errors.
*/
ingestDelay?: string;
/**
* The launch stage of the metric definition.
*/
launchStage?: string;
/**
* The sampling period of metric data points. For metrics which are written
* periodically, consecutive data points are stored at this time interval,
* excluding data loss due to errors. Metrics with a higher granularity have
* a smaller sampling period.
*/
samplePeriod?: string;
}
/**
* Bind API methods to metrics. Binding a method to a metric causes that
* metric's configured quota behaviors to apply to the method call.
*/
interface Schema$MetricRule {
/**
* Metrics to update when the selected methods are called, and the
* associated cost applied to each metric. The key of the map is the metric
* name, and the values are the amount increased for the metric against
* which the quota limits are defined. The value must not be negative.
*/
metricCosts?: {
[key: string]: string;
};
/**
* Selects the methods to which this rule applies. Refer to selector for
* syntax details.
*/
selector?: string;
}
/**
* Declares an API Interface to be included in this interface. The including
* interface must redeclare all the methods from the included interface, but
* documentation and options are inherited as follows: - If after comment and
* whitespace stripping, the documentation string of the redeclared method
* is empty, it will be inherited from the original method. - Each
* annotation belonging to the service config (http, visibility) which is
* not set in the redeclared method will be inherited. - If an http
* annotation is inherited, the path pattern will be modified as follows.
* Any version prefix will be replaced by the version of the including
* interface plus the root path if specified. Example of a simple mixin:
* package google.acl.v1; service AccessControl { // Get the
* underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) {
* option (google.api.http).get = "/v1/{resource=**}:getAcl"; } }
* package google.storage.v2; service Storage { // rpc
* GetAcl(GetAclRequest) returns (Acl); // Get a data record. rpc
* GetData(GetDataRequest) returns (Data) { option
* (google.api.http).get = "/v2/{resource=**}"; } }
* Example of a mixin configuration: apis: - name:
* google.storage.v2.Storage mixins: - name:
* google.acl.v1.AccessControl The mixin construct implies that all methods
* in `AccessControl` are also declared with same name and request/response
* types in `Storage`. A documentation generator or annotation processor will
* see the effective `Storage.GetAcl` method after inherting documentation and
* annotations as follows: service Storage { // Get the underlying
* ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option
* (google.api.http).get = "/v2/{resource=**}:getAcl"; } ...
* } Note how the version in the path pattern changed from `v1` to `v2`. If
* the `root` field in the mixin is specified, it should be a relative path
* under which inherited HTTP paths are placed. Example: apis: -
* name: google.storage.v2.Storage mixins: - name:
* google.acl.v1.AccessControl root: acls This implies the following
* inherited HTTP annotation: service Storage { // Get the
* underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) {
* option (google.api.http).get = "/v2/acls/{resource=**}:getAcl";
* } ... }
*/
interface Schema$Mixin {
/**
* The fully qualified name of the interface which is included.
*/
name?: string;
/**
* If non-empty specifies a path under which inherited HTTP paths are
* rooted.
*/
root?: string;
}
/**
* An object that describes the schema of a MonitoredResource object using a
* type name and a set of labels. For example, the monitored resource
* descriptor for Google Compute Engine VM instances has a type of
* `"gce_instance"` and specifies the use of the labels
* `"instance_id"` and `"zone"` to identify particular VM
* instances. Different APIs can support different monitored resource types.
* APIs generally provide a `list` method that returns the monitored resource
* descriptors used by the API.
*/
interface Schema$MonitoredResourceDescriptor {
/**
* Optional. A detailed description of the monitored resource type that
* might be used in documentation.
*/
description?: string;
/**
* Optional. A concise name for the monitored resource type that might be
* displayed in user interfaces. It should be a Title Cased Noun Phrase,
* without any article or other determiners. For example, `"Google
* Cloud SQL Database"`.
*/
displayName?: string;
/**
* Required. A set of labels used to describe instances of this monitored
* resource type. For example, an individual Google Cloud SQL database is
* identified by values for the labels `"database_id"` and
* `"zone"`.
*/
labels?: Schema$LabelDescriptor[];
/**
* Optional. The resource name of the monitored resource descriptor:
* `"projects/{project_id}/monitoredResourceDescriptors/{type}"`
* where {type} is the value of the `type` field in this object and
* {project_id} is a project ID that provides API-specific context for
* accessing the type. APIs that do not use project information can use the
* resource name format `"monitoredResourceDescriptors/{type}"`.
*/
name?: string;
/**
* Required. The monitored resource type. For example, the type
* `"cloudsql_database"` represents databases in Google Cloud SQL.
* The maximum length of this value is 256 characters.
*/
type?: string;
}
/**
* Monitoring configuration of the service. The example below shows how to
* configure monitored resources and metrics for monitoring. In the example, a
* monitored resource and two metrics are defined. The
* `library.googleapis.com/book/returned_count` metric is sent to both
* producer and consumer projects, whereas the
* `library.googleapis.com/book/overdue_count` metric is only sent to the
* consumer project. monitored_resources: - type:
* library.googleapis.com/branch labels: - key: /city description:
* The city where the library branch is located in. - key: /name
* description: The name of the branch. metrics: - name:
* library.googleapis.com/book/returned_count metric_kind: DELTA
* value_type: INT64 labels: - key: /customer_id - name:
* library.googleapis.com/book/overdue_count metric_kind: GAUGE
* value_type: INT64 labels: - key: /customer_id monitoring:
* producer_destinations: - monitored_resource:
* library.googleapis.com/branch metrics: -
* library.googleapis.com/book/returned_count consumer_destinations: -
* monitored_resource: library.googleapis.com/branch metrics: -
* library.googleapis.com/book/returned_count -
* library.googleapis.com/book/overdue_count
*/
interface Schema$Monitoring {
/**
* Monitoring configurations for sending metrics to the consumer project.
* There can be multiple consumer destinations. A monitored resouce type may
* appear in multiple monitoring destinations if different aggregations are
* needed for different sets of metrics associated with that monitored
* resource type. A monitored resource and metric pair may only be used once
* in the Monitoring configuration.
*/
consumerDestinations?: Schema$MonitoringDestination[];
/**
* Monitoring configurations for sending metrics to the producer project.
* There can be multiple producer destinations. A monitored resouce type may
* appear in multiple monitoring destinations if different aggregations are
* needed for different sets of metrics associated with that monitored
* resource type. A monitored resource and metric pair may only be used once
* in the Monitoring configuration.
*/
producerDestinations?: Schema$MonitoringDestination[];
}
/**
* Configuration of a specific monitoring destination (the producer project or
* the consumer project).
*/
interface Schema$MonitoringDestination {
/**
* Types of the metrics to report to this monitoring destination. Each type
* must be defined in Service.metrics section.
*/
metrics?: string[];
/**
* The monitored resource type. The type must be defined in
* Service.monitored_resources section.
*/
monitoredResource?: string;
}
/**
* OAuth scopes are a way to define data and permissions on data. For example,
* there are scopes defined for "Read-only access to Google
* Calendar" and "Access to Cloud Platform". Users can consent
* to a scope for an application, giving it permission to access that data on
* their behalf. OAuth scope specifications should be fairly coarse grained;
* a user will need to see and understand the text description of what your
* scope means. In most cases: use one or at most two OAuth scopes for an
* entire family of products. If your product has multiple APIs, you should
* probably be sharing the OAuth scope across all of those APIs. When you
* need finer grained OAuth consent screens: talk with your product management
* about how developers will use them in practice. Please note that even
* though each of the canonical scopes is enough for a request to be accepted
* and passed to the backend, a request can still fail due to the backend
* requiring additional scopes or permissions.
*/
interface Schema$OAuthRequirements {
/**
* The list of publicly documented OAuth scopes that are allowed access. An
* OAuth token containing any of these scopes will be accepted. Example:
* canonical_scopes: https://www.googleapis.com/auth/calendar,
* https://www.googleapis.com/auth/calendar.read
*/
canonicalScopes?: string;
}
/**
* This resource represents a long-running operation that is the result of a
* network API call.
*/
interface Schema$Operation {
/**
* If the value is `false`, it means the operation is still in progress. If
* `true`, the operation is completed, and either `error` or `response` is
* available.
*/
done?: boolean;
/**
* The error result of the operation in case of failure or cancellation.
*/
error?: Schema$Status;
/**
* Service-specific metadata associated with the operation. It typically
* contains progress information and common metadata such as create time.
* Some services might not provide such metadata. Any method that returns a
* long-running operation should document the metadata type, if any.
*/
metadata?: {
[key: string]: any;
};
/**
* The server-assigned name, which is only unique within the same service
* that originally returns it. If you use the default HTTP mapping, the
* `name` should have the format of `operations/some/unique/name`.
*/
name?: string;
/**
* The normal response of the operation in case of success. If the original
* method returns no data on success, such as `Delete`, the response is
* `google.protobuf.Empty`. If the original method is standard
* `Get`/`Create`/`Update`, the response should be the resource. For other
* methods, the response should have the type `XxxResponse`, where `Xxx` is
* the original method name. For example, if the original method name is
* `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
*/
response?: {
[key: string]: any;
};
}
/**
* A protocol buffer option, which can be attached to a message, field,
* enumeration, etc.
*/
interface Schema$Option {
/**
* The option's name. For protobuf built-in options (options defined in
* descriptor.proto), this is the short name. For example,
* `"map_entry"`. For custom options, it should be the
* fully-qualified name. For example, `"google.api.http"`.
*/
name?: string;
/**
* The option's value packed in an Any message. If the value is a
* primitive, the corresponding wrapper type defined in
* google/protobuf/wrappers.proto should be used. If the value is an enum,
* it should be stored as an int32 value using the
* google.protobuf.Int32Value type.
*/
value?: {
[key: string]: any;
};
}
/**
* Represents a documentation page. A page can contain subpages to represent
* nested documentation set structure.
*/
interface Schema$Page {
/**
* The Markdown content of the page. You can use <code>&#40;==
* include {path} ==&#41;</code> to include content from a
* Markdown file.
*/
content?: string;
/**
* The name of the page. It will be used as an identity of the page to
* generate URI of the page, text of the link to this page in navigation,
* etc. The full page name (start from the root page name to this page
* concatenated with `.`) can be used as reference to the page in your
* documentation. For example: <pre><code>pages: - name:
* Tutorial content: &#40;== include tutorial.md ==&#41; subpages:
* - name: Java content: &#40;== include tutorial_java.md
* ==&#41; </code></pre> You can reference `Java` page using
* Markdown reference link syntax: `Java`.
*/
name?: string;
/**
* Subpages of this page. The order of subpages specified here will be
* honored in the generated docset.
*/
subpages?: Schema$Page[];
}
/**
* Quota configuration helps to achieve fairness and budgeting in service
* usage. The metric based quota configuration works this way: - The service
* configuration defines a set of metrics. - For API calls, the
* quota.metric_rules maps methods to metrics with corresponding costs. -
* The quota.limits defines limits on the metrics, which will be used for
* quota checks at runtime. An example quota configuration in yaml format:
* quota: limits: - name: apiWriteQpsPerProject metric:
* library.googleapis.com/write_calls unit: "1/min/{project}"
* # rate limit for consumer projects values: STANDARD: 10000
* # The metric rules bind all methods to the read_calls metric, # except
* for the UpdateBook and DeleteBook methods. These two methods # are
* mapped to the write_calls metric, with the UpdateBook method #
* consuming at twice rate as the DeleteBook method. metric_rules: -
* selector: "*" metric_costs:
* library.googleapis.com/read_calls: 1 - selector:
* google.example.library.v1.LibraryService.UpdateBook metric_costs:
* library.googleapis.com/write_calls: 2 - selector:
* google.example.library.v1.LibraryService.DeleteBook metric_costs:
* library.googleapis.com/write_calls: 1 Corresponding Metric definition:
* metrics: - name: library.googleapis.com/read_calls display_name: Read
* requests metric_kind: DELTA value_type: INT64 - name:
* library.googleapis.com/write_calls display_name: Write requests
* metric_kind: DELTA value_type: INT64
*/
interface Schema$Quota {
/**
* List of `QuotaLimit` definitions for the service.
*/
limits?: Schema$QuotaLimit[];
/**
* List of `MetricRule` definitions, each one mapping a selected method to
* one or more metrics.
*/
metricRules?: Schema$MetricRule[];
}
/**
* `QuotaLimit` defines a specific limit that applies over a specified
* duration for a limit type. There can be at most one limit for a duration
* and limit type combination defined within a `QuotaGroup`.
*/
interface Schema$QuotaLimit {
/**
* Default number of tokens that can be consumed during the specified
* duration. This is the number of tokens assigned when a client application
* developer activates the service for his/her project. Specifying a value
* of 0 will block all requests. This can be used if you are provisioning
* quota to selected consumers and blocking others. Similarly, a value of -1
* will indicate an unlimited quota. No other negative values are allowed.
* Used by group-based quotas only.
*/
defaultLimit?: string;
/**
* Optional. User-visible, extended description for this quota limit. Should
* be used only when more context is needed to understand this limit than
* provided by the limit's display name (see: `display_name`).
*/
description?: string;
/**
* User-visible display name for this limit. Optional. If not set, the UI
* will provide a default display name based on the quota configuration.
* This field can be used to override the default display name generated
* from the configuration.
*/
displayName?: string;
/**
* Duration of this limit in textual notation. Example: "100s",
* "24h", "1d". For duration longer than a day, only
* multiple of days is supported. We support only "100s" and
* "1d" for now. Additional support will be added in the future.
* "0" indicates indefinite duration. Used by group-based quotas
* only.
*/
duration?: string;
/**
* Free tier value displayed in the Developers Console for this limit. The
* free tier is the number of tokens that will be subtracted from the billed
* amount when billing is enabled. This field can only be set on a limit
* with duration "1d", in a billable group; it is invalid on any
* other limit. If this field is not set, it defaults to 0, indicating that
* there is no free tier for this service. Used by group-based quotas only.
*/
freeTier?: string;
/**
* Maximum number of tokens that can be consumed during the specified
* duration. Client application developers can override the default limit up
* to this maximum. If specified, this value cannot be set to a value less
* than the default limit. If not specified, it is set to the default limit.
* To allow clients to apply overrides with no upper bound, set this to -1,
* indicating unlimited maximum quota. Used by group-based quotas only.
*/
maxLimit?: string;
/**
* The name of the metric this quota limit applies to. The quota limits with
* the same metric will be checked together during runtime. The metric must
* be defined within the service config.
*/
metric?: string;
/**
* Name of the quota limit. The name must be provided, and it must be
* unique within the service. The name can only include alphanumeric
* characters as well as '-'. The maximum length of the limit name
* is 64 characters.
*/
name?: string;
/**
* Specify the unit of the quota limit. It uses the same syntax as
* Metric.unit. The supported unit kinds are determined by the quota backend
* system. Here are some examples: * "1/min/{project}" for quota
* per minute per project. Note: the order of unit components is
* insignificant. The "1" at the beginning is required to follow
* the metric unit syntax.
*/
unit?: string;
/**
* Tiered limit values. You must specify this as a key:value pair, with an
* integer value that is the maximum number of requests allowed for the
* specified unit. Currently only STANDARD is supported.
*/
values?: {
[key: string]: string;
};
}
/**
* Represents a found unused range.
*/
interface Schema$Range {
/**
* CIDR range in "10.x.x.x/y" format that is within the allocated
* ranges and currently unused.
*/
ipCidrRange?: string;
/**
* In the Shared VPC host project, the VPC network that's peered with
* the consumer network. For example:
* `projects/1234321/global/networks/host-network`
*/
network?: string;
}
/**
* Request to search for an unused range within allocated ranges.
*/
interface Schema$SearchRangeRequest {
/**
* Required. The prefix length of the IP range. Use usual CIDR range
* notation. For example, '30' to find unused x.x.x.x/30 CIDR range.
* Actual range will be determined using allocated range for the consumer
* peered network and returned in the result.
*/
ipPrefixLength?: number;
/**
* Network name in the consumer project. This network must have been
* already peered with a shared VPC network using CreateConnection method.
* Must be in a form 'projects/{project}/global/networks/{network}'.
* {project} is a project number, as in '12345' {network} is network
* name.
*/
network?: string;
}
/**
* `Service` is the root object of Google service configuration schema. It
* describes basic information about a service, such as the name and the
* title, and delegates other aspects to sub-sections. Each sub-section is
* either a proto message or a repeated proto message that configures a
* specific aspect, such as auth. See each proto message definition for
* details. Example: type: google.api.Service config_version: 3
* name: calendar.googleapis.com title: Google Calendar API apis: -
* name: google.calendar.v3.Calendar authentication: providers: -
* id: google_calendar_auth jwks_uri:
* https://www.googleapis.com/oauth2/v1/certs issuer:
* https://securetoken.google.com rules: - selector: "*"
* requirements: provider_id: google_calendar_auth
*/
interface Schema$Service {
/**
* A list of API interfaces exported by this service. Only the `name` field
* of the google.protobuf.Api needs to be provided by the configuration
* author, as the remaining fields will be derived from the IDL during the
* normalization process. It is an error to specify an API interface here
* which cannot be resolved against the associated IDL files.
*/
apis?: Schema$Api[];
/**
* Auth configuration.
*/
authentication?: Schema$Authentication;
/**
* API backend configuration.
*/
backend?: Schema$Backend;
/**
* Billing configuration.
*/
billing?: Schema$Billing;
/**
* The semantic version of the service configuration. The config version
* affects the interpretation of the service configuration. For example,
* certain features are enabled by default for certain config versions. The
* latest config version is `3`.
*/
configVersion?: number;
/**
* Context configuration.
*/
context?: Schema$Context;
/**
* Configuration for the service control plane.
*/
control?: Schema$Control;
/**
* Custom error configuration.
*/
customError?: Schema$CustomError;
/**
* Additional API documentation.
*/
documentation?: Schema$Documentation;
/**
* Configuration for network endpoints. If this is empty, then an endpoint
* with the same name as the service is automatically generated to service
* all defined APIs.
*/
endpoints?: Schema$Endpoint[];
/**
* A list of all enum types included in this API service. Enums referenced
* directly or indirectly by the `apis` are automatically included. Enums
* which are not referenced but shall be included should be listed here by
* name. Example: enums: - name: google.someapi.v1.SomeEnum
*/
enums?: Schema$Enum[];
/**
* Experimental configuration.
*/
experimental?: Schema$Experimental;
/**
* HTTP configuration.
*/
http?: Schema$Http;
/**
* A unique ID for a specific instance of this message, typically assigned
* by the client for tracking purpose. If empty, the server may choose to
* generate one instead. Must be no longer than 60 characters.
*/
id?: string;
/**
* Logging configuration.
*/
logging?: Schema$Logging;
/**
* Defines the logs used by this service.
*/
logs?: Schema$LogDescriptor[];
/**
* Defines the metrics used by this service.
*/
metrics?: Schema$MetricDescriptor[];
/**
* Defines the monitored resources used by this service. This is required by
* the Service.monitoring and Service.logging configurations.
*/
monitoredResources?: Schema$MonitoredResourceDescriptor[];
/**
* Monitoring configuration.
*/
monitoring?: Schema$Monitoring;
/**
* The service name, which is a DNS-like logical identifier for the service,
* such as `calendar.googleapis.com`. The service name typically goes
* through DNS verification to make sure the owner of the service also owns
* the DNS name.
*/
name?: string;
/**
* The Google project that owns this service.
*/
producerProjectId?: string;
/**
* Quota configuration.
*/
quota?: Schema$Quota;
/**
* Output only. The source information for this configuration if available.
*/
sourceInfo?: Schema$SourceInfo;
/**
* System parameter configuration.
*/
systemParameters?: Schema$SystemParameters;
/**
* A list of all proto message types included in this API service. It serves
* similar purpose as [google.api.Service.types], except that these types
* are not needed by user-defined APIs. Therefore, they will not show up in
* the generated discovery doc. This field should only be used to define
* system APIs in ESF.
*/
systemTypes?: Schema$Type[];
/**
* The product title for this service.
*/
title?: string;
/**
* A list of all proto message types included in this API service. Types
* referenced directly or indirectly by the `apis` are automatically
* included. Messages which are not referenced but shall be included, such
* as types used by the `google.protobuf.Any` type, should be listed here by
* name. Example: types: - name: google.protobuf.Int32
*/
types?: Schema$Type[];
/**
* Configuration controlling usage of this service.
*/
usage?: Schema$Usage;
}
/**
* `SourceContext` represents information about the source of a protobuf
* element, like the file in which it is defined.
*/
interface Schema$SourceContext {
/**
* The path-qualified name of the .proto file that contained the associated
* protobuf element. For example:
* `"google/protobuf/source_context.proto"`.
*/
fileName?: string;
}
/**
* Source information used to create a Service Config
*/
interface Schema$SourceInfo {
/**
* All files used during config generation.
*/
sourceFiles?: Array<{
[key: string]: any;
}>;
}
/**
* The `Status` type defines a logical error model that is suitable for
* different programming environments, including REST APIs and RPC APIs. It is
* used by [gRPC](https://github.com/grpc). The error model is designed to be:
* - Simple to use and understand for most users - Flexible enough to meet
* unexpected needs # Overview The `Status` message contains three pieces of
* data: error code, error message, and error details. The error code should
* be an enum value of google.rpc.Code, but it may accept additional error
* codes if needed. The error message should be a developer-facing English
* message that helps developers *understand* and *resolve* the error. If a
* localized user-facing error message is needed, put the localized message in
* the error details or localize it in the client. The optional error details
* may contain arbitrary information about the error. There is a predefined
* set of error detail types in the package `google.rpc` that can be used for
* common error conditions. # Language mapping The `Status` message is the
* logical representation of the error model, but it is not necessarily the
* actual wire format. When the `Status` message is exposed in different
* client libraries and different wire protocols, it can be mapped
* differently. For example, it will likely be mapped to some exceptions in
* Java, but more likely mapped to some error codes in C. # Other uses The
* error model and the `Status` message can be used in a variety of
* environments, either with or without APIs, to provide a consistent
* developer experience across different environments. Example uses of this
* error model include: - Partial errors. If a service needs to return
* partial errors to the client, it may embed the `Status` in the normal
* response to indicate the partial errors. - Workflow errors. A typical
* workflow has multiple steps. Each step may have a `Status` message for
* error reporting. - Batch operations. If a client uses batch request and
* batch response, the `Status` message should be used directly inside
* batch response, one for each error sub-response. - Asynchronous
* operations. If an API call embeds asynchronous operation results in its
* response, the status of those operations should be represented directly
* using the `Status` message. - Logging. If some API errors are stored in
* logs, the message `Status` could be used directly after any stripping
* needed for security/privacy reasons.
*/
interface Schema$Status {
/**
* The status code, which should be an enum value of google.rpc.Code.
*/
code?: number;
/**
* A list of messages that carry the error details. There is a common set
* of message types for APIs to use.
*/
details?: Array<{
[key: string]: any;
}>;
/**
* A developer-facing error message, which should be in English. Any
* user-facing error message should be localized and sent in the
* google.rpc.Status.details field, or localized by the client.
*/
message?: string;
}
/**
* Represents a subnet that was created or discovered by a private access
* management service.
*/
interface Schema$Subnetwork {
/**
* Subnetwork CIDR range in `10.x.x.x/y` format.
*/
ipCidrRange?: string;
/**
* Subnetwork name. See https://cloud.google.com/compute/docs/vpc/
*/
name?: string;
/**
* In the Shared VPC host project, the VPC network that's peered with
* the consumer network. For example:
* `projects/1234321/global/networks/host-network`
*/
network?: string;
/**
* This is a discovered subnet that is not within the current consumer
* allocated ranges.
*/
outsideAllocation?: boolean;
}
/**
* Define a parameter's name and location. The parameter may be passed as
* either an HTTP header or a URL query parameter, and if both are passed the
* behavior is implementation-dependent.
*/
interface Schema$SystemParameter {
/**
* Define the HTTP header name to use for the parameter. It is case
* insensitive.
*/
httpHeader?: string;
/**
* Define the name of the parameter, such as "api_key" . It is
* case sensitive.
*/
name?: string;
/**
* Define the URL query parameter name to use for the parameter. It is case
* sensitive.
*/
urlQueryParameter?: string;
}
/**
* Define a system parameter rule mapping system parameter definitions to
* methods.
*/
interface Schema$SystemParameterRule {
/**
* Define parameters. Multiple names may be defined for a parameter. For a
* given method call, only one of them should be used. If multiple names are
* used the behavior is implementation-dependent. If none of the specified
* names are present the behavior is parameter-dependent.
*/
parameters?: Schema$SystemParameter[];
/**
* Selects the methods to which this rule applies. Use '*' to
* indicate all methods in all APIs. Refer to selector for syntax details.
*/
selector?: string;
}
/**
* ### System parameter configuration A system parameter is a special kind of
* parameter defined by the API system, not by an individual API. It is
* typically mapped to an HTTP header and/or a URL query parameter. This
* configuration specifies which methods change the names of the system
* parameters.
*/
interface Schema$SystemParameters {
/**
* Define system parameters. The parameters defined here will override the
* default parameters implemented by the system. If this field is missing
* from the service config, default system parameters will be used. Default
* system parameters and names is implementation-dependent. Example: define
* api key for all methods system_parameters rules: -
* selector: "*" parameters: - name: api_key
* url_query_parameter: api_key Example: define 2 api key names for a
* specific method. system_parameters rules: - selector:
* "/ListShelves" parameters: - name:
* api_key http_header: Api-Key1 - name: api_key
* http_header: Api-Key2 **NOTE:** All service configuration rules follow
* "last one wins" order.
*/
rules?: Schema$SystemParameterRule[];
}
/**
* A protocol buffer message type.
*/
interface Schema$Type {
/**
* The list of fields.
*/
fields?: Schema$Field[];
/**
* The fully qualified message name.
*/
name?: string;
/**
* The list of types appearing in `oneof` definitions in this type.
*/
oneofs?: string[];
/**
* The protocol buffer options.
*/
options?: Schema$Option[];
/**
* The source context.
*/
sourceContext?: Schema$SourceContext;
/**
* The source syntax.
*/
syntax?: string;
}
/**
* Configuration controlling usage of a service.
*/
interface Schema$Usage {
/**
* The full resource name of a channel used for sending notifications to the
* service producer. Google Service Management currently only supports
* [Google Cloud Pub/Sub](https://cloud.google.com/pubsub) as a notification
* channel. To use Google Cloud Pub/Sub as the channel, this must be the
* name of a Cloud Pub/Sub topic that uses the Cloud Pub/Sub topic name
* format documented in https://cloud.google.com/pubsub/docs/overview.
*/
producerNotificationChannel?: string;
/**
* Requirements that must be satisfied before a consumer project can use the
* service. Each requirement is of the form
* <service.name>/<requirement-id>; for example
* 'serviceusage.googleapis.com/billing-enabled'.
*/
requirements?: string[];
/**
* A list of usage rules that apply to individual API methods. **NOTE:**
* All service configuration rules follow "last one wins" order.
*/
rules?: Schema$UsageRule[];
}
/**
* Usage configuration rules for the service. NOTE: Under development. Use
* this rule to configure unregistered calls for the service. Unregistered
* calls are calls that do not contain consumer project identity. (Example:
* calls that do not contain an API key). By default, API methods do not allow
* unregistered calls, and each method call must be identified by a consumer
* project identity. Use this rule to allow/disallow unregistered calls.
* Example of an API that wants to allow unregistered calls for entire
* service. usage: rules: - selector: "*"
* allow_unregistered_calls: true Example of a method that wants to allow
* unregistered calls. usage: rules: - selector:
* "google.example.library.v1.LibraryService.CreateBook"
* allow_unregistered_calls: true
*/
interface Schema$UsageRule {
/**
* If true, the selected method allows unregistered calls, e.g. calls that
* don't identify any user or application.
*/
allowUnregisteredCalls?: boolean;
/**
* Selects the methods to which this rule applies. Use '*' to
* indicate all methods in all APIs. Refer to selector for syntax details.
*/
selector?: string;
/**
* If true, the selected method should skip service control and the control
* plane features, such as quota and billing, will not be available. This
* flag is used by Google Cloud Endpoints to bypass checks for internal
* methods, such as service health check methods.
*/
skipServiceControl?: boolean;
}
class Resource$Operations {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* servicenetworking.operations.get
* @desc Gets the latest state of a long-running operation. Clients can use
* this method to poll the operation result at intervals as recommended by
* the API service.
* @alias servicenetworking.operations.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The name of the operation resource.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Operations$Get, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
get(params: Params$Resource$Operations$Get, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
get(params: Params$Resource$Operations$Get, callback: BodyResponseCallback<Schema$Operation>): void;
get(callback: BodyResponseCallback<Schema$Operation>): void;
}
interface Params$Resource$Operations$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The name of the operation resource.
*/
name?: string;
}
class Resource$Services {
context: APIRequestContext;
connections: Resource$Services$Connections;
constructor(context: APIRequestContext);
/**
* servicenetworking.services.addSubnetwork
* @desc For service producers, provisions a new subnet in a peered
* service's shared VPC network in the requested region and with the
* requested size that's expressed as a CIDR range (number of leading bits
* of ipV4 network mask). The method checks against the assigned allocated
* ranges to find a non-conflicting IP address range. The method will reuse
* a subnet if subsequent calls contain the same subnet name, region, and
* prefix length. This method will make producer's tenant project to be a
* shared VPC service project as needed. The response from the `get`
* operation will be of type `Subnetwork` if the operation successfully
* completes.
* @alias servicenetworking.services.addSubnetwork
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.parent Required. A tenant project in the service producer organization, in the following format: services/{service}/{collection-id}/{resource-id}. {collection-id} is the cloud resource collection type that represents the tenant project. Only `projects` are supported. {resource-id} is the tenant project numeric id, such as `123456`. {service} the name of the peering service, such as `service-peering.example.com`. This service must already be enabled in the service consumer's project.
* @param {().AddSubnetworkRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
addSubnetwork(params?: Params$Resource$Services$Addsubnetwork, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
addSubnetwork(params: Params$Resource$Services$Addsubnetwork, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
addSubnetwork(params: Params$Resource$Services$Addsubnetwork, callback: BodyResponseCallback<Schema$Operation>): void;
addSubnetwork(callback: BodyResponseCallback<Schema$Operation>): void;
/**
* servicenetworking.services.searchRange
* @desc Service producers can use this method to find a currently unused
* range within consumer allocated ranges. This returned range is not
* reserved, and not guaranteed to remain unused. It will validate
* previously provided allocated ranges, find non-conflicting sub-range of
* requested size (expressed in number of leading bits of ipv4 network mask,
* as in CIDR range notation). Operation<response: Range>
* @alias servicenetworking.services.searchRange
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.parent Required. This is in a form services/{service}. {service} the name of the private access management service, for example 'service-peering.example.com'.
* @param {().SearchRangeRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
searchRange(params?: Params$Resource$Services$Searchrange, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
searchRange(params: Params$Resource$Services$Searchrange, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
searchRange(params: Params$Resource$Services$Searchrange, callback: BodyResponseCallback<Schema$Operation>): void;
searchRange(callback: BodyResponseCallback<Schema$Operation>): void;
/**
* servicenetworking.services.updateConnections
* @desc Updates the allocated ranges that are assigned to a connection. The
* response from the `get` operation will be of type `Connection` if the
* operation successfully completes.
* @alias servicenetworking.services.updateConnections
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {boolean=} params.force If a previously defined allocated range is removed, force flag must be set to true.
* @param {string} params.name The service producer peering service that is managing peering connectivity for a service producer organization. For Google services that support this functionality, this is `services/servicenetworking.googleapis.com`.
* @param {string=} params.updateMask The update mask. If this is omitted, it defaults to "*". You can only update the listed peering ranges.
* @param {().Connection} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
updateConnections(params?: Params$Resource$Services$Updateconnections, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
updateConnections(params: Params$Resource$Services$Updateconnections, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
updateConnections(params: Params$Resource$Services$Updateconnections, callback: BodyResponseCallback<Schema$Operation>): void;
updateConnections(callback: BodyResponseCallback<Schema$Operation>): void;
}
interface Params$Resource$Services$Addsubnetwork extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. A tenant project in the service producer organization, in the
* following format: services/{service}/{collection-id}/{resource-id}.
* {collection-id} is the cloud resource collection type that represents the
* tenant project. Only `projects` are supported. {resource-id} is the
* tenant project numeric id, such as `123456`. {service} the name of the
* peering service, such as `service-peering.example.com`. This service must
* already be enabled in the service consumer's project.
*/
parent?: string;
/**
* Request body metadata
*/
requestBody?: Schema$AddSubnetworkRequest;
}
interface Params$Resource$Services$Searchrange extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. This is in a form services/{service}. {service} the name of the
* private access management service, for example
* 'service-peering.example.com'.
*/
parent?: string;
/**
* Request body metadata
*/
requestBody?: Schema$SearchRangeRequest;
}
interface Params$Resource$Services$Updateconnections extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* If a previously defined allocated range is removed, force flag must be
* set to true.
*/
force?: boolean;
/**
* The service producer peering service that is managing peering
* connectivity for a service producer organization. For Google services
* that support this functionality, this is
* `services/servicenetworking.googleapis.com`.
*/
name?: string;
/**
* The update mask. If this is omitted, it defaults to "*". You can only
* update the listed peering ranges.
*/
updateMask?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Connection;
}
class Resource$Services$Connections {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* servicenetworking.services.connections.create
* @desc Creates a private connection that establishes a VPC Network Peering
* connection to a VPC network in the service producer's organization. The
* administrator of the service consumer's VPC network invokes this method.
* The administrator must assign one or more allocated IP ranges for
* provisioning subnetworks in the service producer's VPC network. This
* connection is used for all supported services in the service producer's
* organization, so it only needs to be invoked once. The response from the
* `get` operation will be of type `Connection` if the operation
* successfully completes.
* @alias servicenetworking.services.connections.create
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.parent The service that is managing peering connectivity for a service producer's organization. For Google services that support this functionality, this value is `services/servicenetworking.googleapis.com`.
* @param {().Connection} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
create(params?: Params$Resource$Services$Connections$Create, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
create(params: Params$Resource$Services$Connections$Create, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
create(params: Params$Resource$Services$Connections$Create, callback: BodyResponseCallback<Schema$Operation>): void;
create(callback: BodyResponseCallback<Schema$Operation>): void;
/**
* servicenetworking.services.connections.list
* @desc List the private connections that are configured in a service
* consumer's VPC network.
* @alias servicenetworking.services.connections.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.network The name of service consumer's VPC network that's connected with service producer network through a private connection. The network name must be in the following format: `projects/{project}/global/networks/{network}`. {project} is a project number, such as in `12345` that includes the VPC service consumer's VPC network. {network} is the name of the service consumer's VPC network.
* @param {string} params.parent The service that is managing peering connectivity for a service producer's organization. For Google services that support this functionality, this value is `services/servicenetworking.googleapis.com`. If you specify `-` as the parameter value, all configured public peering services are listed.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Services$Connections$List, options?: MethodOptions): GaxiosPromise<Schema$ListConnectionsResponse>;
list(params: Params$Resource$Services$Connections$List, options: MethodOptions | BodyResponseCallback<Schema$ListConnectionsResponse>, callback: BodyResponseCallback<Schema$ListConnectionsResponse>): void;
list(params: Params$Resource$Services$Connections$List, callback: BodyResponseCallback<Schema$ListConnectionsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListConnectionsResponse>): void;
}
interface Params$Resource$Services$Connections$Create extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The service that is managing peering connectivity for a service
* producer's organization. For Google services that support this
* functionality, this value is `services/servicenetworking.googleapis.com`.
*/
parent?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Connection;
}
interface Params$Resource$Services$Connections$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The name of service consumer's VPC network that's connected with service
* producer network through a private connection. The network name must be
* in the following format: `projects/{project}/global/networks/{network}`.
* {project} is a project number, such as in `12345` that includes the VPC
* service consumer's VPC network. {network} is the name of the service
* consumer's VPC network.
*/
network?: string;
/**
* The service that is managing peering connectivity for a service
* producer's organization. For Google services that support this
* functionality, this value is `services/servicenetworking.googleapis.com`.
* If you specify `-` as the parameter value, all configured public peering
* services are listed.
*/
parent?: string;
}
}