v2beta1.d.ts
133 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
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
/// <reference types="node" />
import { OAuth2Client, JWT, Compute, UserRefreshClient, GaxiosPromise, GoogleConfigurable, MethodOptions, StreamMethodOptions, GlobalOptions, GoogleAuth, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { Readable } from 'stream';
export declare namespace dns_v2beta1 {
export interface Options extends GlobalOptions {
version: 'v2beta1';
}
interface StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient | GoogleAuth;
/**
* 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;
}
/**
* Cloud DNS API
*
*
*
* @example
* const {google} = require('googleapis');
* const dns = google.dns('v2beta1');
*
* @namespace dns
* @type {Function}
* @version v2beta1
* @variation v2beta1
* @param {object=} options Options for Dns
*/
export class Dns {
context: APIRequestContext;
changes: Resource$Changes;
dnsKeys: Resource$Dnskeys;
managedZoneOperations: Resource$Managedzoneoperations;
managedZones: Resource$Managedzones;
policies: Resource$Policies;
projects: Resource$Projects;
resourceRecordSets: Resource$Resourcerecordsets;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* A Change represents a set of ResourceRecordSet additions and deletions applied atomically to a ManagedZone. ResourceRecordSets within a ManagedZone are modified by creating a new Change element in the Changes collection. In turn the Changes collection also records the past modifications to the ResourceRecordSets in a ManagedZone. The current state of the ManagedZone is the sum effect of applying all Change elements in the Changes collection in sequence.
*/
export interface Schema$Change {
/**
* Which ResourceRecordSets to add?
*/
additions?: Schema$ResourceRecordSet[];
/**
* Which ResourceRecordSets to remove? Must match existing data exactly.
*/
deletions?: Schema$ResourceRecordSet[];
/**
* Unique identifier for the resource; defined by the server (output only).
*/
id?: string | null;
/**
* If the DNS queries for the zone will be served.
*/
isServing?: boolean | null;
kind?: string | null;
/**
* The time that this operation was started by the server (output only). This is in RFC3339 text format.
*/
startTime?: string | null;
/**
* Status of the operation (output only). A status of "done" means that the request to update the authoritative servers has been sent but the servers might not be updated yet.
*/
status?: string | null;
}
/**
* The response to a request to enumerate Changes to a ResourceRecordSets collection.
*/
export interface Schema$ChangesListResponse {
/**
* The requested changes.
*/
changes?: Schema$Change[];
header?: Schema$ResponseHeader;
/**
* Type of resource.
*/
kind?: string | null;
/**
* The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your pagination token. In this way you can retrieve the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned will be an inconsistent view of the collection. There is no way to retrieve a "snapshot" of collections larger than the maximum page size.
*/
nextPageToken?: string | null;
}
/**
* A DNSSEC key pair.
*/
export interface Schema$DnsKey {
/**
* String mnemonic specifying the DNSSEC algorithm of this key. Immutable after creation time.
*/
algorithm?: string | null;
/**
* The time that this resource was created in the control plane. This is in RFC3339 text format. Output only.
*/
creationTime?: string | null;
/**
* A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the resource's function.
*/
description?: string | null;
/**
* Cryptographic hashes of the DNSKEY resource record associated with this DnsKey. These digests are needed to construct a DS record that points at this DNS key. Output only.
*/
digests?: Schema$DnsKeyDigest[];
/**
* Unique identifier for the resource; defined by the server (output only).
*/
id?: string | null;
/**
* Active keys will be used to sign subsequent changes to the ManagedZone. Inactive keys will still be present as DNSKEY Resource Records for the use of resolvers validating existing signatures.
*/
isActive?: boolean | null;
/**
* Length of the key in bits. Specified at creation time then immutable.
*/
keyLength?: number | null;
/**
* The key tag is a non-cryptographic hash of the a DNSKEY resource record associated with this DnsKey. The key tag can be used to identify a DNSKEY more quickly (but it is not a unique identifier). In particular, the key tag is used in a parent zone's DS record to point at the DNSKEY in this child ManagedZone. The key tag is a number in the range [0, 65535] and the algorithm to calculate it is specified in RFC4034 Appendix B. Output only.
*/
keyTag?: number | null;
kind?: string | null;
/**
* Base64 encoded public half of this key. Output only.
*/
publicKey?: string | null;
/**
* One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the Secure Entry Point flag set and, when active, will be used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag will be cleared and this key will be used to sign only resource record sets of other types. Immutable after creation time.
*/
type?: string | null;
}
export interface Schema$DnsKeyDigest {
/**
* The base-16 encoded bytes of this digest. Suitable for use in a DS resource record.
*/
digest?: string | null;
/**
* Specifies the algorithm used to calculate this digest.
*/
type?: string | null;
}
/**
* The response to a request to enumerate DnsKeys in a ManagedZone.
*/
export interface Schema$DnsKeysListResponse {
/**
* The requested resources.
*/
dnsKeys?: Schema$DnsKey[];
header?: Schema$ResponseHeader;
/**
* Type of resource.
*/
kind?: string | null;
/**
* The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your pagination token. In this way you can retrieve the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned will be an inconsistent view of the collection. There is no way to retrieve a "snapshot" of collections larger than the maximum page size.
*/
nextPageToken?: string | null;
}
/**
* Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey.
*/
export interface Schema$DnsKeySpec {
/**
* String mnemonic specifying the DNSSEC algorithm of this key.
*/
algorithm?: string | null;
/**
* Length of the keys in bits.
*/
keyLength?: number | null;
/**
* Specifies whether this is a key signing key (KSK) or a zone signing key (ZSK). Key signing keys have the Secure Entry Point flag set and, when active, will only be used to sign resource record sets of type DNSKEY. Zone signing keys do not have the Secure Entry Point flag set and will be used to sign all other types of resource record sets.
*/
keyType?: string | null;
kind?: string | null;
}
/**
* A zone is a subtree of the DNS namespace under one administrative responsibility. A ManagedZone is a resource that represents a DNS zone hosted by the Cloud DNS service.
*/
export interface Schema$ManagedZone {
/**
* The time that this resource was created on the server. This is in RFC3339 text format. Output only.
*/
creationTime?: string | null;
/**
* A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the managed zone's function.
*/
description?: string | null;
/**
* The DNS name of this managed zone, for instance "example.com.".
*/
dnsName?: string | null;
/**
* DNSSEC configuration.
*/
dnssecConfig?: Schema$ManagedZoneDnsSecConfig;
/**
* The presence for this field indicates that outbound forwarding is enabled for this zone. The value of this field contains the set of destinations to forward to.
*/
forwardingConfig?: Schema$ManagedZoneForwardingConfig;
/**
* Unique identifier for the resource; defined by the server (output only)
*/
id?: string | null;
kind?: string | null;
/**
* User labels.
*/
labels?: {
[key: string]: string;
} | null;
/**
* User assigned name for this resource. Must be unique within the project. The name must be 1-63 characters long, must begin with a letter, end with a letter or digit, and only contain lowercase letters, digits or dashes.
*/
name?: string | null;
/**
* Delegate your managed_zone to these virtual name servers; defined by the server (output only)
*/
nameServers?: string[] | null;
/**
* Optionally specifies the NameServerSet for this ManagedZone. A NameServerSet is a set of DNS name servers that all host the same ManagedZones. Most users will leave this field unset.
*/
nameServerSet?: string | null;
/**
* The presence of this field indicates that DNS Peering is enabled for this zone. The value of this field contains the network to peer with.
*/
peeringConfig?: Schema$ManagedZonePeeringConfig;
/**
* For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from.
*/
privateVisibilityConfig?: Schema$ManagedZonePrivateVisibilityConfig;
/**
* The presence of this field indicates that this is a managed reverse lookup zone and Cloud DNS will resolve reverse lookup queries using automatically configured records for VPC resources. This only applies to networks listed under private_visibility_config.
*/
reverseLookupConfig?: Schema$ManagedZoneReverseLookupConfig;
/**
* The zone's visibility: public zones are exposed to the Internet, while private zones are visible only to Virtual Private Cloud resources.
*/
visibility?: string | null;
}
export interface Schema$ManagedZoneDnsSecConfig {
/**
* Specifies parameters for generating initial DnsKeys for this ManagedZone. Can only be changed while the state is OFF.
*/
defaultKeySpecs?: Schema$DnsKeySpec[];
kind?: string | null;
/**
* Specifies the mechanism for authenticated denial-of-existence responses. Can only be changed while the state is OFF.
*/
nonExistence?: string | null;
/**
* Specifies whether DNSSEC is enabled, and what mode it is in.
*/
state?: string | null;
}
export interface Schema$ManagedZoneForwardingConfig {
kind?: string | null;
/**
* List of target name servers to forward to. Cloud DNS will select the best available name server if more than one target is given.
*/
targetNameServers?: Schema$ManagedZoneForwardingConfigNameServerTarget[];
}
export interface Schema$ManagedZoneForwardingConfigNameServerTarget {
/**
* Forwarding path for this NameServerTarget. If unset or set to DEFAULT, Cloud DNS will make forwarding decision based on address ranges, i.e. RFC1918 addresses go to the VPC, non-RFC1918 addresses go to the Internet. When set to PRIVATE, Cloud DNS will always send queries through VPC for this target.
*/
forwardingPath?: string | null;
/**
* IPv4 address of a target name server.
*/
ipv4Address?: string | null;
kind?: string | null;
}
export interface Schema$ManagedZoneOperationsListResponse {
header?: Schema$ResponseHeader;
kind?: string | null;
/**
* The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your page token. In this way you can retrieve the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned will be an inconsistent view of the collection. There is no way to retrieve a consistent snapshot of a collection larger than the maximum page size.
*/
nextPageToken?: string | null;
/**
* The operation resources.
*/
operations?: Schema$Operation[];
}
export interface Schema$ManagedZonePeeringConfig {
kind?: string | null;
/**
* The network with which to peer.
*/
targetNetwork?: Schema$ManagedZonePeeringConfigTargetNetwork;
}
export interface Schema$ManagedZonePeeringConfigTargetNetwork {
/**
* The time at which the zone was deactivated, in RFC 3339 date-time format. An empty string indicates that the peering connection is active. The producer network can deactivate a zone. The zone is automatically deactivated if the producer network that the zone targeted is deleted. Output only.
*/
deactivateTime?: string | null;
kind?: string | null;
/**
* The fully qualified URL of the VPC network to forward queries to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}
*/
networkUrl?: string | null;
}
export interface Schema$ManagedZonePrivateVisibilityConfig {
kind?: string | null;
/**
* The list of VPC networks that can see this zone.
*/
networks?: Schema$ManagedZonePrivateVisibilityConfigNetwork[];
}
export interface Schema$ManagedZonePrivateVisibilityConfigNetwork {
kind?: string | null;
/**
* The fully qualified URL of the VPC network to bind to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}
*/
networkUrl?: string | null;
}
export interface Schema$ManagedZoneReverseLookupConfig {
kind?: string | null;
}
export interface Schema$ManagedZonesListResponse {
header?: Schema$ResponseHeader;
/**
* Type of resource.
*/
kind?: string | null;
/**
* The managed zone resources.
*/
managedZones?: Schema$ManagedZone[];
/**
* The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your page token. In this way you can retrieve the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned will be an inconsistent view of the collection. There is no way to retrieve a consistent snapshot of a collection larger than the maximum page size.
*/
nextPageToken?: string | null;
}
/**
* An operation represents a successful mutation performed on a Cloud DNS resource. Operations provide: - An audit log of server resource mutations. - A way to recover/retry API calls in the case where the response is never received by the caller. Use the caller specified client_operation_id.
*/
export interface Schema$Operation {
/**
* Only populated if the operation targeted a DnsKey (output only).
*/
dnsKeyContext?: Schema$OperationDnsKeyContext;
/**
* Unique identifier for the resource. This is the client_operation_id if the client specified it when the mutation was initiated, otherwise, it is generated by the server. The name must be 1-63 characters long and match the regular expression [-a-z0-9]? (output only)
*/
id?: string | null;
kind?: string | null;
/**
* The time that this operation was started by the server. This is in RFC3339 text format (output only).
*/
startTime?: string | null;
/**
* Status of the operation. Can be one of the following: "PENDING" or "DONE" (output only). A status of "DONE" means that the request to update the authoritative servers has been sent, but the servers might not be updated yet.
*/
status?: string | null;
/**
* Type of the operation. Operations include insert, update, and delete (output only).
*/
type?: string | null;
/**
* User who requested the operation, for example: user@example.com. cloud-dns-system for operations automatically done by the system. (output only)
*/
user?: string | null;
/**
* Only populated if the operation targeted a ManagedZone (output only).
*/
zoneContext?: Schema$OperationManagedZoneContext;
}
export interface Schema$OperationDnsKeyContext {
/**
* The post-operation DnsKey resource.
*/
newValue?: Schema$DnsKey;
/**
* The pre-operation DnsKey resource.
*/
oldValue?: Schema$DnsKey;
}
export interface Schema$OperationManagedZoneContext {
/**
* The post-operation ManagedZone resource.
*/
newValue?: Schema$ManagedZone;
/**
* The pre-operation ManagedZone resource.
*/
oldValue?: Schema$ManagedZone;
}
export interface Schema$PoliciesListResponse {
header?: Schema$ResponseHeader;
/**
* Type of resource.
*/
kind?: string | null;
/**
* The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your page token. In this way you can retrieve the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned will be an inconsistent view of the collection. There is no way to retrieve a consistent snapshot of a collection larger than the maximum page size.
*/
nextPageToken?: string | null;
/**
* The policy resources.
*/
policies?: Schema$Policy[];
}
export interface Schema$PoliciesPatchResponse {
header?: Schema$ResponseHeader;
policy?: Schema$Policy;
}
export interface Schema$PoliciesUpdateResponse {
header?: Schema$ResponseHeader;
policy?: Schema$Policy;
}
/**
* A policy is a collection of DNS rules applied to one or more Virtual Private Cloud resources.
*/
export interface Schema$Policy {
/**
* Sets an alternative name server for the associated networks. When specified, all DNS queries are forwarded to a name server that you choose. Names such as .internal are not available when an alternative name server is specified.
*/
alternativeNameServerConfig?: Schema$PolicyAlternativeNameServerConfig;
/**
* A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the policy's function.
*/
description?: string | null;
/**
* Allows networks bound to this policy to receive DNS queries sent by VMs or applications over VPN connections. When enabled, a virtual IP address will be allocated from each of the sub-networks that are bound to this policy.
*/
enableInboundForwarding?: boolean | null;
/**
* Controls whether logging is enabled for the networks bound to this policy. Defaults to no logging if not set.
*/
enableLogging?: boolean | null;
/**
* Unique identifier for the resource; defined by the server (output only).
*/
id?: string | null;
kind?: string | null;
/**
* User assigned name for this policy.
*/
name?: string | null;
/**
* List of network names specifying networks to which this policy is applied.
*/
networks?: Schema$PolicyNetwork[];
}
export interface Schema$PolicyAlternativeNameServerConfig {
kind?: string | null;
/**
* Sets an alternative name server for the associated networks. When specified, all DNS queries are forwarded to a name server that you choose. Names such as .internal are not available when an alternative name server is specified.
*/
targetNameServers?: Schema$PolicyAlternativeNameServerConfigTargetNameServer[];
}
export interface Schema$PolicyAlternativeNameServerConfigTargetNameServer {
/**
* Forwarding path for this TargetNameServer. If unset or set to DEFAULT, Cloud DNS will make forwarding decision based on address ranges, i.e. RFC1918 addresses go to the VPC, non-RFC1918 addresses go to the Internet. When set to PRIVATE, Cloud DNS will always send queries through VPC for this target.
*/
forwardingPath?: string | null;
/**
* IPv4 address to forward to.
*/
ipv4Address?: string | null;
kind?: string | null;
}
export interface Schema$PolicyNetwork {
kind?: string | null;
/**
* The fully qualified URL of the VPC network to bind to. This should be formatted like https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}
*/
networkUrl?: string | null;
}
/**
* A project resource. The project is a top level container for resources including Cloud DNS ManagedZones. Projects can be created only in the APIs console.
*/
export interface Schema$Project {
/**
* User assigned unique identifier for the resource (output only).
*/
id?: string | null;
kind?: string | null;
/**
* Unique numeric identifier for the resource; defined by the server (output only).
*/
number?: string | null;
/**
* Quotas assigned to this project (output only).
*/
quota?: Schema$Quota;
}
/**
* Limits associated with a Project.
*/
export interface Schema$Quota {
/**
* Maximum allowed number of DnsKeys per ManagedZone.
*/
dnsKeysPerManagedZone?: number | null;
kind?: string | null;
/**
* Maximum allowed number of managed zones in the project.
*/
managedZones?: number | null;
/**
* Maximum allowed number of managed zones which can be attached to a network.
*/
managedZonesPerNetwork?: number | null;
/**
* Maximum allowed number of networks to which a privately scoped zone can be attached.
*/
networksPerManagedZone?: number | null;
/**
* Maximum allowed number of networks per policy.
*/
networksPerPolicy?: number | null;
/**
* Maximum allowed number of policies per project.
*/
policies?: number | null;
/**
* Maximum allowed number of ResourceRecords per ResourceRecordSet.
*/
resourceRecordsPerRrset?: number | null;
/**
* Maximum allowed number of ResourceRecordSets to add per ChangesCreateRequest.
*/
rrsetAdditionsPerChange?: number | null;
/**
* Maximum allowed number of ResourceRecordSets to delete per ChangesCreateRequest.
*/
rrsetDeletionsPerChange?: number | null;
/**
* Maximum allowed number of ResourceRecordSets per zone in the project.
*/
rrsetsPerManagedZone?: number | null;
/**
* Maximum allowed number of target name servers per managed forwarding zone.
*/
targetNameServersPerManagedZone?: number | null;
/**
* Maximum allowed number of alternative target name servers per policy.
*/
targetNameServersPerPolicy?: number | null;
/**
* Maximum allowed size for total rrdata in one ChangesCreateRequest in bytes.
*/
totalRrdataSizePerChange?: number | null;
/**
* DNSSEC algorithm and key length types that can be used for DnsKeys.
*/
whitelistedKeySpecs?: Schema$DnsKeySpec[];
}
/**
* A unit of data that will be returned by the DNS servers.
*/
export interface Schema$ResourceRecordSet {
kind?: string | null;
/**
* For example, www.example.com.
*/
name?: string | null;
/**
* As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see <a href="/dns/records/json-record">examples</a>.
*/
rrdatas?: string[] | null;
/**
* As defined in RFC 4034 (section 3.2).
*/
signatureRrdatas?: string[] | null;
/**
* Number of seconds that this ResourceRecordSet can be cached by resolvers.
*/
ttl?: number | null;
/**
* The identifier of a supported record type. See the list of <a href="/dns/docs/overview#supported_dns_record_types">Supported DNS record types</a>.
*/
type?: string | null;
}
export interface Schema$ResourceRecordSetsListResponse {
header?: Schema$ResponseHeader;
/**
* Type of resource.
*/
kind?: string | null;
/**
* The presence of this field indicates that there exist more results following your last page of results in pagination order. To fetch them, make another list request using this value as your pagination token. In this way you can retrieve the complete contents of even very large collections one page at a time. However, if the contents of the collection change between the first and last paginated list request, the set of all elements returned will be an inconsistent view of the collection. There is no way to retrieve a consistent snapshot of a collection larger than the maximum page size.
*/
nextPageToken?: string | null;
/**
* The resource record set resources.
*/
rrsets?: Schema$ResourceRecordSet[];
}
/**
* Elements common to every response.
*/
export interface Schema$ResponseHeader {
/**
* For mutating operation requests that completed successfully. This is the client_operation_id if the client specified it, otherwise it is generated by the server (output only).
*/
operationId?: string | null;
}
export class Resource$Changes {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* dns.changes.create
* @desc Atomically update the ResourceRecordSet collection.
* @example
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/dns.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const dns = google.dns('v2beta1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/cloud-platform',
* 'https://www.googleapis.com/auth/ndev.clouddns.readwrite',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await dns.changes.create({
* // For mutating operation requests only. An optional identifier
* // specified by the client. Must be unique for operation resources in the
* // Operations collection.
* clientOperationId: 'placeholder-value',
* // Identifies the managed zone addressed by this request. Can be the managed
* // zone name or id.
* managedZone: 'placeholder-value',
* // Identifies the project addressed by this request.
* project: 'placeholder-value',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "additions": [],
* // "deletions": [],
* // "id": "my_id",
* // "isServing": false,
* // "kind": "my_kind",
* // "startTime": "my_startTime",
* // "status": "my_status"
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "additions": [],
* // "deletions": [],
* // "id": "my_id",
* // "isServing": false,
* // "kind": "my_kind",
* // "startTime": "my_startTime",
* // "status": "my_status"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* @alias dns.changes.create
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.clientOperationId For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
* @param {string} params.managedZone Identifies the managed zone addressed by this request. Can be the managed zone name or id.
* @param {string} params.project Identifies the project addressed by this request.
* @param {().Change} params.requestBody 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$Changes$Create, options: StreamMethodOptions): GaxiosPromise<Readable>;
create(params?: Params$Resource$Changes$Create, options?: MethodOptions): GaxiosPromise<Schema$Change>;
create(params: Params$Resource$Changes$Create, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
create(params: Params$Resource$Changes$Create, options: MethodOptions | BodyResponseCallback<Schema$Change>, callback: BodyResponseCallback<Schema$Change>): void;
create(params: Params$Resource$Changes$Create, callback: BodyResponseCallback<Schema$Change>): void;
create(callback: BodyResponseCallback<Schema$Change>): void;
/**
* dns.changes.get
* @desc Fetch the representation of an existing Change.
* @example
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/dns.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const dns = google.dns('v2beta1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/cloud-platform',
* 'https://www.googleapis.com/auth/cloud-platform.read-only',
* 'https://www.googleapis.com/auth/ndev.clouddns.readonly',
* 'https://www.googleapis.com/auth/ndev.clouddns.readwrite',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await dns.changes.get({
* // The identifier of the requested change, from a previous
* // ResourceRecordSetsChangeResponse.
* changeId: 'placeholder-value',
* // For mutating operation requests only. An optional identifier
* // specified by the client. Must be unique for operation resources in the
* // Operations collection.
* clientOperationId: 'placeholder-value',
* // Identifies the managed zone addressed by this request. Can be the managed
* // zone name or id.
* managedZone: 'placeholder-value',
* // Identifies the project addressed by this request.
* project: 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "additions": [],
* // "deletions": [],
* // "id": "my_id",
* // "isServing": false,
* // "kind": "my_kind",
* // "startTime": "my_startTime",
* // "status": "my_status"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* @alias dns.changes.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.changeId The identifier of the requested change, from a previous ResourceRecordSetsChangeResponse.
* @param {string=} params.clientOperationId For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
* @param {string} params.managedZone Identifies the managed zone addressed by this request. Can be the managed zone name or id.
* @param {string} params.project Identifies the project addressed by this request.
* @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$Changes$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
get(params?: Params$Resource$Changes$Get, options?: MethodOptions): GaxiosPromise<Schema$Change>;
get(params: Params$Resource$Changes$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
get(params: Params$Resource$Changes$Get, options: MethodOptions | BodyResponseCallback<Schema$Change>, callback: BodyResponseCallback<Schema$Change>): void;
get(params: Params$Resource$Changes$Get, callback: BodyResponseCallback<Schema$Change>): void;
get(callback: BodyResponseCallback<Schema$Change>): void;
/**
* dns.changes.list
* @desc Enumerate Changes to a ResourceRecordSet collection.
* @example
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/dns.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const dns = google.dns('v2beta1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/cloud-platform',
* 'https://www.googleapis.com/auth/cloud-platform.read-only',
* 'https://www.googleapis.com/auth/ndev.clouddns.readonly',
* 'https://www.googleapis.com/auth/ndev.clouddns.readwrite',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await dns.changes.list({
* // Identifies the managed zone addressed by this request. Can be the managed
* // zone name or id.
* managedZone: 'placeholder-value',
* // Optional. Maximum number of results to be returned. If unspecified, the
* // server will decide how many results to return.
* maxResults: 'placeholder-value',
* // Optional. A tag returned by a previous list request that was truncated.
* // Use this parameter to continue a previous list request.
* pageToken: 'placeholder-value',
* // Identifies the project addressed by this request.
* project: 'placeholder-value',
* // Sorting criterion. The only supported value is change sequence.
* sortBy: 'placeholder-value',
* // Sorting order direction: 'ascending' or 'descending'.
* sortOrder: 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "changes": [],
* // "header": {},
* // "kind": "my_kind",
* // "nextPageToken": "my_nextPageToken"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* @alias dns.changes.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.managedZone Identifies the managed zone addressed by this request. Can be the managed zone name or id.
* @param {integer=} params.maxResults Optional. Maximum number of results to be returned. If unspecified, the server will decide how many results to return.
* @param {string=} params.pageToken Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request.
* @param {string} params.project Identifies the project addressed by this request.
* @param {string=} params.sortBy Sorting criterion. The only supported value is change sequence.
* @param {string=} params.sortOrder Sorting order direction: 'ascending' or 'descending'.
* @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$Changes$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
list(params?: Params$Resource$Changes$List, options?: MethodOptions): GaxiosPromise<Schema$ChangesListResponse>;
list(params: Params$Resource$Changes$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
list(params: Params$Resource$Changes$List, options: MethodOptions | BodyResponseCallback<Schema$ChangesListResponse>, callback: BodyResponseCallback<Schema$ChangesListResponse>): void;
list(params: Params$Resource$Changes$List, callback: BodyResponseCallback<Schema$ChangesListResponse>): void;
list(callback: BodyResponseCallback<Schema$ChangesListResponse>): void;
}
export interface Params$Resource$Changes$Create extends StandardParameters {
/**
* For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
*/
clientOperationId?: string;
/**
* Identifies the managed zone addressed by this request. Can be the managed zone name or id.
*/
managedZone?: string;
/**
* Identifies the project addressed by this request.
*/
project?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Change;
}
export interface Params$Resource$Changes$Get extends StandardParameters {
/**
* The identifier of the requested change, from a previous ResourceRecordSetsChangeResponse.
*/
changeId?: string;
/**
* For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
*/
clientOperationId?: string;
/**
* Identifies the managed zone addressed by this request. Can be the managed zone name or id.
*/
managedZone?: string;
/**
* Identifies the project addressed by this request.
*/
project?: string;
}
export interface Params$Resource$Changes$List extends StandardParameters {
/**
* Identifies the managed zone addressed by this request. Can be the managed zone name or id.
*/
managedZone?: string;
/**
* Optional. Maximum number of results to be returned. If unspecified, the server will decide how many results to return.
*/
maxResults?: number;
/**
* Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request.
*/
pageToken?: string;
/**
* Identifies the project addressed by this request.
*/
project?: string;
/**
* Sorting criterion. The only supported value is change sequence.
*/
sortBy?: string;
/**
* Sorting order direction: 'ascending' or 'descending'.
*/
sortOrder?: string;
}
export class Resource$Dnskeys {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* dns.dnsKeys.get
* @desc Fetch the representation of an existing DnsKey.
* @example
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/dns.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const dns = google.dns('v2beta1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/cloud-platform',
* 'https://www.googleapis.com/auth/cloud-platform.read-only',
* 'https://www.googleapis.com/auth/ndev.clouddns.readonly',
* 'https://www.googleapis.com/auth/ndev.clouddns.readwrite',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await dns.dnsKeys.get({
* // For mutating operation requests only. An optional identifier
* // specified by the client. Must be unique for operation resources in the
* // Operations collection.
* clientOperationId: 'placeholder-value',
* // An optional comma-separated list of digest types to compute and display
* // for key signing keys. If omitted, the recommended digest type will be
* // computed and displayed.
* digestType: 'placeholder-value',
* // The identifier of the requested DnsKey.
* dnsKeyId: 'placeholder-value',
* // Identifies the managed zone addressed by this request. Can be the managed
* // zone name or id.
* managedZone: 'placeholder-value',
* // Identifies the project addressed by this request.
* project: 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "algorithm": "my_algorithm",
* // "creationTime": "my_creationTime",
* // "description": "my_description",
* // "digests": [],
* // "id": "my_id",
* // "isActive": false,
* // "keyLength": 0,
* // "keyTag": 0,
* // "kind": "my_kind",
* // "publicKey": "my_publicKey",
* // "type": "my_type"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* @alias dns.dnsKeys.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.clientOperationId For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
* @param {string=} params.digestType An optional comma-separated list of digest types to compute and display for key signing keys. If omitted, the recommended digest type will be computed and displayed.
* @param {string} params.dnsKeyId The identifier of the requested DnsKey.
* @param {string} params.managedZone Identifies the managed zone addressed by this request. Can be the managed zone name or id.
* @param {string} params.project Identifies the project addressed by this request.
* @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$Dnskeys$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
get(params?: Params$Resource$Dnskeys$Get, options?: MethodOptions): GaxiosPromise<Schema$DnsKey>;
get(params: Params$Resource$Dnskeys$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
get(params: Params$Resource$Dnskeys$Get, options: MethodOptions | BodyResponseCallback<Schema$DnsKey>, callback: BodyResponseCallback<Schema$DnsKey>): void;
get(params: Params$Resource$Dnskeys$Get, callback: BodyResponseCallback<Schema$DnsKey>): void;
get(callback: BodyResponseCallback<Schema$DnsKey>): void;
/**
* dns.dnsKeys.list
* @desc Enumerate DnsKeys to a ResourceRecordSet collection.
* @example
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/dns.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const dns = google.dns('v2beta1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/cloud-platform',
* 'https://www.googleapis.com/auth/cloud-platform.read-only',
* 'https://www.googleapis.com/auth/ndev.clouddns.readonly',
* 'https://www.googleapis.com/auth/ndev.clouddns.readwrite',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await dns.dnsKeys.list({
* // An optional comma-separated list of digest types to compute and display
* // for key signing keys. If omitted, the recommended digest type will be
* // computed and displayed.
* digestType: 'placeholder-value',
* // Identifies the managed zone addressed by this request. Can be the managed
* // zone name or id.
* managedZone: 'placeholder-value',
* // Optional. Maximum number of results to be returned. If unspecified, the
* // server will decide how many results to return.
* maxResults: 'placeholder-value',
* // Optional. A tag returned by a previous list request that was truncated.
* // Use this parameter to continue a previous list request.
* pageToken: 'placeholder-value',
* // Identifies the project addressed by this request.
* project: 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "dnsKeys": [],
* // "header": {},
* // "kind": "my_kind",
* // "nextPageToken": "my_nextPageToken"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* @alias dns.dnsKeys.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.digestType An optional comma-separated list of digest types to compute and display for key signing keys. If omitted, the recommended digest type will be computed and displayed.
* @param {string} params.managedZone Identifies the managed zone addressed by this request. Can be the managed zone name or id.
* @param {integer=} params.maxResults Optional. Maximum number of results to be returned. If unspecified, the server will decide how many results to return.
* @param {string=} params.pageToken Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request.
* @param {string} params.project Identifies the project addressed by this request.
* @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$Dnskeys$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
list(params?: Params$Resource$Dnskeys$List, options?: MethodOptions): GaxiosPromise<Schema$DnsKeysListResponse>;
list(params: Params$Resource$Dnskeys$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
list(params: Params$Resource$Dnskeys$List, options: MethodOptions | BodyResponseCallback<Schema$DnsKeysListResponse>, callback: BodyResponseCallback<Schema$DnsKeysListResponse>): void;
list(params: Params$Resource$Dnskeys$List, callback: BodyResponseCallback<Schema$DnsKeysListResponse>): void;
list(callback: BodyResponseCallback<Schema$DnsKeysListResponse>): void;
}
export interface Params$Resource$Dnskeys$Get extends StandardParameters {
/**
* For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
*/
clientOperationId?: string;
/**
* An optional comma-separated list of digest types to compute and display for key signing keys. If omitted, the recommended digest type will be computed and displayed.
*/
digestType?: string;
/**
* The identifier of the requested DnsKey.
*/
dnsKeyId?: string;
/**
* Identifies the managed zone addressed by this request. Can be the managed zone name or id.
*/
managedZone?: string;
/**
* Identifies the project addressed by this request.
*/
project?: string;
}
export interface Params$Resource$Dnskeys$List extends StandardParameters {
/**
* An optional comma-separated list of digest types to compute and display for key signing keys. If omitted, the recommended digest type will be computed and displayed.
*/
digestType?: string;
/**
* Identifies the managed zone addressed by this request. Can be the managed zone name or id.
*/
managedZone?: string;
/**
* Optional. Maximum number of results to be returned. If unspecified, the server will decide how many results to return.
*/
maxResults?: number;
/**
* Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request.
*/
pageToken?: string;
/**
* Identifies the project addressed by this request.
*/
project?: string;
}
export class Resource$Managedzoneoperations {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* dns.managedZoneOperations.get
* @desc Fetch the representation of an existing Operation.
* @example
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/dns.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const dns = google.dns('v2beta1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/cloud-platform',
* 'https://www.googleapis.com/auth/cloud-platform.read-only',
* 'https://www.googleapis.com/auth/ndev.clouddns.readonly',
* 'https://www.googleapis.com/auth/ndev.clouddns.readwrite',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await dns.managedZoneOperations.get({
* // For mutating operation requests only. An optional identifier
* // specified by the client. Must be unique for operation resources in the
* // Operations collection.
* clientOperationId: 'placeholder-value',
* // Identifies the managed zone addressed by this request.
* managedZone: 'placeholder-value',
* // Identifies the operation addressed by this request.
* operation: 'placeholder-value',
* // Identifies the project addressed by this request.
* project: 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "dnsKeyContext": {},
* // "id": "my_id",
* // "kind": "my_kind",
* // "startTime": "my_startTime",
* // "status": "my_status",
* // "type": "my_type",
* // "user": "my_user",
* // "zoneContext": {}
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* @alias dns.managedZoneOperations.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.clientOperationId For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
* @param {string} params.managedZone Identifies the managed zone addressed by this request.
* @param {string} params.operation Identifies the operation addressed by this request.
* @param {string} params.project Identifies the project addressed by this request.
* @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$Managedzoneoperations$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
get(params?: Params$Resource$Managedzoneoperations$Get, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
get(params: Params$Resource$Managedzoneoperations$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
get(params: Params$Resource$Managedzoneoperations$Get, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
get(params: Params$Resource$Managedzoneoperations$Get, callback: BodyResponseCallback<Schema$Operation>): void;
get(callback: BodyResponseCallback<Schema$Operation>): void;
/**
* dns.managedZoneOperations.list
* @desc Enumerate Operations for the given ManagedZone.
* @example
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/dns.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const dns = google.dns('v2beta1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/cloud-platform',
* 'https://www.googleapis.com/auth/cloud-platform.read-only',
* 'https://www.googleapis.com/auth/ndev.clouddns.readonly',
* 'https://www.googleapis.com/auth/ndev.clouddns.readwrite',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await dns.managedZoneOperations.list({
* // Identifies the managed zone addressed by this request.
* managedZone: 'placeholder-value',
* // Optional. Maximum number of results to be returned. If unspecified, the
* // server will decide how many results to return.
* maxResults: 'placeholder-value',
* // Optional. A tag returned by a previous list request that was truncated.
* // Use this parameter to continue a previous list request.
* pageToken: 'placeholder-value',
* // Identifies the project addressed by this request.
* project: 'placeholder-value',
* // Sorting criterion. The only supported values are START_TIME and ID.
* sortBy: 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "header": {},
* // "kind": "my_kind",
* // "nextPageToken": "my_nextPageToken",
* // "operations": []
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* @alias dns.managedZoneOperations.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.managedZone Identifies the managed zone addressed by this request.
* @param {integer=} params.maxResults Optional. Maximum number of results to be returned. If unspecified, the server will decide how many results to return.
* @param {string=} params.pageToken Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request.
* @param {string} params.project Identifies the project addressed by this request.
* @param {string=} params.sortBy Sorting criterion. The only supported values are START_TIME and ID.
* @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$Managedzoneoperations$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
list(params?: Params$Resource$Managedzoneoperations$List, options?: MethodOptions): GaxiosPromise<Schema$ManagedZoneOperationsListResponse>;
list(params: Params$Resource$Managedzoneoperations$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
list(params: Params$Resource$Managedzoneoperations$List, options: MethodOptions | BodyResponseCallback<Schema$ManagedZoneOperationsListResponse>, callback: BodyResponseCallback<Schema$ManagedZoneOperationsListResponse>): void;
list(params: Params$Resource$Managedzoneoperations$List, callback: BodyResponseCallback<Schema$ManagedZoneOperationsListResponse>): void;
list(callback: BodyResponseCallback<Schema$ManagedZoneOperationsListResponse>): void;
}
export interface Params$Resource$Managedzoneoperations$Get extends StandardParameters {
/**
* For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
*/
clientOperationId?: string;
/**
* Identifies the managed zone addressed by this request.
*/
managedZone?: string;
/**
* Identifies the operation addressed by this request.
*/
operation?: string;
/**
* Identifies the project addressed by this request.
*/
project?: string;
}
export interface Params$Resource$Managedzoneoperations$List extends StandardParameters {
/**
* Identifies the managed zone addressed by this request.
*/
managedZone?: string;
/**
* Optional. Maximum number of results to be returned. If unspecified, the server will decide how many results to return.
*/
maxResults?: number;
/**
* Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request.
*/
pageToken?: string;
/**
* Identifies the project addressed by this request.
*/
project?: string;
/**
* Sorting criterion. The only supported values are START_TIME and ID.
*/
sortBy?: string;
}
export class Resource$Managedzones {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* dns.managedZones.create
* @desc Create a new ManagedZone.
* @example
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/dns.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const dns = google.dns('v2beta1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/cloud-platform',
* 'https://www.googleapis.com/auth/ndev.clouddns.readwrite',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await dns.managedZones.create({
* // For mutating operation requests only. An optional identifier
* // specified by the client. Must be unique for operation resources in the
* // Operations collection.
* clientOperationId: 'placeholder-value',
* // Identifies the project addressed by this request.
* project: 'placeholder-value',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "creationTime": "my_creationTime",
* // "description": "my_description",
* // "dnsName": "my_dnsName",
* // "dnssecConfig": {},
* // "forwardingConfig": {},
* // "id": "my_id",
* // "kind": "my_kind",
* // "labels": {},
* // "name": "my_name",
* // "nameServerSet": "my_nameServerSet",
* // "nameServers": [],
* // "peeringConfig": {},
* // "privateVisibilityConfig": {},
* // "reverseLookupConfig": {},
* // "visibility": "my_visibility"
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "creationTime": "my_creationTime",
* // "description": "my_description",
* // "dnsName": "my_dnsName",
* // "dnssecConfig": {},
* // "forwardingConfig": {},
* // "id": "my_id",
* // "kind": "my_kind",
* // "labels": {},
* // "name": "my_name",
* // "nameServerSet": "my_nameServerSet",
* // "nameServers": [],
* // "peeringConfig": {},
* // "privateVisibilityConfig": {},
* // "reverseLookupConfig": {},
* // "visibility": "my_visibility"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* @alias dns.managedZones.create
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.clientOperationId For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
* @param {string} params.project Identifies the project addressed by this request.
* @param {().ManagedZone} params.requestBody 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$Managedzones$Create, options: StreamMethodOptions): GaxiosPromise<Readable>;
create(params?: Params$Resource$Managedzones$Create, options?: MethodOptions): GaxiosPromise<Schema$ManagedZone>;
create(params: Params$Resource$Managedzones$Create, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
create(params: Params$Resource$Managedzones$Create, options: MethodOptions | BodyResponseCallback<Schema$ManagedZone>, callback: BodyResponseCallback<Schema$ManagedZone>): void;
create(params: Params$Resource$Managedzones$Create, callback: BodyResponseCallback<Schema$ManagedZone>): void;
create(callback: BodyResponseCallback<Schema$ManagedZone>): void;
/**
* dns.managedZones.delete
* @desc Delete a previously created ManagedZone.
* @example
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/dns.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const dns = google.dns('v2beta1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/cloud-platform',
* 'https://www.googleapis.com/auth/ndev.clouddns.readwrite',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await dns.managedZones.delete({
* // For mutating operation requests only. An optional identifier
* // specified by the client. Must be unique for operation resources in the
* // Operations collection.
* clientOperationId: 'placeholder-value',
* // Identifies the managed zone addressed by this request. Can be the managed
* // zone name or id.
* managedZone: 'placeholder-value',
* // Identifies the project addressed by this request.
* project: 'placeholder-value',
* });
* console.log(res.data);
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* @alias dns.managedZones.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.clientOperationId For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
* @param {string} params.managedZone Identifies the managed zone addressed by this request. Can be the managed zone name or id.
* @param {string} params.project Identifies the project addressed by this request.
* @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
*/
delete(params: Params$Resource$Managedzones$Delete, options: StreamMethodOptions): GaxiosPromise<Readable>;
delete(params?: Params$Resource$Managedzones$Delete, options?: MethodOptions): GaxiosPromise<void>;
delete(params: Params$Resource$Managedzones$Delete, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
delete(params: Params$Resource$Managedzones$Delete, options: MethodOptions | BodyResponseCallback<void>, callback: BodyResponseCallback<void>): void;
delete(params: Params$Resource$Managedzones$Delete, callback: BodyResponseCallback<void>): void;
delete(callback: BodyResponseCallback<void>): void;
/**
* dns.managedZones.get
* @desc Fetch the representation of an existing ManagedZone.
* @example
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/dns.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const dns = google.dns('v2beta1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/cloud-platform',
* 'https://www.googleapis.com/auth/cloud-platform.read-only',
* 'https://www.googleapis.com/auth/ndev.clouddns.readonly',
* 'https://www.googleapis.com/auth/ndev.clouddns.readwrite',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await dns.managedZones.get({
* // For mutating operation requests only. An optional identifier
* // specified by the client. Must be unique for operation resources in the
* // Operations collection.
* clientOperationId: 'placeholder-value',
* // Identifies the managed zone addressed by this request. Can be the managed
* // zone name or id.
* managedZone: 'placeholder-value',
* // Identifies the project addressed by this request.
* project: 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "creationTime": "my_creationTime",
* // "description": "my_description",
* // "dnsName": "my_dnsName",
* // "dnssecConfig": {},
* // "forwardingConfig": {},
* // "id": "my_id",
* // "kind": "my_kind",
* // "labels": {},
* // "name": "my_name",
* // "nameServerSet": "my_nameServerSet",
* // "nameServers": [],
* // "peeringConfig": {},
* // "privateVisibilityConfig": {},
* // "reverseLookupConfig": {},
* // "visibility": "my_visibility"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* @alias dns.managedZones.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.clientOperationId For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
* @param {string} params.managedZone Identifies the managed zone addressed by this request. Can be the managed zone name or id.
* @param {string} params.project Identifies the project addressed by this request.
* @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$Managedzones$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
get(params?: Params$Resource$Managedzones$Get, options?: MethodOptions): GaxiosPromise<Schema$ManagedZone>;
get(params: Params$Resource$Managedzones$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
get(params: Params$Resource$Managedzones$Get, options: MethodOptions | BodyResponseCallback<Schema$ManagedZone>, callback: BodyResponseCallback<Schema$ManagedZone>): void;
get(params: Params$Resource$Managedzones$Get, callback: BodyResponseCallback<Schema$ManagedZone>): void;
get(callback: BodyResponseCallback<Schema$ManagedZone>): void;
/**
* dns.managedZones.list
* @desc Enumerate ManagedZones that have been created but not yet deleted.
* @example
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/dns.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const dns = google.dns('v2beta1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/cloud-platform',
* 'https://www.googleapis.com/auth/cloud-platform.read-only',
* 'https://www.googleapis.com/auth/ndev.clouddns.readonly',
* 'https://www.googleapis.com/auth/ndev.clouddns.readwrite',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await dns.managedZones.list({
* // Restricts the list to return only zones with this domain name.
* dnsName: 'placeholder-value',
* // Optional. Maximum number of results to be returned. If unspecified, the
* // server will decide how many results to return.
* maxResults: 'placeholder-value',
* // Optional. A tag returned by a previous list request that was truncated.
* // Use this parameter to continue a previous list request.
* pageToken: 'placeholder-value',
* // Identifies the project addressed by this request.
* project: 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "header": {},
* // "kind": "my_kind",
* // "managedZones": [],
* // "nextPageToken": "my_nextPageToken"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* @alias dns.managedZones.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.dnsName Restricts the list to return only zones with this domain name.
* @param {integer=} params.maxResults Optional. Maximum number of results to be returned. If unspecified, the server will decide how many results to return.
* @param {string=} params.pageToken Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request.
* @param {string} params.project Identifies the project addressed by this request.
* @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$Managedzones$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
list(params?: Params$Resource$Managedzones$List, options?: MethodOptions): GaxiosPromise<Schema$ManagedZonesListResponse>;
list(params: Params$Resource$Managedzones$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
list(params: Params$Resource$Managedzones$List, options: MethodOptions | BodyResponseCallback<Schema$ManagedZonesListResponse>, callback: BodyResponseCallback<Schema$ManagedZonesListResponse>): void;
list(params: Params$Resource$Managedzones$List, callback: BodyResponseCallback<Schema$ManagedZonesListResponse>): void;
list(callback: BodyResponseCallback<Schema$ManagedZonesListResponse>): void;
/**
* dns.managedZones.patch
* @desc Apply a partial update to an existing ManagedZone.
* @example
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/dns.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const dns = google.dns('v2beta1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/cloud-platform',
* 'https://www.googleapis.com/auth/ndev.clouddns.readwrite',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await dns.managedZones.patch({
* // For mutating operation requests only. An optional identifier
* // specified by the client. Must be unique for operation resources in the
* // Operations collection.
* clientOperationId: 'placeholder-value',
* // Identifies the managed zone addressed by this request. Can be the managed
* // zone name or id.
* managedZone: 'placeholder-value',
* // Identifies the project addressed by this request.
* project: 'placeholder-value',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "creationTime": "my_creationTime",
* // "description": "my_description",
* // "dnsName": "my_dnsName",
* // "dnssecConfig": {},
* // "forwardingConfig": {},
* // "id": "my_id",
* // "kind": "my_kind",
* // "labels": {},
* // "name": "my_name",
* // "nameServerSet": "my_nameServerSet",
* // "nameServers": [],
* // "peeringConfig": {},
* // "privateVisibilityConfig": {},
* // "reverseLookupConfig": {},
* // "visibility": "my_visibility"
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "dnsKeyContext": {},
* // "id": "my_id",
* // "kind": "my_kind",
* // "startTime": "my_startTime",
* // "status": "my_status",
* // "type": "my_type",
* // "user": "my_user",
* // "zoneContext": {}
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* @alias dns.managedZones.patch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.clientOperationId For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
* @param {string} params.managedZone Identifies the managed zone addressed by this request. Can be the managed zone name or id.
* @param {string} params.project Identifies the project addressed by this request.
* @param {().ManagedZone} params.requestBody 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
*/
patch(params: Params$Resource$Managedzones$Patch, options: StreamMethodOptions): GaxiosPromise<Readable>;
patch(params?: Params$Resource$Managedzones$Patch, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
patch(params: Params$Resource$Managedzones$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
patch(params: Params$Resource$Managedzones$Patch, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
patch(params: Params$Resource$Managedzones$Patch, callback: BodyResponseCallback<Schema$Operation>): void;
patch(callback: BodyResponseCallback<Schema$Operation>): void;
/**
* dns.managedZones.update
* @desc Update an existing ManagedZone.
* @example
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/dns.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const dns = google.dns('v2beta1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/cloud-platform',
* 'https://www.googleapis.com/auth/ndev.clouddns.readwrite',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await dns.managedZones.update({
* // For mutating operation requests only. An optional identifier
* // specified by the client. Must be unique for operation resources in the
* // Operations collection.
* clientOperationId: 'placeholder-value',
* // Identifies the managed zone addressed by this request. Can be the managed
* // zone name or id.
* managedZone: 'placeholder-value',
* // Identifies the project addressed by this request.
* project: 'placeholder-value',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "creationTime": "my_creationTime",
* // "description": "my_description",
* // "dnsName": "my_dnsName",
* // "dnssecConfig": {},
* // "forwardingConfig": {},
* // "id": "my_id",
* // "kind": "my_kind",
* // "labels": {},
* // "name": "my_name",
* // "nameServerSet": "my_nameServerSet",
* // "nameServers": [],
* // "peeringConfig": {},
* // "privateVisibilityConfig": {},
* // "reverseLookupConfig": {},
* // "visibility": "my_visibility"
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "dnsKeyContext": {},
* // "id": "my_id",
* // "kind": "my_kind",
* // "startTime": "my_startTime",
* // "status": "my_status",
* // "type": "my_type",
* // "user": "my_user",
* // "zoneContext": {}
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* @alias dns.managedZones.update
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.clientOperationId For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
* @param {string} params.managedZone Identifies the managed zone addressed by this request. Can be the managed zone name or id.
* @param {string} params.project Identifies the project addressed by this request.
* @param {().ManagedZone} params.requestBody 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
*/
update(params: Params$Resource$Managedzones$Update, options: StreamMethodOptions): GaxiosPromise<Readable>;
update(params?: Params$Resource$Managedzones$Update, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
update(params: Params$Resource$Managedzones$Update, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
update(params: Params$Resource$Managedzones$Update, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
update(params: Params$Resource$Managedzones$Update, callback: BodyResponseCallback<Schema$Operation>): void;
update(callback: BodyResponseCallback<Schema$Operation>): void;
}
export interface Params$Resource$Managedzones$Create extends StandardParameters {
/**
* For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
*/
clientOperationId?: string;
/**
* Identifies the project addressed by this request.
*/
project?: string;
/**
* Request body metadata
*/
requestBody?: Schema$ManagedZone;
}
export interface Params$Resource$Managedzones$Delete extends StandardParameters {
/**
* For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
*/
clientOperationId?: string;
/**
* Identifies the managed zone addressed by this request. Can be the managed zone name or id.
*/
managedZone?: string;
/**
* Identifies the project addressed by this request.
*/
project?: string;
}
export interface Params$Resource$Managedzones$Get extends StandardParameters {
/**
* For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
*/
clientOperationId?: string;
/**
* Identifies the managed zone addressed by this request. Can be the managed zone name or id.
*/
managedZone?: string;
/**
* Identifies the project addressed by this request.
*/
project?: string;
}
export interface Params$Resource$Managedzones$List extends StandardParameters {
/**
* Restricts the list to return only zones with this domain name.
*/
dnsName?: string;
/**
* Optional. Maximum number of results to be returned. If unspecified, the server will decide how many results to return.
*/
maxResults?: number;
/**
* Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request.
*/
pageToken?: string;
/**
* Identifies the project addressed by this request.
*/
project?: string;
}
export interface Params$Resource$Managedzones$Patch extends StandardParameters {
/**
* For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
*/
clientOperationId?: string;
/**
* Identifies the managed zone addressed by this request. Can be the managed zone name or id.
*/
managedZone?: string;
/**
* Identifies the project addressed by this request.
*/
project?: string;
/**
* Request body metadata
*/
requestBody?: Schema$ManagedZone;
}
export interface Params$Resource$Managedzones$Update extends StandardParameters {
/**
* For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
*/
clientOperationId?: string;
/**
* Identifies the managed zone addressed by this request. Can be the managed zone name or id.
*/
managedZone?: string;
/**
* Identifies the project addressed by this request.
*/
project?: string;
/**
* Request body metadata
*/
requestBody?: Schema$ManagedZone;
}
export class Resource$Policies {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* dns.policies.create
* @desc Create a new Policy
* @example
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/dns.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const dns = google.dns('v2beta1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await dns.policies.create({
* // For mutating operation requests only. An optional identifier
* // specified by the client. Must be unique for operation resources in the
* // Operations collection.
* clientOperationId: 'placeholder-value',
* // Identifies the project addressed by this request.
* project: 'placeholder-value',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "alternativeNameServerConfig": {},
* // "description": "my_description",
* // "enableInboundForwarding": false,
* // "enableLogging": false,
* // "id": "my_id",
* // "kind": "my_kind",
* // "name": "my_name",
* // "networks": []
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "alternativeNameServerConfig": {},
* // "description": "my_description",
* // "enableInboundForwarding": false,
* // "enableLogging": false,
* // "id": "my_id",
* // "kind": "my_kind",
* // "name": "my_name",
* // "networks": []
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* @alias dns.policies.create
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.clientOperationId For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
* @param {string} params.project Identifies the project addressed by this request.
* @param {().Policy} params.requestBody 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$Policies$Create, options: StreamMethodOptions): GaxiosPromise<Readable>;
create(params?: Params$Resource$Policies$Create, options?: MethodOptions): GaxiosPromise<Schema$Policy>;
create(params: Params$Resource$Policies$Create, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
create(params: Params$Resource$Policies$Create, options: MethodOptions | BodyResponseCallback<Schema$Policy>, callback: BodyResponseCallback<Schema$Policy>): void;
create(params: Params$Resource$Policies$Create, callback: BodyResponseCallback<Schema$Policy>): void;
create(callback: BodyResponseCallback<Schema$Policy>): void;
/**
* dns.policies.delete
* @desc Delete a previously created Policy. Will fail if the policy is still being referenced by a network.
* @example
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/dns.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const dns = google.dns('v2beta1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await dns.policies.delete({
* // For mutating operation requests only. An optional identifier
* // specified by the client. Must be unique for operation resources in the
* // Operations collection.
* clientOperationId: 'placeholder-value',
* // User given friendly name of the policy addressed by this request.
* policy: 'placeholder-value',
* // Identifies the project addressed by this request.
* project: 'placeholder-value',
* });
* console.log(res.data);
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* @alias dns.policies.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.clientOperationId For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
* @param {string} params.policy User given friendly name of the policy addressed by this request.
* @param {string} params.project Identifies the project addressed by this request.
* @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
*/
delete(params: Params$Resource$Policies$Delete, options: StreamMethodOptions): GaxiosPromise<Readable>;
delete(params?: Params$Resource$Policies$Delete, options?: MethodOptions): GaxiosPromise<void>;
delete(params: Params$Resource$Policies$Delete, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
delete(params: Params$Resource$Policies$Delete, options: MethodOptions | BodyResponseCallback<void>, callback: BodyResponseCallback<void>): void;
delete(params: Params$Resource$Policies$Delete, callback: BodyResponseCallback<void>): void;
delete(callback: BodyResponseCallback<void>): void;
/**
* dns.policies.get
* @desc Fetch the representation of an existing Policy.
* @example
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/dns.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const dns = google.dns('v2beta1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await dns.policies.get({
* // For mutating operation requests only. An optional identifier
* // specified by the client. Must be unique for operation resources in the
* // Operations collection.
* clientOperationId: 'placeholder-value',
* // User given friendly name of the policy addressed by this request.
* policy: 'placeholder-value',
* // Identifies the project addressed by this request.
* project: 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "alternativeNameServerConfig": {},
* // "description": "my_description",
* // "enableInboundForwarding": false,
* // "enableLogging": false,
* // "id": "my_id",
* // "kind": "my_kind",
* // "name": "my_name",
* // "networks": []
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* @alias dns.policies.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.clientOperationId For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
* @param {string} params.policy User given friendly name of the policy addressed by this request.
* @param {string} params.project Identifies the project addressed by this request.
* @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$Policies$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
get(params?: Params$Resource$Policies$Get, options?: MethodOptions): GaxiosPromise<Schema$Policy>;
get(params: Params$Resource$Policies$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
get(params: Params$Resource$Policies$Get, options: MethodOptions | BodyResponseCallback<Schema$Policy>, callback: BodyResponseCallback<Schema$Policy>): void;
get(params: Params$Resource$Policies$Get, callback: BodyResponseCallback<Schema$Policy>): void;
get(callback: BodyResponseCallback<Schema$Policy>): void;
/**
* dns.policies.list
* @desc Enumerate all Policies associated with a project.
* @example
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/dns.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const dns = google.dns('v2beta1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await dns.policies.list({
* // Optional. Maximum number of results to be returned. If unspecified, the
* // server will decide how many results to return.
* maxResults: 'placeholder-value',
* // Optional. A tag returned by a previous list request that was truncated.
* // Use this parameter to continue a previous list request.
* pageToken: 'placeholder-value',
* // Identifies the project addressed by this request.
* project: 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "header": {},
* // "kind": "my_kind",
* // "nextPageToken": "my_nextPageToken",
* // "policies": []
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* @alias dns.policies.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {integer=} params.maxResults Optional. Maximum number of results to be returned. If unspecified, the server will decide how many results to return.
* @param {string=} params.pageToken Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request.
* @param {string} params.project Identifies the project addressed by this request.
* @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$Policies$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
list(params?: Params$Resource$Policies$List, options?: MethodOptions): GaxiosPromise<Schema$PoliciesListResponse>;
list(params: Params$Resource$Policies$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
list(params: Params$Resource$Policies$List, options: MethodOptions | BodyResponseCallback<Schema$PoliciesListResponse>, callback: BodyResponseCallback<Schema$PoliciesListResponse>): void;
list(params: Params$Resource$Policies$List, callback: BodyResponseCallback<Schema$PoliciesListResponse>): void;
list(callback: BodyResponseCallback<Schema$PoliciesListResponse>): void;
/**
* dns.policies.patch
* @desc Apply a partial update to an existing Policy.
* @example
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/dns.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const dns = google.dns('v2beta1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await dns.policies.patch({
* // For mutating operation requests only. An optional identifier
* // specified by the client. Must be unique for operation resources in the
* // Operations collection.
* clientOperationId: 'placeholder-value',
* // User given friendly name of the policy addressed by this request.
* policy: 'placeholder-value',
* // Identifies the project addressed by this request.
* project: 'placeholder-value',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "alternativeNameServerConfig": {},
* // "description": "my_description",
* // "enableInboundForwarding": false,
* // "enableLogging": false,
* // "id": "my_id",
* // "kind": "my_kind",
* // "name": "my_name",
* // "networks": []
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "header": {},
* // "policy": {}
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* @alias dns.policies.patch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.clientOperationId For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
* @param {string} params.policy User given friendly name of the policy addressed by this request.
* @param {string} params.project Identifies the project addressed by this request.
* @param {().Policy} params.requestBody 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
*/
patch(params: Params$Resource$Policies$Patch, options: StreamMethodOptions): GaxiosPromise<Readable>;
patch(params?: Params$Resource$Policies$Patch, options?: MethodOptions): GaxiosPromise<Schema$PoliciesPatchResponse>;
patch(params: Params$Resource$Policies$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
patch(params: Params$Resource$Policies$Patch, options: MethodOptions | BodyResponseCallback<Schema$PoliciesPatchResponse>, callback: BodyResponseCallback<Schema$PoliciesPatchResponse>): void;
patch(params: Params$Resource$Policies$Patch, callback: BodyResponseCallback<Schema$PoliciesPatchResponse>): void;
patch(callback: BodyResponseCallback<Schema$PoliciesPatchResponse>): void;
/**
* dns.policies.update
* @desc Update an existing Policy.
* @example
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/dns.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const dns = google.dns('v2beta1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await dns.policies.update({
* // For mutating operation requests only. An optional identifier
* // specified by the client. Must be unique for operation resources in the
* // Operations collection.
* clientOperationId: 'placeholder-value',
* // User given friendly name of the policy addressed by this request.
* policy: 'placeholder-value',
* // Identifies the project addressed by this request.
* project: 'placeholder-value',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "alternativeNameServerConfig": {},
* // "description": "my_description",
* // "enableInboundForwarding": false,
* // "enableLogging": false,
* // "id": "my_id",
* // "kind": "my_kind",
* // "name": "my_name",
* // "networks": []
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "header": {},
* // "policy": {}
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* @alias dns.policies.update
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.clientOperationId For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
* @param {string} params.policy User given friendly name of the policy addressed by this request.
* @param {string} params.project Identifies the project addressed by this request.
* @param {().Policy} params.requestBody 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
*/
update(params: Params$Resource$Policies$Update, options: StreamMethodOptions): GaxiosPromise<Readable>;
update(params?: Params$Resource$Policies$Update, options?: MethodOptions): GaxiosPromise<Schema$PoliciesUpdateResponse>;
update(params: Params$Resource$Policies$Update, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
update(params: Params$Resource$Policies$Update, options: MethodOptions | BodyResponseCallback<Schema$PoliciesUpdateResponse>, callback: BodyResponseCallback<Schema$PoliciesUpdateResponse>): void;
update(params: Params$Resource$Policies$Update, callback: BodyResponseCallback<Schema$PoliciesUpdateResponse>): void;
update(callback: BodyResponseCallback<Schema$PoliciesUpdateResponse>): void;
}
export interface Params$Resource$Policies$Create extends StandardParameters {
/**
* For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
*/
clientOperationId?: string;
/**
* Identifies the project addressed by this request.
*/
project?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Policy;
}
export interface Params$Resource$Policies$Delete extends StandardParameters {
/**
* For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
*/
clientOperationId?: string;
/**
* User given friendly name of the policy addressed by this request.
*/
policy?: string;
/**
* Identifies the project addressed by this request.
*/
project?: string;
}
export interface Params$Resource$Policies$Get extends StandardParameters {
/**
* For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
*/
clientOperationId?: string;
/**
* User given friendly name of the policy addressed by this request.
*/
policy?: string;
/**
* Identifies the project addressed by this request.
*/
project?: string;
}
export interface Params$Resource$Policies$List extends StandardParameters {
/**
* Optional. Maximum number of results to be returned. If unspecified, the server will decide how many results to return.
*/
maxResults?: number;
/**
* Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request.
*/
pageToken?: string;
/**
* Identifies the project addressed by this request.
*/
project?: string;
}
export interface Params$Resource$Policies$Patch extends StandardParameters {
/**
* For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
*/
clientOperationId?: string;
/**
* User given friendly name of the policy addressed by this request.
*/
policy?: string;
/**
* Identifies the project addressed by this request.
*/
project?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Policy;
}
export interface Params$Resource$Policies$Update extends StandardParameters {
/**
* For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
*/
clientOperationId?: string;
/**
* User given friendly name of the policy addressed by this request.
*/
policy?: string;
/**
* Identifies the project addressed by this request.
*/
project?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Policy;
}
export class Resource$Projects {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* dns.projects.get
* @desc Fetch the representation of an existing Project.
* @example
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/dns.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const dns = google.dns('v2beta1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/cloud-platform',
* 'https://www.googleapis.com/auth/cloud-platform.read-only',
* 'https://www.googleapis.com/auth/ndev.clouddns.readonly',
* 'https://www.googleapis.com/auth/ndev.clouddns.readwrite',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await dns.projects.get({
* // For mutating operation requests only. An optional identifier
* // specified by the client. Must be unique for operation resources in the
* // Operations collection.
* clientOperationId: 'placeholder-value',
* // Identifies the project addressed by this request.
* project: 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "id": "my_id",
* // "kind": "my_kind",
* // "number": "my_number",
* // "quota": {}
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* @alias dns.projects.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.clientOperationId For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
* @param {string} params.project Identifies the project addressed by this request.
* @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$Projects$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
get(params?: Params$Resource$Projects$Get, options?: MethodOptions): GaxiosPromise<Schema$Project>;
get(params: Params$Resource$Projects$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
get(params: Params$Resource$Projects$Get, options: MethodOptions | BodyResponseCallback<Schema$Project>, callback: BodyResponseCallback<Schema$Project>): void;
get(params: Params$Resource$Projects$Get, callback: BodyResponseCallback<Schema$Project>): void;
get(callback: BodyResponseCallback<Schema$Project>): void;
}
export interface Params$Resource$Projects$Get extends StandardParameters {
/**
* For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection.
*/
clientOperationId?: string;
/**
* Identifies the project addressed by this request.
*/
project?: string;
}
export class Resource$Resourcerecordsets {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* dns.resourceRecordSets.list
* @desc Enumerate ResourceRecordSets that have been created but not yet deleted.
* @example
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/dns.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const dns = google.dns('v2beta1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/cloud-platform',
* 'https://www.googleapis.com/auth/cloud-platform.read-only',
* 'https://www.googleapis.com/auth/ndev.clouddns.readonly',
* 'https://www.googleapis.com/auth/ndev.clouddns.readwrite',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await dns.resourceRecordSets.list({
* // Identifies the managed zone addressed by this request. Can be the managed
* // zone name or id.
* managedZone: 'placeholder-value',
* // Optional. Maximum number of results to be returned. If unspecified, the
* // server will decide how many results to return.
* maxResults: 'placeholder-value',
* // Restricts the list to return only records with this fully qualified domain
* // name.
* name: 'placeholder-value',
* // Optional. A tag returned by a previous list request that was truncated.
* // Use this parameter to continue a previous list request.
* pageToken: 'placeholder-value',
* // Identifies the project addressed by this request.
* project: 'placeholder-value',
* // Restricts the list to return only records of this type. If present, the
* // "name" parameter must also be present.
* type: 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "header": {},
* // "kind": "my_kind",
* // "nextPageToken": "my_nextPageToken",
* // "rrsets": []
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* @alias dns.resourceRecordSets.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.managedZone Identifies the managed zone addressed by this request. Can be the managed zone name or id.
* @param {integer=} params.maxResults Optional. Maximum number of results to be returned. If unspecified, the server will decide how many results to return.
* @param {string=} params.name Restricts the list to return only records with this fully qualified domain name.
* @param {string=} params.pageToken Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request.
* @param {string} params.project Identifies the project addressed by this request.
* @param {string=} params.type Restricts the list to return only records of this type. If present, the "name" parameter must also be present.
* @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$Resourcerecordsets$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
list(params?: Params$Resource$Resourcerecordsets$List, options?: MethodOptions): GaxiosPromise<Schema$ResourceRecordSetsListResponse>;
list(params: Params$Resource$Resourcerecordsets$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
list(params: Params$Resource$Resourcerecordsets$List, options: MethodOptions | BodyResponseCallback<Schema$ResourceRecordSetsListResponse>, callback: BodyResponseCallback<Schema$ResourceRecordSetsListResponse>): void;
list(params: Params$Resource$Resourcerecordsets$List, callback: BodyResponseCallback<Schema$ResourceRecordSetsListResponse>): void;
list(callback: BodyResponseCallback<Schema$ResourceRecordSetsListResponse>): void;
}
export interface Params$Resource$Resourcerecordsets$List extends StandardParameters {
/**
* Identifies the managed zone addressed by this request. Can be the managed zone name or id.
*/
managedZone?: string;
/**
* Optional. Maximum number of results to be returned. If unspecified, the server will decide how many results to return.
*/
maxResults?: number;
/**
* Restricts the list to return only records with this fully qualified domain name.
*/
name?: string;
/**
* Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request.
*/
pageToken?: string;
/**
* Identifies the project addressed by this request.
*/
project?: string;
/**
* Restricts the list to return only records of this type. If present, the "name" parameter must also be present.
*/
type?: string;
}
export {};
}