@googleapis/tpu 2.0.0 → 2.2.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.
package/v2.ts CHANGED
@@ -124,16 +124,33 @@ export namespace tpu_v2 {
124
124
  }
125
125
  }
126
126
 
127
+ /**
128
+ * A TPU accelerator configuration.
129
+ */
130
+ export interface Schema$AcceleratorConfig {
131
+ /**
132
+ * Required. Topology of TPU in chips.
133
+ */
134
+ topology?: string | null;
135
+ /**
136
+ * Required. Type of TPU.
137
+ */
138
+ type?: string | null;
139
+ }
127
140
  /**
128
141
  * A accelerator type that a Node can be configured with.
129
142
  */
130
143
  export interface Schema$AcceleratorType {
144
+ /**
145
+ * The accelerator config.
146
+ */
147
+ acceleratorConfigs?: Schema$AcceleratorConfig[];
131
148
  /**
132
149
  * The resource name.
133
150
  */
134
151
  name?: string | null;
135
152
  /**
136
- * the accelerator type.
153
+ * The accelerator type.
137
154
  */
138
155
  type?: string | null;
139
156
  }
@@ -315,7 +332,7 @@ export namespace tpu_v2 {
315
332
  unreachable?: string[] | null;
316
333
  }
317
334
  /**
318
- * A resource that represents Google Cloud Platform location.
335
+ * A resource that represents a Google Cloud location.
319
336
  */
320
337
  export interface Schema$Location {
321
338
  /**
@@ -382,7 +399,11 @@ export namespace tpu_v2 {
382
399
  */
383
400
  export interface Schema$Node {
384
401
  /**
385
- * Required. The type of hardware accelerators associated with this node.
402
+ * The AccleratorConfig for the TPU Node.
403
+ */
404
+ acceleratorConfig?: Schema$AcceleratorConfig;
405
+ /**
406
+ * Optional. The type of hardware accelerators associated with this node.
386
407
  */
387
408
  acceleratorType?: string | null;
388
409
  /**
@@ -425,6 +446,10 @@ export namespace tpu_v2 {
425
446
  * Custom metadata to apply to the TPU Node. Can set startup-script and shutdown-script
426
447
  */
427
448
  metadata?: {[key: string]: string} | null;
449
+ /**
450
+ * Output only. Whether the Node belongs to a Multislice group.
451
+ */
452
+ multisliceNode?: boolean | null;
428
453
  /**
429
454
  * Output only. Immutable. The name of the TPU.
430
455
  */
@@ -437,6 +462,10 @@ export namespace tpu_v2 {
437
462
  * Output only. The network endpoints where TPU workers can be accessed and sent work. It is recommended that runtime clients of the node reach out to the 0th entry in this map first.
438
463
  */
439
464
  networkEndpoints?: Schema$NetworkEndpoint[];
465
+ /**
466
+ * Output only. The qualified name of the QueuedResource that requested this Node.
467
+ */
468
+ queuedResource?: string | null;
440
469
  /**
441
470
  * Required. The runtime version running in the Node.
442
471
  */
@@ -487,7 +516,7 @@ export namespace tpu_v2 {
487
516
  */
488
517
  name?: string | null;
489
518
  /**
490
- * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
519
+ * The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
491
520
  */
492
521
  response?: {[key: string]: any} | null;
493
522
  }
@@ -659,54 +688,6 @@ export namespace tpu_v2 {
659
688
 
660
689
  /**
661
690
  * Generates the Cloud TPU service identity for the project.
662
- * @example
663
- * ```js
664
- * // Before running the sample:
665
- * // - Enable the API at:
666
- * // https://console.developers.google.com/apis/api/tpu.googleapis.com
667
- * // - Login into gcloud by running:
668
- * // `$ gcloud auth application-default login`
669
- * // - Install the npm module by running:
670
- * // `$ npm install googleapis`
671
- *
672
- * const {google} = require('googleapis');
673
- * const tpu = google.tpu('v2');
674
- *
675
- * async function main() {
676
- * const auth = new google.auth.GoogleAuth({
677
- * // Scopes can be specified either as an array or as a single, space-delimited string.
678
- * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
679
- * });
680
- *
681
- * // Acquire an auth client, and bind it to all future calls
682
- * const authClient = await auth.getClient();
683
- * google.options({auth: authClient});
684
- *
685
- * // Do the magic
686
- * const res = await tpu.projects.locations.generateServiceIdentity({
687
- * // Required. The parent resource name.
688
- * parent: 'projects/my-project/locations/my-location',
689
- *
690
- * // Request body metadata
691
- * requestBody: {
692
- * // request body parameters
693
- * // {}
694
- * },
695
- * });
696
- * console.log(res.data);
697
- *
698
- * // Example response
699
- * // {
700
- * // "identity": {}
701
- * // }
702
- * }
703
- *
704
- * main().catch(e => {
705
- * console.error(e);
706
- * throw e;
707
- * });
708
- *
709
- * ```
710
691
  *
711
692
  * @param params - Parameters for request
712
693
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -804,52 +785,6 @@ export namespace tpu_v2 {
804
785
 
805
786
  /**
806
787
  * Gets information about a location.
807
- * @example
808
- * ```js
809
- * // Before running the sample:
810
- * // - Enable the API at:
811
- * // https://console.developers.google.com/apis/api/tpu.googleapis.com
812
- * // - Login into gcloud by running:
813
- * // `$ gcloud auth application-default login`
814
- * // - Install the npm module by running:
815
- * // `$ npm install googleapis`
816
- *
817
- * const {google} = require('googleapis');
818
- * const tpu = google.tpu('v2');
819
- *
820
- * async function main() {
821
- * const auth = new google.auth.GoogleAuth({
822
- * // Scopes can be specified either as an array or as a single, space-delimited string.
823
- * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
824
- * });
825
- *
826
- * // Acquire an auth client, and bind it to all future calls
827
- * const authClient = await auth.getClient();
828
- * google.options({auth: authClient});
829
- *
830
- * // Do the magic
831
- * const res = await tpu.projects.locations.get({
832
- * // Resource name for the location.
833
- * name: 'projects/my-project/locations/my-location',
834
- * });
835
- * console.log(res.data);
836
- *
837
- * // Example response
838
- * // {
839
- * // "displayName": "my_displayName",
840
- * // "labels": {},
841
- * // "locationId": "my_locationId",
842
- * // "metadata": {},
843
- * // "name": "my_name"
844
- * // }
845
- * }
846
- *
847
- * main().catch(e => {
848
- * console.error(e);
849
- * throw e;
850
- * });
851
- *
852
- * ```
853
788
  *
854
789
  * @param params - Parameters for request
855
790
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -934,55 +869,6 @@ export namespace tpu_v2 {
934
869
 
935
870
  /**
936
871
  * Lists information about the supported locations for this service.
937
- * @example
938
- * ```js
939
- * // Before running the sample:
940
- * // - Enable the API at:
941
- * // https://console.developers.google.com/apis/api/tpu.googleapis.com
942
- * // - Login into gcloud by running:
943
- * // `$ gcloud auth application-default login`
944
- * // - Install the npm module by running:
945
- * // `$ npm install googleapis`
946
- *
947
- * const {google} = require('googleapis');
948
- * const tpu = google.tpu('v2');
949
- *
950
- * async function main() {
951
- * const auth = new google.auth.GoogleAuth({
952
- * // Scopes can be specified either as an array or as a single, space-delimited string.
953
- * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
954
- * });
955
- *
956
- * // Acquire an auth client, and bind it to all future calls
957
- * const authClient = await auth.getClient();
958
- * google.options({auth: authClient});
959
- *
960
- * // Do the magic
961
- * const res = await tpu.projects.locations.list({
962
- * // 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).
963
- * filter: 'placeholder-value',
964
- * // The resource that owns the locations collection, if applicable.
965
- * name: 'projects/my-project',
966
- * // The maximum number of results to return. If not set, the service selects a default.
967
- * pageSize: 'placeholder-value',
968
- * // A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
969
- * pageToken: 'placeholder-value',
970
- * });
971
- * console.log(res.data);
972
- *
973
- * // Example response
974
- * // {
975
- * // "locations": [],
976
- * // "nextPageToken": "my_nextPageToken"
977
- * // }
978
- * }
979
- *
980
- * main().catch(e => {
981
- * console.error(e);
982
- * throw e;
983
- * });
984
- *
985
- * ```
986
872
  *
987
873
  * @param params - Parameters for request
988
874
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1121,49 +1007,6 @@ export namespace tpu_v2 {
1121
1007
 
1122
1008
  /**
1123
1009
  * Gets AcceleratorType.
1124
- * @example
1125
- * ```js
1126
- * // Before running the sample:
1127
- * // - Enable the API at:
1128
- * // https://console.developers.google.com/apis/api/tpu.googleapis.com
1129
- * // - Login into gcloud by running:
1130
- * // `$ gcloud auth application-default login`
1131
- * // - Install the npm module by running:
1132
- * // `$ npm install googleapis`
1133
- *
1134
- * const {google} = require('googleapis');
1135
- * const tpu = google.tpu('v2');
1136
- *
1137
- * async function main() {
1138
- * const auth = new google.auth.GoogleAuth({
1139
- * // Scopes can be specified either as an array or as a single, space-delimited string.
1140
- * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
1141
- * });
1142
- *
1143
- * // Acquire an auth client, and bind it to all future calls
1144
- * const authClient = await auth.getClient();
1145
- * google.options({auth: authClient});
1146
- *
1147
- * // Do the magic
1148
- * const res = await tpu.projects.locations.acceleratorTypes.get({
1149
- * // Required. The resource name.
1150
- * name: 'projects/my-project/locations/my-location/acceleratorTypes/my-acceleratorType',
1151
- * });
1152
- * console.log(res.data);
1153
- *
1154
- * // Example response
1155
- * // {
1156
- * // "name": "my_name",
1157
- * // "type": "my_type"
1158
- * // }
1159
- * }
1160
- *
1161
- * main().catch(e => {
1162
- * console.error(e);
1163
- * throw e;
1164
- * });
1165
- *
1166
- * ```
1167
1010
  *
1168
1011
  * @param params - Parameters for request
1169
1012
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1248,58 +1091,6 @@ export namespace tpu_v2 {
1248
1091
 
1249
1092
  /**
1250
1093
  * Lists accelerator types supported by this API.
1251
- * @example
1252
- * ```js
1253
- * // Before running the sample:
1254
- * // - Enable the API at:
1255
- * // https://console.developers.google.com/apis/api/tpu.googleapis.com
1256
- * // - Login into gcloud by running:
1257
- * // `$ gcloud auth application-default login`
1258
- * // - Install the npm module by running:
1259
- * // `$ npm install googleapis`
1260
- *
1261
- * const {google} = require('googleapis');
1262
- * const tpu = google.tpu('v2');
1263
- *
1264
- * async function main() {
1265
- * const auth = new google.auth.GoogleAuth({
1266
- * // Scopes can be specified either as an array or as a single, space-delimited string.
1267
- * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
1268
- * });
1269
- *
1270
- * // Acquire an auth client, and bind it to all future calls
1271
- * const authClient = await auth.getClient();
1272
- * google.options({auth: authClient});
1273
- *
1274
- * // Do the magic
1275
- * const res = await tpu.projects.locations.acceleratorTypes.list({
1276
- * // List filter.
1277
- * filter: 'placeholder-value',
1278
- * // Sort results.
1279
- * orderBy: 'placeholder-value',
1280
- * // The maximum number of items to return.
1281
- * pageSize: 'placeholder-value',
1282
- * // The next_page_token value returned from a previous List request, if any.
1283
- * pageToken: 'placeholder-value',
1284
- * // Required. The parent resource name.
1285
- * parent: 'projects/my-project/locations/my-location',
1286
- * });
1287
- * console.log(res.data);
1288
- *
1289
- * // Example response
1290
- * // {
1291
- * // "acceleratorTypes": [],
1292
- * // "nextPageToken": "my_nextPageToken",
1293
- * // "unreachable": []
1294
- * // }
1295
- * }
1296
- *
1297
- * main().catch(e => {
1298
- * console.error(e);
1299
- * throw e;
1300
- * });
1301
- *
1302
- * ```
1303
1094
  *
1304
1095
  * @param params - Parameters for request
1305
1096
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1434,82 +1225,6 @@ export namespace tpu_v2 {
1434
1225
 
1435
1226
  /**
1436
1227
  * Creates a node.
1437
- * @example
1438
- * ```js
1439
- * // Before running the sample:
1440
- * // - Enable the API at:
1441
- * // https://console.developers.google.com/apis/api/tpu.googleapis.com
1442
- * // - Login into gcloud by running:
1443
- * // `$ gcloud auth application-default login`
1444
- * // - Install the npm module by running:
1445
- * // `$ npm install googleapis`
1446
- *
1447
- * const {google} = require('googleapis');
1448
- * const tpu = google.tpu('v2');
1449
- *
1450
- * async function main() {
1451
- * const auth = new google.auth.GoogleAuth({
1452
- * // Scopes can be specified either as an array or as a single, space-delimited string.
1453
- * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
1454
- * });
1455
- *
1456
- * // Acquire an auth client, and bind it to all future calls
1457
- * const authClient = await auth.getClient();
1458
- * google.options({auth: authClient});
1459
- *
1460
- * // Do the magic
1461
- * const res = await tpu.projects.locations.nodes.create({
1462
- * // The unqualified resource name.
1463
- * nodeId: 'placeholder-value',
1464
- * // Required. The parent resource name.
1465
- * parent: 'projects/my-project/locations/my-location',
1466
- *
1467
- * // Request body metadata
1468
- * requestBody: {
1469
- * // request body parameters
1470
- * // {
1471
- * // "acceleratorType": "my_acceleratorType",
1472
- * // "apiVersion": "my_apiVersion",
1473
- * // "cidrBlock": "my_cidrBlock",
1474
- * // "createTime": "my_createTime",
1475
- * // "dataDisks": [],
1476
- * // "description": "my_description",
1477
- * // "health": "my_health",
1478
- * // "healthDescription": "my_healthDescription",
1479
- * // "id": "my_id",
1480
- * // "labels": {},
1481
- * // "metadata": {},
1482
- * // "name": "my_name",
1483
- * // "networkConfig": {},
1484
- * // "networkEndpoints": [],
1485
- * // "runtimeVersion": "my_runtimeVersion",
1486
- * // "schedulingConfig": {},
1487
- * // "serviceAccount": {},
1488
- * // "shieldedInstanceConfig": {},
1489
- * // "state": "my_state",
1490
- * // "symptoms": [],
1491
- * // "tags": []
1492
- * // }
1493
- * },
1494
- * });
1495
- * console.log(res.data);
1496
- *
1497
- * // Example response
1498
- * // {
1499
- * // "done": false,
1500
- * // "error": {},
1501
- * // "metadata": {},
1502
- * // "name": "my_name",
1503
- * // "response": {}
1504
- * // }
1505
- * }
1506
- *
1507
- * main().catch(e => {
1508
- * console.error(e);
1509
- * throw e;
1510
- * });
1511
- *
1512
- * ```
1513
1228
  *
1514
1229
  * @param params - Parameters for request
1515
1230
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1597,52 +1312,6 @@ export namespace tpu_v2 {
1597
1312
 
1598
1313
  /**
1599
1314
  * Deletes a node.
1600
- * @example
1601
- * ```js
1602
- * // Before running the sample:
1603
- * // - Enable the API at:
1604
- * // https://console.developers.google.com/apis/api/tpu.googleapis.com
1605
- * // - Login into gcloud by running:
1606
- * // `$ gcloud auth application-default login`
1607
- * // - Install the npm module by running:
1608
- * // `$ npm install googleapis`
1609
- *
1610
- * const {google} = require('googleapis');
1611
- * const tpu = google.tpu('v2');
1612
- *
1613
- * async function main() {
1614
- * const auth = new google.auth.GoogleAuth({
1615
- * // Scopes can be specified either as an array or as a single, space-delimited string.
1616
- * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
1617
- * });
1618
- *
1619
- * // Acquire an auth client, and bind it to all future calls
1620
- * const authClient = await auth.getClient();
1621
- * google.options({auth: authClient});
1622
- *
1623
- * // Do the magic
1624
- * const res = await tpu.projects.locations.nodes.delete({
1625
- * // Required. The resource name.
1626
- * name: 'projects/my-project/locations/my-location/nodes/my-node',
1627
- * });
1628
- * console.log(res.data);
1629
- *
1630
- * // Example response
1631
- * // {
1632
- * // "done": false,
1633
- * // "error": {},
1634
- * // "metadata": {},
1635
- * // "name": "my_name",
1636
- * // "response": {}
1637
- * // }
1638
- * }
1639
- *
1640
- * main().catch(e => {
1641
- * console.error(e);
1642
- * throw e;
1643
- * });
1644
- *
1645
- * ```
1646
1315
  *
1647
1316
  * @param params - Parameters for request
1648
1317
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1727,68 +1396,6 @@ export namespace tpu_v2 {
1727
1396
 
1728
1397
  /**
1729
1398
  * Gets the details of a node.
1730
- * @example
1731
- * ```js
1732
- * // Before running the sample:
1733
- * // - Enable the API at:
1734
- * // https://console.developers.google.com/apis/api/tpu.googleapis.com
1735
- * // - Login into gcloud by running:
1736
- * // `$ gcloud auth application-default login`
1737
- * // - Install the npm module by running:
1738
- * // `$ npm install googleapis`
1739
- *
1740
- * const {google} = require('googleapis');
1741
- * const tpu = google.tpu('v2');
1742
- *
1743
- * async function main() {
1744
- * const auth = new google.auth.GoogleAuth({
1745
- * // Scopes can be specified either as an array or as a single, space-delimited string.
1746
- * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
1747
- * });
1748
- *
1749
- * // Acquire an auth client, and bind it to all future calls
1750
- * const authClient = await auth.getClient();
1751
- * google.options({auth: authClient});
1752
- *
1753
- * // Do the magic
1754
- * const res = await tpu.projects.locations.nodes.get({
1755
- * // Required. The resource name.
1756
- * name: 'projects/my-project/locations/my-location/nodes/my-node',
1757
- * });
1758
- * console.log(res.data);
1759
- *
1760
- * // Example response
1761
- * // {
1762
- * // "acceleratorType": "my_acceleratorType",
1763
- * // "apiVersion": "my_apiVersion",
1764
- * // "cidrBlock": "my_cidrBlock",
1765
- * // "createTime": "my_createTime",
1766
- * // "dataDisks": [],
1767
- * // "description": "my_description",
1768
- * // "health": "my_health",
1769
- * // "healthDescription": "my_healthDescription",
1770
- * // "id": "my_id",
1771
- * // "labels": {},
1772
- * // "metadata": {},
1773
- * // "name": "my_name",
1774
- * // "networkConfig": {},
1775
- * // "networkEndpoints": [],
1776
- * // "runtimeVersion": "my_runtimeVersion",
1777
- * // "schedulingConfig": {},
1778
- * // "serviceAccount": {},
1779
- * // "shieldedInstanceConfig": {},
1780
- * // "state": "my_state",
1781
- * // "symptoms": [],
1782
- * // "tags": []
1783
- * // }
1784
- * }
1785
- *
1786
- * main().catch(e => {
1787
- * console.error(e);
1788
- * throw e;
1789
- * });
1790
- *
1791
- * ```
1792
1399
  *
1793
1400
  * @param params - Parameters for request
1794
1401
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1873,57 +1480,6 @@ export namespace tpu_v2 {
1873
1480
 
1874
1481
  /**
1875
1482
  * Retrieves the guest attributes for the node.
1876
- * @example
1877
- * ```js
1878
- * // Before running the sample:
1879
- * // - Enable the API at:
1880
- * // https://console.developers.google.com/apis/api/tpu.googleapis.com
1881
- * // - Login into gcloud by running:
1882
- * // `$ gcloud auth application-default login`
1883
- * // - Install the npm module by running:
1884
- * // `$ npm install googleapis`
1885
- *
1886
- * const {google} = require('googleapis');
1887
- * const tpu = google.tpu('v2');
1888
- *
1889
- * async function main() {
1890
- * const auth = new google.auth.GoogleAuth({
1891
- * // Scopes can be specified either as an array or as a single, space-delimited string.
1892
- * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
1893
- * });
1894
- *
1895
- * // Acquire an auth client, and bind it to all future calls
1896
- * const authClient = await auth.getClient();
1897
- * google.options({auth: authClient});
1898
- *
1899
- * // Do the magic
1900
- * const res = await tpu.projects.locations.nodes.getGuestAttributes({
1901
- * // Required. The resource name.
1902
- * name: 'projects/my-project/locations/my-location/nodes/my-node',
1903
- *
1904
- * // Request body metadata
1905
- * requestBody: {
1906
- * // request body parameters
1907
- * // {
1908
- * // "queryPath": "my_queryPath",
1909
- * // "workerIds": []
1910
- * // }
1911
- * },
1912
- * });
1913
- * console.log(res.data);
1914
- *
1915
- * // Example response
1916
- * // {
1917
- * // "guestAttributes": []
1918
- * // }
1919
- * }
1920
- *
1921
- * main().catch(e => {
1922
- * console.error(e);
1923
- * throw e;
1924
- * });
1925
- *
1926
- * ```
1927
1483
  *
1928
1484
  * @param params - Parameters for request
1929
1485
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2019,54 +1575,6 @@ export namespace tpu_v2 {
2019
1575
 
2020
1576
  /**
2021
1577
  * Lists nodes.
2022
- * @example
2023
- * ```js
2024
- * // Before running the sample:
2025
- * // - Enable the API at:
2026
- * // https://console.developers.google.com/apis/api/tpu.googleapis.com
2027
- * // - Login into gcloud by running:
2028
- * // `$ gcloud auth application-default login`
2029
- * // - Install the npm module by running:
2030
- * // `$ npm install googleapis`
2031
- *
2032
- * const {google} = require('googleapis');
2033
- * const tpu = google.tpu('v2');
2034
- *
2035
- * async function main() {
2036
- * const auth = new google.auth.GoogleAuth({
2037
- * // Scopes can be specified either as an array or as a single, space-delimited string.
2038
- * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
2039
- * });
2040
- *
2041
- * // Acquire an auth client, and bind it to all future calls
2042
- * const authClient = await auth.getClient();
2043
- * google.options({auth: authClient});
2044
- *
2045
- * // Do the magic
2046
- * const res = await tpu.projects.locations.nodes.list({
2047
- * // The maximum number of items to return.
2048
- * pageSize: 'placeholder-value',
2049
- * // The next_page_token value returned from a previous List request, if any.
2050
- * pageToken: 'placeholder-value',
2051
- * // Required. The parent resource name.
2052
- * parent: 'projects/my-project/locations/my-location',
2053
- * });
2054
- * console.log(res.data);
2055
- *
2056
- * // Example response
2057
- * // {
2058
- * // "nextPageToken": "my_nextPageToken",
2059
- * // "nodes": [],
2060
- * // "unreachable": []
2061
- * // }
2062
- * }
2063
- *
2064
- * main().catch(e => {
2065
- * console.error(e);
2066
- * throw e;
2067
- * });
2068
- *
2069
- * ```
2070
1578
  *
2071
1579
  * @param params - Parameters for request
2072
1580
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2157,82 +1665,6 @@ export namespace tpu_v2 {
2157
1665
 
2158
1666
  /**
2159
1667
  * Updates the configurations of a node.
2160
- * @example
2161
- * ```js
2162
- * // Before running the sample:
2163
- * // - Enable the API at:
2164
- * // https://console.developers.google.com/apis/api/tpu.googleapis.com
2165
- * // - Login into gcloud by running:
2166
- * // `$ gcloud auth application-default login`
2167
- * // - Install the npm module by running:
2168
- * // `$ npm install googleapis`
2169
- *
2170
- * const {google} = require('googleapis');
2171
- * const tpu = google.tpu('v2');
2172
- *
2173
- * async function main() {
2174
- * const auth = new google.auth.GoogleAuth({
2175
- * // Scopes can be specified either as an array or as a single, space-delimited string.
2176
- * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
2177
- * });
2178
- *
2179
- * // Acquire an auth client, and bind it to all future calls
2180
- * const authClient = await auth.getClient();
2181
- * google.options({auth: authClient});
2182
- *
2183
- * // Do the magic
2184
- * const res = await tpu.projects.locations.nodes.patch({
2185
- * // Output only. Immutable. The name of the TPU.
2186
- * name: 'projects/my-project/locations/my-location/nodes/my-node',
2187
- * // Required. Mask of fields from Node to update. Supported fields: [description, tags, labels, metadata, network_config.enable_external_ips].
2188
- * updateMask: 'placeholder-value',
2189
- *
2190
- * // Request body metadata
2191
- * requestBody: {
2192
- * // request body parameters
2193
- * // {
2194
- * // "acceleratorType": "my_acceleratorType",
2195
- * // "apiVersion": "my_apiVersion",
2196
- * // "cidrBlock": "my_cidrBlock",
2197
- * // "createTime": "my_createTime",
2198
- * // "dataDisks": [],
2199
- * // "description": "my_description",
2200
- * // "health": "my_health",
2201
- * // "healthDescription": "my_healthDescription",
2202
- * // "id": "my_id",
2203
- * // "labels": {},
2204
- * // "metadata": {},
2205
- * // "name": "my_name",
2206
- * // "networkConfig": {},
2207
- * // "networkEndpoints": [],
2208
- * // "runtimeVersion": "my_runtimeVersion",
2209
- * // "schedulingConfig": {},
2210
- * // "serviceAccount": {},
2211
- * // "shieldedInstanceConfig": {},
2212
- * // "state": "my_state",
2213
- * // "symptoms": [],
2214
- * // "tags": []
2215
- * // }
2216
- * },
2217
- * });
2218
- * console.log(res.data);
2219
- *
2220
- * // Example response
2221
- * // {
2222
- * // "done": false,
2223
- * // "error": {},
2224
- * // "metadata": {},
2225
- * // "name": "my_name",
2226
- * // "response": {}
2227
- * // }
2228
- * }
2229
- *
2230
- * main().catch(e => {
2231
- * console.error(e);
2232
- * throw e;
2233
- * });
2234
- *
2235
- * ```
2236
1668
  *
2237
1669
  * @param params - Parameters for request
2238
1670
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2317,58 +1749,6 @@ export namespace tpu_v2 {
2317
1749
 
2318
1750
  /**
2319
1751
  * Starts a node.
2320
- * @example
2321
- * ```js
2322
- * // Before running the sample:
2323
- * // - Enable the API at:
2324
- * // https://console.developers.google.com/apis/api/tpu.googleapis.com
2325
- * // - Login into gcloud by running:
2326
- * // `$ gcloud auth application-default login`
2327
- * // - Install the npm module by running:
2328
- * // `$ npm install googleapis`
2329
- *
2330
- * const {google} = require('googleapis');
2331
- * const tpu = google.tpu('v2');
2332
- *
2333
- * async function main() {
2334
- * const auth = new google.auth.GoogleAuth({
2335
- * // Scopes can be specified either as an array or as a single, space-delimited string.
2336
- * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
2337
- * });
2338
- *
2339
- * // Acquire an auth client, and bind it to all future calls
2340
- * const authClient = await auth.getClient();
2341
- * google.options({auth: authClient});
2342
- *
2343
- * // Do the magic
2344
- * const res = await tpu.projects.locations.nodes.start({
2345
- * // The resource name.
2346
- * name: 'projects/my-project/locations/my-location/nodes/my-node',
2347
- *
2348
- * // Request body metadata
2349
- * requestBody: {
2350
- * // request body parameters
2351
- * // {}
2352
- * },
2353
- * });
2354
- * console.log(res.data);
2355
- *
2356
- * // Example response
2357
- * // {
2358
- * // "done": false,
2359
- * // "error": {},
2360
- * // "metadata": {},
2361
- * // "name": "my_name",
2362
- * // "response": {}
2363
- * // }
2364
- * }
2365
- *
2366
- * main().catch(e => {
2367
- * console.error(e);
2368
- * throw e;
2369
- * });
2370
- *
2371
- * ```
2372
1752
  *
2373
1753
  * @param params - Parameters for request
2374
1754
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2453,58 +1833,6 @@ export namespace tpu_v2 {
2453
1833
 
2454
1834
  /**
2455
1835
  * Stops a node. This operation is only available with single TPU nodes.
2456
- * @example
2457
- * ```js
2458
- * // Before running the sample:
2459
- * // - Enable the API at:
2460
- * // https://console.developers.google.com/apis/api/tpu.googleapis.com
2461
- * // - Login into gcloud by running:
2462
- * // `$ gcloud auth application-default login`
2463
- * // - Install the npm module by running:
2464
- * // `$ npm install googleapis`
2465
- *
2466
- * const {google} = require('googleapis');
2467
- * const tpu = google.tpu('v2');
2468
- *
2469
- * async function main() {
2470
- * const auth = new google.auth.GoogleAuth({
2471
- * // Scopes can be specified either as an array or as a single, space-delimited string.
2472
- * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
2473
- * });
2474
- *
2475
- * // Acquire an auth client, and bind it to all future calls
2476
- * const authClient = await auth.getClient();
2477
- * google.options({auth: authClient});
2478
- *
2479
- * // Do the magic
2480
- * const res = await tpu.projects.locations.nodes.stop({
2481
- * // The resource name.
2482
- * name: 'projects/my-project/locations/my-location/nodes/my-node',
2483
- *
2484
- * // Request body metadata
2485
- * requestBody: {
2486
- * // request body parameters
2487
- * // {}
2488
- * },
2489
- * });
2490
- * console.log(res.data);
2491
- *
2492
- * // Example response
2493
- * // {
2494
- * // "done": false,
2495
- * // "error": {},
2496
- * // "metadata": {},
2497
- * // "name": "my_name",
2498
- * // "response": {}
2499
- * // }
2500
- * }
2501
- *
2502
- * main().catch(e => {
2503
- * console.error(e);
2504
- * throw e;
2505
- * });
2506
- *
2507
- * ```
2508
1836
  *
2509
1837
  * @param params - Parameters for request
2510
1838
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2664,7 +1992,7 @@ export namespace tpu_v2 {
2664
1992
  export interface Params$Resource$Projects$Locations$Nodes$Start
2665
1993
  extends StandardParameters {
2666
1994
  /**
2667
- * The resource name.
1995
+ * Required. The resource name.
2668
1996
  */
2669
1997
  name?: string;
2670
1998
 
@@ -2676,7 +2004,7 @@ export namespace tpu_v2 {
2676
2004
  export interface Params$Resource$Projects$Locations$Nodes$Stop
2677
2005
  extends StandardParameters {
2678
2006
  /**
2679
- * The resource name.
2007
+ * Required. The resource name.
2680
2008
  */
2681
2009
  name?: string;
2682
2010
 
@@ -2694,46 +2022,6 @@ export namespace tpu_v2 {
2694
2022
 
2695
2023
  /**
2696
2024
  * 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`.
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
- * // `$ gcloud auth application-default login`
2704
- * // - Install the npm module by running:
2705
- * // `$ npm install googleapis`
2706
- *
2707
- * const {google} = require('googleapis');
2708
- * const tpu = google.tpu('v2');
2709
- *
2710
- * async function main() {
2711
- * const auth = new google.auth.GoogleAuth({
2712
- * // Scopes can be specified either as an array or as a single, space-delimited string.
2713
- * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
2714
- * });
2715
- *
2716
- * // Acquire an auth client, and bind it to all future calls
2717
- * const authClient = await auth.getClient();
2718
- * google.options({auth: authClient});
2719
- *
2720
- * // Do the magic
2721
- * const res = await tpu.projects.locations.operations.cancel({
2722
- * // The name of the operation resource to be cancelled.
2723
- * name: 'projects/my-project/locations/my-location/operations/my-operation',
2724
- * });
2725
- * console.log(res.data);
2726
- *
2727
- * // Example response
2728
- * // {}
2729
- * }
2730
- *
2731
- * main().catch(e => {
2732
- * console.error(e);
2733
- * throw e;
2734
- * });
2735
- *
2736
- * ```
2737
2025
  *
2738
2026
  * @param params - Parameters for request
2739
2027
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2818,46 +2106,6 @@ export namespace tpu_v2 {
2818
2106
 
2819
2107
  /**
2820
2108
  * 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`.
2821
- * @example
2822
- * ```js
2823
- * // Before running the sample:
2824
- * // - Enable the API at:
2825
- * // https://console.developers.google.com/apis/api/tpu.googleapis.com
2826
- * // - Login into gcloud by running:
2827
- * // `$ gcloud auth application-default login`
2828
- * // - Install the npm module by running:
2829
- * // `$ npm install googleapis`
2830
- *
2831
- * const {google} = require('googleapis');
2832
- * const tpu = google.tpu('v2');
2833
- *
2834
- * async function main() {
2835
- * const auth = new google.auth.GoogleAuth({
2836
- * // Scopes can be specified either as an array or as a single, space-delimited string.
2837
- * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
2838
- * });
2839
- *
2840
- * // Acquire an auth client, and bind it to all future calls
2841
- * const authClient = await auth.getClient();
2842
- * google.options({auth: authClient});
2843
- *
2844
- * // Do the magic
2845
- * const res = await tpu.projects.locations.operations.delete({
2846
- * // The name of the operation resource to be deleted.
2847
- * name: 'projects/my-project/locations/my-location/operations/my-operation',
2848
- * });
2849
- * console.log(res.data);
2850
- *
2851
- * // Example response
2852
- * // {}
2853
- * }
2854
- *
2855
- * main().catch(e => {
2856
- * console.error(e);
2857
- * throw e;
2858
- * });
2859
- *
2860
- * ```
2861
2109
  *
2862
2110
  * @param params - Parameters for request
2863
2111
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2942,52 +2190,6 @@ export namespace tpu_v2 {
2942
2190
 
2943
2191
  /**
2944
2192
  * 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.
2945
- * @example
2946
- * ```js
2947
- * // Before running the sample:
2948
- * // - Enable the API at:
2949
- * // https://console.developers.google.com/apis/api/tpu.googleapis.com
2950
- * // - Login into gcloud by running:
2951
- * // `$ gcloud auth application-default login`
2952
- * // - Install the npm module by running:
2953
- * // `$ npm install googleapis`
2954
- *
2955
- * const {google} = require('googleapis');
2956
- * const tpu = google.tpu('v2');
2957
- *
2958
- * async function main() {
2959
- * const auth = new google.auth.GoogleAuth({
2960
- * // Scopes can be specified either as an array or as a single, space-delimited string.
2961
- * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
2962
- * });
2963
- *
2964
- * // Acquire an auth client, and bind it to all future calls
2965
- * const authClient = await auth.getClient();
2966
- * google.options({auth: authClient});
2967
- *
2968
- * // Do the magic
2969
- * const res = await tpu.projects.locations.operations.get({
2970
- * // The name of the operation resource.
2971
- * name: 'projects/my-project/locations/my-location/operations/my-operation',
2972
- * });
2973
- * console.log(res.data);
2974
- *
2975
- * // Example response
2976
- * // {
2977
- * // "done": false,
2978
- * // "error": {},
2979
- * // "metadata": {},
2980
- * // "name": "my_name",
2981
- * // "response": {}
2982
- * // }
2983
- * }
2984
- *
2985
- * main().catch(e => {
2986
- * console.error(e);
2987
- * throw e;
2988
- * });
2989
- *
2990
- * ```
2991
2193
  *
2992
2194
  * @param params - Parameters for request
2993
2195
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3071,56 +2273,7 @@ export namespace tpu_v2 {
3071
2273
  }
3072
2274
 
3073
2275
  /**
3074
- * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/x/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/x\}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.
3075
- * @example
3076
- * ```js
3077
- * // Before running the sample:
3078
- * // - Enable the API at:
3079
- * // https://console.developers.google.com/apis/api/tpu.googleapis.com
3080
- * // - Login into gcloud by running:
3081
- * // `$ gcloud auth application-default login`
3082
- * // - Install the npm module by running:
3083
- * // `$ npm install googleapis`
3084
- *
3085
- * const {google} = require('googleapis');
3086
- * const tpu = google.tpu('v2');
3087
- *
3088
- * async function main() {
3089
- * const auth = new google.auth.GoogleAuth({
3090
- * // Scopes can be specified either as an array or as a single, space-delimited string.
3091
- * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
3092
- * });
3093
- *
3094
- * // Acquire an auth client, and bind it to all future calls
3095
- * const authClient = await auth.getClient();
3096
- * google.options({auth: authClient});
3097
- *
3098
- * // Do the magic
3099
- * const res = await tpu.projects.locations.operations.list({
3100
- * // The standard list filter.
3101
- * filter: 'placeholder-value',
3102
- * // The name of the operation's parent resource.
3103
- * name: 'projects/my-project/locations/my-location',
3104
- * // The standard list page size.
3105
- * pageSize: 'placeholder-value',
3106
- * // The standard list page token.
3107
- * pageToken: 'placeholder-value',
3108
- * });
3109
- * console.log(res.data);
3110
- *
3111
- * // Example response
3112
- * // {
3113
- * // "nextPageToken": "my_nextPageToken",
3114
- * // "operations": []
3115
- * // }
3116
- * }
3117
- *
3118
- * main().catch(e => {
3119
- * console.error(e);
3120
- * throw e;
3121
- * });
3122
- *
3123
- * ```
2276
+ * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
3124
2277
  *
3125
2278
  * @param params - Parameters for request
3126
2279
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3261,49 +2414,6 @@ export namespace tpu_v2 {
3261
2414
 
3262
2415
  /**
3263
2416
  * Gets a runtime version.
3264
- * @example
3265
- * ```js
3266
- * // Before running the sample:
3267
- * // - Enable the API at:
3268
- * // https://console.developers.google.com/apis/api/tpu.googleapis.com
3269
- * // - Login into gcloud by running:
3270
- * // `$ gcloud auth application-default login`
3271
- * // - Install the npm module by running:
3272
- * // `$ npm install googleapis`
3273
- *
3274
- * const {google} = require('googleapis');
3275
- * const tpu = google.tpu('v2');
3276
- *
3277
- * async function main() {
3278
- * const auth = new google.auth.GoogleAuth({
3279
- * // Scopes can be specified either as an array or as a single, space-delimited string.
3280
- * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
3281
- * });
3282
- *
3283
- * // Acquire an auth client, and bind it to all future calls
3284
- * const authClient = await auth.getClient();
3285
- * google.options({auth: authClient});
3286
- *
3287
- * // Do the magic
3288
- * const res = await tpu.projects.locations.runtimeVersions.get({
3289
- * // Required. The resource name.
3290
- * name: 'projects/my-project/locations/my-location/runtimeVersions/my-runtimeVersion',
3291
- * });
3292
- * console.log(res.data);
3293
- *
3294
- * // Example response
3295
- * // {
3296
- * // "name": "my_name",
3297
- * // "version": "my_version"
3298
- * // }
3299
- * }
3300
- *
3301
- * main().catch(e => {
3302
- * console.error(e);
3303
- * throw e;
3304
- * });
3305
- *
3306
- * ```
3307
2417
  *
3308
2418
  * @param params - Parameters for request
3309
2419
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3388,58 +2498,6 @@ export namespace tpu_v2 {
3388
2498
 
3389
2499
  /**
3390
2500
  * Lists runtime versions supported by this API.
3391
- * @example
3392
- * ```js
3393
- * // Before running the sample:
3394
- * // - Enable the API at:
3395
- * // https://console.developers.google.com/apis/api/tpu.googleapis.com
3396
- * // - Login into gcloud by running:
3397
- * // `$ gcloud auth application-default login`
3398
- * // - Install the npm module by running:
3399
- * // `$ npm install googleapis`
3400
- *
3401
- * const {google} = require('googleapis');
3402
- * const tpu = google.tpu('v2');
3403
- *
3404
- * async function main() {
3405
- * const auth = new google.auth.GoogleAuth({
3406
- * // Scopes can be specified either as an array or as a single, space-delimited string.
3407
- * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
3408
- * });
3409
- *
3410
- * // Acquire an auth client, and bind it to all future calls
3411
- * const authClient = await auth.getClient();
3412
- * google.options({auth: authClient});
3413
- *
3414
- * // Do the magic
3415
- * const res = await tpu.projects.locations.runtimeVersions.list({
3416
- * // List filter.
3417
- * filter: 'placeholder-value',
3418
- * // Sort results.
3419
- * orderBy: 'placeholder-value',
3420
- * // The maximum number of items to return.
3421
- * pageSize: 'placeholder-value',
3422
- * // The next_page_token value returned from a previous List request, if any.
3423
- * pageToken: 'placeholder-value',
3424
- * // Required. The parent resource name.
3425
- * parent: 'projects/my-project/locations/my-location',
3426
- * });
3427
- * console.log(res.data);
3428
- *
3429
- * // Example response
3430
- * // {
3431
- * // "nextPageToken": "my_nextPageToken",
3432
- * // "runtimeVersions": [],
3433
- * // "unreachable": []
3434
- * // }
3435
- * }
3436
- *
3437
- * main().catch(e => {
3438
- * console.error(e);
3439
- * throw e;
3440
- * });
3441
- *
3442
- * ```
3443
2501
  *
3444
2502
  * @param params - Parameters for request
3445
2503
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.