@googleapis/tpu 6.0.1 → 7.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -902,6 +902,10 @@ export declare namespace tpu_v2alpha1 {
902
902
  * Optional. Defines the provisioning model for the node.
903
903
  */
904
904
  provisioningModel?: string | null;
905
+ /**
906
+ * Optional. Name of the reservation in which the node should be provisioned.
907
+ */
908
+ reservationName?: string | null;
905
909
  /**
906
910
  * Whether the node is created under a reservation.
907
911
  */
@@ -1108,6 +1112,58 @@ export declare namespace tpu_v2alpha1 {
1108
1112
  constructor(context: APIRequestContext);
1109
1113
  /**
1110
1114
  * Generates the Cloud TPU service identity for the project.
1115
+ * @example
1116
+ * ```js
1117
+ * // Before running the sample:
1118
+ * // - Enable the API at:
1119
+ * // https://console.developers.google.com/apis/api/tpu.googleapis.com
1120
+ * // - Login into gcloud by running:
1121
+ * // ```sh
1122
+ * // $ gcloud auth application-default login
1123
+ * // ```
1124
+ * // - Install the npm module by running:
1125
+ * // ```sh
1126
+ * // $ npm install googleapis
1127
+ * // ```
1128
+ *
1129
+ * const {google} = require('googleapis');
1130
+ * const tpu = google.tpu('v2alpha1');
1131
+ *
1132
+ * async function main() {
1133
+ * const auth = new google.auth.GoogleAuth({
1134
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
1135
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
1136
+ * });
1137
+ *
1138
+ * // Acquire an auth client, and bind it to all future calls
1139
+ * const authClient = await auth.getClient();
1140
+ * google.options({auth: authClient});
1141
+ *
1142
+ * // Do the magic
1143
+ * const res = await tpu.projects.locations.generateServiceIdentity({
1144
+ * // Required. The parent resource name.
1145
+ * parent: 'projects/my-project/locations/my-location',
1146
+ *
1147
+ * // Request body metadata
1148
+ * requestBody: {
1149
+ * // request body parameters
1150
+ * // {}
1151
+ * },
1152
+ * });
1153
+ * console.log(res.data);
1154
+ *
1155
+ * // Example response
1156
+ * // {
1157
+ * // "identity": {}
1158
+ * // }
1159
+ * }
1160
+ *
1161
+ * main().catch(e => {
1162
+ * console.error(e);
1163
+ * throw e;
1164
+ * });
1165
+ *
1166
+ * ```
1111
1167
  *
1112
1168
  * @param params - Parameters for request
1113
1169
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1122,6 +1178,56 @@ export declare namespace tpu_v2alpha1 {
1122
1178
  generateServiceIdentity(callback: BodyResponseCallback<Schema$GenerateServiceIdentityResponse>): void;
1123
1179
  /**
1124
1180
  * Gets information about a location.
1181
+ * @example
1182
+ * ```js
1183
+ * // Before running the sample:
1184
+ * // - Enable the API at:
1185
+ * // https://console.developers.google.com/apis/api/tpu.googleapis.com
1186
+ * // - Login into gcloud by running:
1187
+ * // ```sh
1188
+ * // $ gcloud auth application-default login
1189
+ * // ```
1190
+ * // - Install the npm module by running:
1191
+ * // ```sh
1192
+ * // $ npm install googleapis
1193
+ * // ```
1194
+ *
1195
+ * const {google} = require('googleapis');
1196
+ * const tpu = google.tpu('v2alpha1');
1197
+ *
1198
+ * async function main() {
1199
+ * const auth = new google.auth.GoogleAuth({
1200
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
1201
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
1202
+ * });
1203
+ *
1204
+ * // Acquire an auth client, and bind it to all future calls
1205
+ * const authClient = await auth.getClient();
1206
+ * google.options({auth: authClient});
1207
+ *
1208
+ * // Do the magic
1209
+ * const res = await tpu.projects.locations.get({
1210
+ * // Resource name for the location.
1211
+ * name: 'projects/my-project/locations/my-location',
1212
+ * });
1213
+ * console.log(res.data);
1214
+ *
1215
+ * // Example response
1216
+ * // {
1217
+ * // "displayName": "my_displayName",
1218
+ * // "labels": {},
1219
+ * // "locationId": "my_locationId",
1220
+ * // "metadata": {},
1221
+ * // "name": "my_name"
1222
+ * // }
1223
+ * }
1224
+ *
1225
+ * main().catch(e => {
1226
+ * console.error(e);
1227
+ * throw e;
1228
+ * });
1229
+ *
1230
+ * ```
1125
1231
  *
1126
1232
  * @param params - Parameters for request
1127
1233
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1136,6 +1242,61 @@ export declare namespace tpu_v2alpha1 {
1136
1242
  get(callback: BodyResponseCallback<Schema$Location>): void;
1137
1243
  /**
1138
1244
  * Lists information about the supported locations for this service.
1245
+ * @example
1246
+ * ```js
1247
+ * // Before running the sample:
1248
+ * // - Enable the API at:
1249
+ * // https://console.developers.google.com/apis/api/tpu.googleapis.com
1250
+ * // - Login into gcloud by running:
1251
+ * // ```sh
1252
+ * // $ gcloud auth application-default login
1253
+ * // ```
1254
+ * // - Install the npm module by running:
1255
+ * // ```sh
1256
+ * // $ npm install googleapis
1257
+ * // ```
1258
+ *
1259
+ * const {google} = require('googleapis');
1260
+ * const tpu = google.tpu('v2alpha1');
1261
+ *
1262
+ * async function main() {
1263
+ * const auth = new google.auth.GoogleAuth({
1264
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
1265
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
1266
+ * });
1267
+ *
1268
+ * // Acquire an auth client, and bind it to all future calls
1269
+ * const authClient = await auth.getClient();
1270
+ * google.options({auth: authClient});
1271
+ *
1272
+ * // Do the magic
1273
+ * const res = await tpu.projects.locations.list({
1274
+ * // Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.
1275
+ * extraLocationTypes: 'placeholder-value',
1276
+ * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
1277
+ * filter: 'placeholder-value',
1278
+ * // The resource that owns the locations collection, if applicable.
1279
+ * name: 'projects/my-project',
1280
+ * // The maximum number of results to return. If not set, the service selects a default.
1281
+ * pageSize: 'placeholder-value',
1282
+ * // A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
1283
+ * pageToken: 'placeholder-value',
1284
+ * });
1285
+ * console.log(res.data);
1286
+ *
1287
+ * // Example response
1288
+ * // {
1289
+ * // "locations": [],
1290
+ * // "nextPageToken": "my_nextPageToken"
1291
+ * // }
1292
+ * }
1293
+ *
1294
+ * main().catch(e => {
1295
+ * console.error(e);
1296
+ * throw e;
1297
+ * });
1298
+ *
1299
+ * ```
1139
1300
  *
1140
1301
  * @param params - Parameters for request
1141
1302
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1192,6 +1353,54 @@ export declare namespace tpu_v2alpha1 {
1192
1353
  constructor(context: APIRequestContext);
1193
1354
  /**
1194
1355
  * Gets AcceleratorType.
1356
+ * @example
1357
+ * ```js
1358
+ * // Before running the sample:
1359
+ * // - Enable the API at:
1360
+ * // https://console.developers.google.com/apis/api/tpu.googleapis.com
1361
+ * // - Login into gcloud by running:
1362
+ * // ```sh
1363
+ * // $ gcloud auth application-default login
1364
+ * // ```
1365
+ * // - Install the npm module by running:
1366
+ * // ```sh
1367
+ * // $ npm install googleapis
1368
+ * // ```
1369
+ *
1370
+ * const {google} = require('googleapis');
1371
+ * const tpu = google.tpu('v2alpha1');
1372
+ *
1373
+ * async function main() {
1374
+ * const auth = new google.auth.GoogleAuth({
1375
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
1376
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
1377
+ * });
1378
+ *
1379
+ * // Acquire an auth client, and bind it to all future calls
1380
+ * const authClient = await auth.getClient();
1381
+ * google.options({auth: authClient});
1382
+ *
1383
+ * // Do the magic
1384
+ * const res = await tpu.projects.locations.acceleratorTypes.get({
1385
+ * // Required. The resource name.
1386
+ * name: 'projects/my-project/locations/my-location/acceleratorTypes/my-acceleratorType',
1387
+ * });
1388
+ * console.log(res.data);
1389
+ *
1390
+ * // Example response
1391
+ * // {
1392
+ * // "acceleratorConfigs": [],
1393
+ * // "name": "my_name",
1394
+ * // "type": "my_type"
1395
+ * // }
1396
+ * }
1397
+ *
1398
+ * main().catch(e => {
1399
+ * console.error(e);
1400
+ * throw e;
1401
+ * });
1402
+ *
1403
+ * ```
1195
1404
  *
1196
1405
  * @param params - Parameters for request
1197
1406
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1206,6 +1415,62 @@ export declare namespace tpu_v2alpha1 {
1206
1415
  get(callback: BodyResponseCallback<Schema$AcceleratorType>): void;
1207
1416
  /**
1208
1417
  * Lists accelerator types supported by this API.
1418
+ * @example
1419
+ * ```js
1420
+ * // Before running the sample:
1421
+ * // - Enable the API at:
1422
+ * // https://console.developers.google.com/apis/api/tpu.googleapis.com
1423
+ * // - Login into gcloud by running:
1424
+ * // ```sh
1425
+ * // $ gcloud auth application-default login
1426
+ * // ```
1427
+ * // - Install the npm module by running:
1428
+ * // ```sh
1429
+ * // $ npm install googleapis
1430
+ * // ```
1431
+ *
1432
+ * const {google} = require('googleapis');
1433
+ * const tpu = google.tpu('v2alpha1');
1434
+ *
1435
+ * async function main() {
1436
+ * const auth = new google.auth.GoogleAuth({
1437
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
1438
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
1439
+ * });
1440
+ *
1441
+ * // Acquire an auth client, and bind it to all future calls
1442
+ * const authClient = await auth.getClient();
1443
+ * google.options({auth: authClient});
1444
+ *
1445
+ * // Do the magic
1446
+ * const res = await tpu.projects.locations.acceleratorTypes.list({
1447
+ * // List filter.
1448
+ * filter: 'placeholder-value',
1449
+ * // Sort results.
1450
+ * orderBy: 'placeholder-value',
1451
+ * // The maximum number of items to return.
1452
+ * pageSize: 'placeholder-value',
1453
+ * // The next_page_token value returned from a previous List request, if any.
1454
+ * pageToken: 'placeholder-value',
1455
+ * // Required. The parent resource name.
1456
+ * parent: 'projects/my-project/locations/my-location',
1457
+ * });
1458
+ * console.log(res.data);
1459
+ *
1460
+ * // Example response
1461
+ * // {
1462
+ * // "acceleratorTypes": [],
1463
+ * // "nextPageToken": "my_nextPageToken",
1464
+ * // "unreachable": []
1465
+ * // }
1466
+ * }
1467
+ *
1468
+ * main().catch(e => {
1469
+ * console.error(e);
1470
+ * throw e;
1471
+ * });
1472
+ *
1473
+ * ```
1209
1474
  *
1210
1475
  * @param params - Parameters for request
1211
1476
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1252,6 +1517,95 @@ export declare namespace tpu_v2alpha1 {
1252
1517
  constructor(context: APIRequestContext);
1253
1518
  /**
1254
1519
  * Creates a node.
1520
+ * @example
1521
+ * ```js
1522
+ * // Before running the sample:
1523
+ * // - Enable the API at:
1524
+ * // https://console.developers.google.com/apis/api/tpu.googleapis.com
1525
+ * // - Login into gcloud by running:
1526
+ * // ```sh
1527
+ * // $ gcloud auth application-default login
1528
+ * // ```
1529
+ * // - Install the npm module by running:
1530
+ * // ```sh
1531
+ * // $ npm install googleapis
1532
+ * // ```
1533
+ *
1534
+ * const {google} = require('googleapis');
1535
+ * const tpu = google.tpu('v2alpha1');
1536
+ *
1537
+ * async function main() {
1538
+ * const auth = new google.auth.GoogleAuth({
1539
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
1540
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
1541
+ * });
1542
+ *
1543
+ * // Acquire an auth client, and bind it to all future calls
1544
+ * const authClient = await auth.getClient();
1545
+ * google.options({auth: authClient});
1546
+ *
1547
+ * // Do the magic
1548
+ * const res = await tpu.projects.locations.nodes.create({
1549
+ * // The unqualified resource name.
1550
+ * nodeId: 'placeholder-value',
1551
+ * // Required. The parent resource name.
1552
+ * parent: 'projects/my-project/locations/my-location',
1553
+ * // Idempotent request UUID.
1554
+ * requestId: 'placeholder-value',
1555
+ *
1556
+ * // Request body metadata
1557
+ * requestBody: {
1558
+ * // request body parameters
1559
+ * // {
1560
+ * // "acceleratorConfig": {},
1561
+ * // "acceleratorType": "my_acceleratorType",
1562
+ * // "apiVersion": "my_apiVersion",
1563
+ * // "autocheckpointEnabled": false,
1564
+ * // "bootDiskConfig": {},
1565
+ * // "cidrBlock": "my_cidrBlock",
1566
+ * // "createTime": "my_createTime",
1567
+ * // "dataDisks": [],
1568
+ * // "description": "my_description",
1569
+ * // "health": "my_health",
1570
+ * // "healthDescription": "my_healthDescription",
1571
+ * // "id": "my_id",
1572
+ * // "labels": {},
1573
+ * // "metadata": {},
1574
+ * // "multisliceNode": false,
1575
+ * // "name": "my_name",
1576
+ * // "networkConfig": {},
1577
+ * // "networkConfigs": [],
1578
+ * // "networkEndpoints": [],
1579
+ * // "queuedResource": "my_queuedResource",
1580
+ * // "runtimeVersion": "my_runtimeVersion",
1581
+ * // "schedulingConfig": {},
1582
+ * // "serviceAccount": {},
1583
+ * // "shieldedInstanceConfig": {},
1584
+ * // "state": "my_state",
1585
+ * // "symptoms": [],
1586
+ * // "tags": [],
1587
+ * // "upcomingMaintenance": {}
1588
+ * // }
1589
+ * },
1590
+ * });
1591
+ * console.log(res.data);
1592
+ *
1593
+ * // Example response
1594
+ * // {
1595
+ * // "done": false,
1596
+ * // "error": {},
1597
+ * // "metadata": {},
1598
+ * // "name": "my_name",
1599
+ * // "response": {}
1600
+ * // }
1601
+ * }
1602
+ *
1603
+ * main().catch(e => {
1604
+ * console.error(e);
1605
+ * throw e;
1606
+ * });
1607
+ *
1608
+ * ```
1255
1609
  *
1256
1610
  * @param params - Parameters for request
1257
1611
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1266,6 +1620,58 @@ export declare namespace tpu_v2alpha1 {
1266
1620
  create(callback: BodyResponseCallback<Schema$Operation>): void;
1267
1621
  /**
1268
1622
  * Deletes a node.
1623
+ * @example
1624
+ * ```js
1625
+ * // Before running the sample:
1626
+ * // - Enable the API at:
1627
+ * // https://console.developers.google.com/apis/api/tpu.googleapis.com
1628
+ * // - Login into gcloud by running:
1629
+ * // ```sh
1630
+ * // $ gcloud auth application-default login
1631
+ * // ```
1632
+ * // - Install the npm module by running:
1633
+ * // ```sh
1634
+ * // $ npm install googleapis
1635
+ * // ```
1636
+ *
1637
+ * const {google} = require('googleapis');
1638
+ * const tpu = google.tpu('v2alpha1');
1639
+ *
1640
+ * async function main() {
1641
+ * const auth = new google.auth.GoogleAuth({
1642
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
1643
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
1644
+ * });
1645
+ *
1646
+ * // Acquire an auth client, and bind it to all future calls
1647
+ * const authClient = await auth.getClient();
1648
+ * google.options({auth: authClient});
1649
+ *
1650
+ * // Do the magic
1651
+ * const res = await tpu.projects.locations.nodes.delete({
1652
+ * // Required. The resource name.
1653
+ * name: 'projects/my-project/locations/my-location/nodes/my-node',
1654
+ * // Idempotent request UUID.
1655
+ * requestId: 'placeholder-value',
1656
+ * });
1657
+ * console.log(res.data);
1658
+ *
1659
+ * // Example response
1660
+ * // {
1661
+ * // "done": false,
1662
+ * // "error": {},
1663
+ * // "metadata": {},
1664
+ * // "name": "my_name",
1665
+ * // "response": {}
1666
+ * // }
1667
+ * }
1668
+ *
1669
+ * main().catch(e => {
1670
+ * console.error(e);
1671
+ * throw e;
1672
+ * });
1673
+ *
1674
+ * ```
1269
1675
  *
1270
1676
  * @param params - Parameters for request
1271
1677
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1280,6 +1686,79 @@ export declare namespace tpu_v2alpha1 {
1280
1686
  delete(callback: BodyResponseCallback<Schema$Operation>): void;
1281
1687
  /**
1282
1688
  * Gets the details of a node.
1689
+ * @example
1690
+ * ```js
1691
+ * // Before running the sample:
1692
+ * // - Enable the API at:
1693
+ * // https://console.developers.google.com/apis/api/tpu.googleapis.com
1694
+ * // - Login into gcloud by running:
1695
+ * // ```sh
1696
+ * // $ gcloud auth application-default login
1697
+ * // ```
1698
+ * // - Install the npm module by running:
1699
+ * // ```sh
1700
+ * // $ npm install googleapis
1701
+ * // ```
1702
+ *
1703
+ * const {google} = require('googleapis');
1704
+ * const tpu = google.tpu('v2alpha1');
1705
+ *
1706
+ * async function main() {
1707
+ * const auth = new google.auth.GoogleAuth({
1708
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
1709
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
1710
+ * });
1711
+ *
1712
+ * // Acquire an auth client, and bind it to all future calls
1713
+ * const authClient = await auth.getClient();
1714
+ * google.options({auth: authClient});
1715
+ *
1716
+ * // Do the magic
1717
+ * const res = await tpu.projects.locations.nodes.get({
1718
+ * // Required. The resource name.
1719
+ * name: 'projects/my-project/locations/my-location/nodes/my-node',
1720
+ * });
1721
+ * console.log(res.data);
1722
+ *
1723
+ * // Example response
1724
+ * // {
1725
+ * // "acceleratorConfig": {},
1726
+ * // "acceleratorType": "my_acceleratorType",
1727
+ * // "apiVersion": "my_apiVersion",
1728
+ * // "autocheckpointEnabled": false,
1729
+ * // "bootDiskConfig": {},
1730
+ * // "cidrBlock": "my_cidrBlock",
1731
+ * // "createTime": "my_createTime",
1732
+ * // "dataDisks": [],
1733
+ * // "description": "my_description",
1734
+ * // "health": "my_health",
1735
+ * // "healthDescription": "my_healthDescription",
1736
+ * // "id": "my_id",
1737
+ * // "labels": {},
1738
+ * // "metadata": {},
1739
+ * // "multisliceNode": false,
1740
+ * // "name": "my_name",
1741
+ * // "networkConfig": {},
1742
+ * // "networkConfigs": [],
1743
+ * // "networkEndpoints": [],
1744
+ * // "queuedResource": "my_queuedResource",
1745
+ * // "runtimeVersion": "my_runtimeVersion",
1746
+ * // "schedulingConfig": {},
1747
+ * // "serviceAccount": {},
1748
+ * // "shieldedInstanceConfig": {},
1749
+ * // "state": "my_state",
1750
+ * // "symptoms": [],
1751
+ * // "tags": [],
1752
+ * // "upcomingMaintenance": {}
1753
+ * // }
1754
+ * }
1755
+ *
1756
+ * main().catch(e => {
1757
+ * console.error(e);
1758
+ * throw e;
1759
+ * });
1760
+ *
1761
+ * ```
1283
1762
  *
1284
1763
  * @param params - Parameters for request
1285
1764
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1294,6 +1773,61 @@ export declare namespace tpu_v2alpha1 {
1294
1773
  get(callback: BodyResponseCallback<Schema$Node>): void;
1295
1774
  /**
1296
1775
  * Retrieves the guest attributes for the node.
1776
+ * @example
1777
+ * ```js
1778
+ * // Before running the sample:
1779
+ * // - Enable the API at:
1780
+ * // https://console.developers.google.com/apis/api/tpu.googleapis.com
1781
+ * // - Login into gcloud by running:
1782
+ * // ```sh
1783
+ * // $ gcloud auth application-default login
1784
+ * // ```
1785
+ * // - Install the npm module by running:
1786
+ * // ```sh
1787
+ * // $ npm install googleapis
1788
+ * // ```
1789
+ *
1790
+ * const {google} = require('googleapis');
1791
+ * const tpu = google.tpu('v2alpha1');
1792
+ *
1793
+ * async function main() {
1794
+ * const auth = new google.auth.GoogleAuth({
1795
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
1796
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
1797
+ * });
1798
+ *
1799
+ * // Acquire an auth client, and bind it to all future calls
1800
+ * const authClient = await auth.getClient();
1801
+ * google.options({auth: authClient});
1802
+ *
1803
+ * // Do the magic
1804
+ * const res = await tpu.projects.locations.nodes.getGuestAttributes({
1805
+ * // Required. The resource name.
1806
+ * name: 'projects/my-project/locations/my-location/nodes/my-node',
1807
+ *
1808
+ * // Request body metadata
1809
+ * requestBody: {
1810
+ * // request body parameters
1811
+ * // {
1812
+ * // "queryPath": "my_queryPath",
1813
+ * // "workerIds": []
1814
+ * // }
1815
+ * },
1816
+ * });
1817
+ * console.log(res.data);
1818
+ *
1819
+ * // Example response
1820
+ * // {
1821
+ * // "guestAttributes": []
1822
+ * // }
1823
+ * }
1824
+ *
1825
+ * main().catch(e => {
1826
+ * console.error(e);
1827
+ * throw e;
1828
+ * });
1829
+ *
1830
+ * ```
1297
1831
  *
1298
1832
  * @param params - Parameters for request
1299
1833
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1308,6 +1842,58 @@ export declare namespace tpu_v2alpha1 {
1308
1842
  getGuestAttributes(callback: BodyResponseCallback<Schema$GetGuestAttributesResponse>): void;
1309
1843
  /**
1310
1844
  * Lists nodes.
1845
+ * @example
1846
+ * ```js
1847
+ * // Before running the sample:
1848
+ * // - Enable the API at:
1849
+ * // https://console.developers.google.com/apis/api/tpu.googleapis.com
1850
+ * // - Login into gcloud by running:
1851
+ * // ```sh
1852
+ * // $ gcloud auth application-default login
1853
+ * // ```
1854
+ * // - Install the npm module by running:
1855
+ * // ```sh
1856
+ * // $ npm install googleapis
1857
+ * // ```
1858
+ *
1859
+ * const {google} = require('googleapis');
1860
+ * const tpu = google.tpu('v2alpha1');
1861
+ *
1862
+ * async function main() {
1863
+ * const auth = new google.auth.GoogleAuth({
1864
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
1865
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
1866
+ * });
1867
+ *
1868
+ * // Acquire an auth client, and bind it to all future calls
1869
+ * const authClient = await auth.getClient();
1870
+ * google.options({auth: authClient});
1871
+ *
1872
+ * // Do the magic
1873
+ * const res = await tpu.projects.locations.nodes.list({
1874
+ * // The maximum number of items to return.
1875
+ * pageSize: 'placeholder-value',
1876
+ * // The next_page_token value returned from a previous List request, if any.
1877
+ * pageToken: 'placeholder-value',
1878
+ * // Required. The parent resource name.
1879
+ * parent: 'projects/my-project/locations/my-location',
1880
+ * });
1881
+ * console.log(res.data);
1882
+ *
1883
+ * // Example response
1884
+ * // {
1885
+ * // "nextPageToken": "my_nextPageToken",
1886
+ * // "nodes": [],
1887
+ * // "unreachable": []
1888
+ * // }
1889
+ * }
1890
+ *
1891
+ * main().catch(e => {
1892
+ * console.error(e);
1893
+ * throw e;
1894
+ * });
1895
+ *
1896
+ * ```
1311
1897
  *
1312
1898
  * @param params - Parameters for request
1313
1899
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1322,6 +1908,93 @@ export declare namespace tpu_v2alpha1 {
1322
1908
  list(callback: BodyResponseCallback<Schema$ListNodesResponse>): void;
1323
1909
  /**
1324
1910
  * Updates the configurations of a node.
1911
+ * @example
1912
+ * ```js
1913
+ * // Before running the sample:
1914
+ * // - Enable the API at:
1915
+ * // https://console.developers.google.com/apis/api/tpu.googleapis.com
1916
+ * // - Login into gcloud by running:
1917
+ * // ```sh
1918
+ * // $ gcloud auth application-default login
1919
+ * // ```
1920
+ * // - Install the npm module by running:
1921
+ * // ```sh
1922
+ * // $ npm install googleapis
1923
+ * // ```
1924
+ *
1925
+ * const {google} = require('googleapis');
1926
+ * const tpu = google.tpu('v2alpha1');
1927
+ *
1928
+ * async function main() {
1929
+ * const auth = new google.auth.GoogleAuth({
1930
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
1931
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
1932
+ * });
1933
+ *
1934
+ * // Acquire an auth client, and bind it to all future calls
1935
+ * const authClient = await auth.getClient();
1936
+ * google.options({auth: authClient});
1937
+ *
1938
+ * // Do the magic
1939
+ * const res = await tpu.projects.locations.nodes.patch({
1940
+ * // Output only. Immutable. The name of the TPU.
1941
+ * name: 'projects/my-project/locations/my-location/nodes/my-node',
1942
+ * // Required. Mask of fields from Node to update. Supported fields: [description, tags, labels, metadata, network_config.enable_external_ips].
1943
+ * updateMask: 'placeholder-value',
1944
+ *
1945
+ * // Request body metadata
1946
+ * requestBody: {
1947
+ * // request body parameters
1948
+ * // {
1949
+ * // "acceleratorConfig": {},
1950
+ * // "acceleratorType": "my_acceleratorType",
1951
+ * // "apiVersion": "my_apiVersion",
1952
+ * // "autocheckpointEnabled": false,
1953
+ * // "bootDiskConfig": {},
1954
+ * // "cidrBlock": "my_cidrBlock",
1955
+ * // "createTime": "my_createTime",
1956
+ * // "dataDisks": [],
1957
+ * // "description": "my_description",
1958
+ * // "health": "my_health",
1959
+ * // "healthDescription": "my_healthDescription",
1960
+ * // "id": "my_id",
1961
+ * // "labels": {},
1962
+ * // "metadata": {},
1963
+ * // "multisliceNode": false,
1964
+ * // "name": "my_name",
1965
+ * // "networkConfig": {},
1966
+ * // "networkConfigs": [],
1967
+ * // "networkEndpoints": [],
1968
+ * // "queuedResource": "my_queuedResource",
1969
+ * // "runtimeVersion": "my_runtimeVersion",
1970
+ * // "schedulingConfig": {},
1971
+ * // "serviceAccount": {},
1972
+ * // "shieldedInstanceConfig": {},
1973
+ * // "state": "my_state",
1974
+ * // "symptoms": [],
1975
+ * // "tags": [],
1976
+ * // "upcomingMaintenance": {}
1977
+ * // }
1978
+ * },
1979
+ * });
1980
+ * console.log(res.data);
1981
+ *
1982
+ * // Example response
1983
+ * // {
1984
+ * // "done": false,
1985
+ * // "error": {},
1986
+ * // "metadata": {},
1987
+ * // "name": "my_name",
1988
+ * // "response": {}
1989
+ * // }
1990
+ * }
1991
+ *
1992
+ * main().catch(e => {
1993
+ * console.error(e);
1994
+ * throw e;
1995
+ * });
1996
+ *
1997
+ * ```
1325
1998
  *
1326
1999
  * @param params - Parameters for request
1327
2000
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1336,6 +2009,62 @@ export declare namespace tpu_v2alpha1 {
1336
2009
  patch(callback: BodyResponseCallback<Schema$Operation>): void;
1337
2010
  /**
1338
2011
  * Perform manual maintenance on a node.
2012
+ * @example
2013
+ * ```js
2014
+ * // Before running the sample:
2015
+ * // - Enable the API at:
2016
+ * // https://console.developers.google.com/apis/api/tpu.googleapis.com
2017
+ * // - Login into gcloud by running:
2018
+ * // ```sh
2019
+ * // $ gcloud auth application-default login
2020
+ * // ```
2021
+ * // - Install the npm module by running:
2022
+ * // ```sh
2023
+ * // $ npm install googleapis
2024
+ * // ```
2025
+ *
2026
+ * const {google} = require('googleapis');
2027
+ * const tpu = google.tpu('v2alpha1');
2028
+ *
2029
+ * async function main() {
2030
+ * const auth = new google.auth.GoogleAuth({
2031
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2032
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
2033
+ * });
2034
+ *
2035
+ * // Acquire an auth client, and bind it to all future calls
2036
+ * const authClient = await auth.getClient();
2037
+ * google.options({auth: authClient});
2038
+ *
2039
+ * // Do the magic
2040
+ * const res = await tpu.projects.locations.nodes.performMaintenance({
2041
+ * // Required. The resource name.
2042
+ * name: 'projects/my-project/locations/my-location/nodes/my-node',
2043
+ *
2044
+ * // Request body metadata
2045
+ * requestBody: {
2046
+ * // request body parameters
2047
+ * // {}
2048
+ * },
2049
+ * });
2050
+ * console.log(res.data);
2051
+ *
2052
+ * // Example response
2053
+ * // {
2054
+ * // "done": false,
2055
+ * // "error": {},
2056
+ * // "metadata": {},
2057
+ * // "name": "my_name",
2058
+ * // "response": {}
2059
+ * // }
2060
+ * }
2061
+ *
2062
+ * main().catch(e => {
2063
+ * console.error(e);
2064
+ * throw e;
2065
+ * });
2066
+ *
2067
+ * ```
1339
2068
  *
1340
2069
  * @param params - Parameters for request
1341
2070
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1350,6 +2079,64 @@ export declare namespace tpu_v2alpha1 {
1350
2079
  performMaintenance(callback: BodyResponseCallback<Schema$Operation>): void;
1351
2080
  /**
1352
2081
  * Simulates a maintenance event.
2082
+ * @example
2083
+ * ```js
2084
+ * // Before running the sample:
2085
+ * // - Enable the API at:
2086
+ * // https://console.developers.google.com/apis/api/tpu.googleapis.com
2087
+ * // - Login into gcloud by running:
2088
+ * // ```sh
2089
+ * // $ gcloud auth application-default login
2090
+ * // ```
2091
+ * // - Install the npm module by running:
2092
+ * // ```sh
2093
+ * // $ npm install googleapis
2094
+ * // ```
2095
+ *
2096
+ * const {google} = require('googleapis');
2097
+ * const tpu = google.tpu('v2alpha1');
2098
+ *
2099
+ * async function main() {
2100
+ * const auth = new google.auth.GoogleAuth({
2101
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2102
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
2103
+ * });
2104
+ *
2105
+ * // Acquire an auth client, and bind it to all future calls
2106
+ * const authClient = await auth.getClient();
2107
+ * google.options({auth: authClient});
2108
+ *
2109
+ * // Do the magic
2110
+ * const res = await tpu.projects.locations.nodes.simulateMaintenanceEvent({
2111
+ * // Required. The resource name.
2112
+ * name: 'projects/my-project/locations/my-location/nodes/my-node',
2113
+ *
2114
+ * // Request body metadata
2115
+ * requestBody: {
2116
+ * // request body parameters
2117
+ * // {
2118
+ * // "workerIds": []
2119
+ * // }
2120
+ * },
2121
+ * });
2122
+ * console.log(res.data);
2123
+ *
2124
+ * // Example response
2125
+ * // {
2126
+ * // "done": false,
2127
+ * // "error": {},
2128
+ * // "metadata": {},
2129
+ * // "name": "my_name",
2130
+ * // "response": {}
2131
+ * // }
2132
+ * }
2133
+ *
2134
+ * main().catch(e => {
2135
+ * console.error(e);
2136
+ * throw e;
2137
+ * });
2138
+ *
2139
+ * ```
1353
2140
  *
1354
2141
  * @param params - Parameters for request
1355
2142
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1364,6 +2151,62 @@ export declare namespace tpu_v2alpha1 {
1364
2151
  simulateMaintenanceEvent(callback: BodyResponseCallback<Schema$Operation>): void;
1365
2152
  /**
1366
2153
  * Starts a node.
2154
+ * @example
2155
+ * ```js
2156
+ * // Before running the sample:
2157
+ * // - Enable the API at:
2158
+ * // https://console.developers.google.com/apis/api/tpu.googleapis.com
2159
+ * // - Login into gcloud by running:
2160
+ * // ```sh
2161
+ * // $ gcloud auth application-default login
2162
+ * // ```
2163
+ * // - Install the npm module by running:
2164
+ * // ```sh
2165
+ * // $ npm install googleapis
2166
+ * // ```
2167
+ *
2168
+ * const {google} = require('googleapis');
2169
+ * const tpu = google.tpu('v2alpha1');
2170
+ *
2171
+ * async function main() {
2172
+ * const auth = new google.auth.GoogleAuth({
2173
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2174
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
2175
+ * });
2176
+ *
2177
+ * // Acquire an auth client, and bind it to all future calls
2178
+ * const authClient = await auth.getClient();
2179
+ * google.options({auth: authClient});
2180
+ *
2181
+ * // Do the magic
2182
+ * const res = await tpu.projects.locations.nodes.start({
2183
+ * // Required. The resource name.
2184
+ * name: 'projects/my-project/locations/my-location/nodes/my-node',
2185
+ *
2186
+ * // Request body metadata
2187
+ * requestBody: {
2188
+ * // request body parameters
2189
+ * // {}
2190
+ * },
2191
+ * });
2192
+ * console.log(res.data);
2193
+ *
2194
+ * // Example response
2195
+ * // {
2196
+ * // "done": false,
2197
+ * // "error": {},
2198
+ * // "metadata": {},
2199
+ * // "name": "my_name",
2200
+ * // "response": {}
2201
+ * // }
2202
+ * }
2203
+ *
2204
+ * main().catch(e => {
2205
+ * console.error(e);
2206
+ * throw e;
2207
+ * });
2208
+ *
2209
+ * ```
1367
2210
  *
1368
2211
  * @param params - Parameters for request
1369
2212
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1378,6 +2221,62 @@ export declare namespace tpu_v2alpha1 {
1378
2221
  start(callback: BodyResponseCallback<Schema$Operation>): void;
1379
2222
  /**
1380
2223
  * Stops a node. This operation is only available with single TPU nodes.
2224
+ * @example
2225
+ * ```js
2226
+ * // Before running the sample:
2227
+ * // - Enable the API at:
2228
+ * // https://console.developers.google.com/apis/api/tpu.googleapis.com
2229
+ * // - Login into gcloud by running:
2230
+ * // ```sh
2231
+ * // $ gcloud auth application-default login
2232
+ * // ```
2233
+ * // - Install the npm module by running:
2234
+ * // ```sh
2235
+ * // $ npm install googleapis
2236
+ * // ```
2237
+ *
2238
+ * const {google} = require('googleapis');
2239
+ * const tpu = google.tpu('v2alpha1');
2240
+ *
2241
+ * async function main() {
2242
+ * const auth = new google.auth.GoogleAuth({
2243
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2244
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
2245
+ * });
2246
+ *
2247
+ * // Acquire an auth client, and bind it to all future calls
2248
+ * const authClient = await auth.getClient();
2249
+ * google.options({auth: authClient});
2250
+ *
2251
+ * // Do the magic
2252
+ * const res = await tpu.projects.locations.nodes.stop({
2253
+ * // Required. The resource name.
2254
+ * name: 'projects/my-project/locations/my-location/nodes/my-node',
2255
+ *
2256
+ * // Request body metadata
2257
+ * requestBody: {
2258
+ * // request body parameters
2259
+ * // {}
2260
+ * },
2261
+ * });
2262
+ * console.log(res.data);
2263
+ *
2264
+ * // Example response
2265
+ * // {
2266
+ * // "done": false,
2267
+ * // "error": {},
2268
+ * // "metadata": {},
2269
+ * // "name": "my_name",
2270
+ * // "response": {}
2271
+ * // }
2272
+ * }
2273
+ *
2274
+ * main().catch(e => {
2275
+ * console.error(e);
2276
+ * throw e;
2277
+ * });
2278
+ *
2279
+ * ```
1381
2280
  *
1382
2281
  * @param params - Parameters for request
1383
2282
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1508,6 +2407,50 @@ export declare namespace tpu_v2alpha1 {
1508
2407
  constructor(context: APIRequestContext);
1509
2408
  /**
1510
2409
  * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
2410
+ * @example
2411
+ * ```js
2412
+ * // Before running the sample:
2413
+ * // - Enable the API at:
2414
+ * // https://console.developers.google.com/apis/api/tpu.googleapis.com
2415
+ * // - Login into gcloud by running:
2416
+ * // ```sh
2417
+ * // $ gcloud auth application-default login
2418
+ * // ```
2419
+ * // - Install the npm module by running:
2420
+ * // ```sh
2421
+ * // $ npm install googleapis
2422
+ * // ```
2423
+ *
2424
+ * const {google} = require('googleapis');
2425
+ * const tpu = google.tpu('v2alpha1');
2426
+ *
2427
+ * async function main() {
2428
+ * const auth = new google.auth.GoogleAuth({
2429
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2430
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
2431
+ * });
2432
+ *
2433
+ * // Acquire an auth client, and bind it to all future calls
2434
+ * const authClient = await auth.getClient();
2435
+ * google.options({auth: authClient});
2436
+ *
2437
+ * // Do the magic
2438
+ * const res = await tpu.projects.locations.operations.cancel({
2439
+ * // The name of the operation resource to be cancelled.
2440
+ * name: 'projects/my-project/locations/my-location/operations/my-operation',
2441
+ * });
2442
+ * console.log(res.data);
2443
+ *
2444
+ * // Example response
2445
+ * // {}
2446
+ * }
2447
+ *
2448
+ * main().catch(e => {
2449
+ * console.error(e);
2450
+ * throw e;
2451
+ * });
2452
+ *
2453
+ * ```
1511
2454
  *
1512
2455
  * @param params - Parameters for request
1513
2456
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1522,6 +2465,50 @@ export declare namespace tpu_v2alpha1 {
1522
2465
  cancel(callback: BodyResponseCallback<Schema$Empty>): void;
1523
2466
  /**
1524
2467
  * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
2468
+ * @example
2469
+ * ```js
2470
+ * // Before running the sample:
2471
+ * // - Enable the API at:
2472
+ * // https://console.developers.google.com/apis/api/tpu.googleapis.com
2473
+ * // - Login into gcloud by running:
2474
+ * // ```sh
2475
+ * // $ gcloud auth application-default login
2476
+ * // ```
2477
+ * // - Install the npm module by running:
2478
+ * // ```sh
2479
+ * // $ npm install googleapis
2480
+ * // ```
2481
+ *
2482
+ * const {google} = require('googleapis');
2483
+ * const tpu = google.tpu('v2alpha1');
2484
+ *
2485
+ * async function main() {
2486
+ * const auth = new google.auth.GoogleAuth({
2487
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2488
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
2489
+ * });
2490
+ *
2491
+ * // Acquire an auth client, and bind it to all future calls
2492
+ * const authClient = await auth.getClient();
2493
+ * google.options({auth: authClient});
2494
+ *
2495
+ * // Do the magic
2496
+ * const res = await tpu.projects.locations.operations.delete({
2497
+ * // The name of the operation resource to be deleted.
2498
+ * name: 'projects/my-project/locations/my-location/operations/my-operation',
2499
+ * });
2500
+ * console.log(res.data);
2501
+ *
2502
+ * // Example response
2503
+ * // {}
2504
+ * }
2505
+ *
2506
+ * main().catch(e => {
2507
+ * console.error(e);
2508
+ * throw e;
2509
+ * });
2510
+ *
2511
+ * ```
1525
2512
  *
1526
2513
  * @param params - Parameters for request
1527
2514
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1536,6 +2523,56 @@ export declare namespace tpu_v2alpha1 {
1536
2523
  delete(callback: BodyResponseCallback<Schema$Empty>): void;
1537
2524
  /**
1538
2525
  * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
2526
+ * @example
2527
+ * ```js
2528
+ * // Before running the sample:
2529
+ * // - Enable the API at:
2530
+ * // https://console.developers.google.com/apis/api/tpu.googleapis.com
2531
+ * // - Login into gcloud by running:
2532
+ * // ```sh
2533
+ * // $ gcloud auth application-default login
2534
+ * // ```
2535
+ * // - Install the npm module by running:
2536
+ * // ```sh
2537
+ * // $ npm install googleapis
2538
+ * // ```
2539
+ *
2540
+ * const {google} = require('googleapis');
2541
+ * const tpu = google.tpu('v2alpha1');
2542
+ *
2543
+ * async function main() {
2544
+ * const auth = new google.auth.GoogleAuth({
2545
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2546
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
2547
+ * });
2548
+ *
2549
+ * // Acquire an auth client, and bind it to all future calls
2550
+ * const authClient = await auth.getClient();
2551
+ * google.options({auth: authClient});
2552
+ *
2553
+ * // Do the magic
2554
+ * const res = await tpu.projects.locations.operations.get({
2555
+ * // The name of the operation resource.
2556
+ * name: 'projects/my-project/locations/my-location/operations/my-operation',
2557
+ * });
2558
+ * console.log(res.data);
2559
+ *
2560
+ * // Example response
2561
+ * // {
2562
+ * // "done": false,
2563
+ * // "error": {},
2564
+ * // "metadata": {},
2565
+ * // "name": "my_name",
2566
+ * // "response": {}
2567
+ * // }
2568
+ * }
2569
+ *
2570
+ * main().catch(e => {
2571
+ * console.error(e);
2572
+ * throw e;
2573
+ * });
2574
+ *
2575
+ * ```
1539
2576
  *
1540
2577
  * @param params - Parameters for request
1541
2578
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1550,6 +2587,59 @@ export declare namespace tpu_v2alpha1 {
1550
2587
  get(callback: BodyResponseCallback<Schema$Operation>): void;
1551
2588
  /**
1552
2589
  * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
2590
+ * @example
2591
+ * ```js
2592
+ * // Before running the sample:
2593
+ * // - Enable the API at:
2594
+ * // https://console.developers.google.com/apis/api/tpu.googleapis.com
2595
+ * // - Login into gcloud by running:
2596
+ * // ```sh
2597
+ * // $ gcloud auth application-default login
2598
+ * // ```
2599
+ * // - Install the npm module by running:
2600
+ * // ```sh
2601
+ * // $ npm install googleapis
2602
+ * // ```
2603
+ *
2604
+ * const {google} = require('googleapis');
2605
+ * const tpu = google.tpu('v2alpha1');
2606
+ *
2607
+ * async function main() {
2608
+ * const auth = new google.auth.GoogleAuth({
2609
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2610
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
2611
+ * });
2612
+ *
2613
+ * // Acquire an auth client, and bind it to all future calls
2614
+ * const authClient = await auth.getClient();
2615
+ * google.options({auth: authClient});
2616
+ *
2617
+ * // Do the magic
2618
+ * const res = await tpu.projects.locations.operations.list({
2619
+ * // The standard list filter.
2620
+ * filter: 'placeholder-value',
2621
+ * // The name of the operation's parent resource.
2622
+ * name: 'projects/my-project/locations/my-location',
2623
+ * // The standard list page size.
2624
+ * pageSize: 'placeholder-value',
2625
+ * // The standard list page token.
2626
+ * pageToken: 'placeholder-value',
2627
+ * });
2628
+ * console.log(res.data);
2629
+ *
2630
+ * // Example response
2631
+ * // {
2632
+ * // "nextPageToken": "my_nextPageToken",
2633
+ * // "operations": []
2634
+ * // }
2635
+ * }
2636
+ *
2637
+ * main().catch(e => {
2638
+ * console.error(e);
2639
+ * throw e;
2640
+ * });
2641
+ *
2642
+ * ```
1553
2643
  *
1554
2644
  * @param params - Parameters for request
1555
2645
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1604,6 +2694,78 @@ export declare namespace tpu_v2alpha1 {
1604
2694
  constructor(context: APIRequestContext);
1605
2695
  /**
1606
2696
  * Creates a QueuedResource TPU instance.
2697
+ * @example
2698
+ * ```js
2699
+ * // Before running the sample:
2700
+ * // - Enable the API at:
2701
+ * // https://console.developers.google.com/apis/api/tpu.googleapis.com
2702
+ * // - Login into gcloud by running:
2703
+ * // ```sh
2704
+ * // $ gcloud auth application-default login
2705
+ * // ```
2706
+ * // - Install the npm module by running:
2707
+ * // ```sh
2708
+ * // $ npm install googleapis
2709
+ * // ```
2710
+ *
2711
+ * const {google} = require('googleapis');
2712
+ * const tpu = google.tpu('v2alpha1');
2713
+ *
2714
+ * async function main() {
2715
+ * const auth = new google.auth.GoogleAuth({
2716
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2717
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
2718
+ * });
2719
+ *
2720
+ * // Acquire an auth client, and bind it to all future calls
2721
+ * const authClient = await auth.getClient();
2722
+ * google.options({auth: authClient});
2723
+ *
2724
+ * // Do the magic
2725
+ * const res = await tpu.projects.locations.queuedResources.create({
2726
+ * // Required. The parent resource name.
2727
+ * parent: 'projects/my-project/locations/my-location',
2728
+ * // The unqualified resource name. Should follow the `^[A-Za-z0-9_.~+%-]+$` regex format.
2729
+ * queuedResourceId: 'placeholder-value',
2730
+ * // Idempotent request UUID.
2731
+ * requestId: 'placeholder-value',
2732
+ *
2733
+ * // Request body metadata
2734
+ * requestBody: {
2735
+ * // request body parameters
2736
+ * // {
2737
+ * // "bestEffort": {},
2738
+ * // "createTime": "my_createTime",
2739
+ * // "guaranteed": {},
2740
+ * // "name": "my_name",
2741
+ * // "provisioningModel": "my_provisioningModel",
2742
+ * // "queueingPolicy": {},
2743
+ * // "reservationName": "my_reservationName",
2744
+ * // "runDuration": {},
2745
+ * // "spot": {},
2746
+ * // "state": {},
2747
+ * // "tpu": {}
2748
+ * // }
2749
+ * },
2750
+ * });
2751
+ * console.log(res.data);
2752
+ *
2753
+ * // Example response
2754
+ * // {
2755
+ * // "done": false,
2756
+ * // "error": {},
2757
+ * // "metadata": {},
2758
+ * // "name": "my_name",
2759
+ * // "response": {}
2760
+ * // }
2761
+ * }
2762
+ *
2763
+ * main().catch(e => {
2764
+ * console.error(e);
2765
+ * throw e;
2766
+ * });
2767
+ *
2768
+ * ```
1607
2769
  *
1608
2770
  * @param params - Parameters for request
1609
2771
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1618,6 +2780,60 @@ export declare namespace tpu_v2alpha1 {
1618
2780
  create(callback: BodyResponseCallback<Schema$Operation>): void;
1619
2781
  /**
1620
2782
  * Deletes a QueuedResource TPU instance.
2783
+ * @example
2784
+ * ```js
2785
+ * // Before running the sample:
2786
+ * // - Enable the API at:
2787
+ * // https://console.developers.google.com/apis/api/tpu.googleapis.com
2788
+ * // - Login into gcloud by running:
2789
+ * // ```sh
2790
+ * // $ gcloud auth application-default login
2791
+ * // ```
2792
+ * // - Install the npm module by running:
2793
+ * // ```sh
2794
+ * // $ npm install googleapis
2795
+ * // ```
2796
+ *
2797
+ * const {google} = require('googleapis');
2798
+ * const tpu = google.tpu('v2alpha1');
2799
+ *
2800
+ * async function main() {
2801
+ * const auth = new google.auth.GoogleAuth({
2802
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2803
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
2804
+ * });
2805
+ *
2806
+ * // Acquire an auth client, and bind it to all future calls
2807
+ * const authClient = await auth.getClient();
2808
+ * google.options({auth: authClient});
2809
+ *
2810
+ * // Do the magic
2811
+ * const res = await tpu.projects.locations.queuedResources.delete({
2812
+ * // If set to true, all running nodes belonging to this queued resource will be deleted first and then the queued resource will be deleted. Otherwise (i.e. force=false), the queued resource will only be deleted if its nodes have already been deleted or the queued resource is in the ACCEPTED, FAILED, or SUSPENDED state.
2813
+ * force: 'placeholder-value',
2814
+ * // Required. The resource name.
2815
+ * name: 'projects/my-project/locations/my-location/queuedResources/my-queuedResource',
2816
+ * // Idempotent request UUID.
2817
+ * requestId: 'placeholder-value',
2818
+ * });
2819
+ * console.log(res.data);
2820
+ *
2821
+ * // Example response
2822
+ * // {
2823
+ * // "done": false,
2824
+ * // "error": {},
2825
+ * // "metadata": {},
2826
+ * // "name": "my_name",
2827
+ * // "response": {}
2828
+ * // }
2829
+ * }
2830
+ *
2831
+ * main().catch(e => {
2832
+ * console.error(e);
2833
+ * throw e;
2834
+ * });
2835
+ *
2836
+ * ```
1621
2837
  *
1622
2838
  * @param params - Parameters for request
1623
2839
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1632,6 +2848,62 @@ export declare namespace tpu_v2alpha1 {
1632
2848
  delete(callback: BodyResponseCallback<Schema$Operation>): void;
1633
2849
  /**
1634
2850
  * Gets details of a queued resource.
2851
+ * @example
2852
+ * ```js
2853
+ * // Before running the sample:
2854
+ * // - Enable the API at:
2855
+ * // https://console.developers.google.com/apis/api/tpu.googleapis.com
2856
+ * // - Login into gcloud by running:
2857
+ * // ```sh
2858
+ * // $ gcloud auth application-default login
2859
+ * // ```
2860
+ * // - Install the npm module by running:
2861
+ * // ```sh
2862
+ * // $ npm install googleapis
2863
+ * // ```
2864
+ *
2865
+ * const {google} = require('googleapis');
2866
+ * const tpu = google.tpu('v2alpha1');
2867
+ *
2868
+ * async function main() {
2869
+ * const auth = new google.auth.GoogleAuth({
2870
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2871
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
2872
+ * });
2873
+ *
2874
+ * // Acquire an auth client, and bind it to all future calls
2875
+ * const authClient = await auth.getClient();
2876
+ * google.options({auth: authClient});
2877
+ *
2878
+ * // Do the magic
2879
+ * const res = await tpu.projects.locations.queuedResources.get({
2880
+ * // Required. The resource name.
2881
+ * name: 'projects/my-project/locations/my-location/queuedResources/my-queuedResource',
2882
+ * });
2883
+ * console.log(res.data);
2884
+ *
2885
+ * // Example response
2886
+ * // {
2887
+ * // "bestEffort": {},
2888
+ * // "createTime": "my_createTime",
2889
+ * // "guaranteed": {},
2890
+ * // "name": "my_name",
2891
+ * // "provisioningModel": "my_provisioningModel",
2892
+ * // "queueingPolicy": {},
2893
+ * // "reservationName": "my_reservationName",
2894
+ * // "runDuration": {},
2895
+ * // "spot": {},
2896
+ * // "state": {},
2897
+ * // "tpu": {}
2898
+ * // }
2899
+ * }
2900
+ *
2901
+ * main().catch(e => {
2902
+ * console.error(e);
2903
+ * throw e;
2904
+ * });
2905
+ *
2906
+ * ```
1635
2907
  *
1636
2908
  * @param params - Parameters for request
1637
2909
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1646,6 +2918,58 @@ export declare namespace tpu_v2alpha1 {
1646
2918
  get(callback: BodyResponseCallback<Schema$QueuedResource>): void;
1647
2919
  /**
1648
2920
  * Lists queued resources.
2921
+ * @example
2922
+ * ```js
2923
+ * // Before running the sample:
2924
+ * // - Enable the API at:
2925
+ * // https://console.developers.google.com/apis/api/tpu.googleapis.com
2926
+ * // - Login into gcloud by running:
2927
+ * // ```sh
2928
+ * // $ gcloud auth application-default login
2929
+ * // ```
2930
+ * // - Install the npm module by running:
2931
+ * // ```sh
2932
+ * // $ npm install googleapis
2933
+ * // ```
2934
+ *
2935
+ * const {google} = require('googleapis');
2936
+ * const tpu = google.tpu('v2alpha1');
2937
+ *
2938
+ * async function main() {
2939
+ * const auth = new google.auth.GoogleAuth({
2940
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2941
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
2942
+ * });
2943
+ *
2944
+ * // Acquire an auth client, and bind it to all future calls
2945
+ * const authClient = await auth.getClient();
2946
+ * google.options({auth: authClient});
2947
+ *
2948
+ * // Do the magic
2949
+ * const res = await tpu.projects.locations.queuedResources.list({
2950
+ * // The maximum number of items to return.
2951
+ * pageSize: 'placeholder-value',
2952
+ * // The next_page_token value returned from a previous List request, if any.
2953
+ * pageToken: 'placeholder-value',
2954
+ * // Required. The parent resource name.
2955
+ * parent: 'projects/my-project/locations/my-location',
2956
+ * });
2957
+ * console.log(res.data);
2958
+ *
2959
+ * // Example response
2960
+ * // {
2961
+ * // "nextPageToken": "my_nextPageToken",
2962
+ * // "queuedResources": [],
2963
+ * // "unreachable": []
2964
+ * // }
2965
+ * }
2966
+ *
2967
+ * main().catch(e => {
2968
+ * console.error(e);
2969
+ * throw e;
2970
+ * });
2971
+ *
2972
+ * ```
1649
2973
  *
1650
2974
  * @param params - Parameters for request
1651
2975
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1660,6 +2984,67 @@ export declare namespace tpu_v2alpha1 {
1660
2984
  list(callback: BodyResponseCallback<Schema$ListQueuedResourcesResponse>): void;
1661
2985
  /**
1662
2986
  * Perform manual maintenance on specific nodes of a QueuedResource.
2987
+ * @example
2988
+ * ```js
2989
+ * // Before running the sample:
2990
+ * // - Enable the API at:
2991
+ * // https://console.developers.google.com/apis/api/tpu.googleapis.com
2992
+ * // - Login into gcloud by running:
2993
+ * // ```sh
2994
+ * // $ gcloud auth application-default login
2995
+ * // ```
2996
+ * // - Install the npm module by running:
2997
+ * // ```sh
2998
+ * // $ npm install googleapis
2999
+ * // ```
3000
+ *
3001
+ * const {google} = require('googleapis');
3002
+ * const tpu = google.tpu('v2alpha1');
3003
+ *
3004
+ * async function main() {
3005
+ * const auth = new google.auth.GoogleAuth({
3006
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3007
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
3008
+ * });
3009
+ *
3010
+ * // Acquire an auth client, and bind it to all future calls
3011
+ * const authClient = await auth.getClient();
3012
+ * google.options({auth: authClient});
3013
+ *
3014
+ * // Do the magic
3015
+ * const res =
3016
+ * await tpu.projects.locations.queuedResources.performMaintenanceQueuedResource(
3017
+ * {
3018
+ * // Required. The name of the QueuedResource which holds the nodes to perform maintenance on.
3019
+ * name: 'projects/my-project/locations/my-location/queuedResources/my-queuedResource',
3020
+ *
3021
+ * // Request body metadata
3022
+ * requestBody: {
3023
+ * // request body parameters
3024
+ * // {
3025
+ * // "nodeNames": []
3026
+ * // }
3027
+ * },
3028
+ * },
3029
+ * );
3030
+ * console.log(res.data);
3031
+ *
3032
+ * // Example response
3033
+ * // {
3034
+ * // "done": false,
3035
+ * // "error": {},
3036
+ * // "metadata": {},
3037
+ * // "name": "my_name",
3038
+ * // "response": {}
3039
+ * // }
3040
+ * }
3041
+ *
3042
+ * main().catch(e => {
3043
+ * console.error(e);
3044
+ * throw e;
3045
+ * });
3046
+ *
3047
+ * ```
1663
3048
  *
1664
3049
  * @param params - Parameters for request
1665
3050
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1674,6 +3059,62 @@ export declare namespace tpu_v2alpha1 {
1674
3059
  performMaintenanceQueuedResource(callback: BodyResponseCallback<Schema$Operation>): void;
1675
3060
  /**
1676
3061
  * Resets a QueuedResource TPU instance
3062
+ * @example
3063
+ * ```js
3064
+ * // Before running the sample:
3065
+ * // - Enable the API at:
3066
+ * // https://console.developers.google.com/apis/api/tpu.googleapis.com
3067
+ * // - Login into gcloud by running:
3068
+ * // ```sh
3069
+ * // $ gcloud auth application-default login
3070
+ * // ```
3071
+ * // - Install the npm module by running:
3072
+ * // ```sh
3073
+ * // $ npm install googleapis
3074
+ * // ```
3075
+ *
3076
+ * const {google} = require('googleapis');
3077
+ * const tpu = google.tpu('v2alpha1');
3078
+ *
3079
+ * async function main() {
3080
+ * const auth = new google.auth.GoogleAuth({
3081
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3082
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
3083
+ * });
3084
+ *
3085
+ * // Acquire an auth client, and bind it to all future calls
3086
+ * const authClient = await auth.getClient();
3087
+ * google.options({auth: authClient});
3088
+ *
3089
+ * // Do the magic
3090
+ * const res = await tpu.projects.locations.queuedResources.reset({
3091
+ * // Required. The name of the queued resource.
3092
+ * name: 'projects/my-project/locations/my-location/queuedResources/my-queuedResource',
3093
+ *
3094
+ * // Request body metadata
3095
+ * requestBody: {
3096
+ * // request body parameters
3097
+ * // {}
3098
+ * },
3099
+ * });
3100
+ * console.log(res.data);
3101
+ *
3102
+ * // Example response
3103
+ * // {
3104
+ * // "done": false,
3105
+ * // "error": {},
3106
+ * // "metadata": {},
3107
+ * // "name": "my_name",
3108
+ * // "response": {}
3109
+ * // }
3110
+ * }
3111
+ *
3112
+ * main().catch(e => {
3113
+ * console.error(e);
3114
+ * throw e;
3115
+ * });
3116
+ *
3117
+ * ```
1677
3118
  *
1678
3119
  * @param params - Parameters for request
1679
3120
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1764,6 +3205,57 @@ export declare namespace tpu_v2alpha1 {
1764
3205
  constructor(context: APIRequestContext);
1765
3206
  /**
1766
3207
  * Retrieves the reservations for the given project in the given location.
3208
+ * @example
3209
+ * ```js
3210
+ * // Before running the sample:
3211
+ * // - Enable the API at:
3212
+ * // https://console.developers.google.com/apis/api/tpu.googleapis.com
3213
+ * // - Login into gcloud by running:
3214
+ * // ```sh
3215
+ * // $ gcloud auth application-default login
3216
+ * // ```
3217
+ * // - Install the npm module by running:
3218
+ * // ```sh
3219
+ * // $ npm install googleapis
3220
+ * // ```
3221
+ *
3222
+ * const {google} = require('googleapis');
3223
+ * const tpu = google.tpu('v2alpha1');
3224
+ *
3225
+ * async function main() {
3226
+ * const auth = new google.auth.GoogleAuth({
3227
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3228
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
3229
+ * });
3230
+ *
3231
+ * // Acquire an auth client, and bind it to all future calls
3232
+ * const authClient = await auth.getClient();
3233
+ * google.options({auth: authClient});
3234
+ *
3235
+ * // Do the magic
3236
+ * const res = await tpu.projects.locations.reservations.list({
3237
+ * // The maximum number of items to return. Defaults to 0 if not specified, which means no limit.
3238
+ * pageSize: 'placeholder-value',
3239
+ * // The next_page_token value returned from a previous List request, if any.
3240
+ * pageToken: 'placeholder-value',
3241
+ * // Required. The parent for reservations.
3242
+ * parent: 'projects/my-project/locations/my-location',
3243
+ * });
3244
+ * console.log(res.data);
3245
+ *
3246
+ * // Example response
3247
+ * // {
3248
+ * // "nextPageToken": "my_nextPageToken",
3249
+ * // "reservations": []
3250
+ * // }
3251
+ * }
3252
+ *
3253
+ * main().catch(e => {
3254
+ * console.error(e);
3255
+ * throw e;
3256
+ * });
3257
+ *
3258
+ * ```
1767
3259
  *
1768
3260
  * @param params - Parameters for request
1769
3261
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1796,6 +3288,53 @@ export declare namespace tpu_v2alpha1 {
1796
3288
  constructor(context: APIRequestContext);
1797
3289
  /**
1798
3290
  * Gets a runtime version.
3291
+ * @example
3292
+ * ```js
3293
+ * // Before running the sample:
3294
+ * // - Enable the API at:
3295
+ * // https://console.developers.google.com/apis/api/tpu.googleapis.com
3296
+ * // - Login into gcloud by running:
3297
+ * // ```sh
3298
+ * // $ gcloud auth application-default login
3299
+ * // ```
3300
+ * // - Install the npm module by running:
3301
+ * // ```sh
3302
+ * // $ npm install googleapis
3303
+ * // ```
3304
+ *
3305
+ * const {google} = require('googleapis');
3306
+ * const tpu = google.tpu('v2alpha1');
3307
+ *
3308
+ * async function main() {
3309
+ * const auth = new google.auth.GoogleAuth({
3310
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3311
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
3312
+ * });
3313
+ *
3314
+ * // Acquire an auth client, and bind it to all future calls
3315
+ * const authClient = await auth.getClient();
3316
+ * google.options({auth: authClient});
3317
+ *
3318
+ * // Do the magic
3319
+ * const res = await tpu.projects.locations.runtimeVersions.get({
3320
+ * // Required. The resource name.
3321
+ * name: 'projects/my-project/locations/my-location/runtimeVersions/my-runtimeVersion',
3322
+ * });
3323
+ * console.log(res.data);
3324
+ *
3325
+ * // Example response
3326
+ * // {
3327
+ * // "name": "my_name",
3328
+ * // "version": "my_version"
3329
+ * // }
3330
+ * }
3331
+ *
3332
+ * main().catch(e => {
3333
+ * console.error(e);
3334
+ * throw e;
3335
+ * });
3336
+ *
3337
+ * ```
1799
3338
  *
1800
3339
  * @param params - Parameters for request
1801
3340
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1810,6 +3349,62 @@ export declare namespace tpu_v2alpha1 {
1810
3349
  get(callback: BodyResponseCallback<Schema$RuntimeVersion>): void;
1811
3350
  /**
1812
3351
  * Lists runtime versions supported by this API.
3352
+ * @example
3353
+ * ```js
3354
+ * // Before running the sample:
3355
+ * // - Enable the API at:
3356
+ * // https://console.developers.google.com/apis/api/tpu.googleapis.com
3357
+ * // - Login into gcloud by running:
3358
+ * // ```sh
3359
+ * // $ gcloud auth application-default login
3360
+ * // ```
3361
+ * // - Install the npm module by running:
3362
+ * // ```sh
3363
+ * // $ npm install googleapis
3364
+ * // ```
3365
+ *
3366
+ * const {google} = require('googleapis');
3367
+ * const tpu = google.tpu('v2alpha1');
3368
+ *
3369
+ * async function main() {
3370
+ * const auth = new google.auth.GoogleAuth({
3371
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3372
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
3373
+ * });
3374
+ *
3375
+ * // Acquire an auth client, and bind it to all future calls
3376
+ * const authClient = await auth.getClient();
3377
+ * google.options({auth: authClient});
3378
+ *
3379
+ * // Do the magic
3380
+ * const res = await tpu.projects.locations.runtimeVersions.list({
3381
+ * // List filter.
3382
+ * filter: 'placeholder-value',
3383
+ * // Sort results.
3384
+ * orderBy: 'placeholder-value',
3385
+ * // The maximum number of items to return.
3386
+ * pageSize: 'placeholder-value',
3387
+ * // The next_page_token value returned from a previous List request, if any.
3388
+ * pageToken: 'placeholder-value',
3389
+ * // Required. The parent resource name.
3390
+ * parent: 'projects/my-project/locations/my-location',
3391
+ * });
3392
+ * console.log(res.data);
3393
+ *
3394
+ * // Example response
3395
+ * // {
3396
+ * // "nextPageToken": "my_nextPageToken",
3397
+ * // "runtimeVersions": [],
3398
+ * // "unreachable": []
3399
+ * // }
3400
+ * }
3401
+ *
3402
+ * main().catch(e => {
3403
+ * console.error(e);
3404
+ * throw e;
3405
+ * });
3406
+ *
3407
+ * ```
1813
3408
  *
1814
3409
  * @param params - Parameters for request
1815
3410
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.