@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/build/v2.d.ts CHANGED
@@ -71,16 +71,33 @@ export declare namespace tpu_v2 {
71
71
  projects: Resource$Projects;
72
72
  constructor(options: GlobalOptions, google?: GoogleConfigurable);
73
73
  }
74
+ /**
75
+ * A TPU accelerator configuration.
76
+ */
77
+ export interface Schema$AcceleratorConfig {
78
+ /**
79
+ * Required. Topology of TPU in chips.
80
+ */
81
+ topology?: string | null;
82
+ /**
83
+ * Required. Type of TPU.
84
+ */
85
+ type?: string | null;
86
+ }
74
87
  /**
75
88
  * A accelerator type that a Node can be configured with.
76
89
  */
77
90
  export interface Schema$AcceleratorType {
91
+ /**
92
+ * The accelerator config.
93
+ */
94
+ acceleratorConfigs?: Schema$AcceleratorConfig[];
78
95
  /**
79
96
  * The resource name.
80
97
  */
81
98
  name?: string | null;
82
99
  /**
83
- * the accelerator type.
100
+ * The accelerator type.
84
101
  */
85
102
  type?: string | null;
86
103
  }
@@ -264,7 +281,7 @@ export declare namespace tpu_v2 {
264
281
  unreachable?: string[] | null;
265
282
  }
266
283
  /**
267
- * A resource that represents Google Cloud Platform location.
284
+ * A resource that represents a Google Cloud location.
268
285
  */
269
286
  export interface Schema$Location {
270
287
  /**
@@ -335,7 +352,11 @@ export declare namespace tpu_v2 {
335
352
  */
336
353
  export interface Schema$Node {
337
354
  /**
338
- * Required. The type of hardware accelerators associated with this node.
355
+ * The AccleratorConfig for the TPU Node.
356
+ */
357
+ acceleratorConfig?: Schema$AcceleratorConfig;
358
+ /**
359
+ * Optional. The type of hardware accelerators associated with this node.
339
360
  */
340
361
  acceleratorType?: string | null;
341
362
  /**
@@ -382,6 +403,10 @@ export declare namespace tpu_v2 {
382
403
  metadata?: {
383
404
  [key: string]: string;
384
405
  } | null;
406
+ /**
407
+ * Output only. Whether the Node belongs to a Multislice group.
408
+ */
409
+ multisliceNode?: boolean | null;
385
410
  /**
386
411
  * Output only. Immutable. The name of the TPU.
387
412
  */
@@ -394,6 +419,10 @@ export declare namespace tpu_v2 {
394
419
  * 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.
395
420
  */
396
421
  networkEndpoints?: Schema$NetworkEndpoint[];
422
+ /**
423
+ * Output only. The qualified name of the QueuedResource that requested this Node.
424
+ */
425
+ queuedResource?: string | null;
397
426
  /**
398
427
  * Required. The runtime version running in the Node.
399
428
  */
@@ -446,7 +475,7 @@ export declare namespace tpu_v2 {
446
475
  */
447
476
  name?: string | null;
448
477
  /**
449
- * 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`.
478
+ * 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`.
450
479
  */
451
480
  response?: {
452
481
  [key: string]: any;
@@ -606,54 +635,6 @@ export declare namespace tpu_v2 {
606
635
  constructor(context: APIRequestContext);
607
636
  /**
608
637
  * Generates the Cloud TPU service identity for the project.
609
- * @example
610
- * ```js
611
- * // Before running the sample:
612
- * // - Enable the API at:
613
- * // https://console.developers.google.com/apis/api/tpu.googleapis.com
614
- * // - Login into gcloud by running:
615
- * // `$ gcloud auth application-default login`
616
- * // - Install the npm module by running:
617
- * // `$ npm install googleapis`
618
- *
619
- * const {google} = require('googleapis');
620
- * const tpu = google.tpu('v2');
621
- *
622
- * async function main() {
623
- * const auth = new google.auth.GoogleAuth({
624
- * // Scopes can be specified either as an array or as a single, space-delimited string.
625
- * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
626
- * });
627
- *
628
- * // Acquire an auth client, and bind it to all future calls
629
- * const authClient = await auth.getClient();
630
- * google.options({auth: authClient});
631
- *
632
- * // Do the magic
633
- * const res = await tpu.projects.locations.generateServiceIdentity({
634
- * // Required. The parent resource name.
635
- * parent: 'projects/my-project/locations/my-location',
636
- *
637
- * // Request body metadata
638
- * requestBody: {
639
- * // request body parameters
640
- * // {}
641
- * },
642
- * });
643
- * console.log(res.data);
644
- *
645
- * // Example response
646
- * // {
647
- * // "identity": {}
648
- * // }
649
- * }
650
- *
651
- * main().catch(e => {
652
- * console.error(e);
653
- * throw e;
654
- * });
655
- *
656
- * ```
657
638
  *
658
639
  * @param params - Parameters for request
659
640
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -668,52 +649,6 @@ export declare namespace tpu_v2 {
668
649
  generateServiceIdentity(callback: BodyResponseCallback<Schema$GenerateServiceIdentityResponse>): void;
669
650
  /**
670
651
  * Gets information about a location.
671
- * @example
672
- * ```js
673
- * // Before running the sample:
674
- * // - Enable the API at:
675
- * // https://console.developers.google.com/apis/api/tpu.googleapis.com
676
- * // - Login into gcloud by running:
677
- * // `$ gcloud auth application-default login`
678
- * // - Install the npm module by running:
679
- * // `$ npm install googleapis`
680
- *
681
- * const {google} = require('googleapis');
682
- * const tpu = google.tpu('v2');
683
- *
684
- * async function main() {
685
- * const auth = new google.auth.GoogleAuth({
686
- * // Scopes can be specified either as an array or as a single, space-delimited string.
687
- * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
688
- * });
689
- *
690
- * // Acquire an auth client, and bind it to all future calls
691
- * const authClient = await auth.getClient();
692
- * google.options({auth: authClient});
693
- *
694
- * // Do the magic
695
- * const res = await tpu.projects.locations.get({
696
- * // Resource name for the location.
697
- * name: 'projects/my-project/locations/my-location',
698
- * });
699
- * console.log(res.data);
700
- *
701
- * // Example response
702
- * // {
703
- * // "displayName": "my_displayName",
704
- * // "labels": {},
705
- * // "locationId": "my_locationId",
706
- * // "metadata": {},
707
- * // "name": "my_name"
708
- * // }
709
- * }
710
- *
711
- * main().catch(e => {
712
- * console.error(e);
713
- * throw e;
714
- * });
715
- *
716
- * ```
717
652
  *
718
653
  * @param params - Parameters for request
719
654
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -728,55 +663,6 @@ export declare namespace tpu_v2 {
728
663
  get(callback: BodyResponseCallback<Schema$Location>): void;
729
664
  /**
730
665
  * Lists information about the supported locations for this service.
731
- * @example
732
- * ```js
733
- * // Before running the sample:
734
- * // - Enable the API at:
735
- * // https://console.developers.google.com/apis/api/tpu.googleapis.com
736
- * // - Login into gcloud by running:
737
- * // `$ gcloud auth application-default login`
738
- * // - Install the npm module by running:
739
- * // `$ npm install googleapis`
740
- *
741
- * const {google} = require('googleapis');
742
- * const tpu = google.tpu('v2');
743
- *
744
- * async function main() {
745
- * const auth = new google.auth.GoogleAuth({
746
- * // Scopes can be specified either as an array or as a single, space-delimited string.
747
- * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
748
- * });
749
- *
750
- * // Acquire an auth client, and bind it to all future calls
751
- * const authClient = await auth.getClient();
752
- * google.options({auth: authClient});
753
- *
754
- * // Do the magic
755
- * const res = await tpu.projects.locations.list({
756
- * // 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).
757
- * filter: 'placeholder-value',
758
- * // The resource that owns the locations collection, if applicable.
759
- * name: 'projects/my-project',
760
- * // The maximum number of results to return. If not set, the service selects a default.
761
- * pageSize: 'placeholder-value',
762
- * // A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
763
- * pageToken: 'placeholder-value',
764
- * });
765
- * console.log(res.data);
766
- *
767
- * // Example response
768
- * // {
769
- * // "locations": [],
770
- * // "nextPageToken": "my_nextPageToken"
771
- * // }
772
- * }
773
- *
774
- * main().catch(e => {
775
- * console.error(e);
776
- * throw e;
777
- * });
778
- *
779
- * ```
780
666
  *
781
667
  * @param params - Parameters for request
782
668
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -829,49 +715,6 @@ export declare namespace tpu_v2 {
829
715
  constructor(context: APIRequestContext);
830
716
  /**
831
717
  * Gets AcceleratorType.
832
- * @example
833
- * ```js
834
- * // Before running the sample:
835
- * // - Enable the API at:
836
- * // https://console.developers.google.com/apis/api/tpu.googleapis.com
837
- * // - Login into gcloud by running:
838
- * // `$ gcloud auth application-default login`
839
- * // - Install the npm module by running:
840
- * // `$ npm install googleapis`
841
- *
842
- * const {google} = require('googleapis');
843
- * const tpu = google.tpu('v2');
844
- *
845
- * async function main() {
846
- * const auth = new google.auth.GoogleAuth({
847
- * // Scopes can be specified either as an array or as a single, space-delimited string.
848
- * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
849
- * });
850
- *
851
- * // Acquire an auth client, and bind it to all future calls
852
- * const authClient = await auth.getClient();
853
- * google.options({auth: authClient});
854
- *
855
- * // Do the magic
856
- * const res = await tpu.projects.locations.acceleratorTypes.get({
857
- * // Required. The resource name.
858
- * name: 'projects/my-project/locations/my-location/acceleratorTypes/my-acceleratorType',
859
- * });
860
- * console.log(res.data);
861
- *
862
- * // Example response
863
- * // {
864
- * // "name": "my_name",
865
- * // "type": "my_type"
866
- * // }
867
- * }
868
- *
869
- * main().catch(e => {
870
- * console.error(e);
871
- * throw e;
872
- * });
873
- *
874
- * ```
875
718
  *
876
719
  * @param params - Parameters for request
877
720
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -886,58 +729,6 @@ export declare namespace tpu_v2 {
886
729
  get(callback: BodyResponseCallback<Schema$AcceleratorType>): void;
887
730
  /**
888
731
  * Lists accelerator types supported by this API.
889
- * @example
890
- * ```js
891
- * // Before running the sample:
892
- * // - Enable the API at:
893
- * // https://console.developers.google.com/apis/api/tpu.googleapis.com
894
- * // - Login into gcloud by running:
895
- * // `$ gcloud auth application-default login`
896
- * // - Install the npm module by running:
897
- * // `$ npm install googleapis`
898
- *
899
- * const {google} = require('googleapis');
900
- * const tpu = google.tpu('v2');
901
- *
902
- * async function main() {
903
- * const auth = new google.auth.GoogleAuth({
904
- * // Scopes can be specified either as an array or as a single, space-delimited string.
905
- * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
906
- * });
907
- *
908
- * // Acquire an auth client, and bind it to all future calls
909
- * const authClient = await auth.getClient();
910
- * google.options({auth: authClient});
911
- *
912
- * // Do the magic
913
- * const res = await tpu.projects.locations.acceleratorTypes.list({
914
- * // List filter.
915
- * filter: 'placeholder-value',
916
- * // Sort results.
917
- * orderBy: 'placeholder-value',
918
- * // The maximum number of items to return.
919
- * pageSize: 'placeholder-value',
920
- * // The next_page_token value returned from a previous List request, if any.
921
- * pageToken: 'placeholder-value',
922
- * // Required. The parent resource name.
923
- * parent: 'projects/my-project/locations/my-location',
924
- * });
925
- * console.log(res.data);
926
- *
927
- * // Example response
928
- * // {
929
- * // "acceleratorTypes": [],
930
- * // "nextPageToken": "my_nextPageToken",
931
- * // "unreachable": []
932
- * // }
933
- * }
934
- *
935
- * main().catch(e => {
936
- * console.error(e);
937
- * throw e;
938
- * });
939
- *
940
- * ```
941
732
  *
942
733
  * @param params - Parameters for request
943
734
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -984,82 +775,6 @@ export declare namespace tpu_v2 {
984
775
  constructor(context: APIRequestContext);
985
776
  /**
986
777
  * Creates a node.
987
- * @example
988
- * ```js
989
- * // Before running the sample:
990
- * // - Enable the API at:
991
- * // https://console.developers.google.com/apis/api/tpu.googleapis.com
992
- * // - Login into gcloud by running:
993
- * // `$ gcloud auth application-default login`
994
- * // - Install the npm module by running:
995
- * // `$ npm install googleapis`
996
- *
997
- * const {google} = require('googleapis');
998
- * const tpu = google.tpu('v2');
999
- *
1000
- * async function main() {
1001
- * const auth = new google.auth.GoogleAuth({
1002
- * // Scopes can be specified either as an array or as a single, space-delimited string.
1003
- * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
1004
- * });
1005
- *
1006
- * // Acquire an auth client, and bind it to all future calls
1007
- * const authClient = await auth.getClient();
1008
- * google.options({auth: authClient});
1009
- *
1010
- * // Do the magic
1011
- * const res = await tpu.projects.locations.nodes.create({
1012
- * // The unqualified resource name.
1013
- * nodeId: 'placeholder-value',
1014
- * // Required. The parent resource name.
1015
- * parent: 'projects/my-project/locations/my-location',
1016
- *
1017
- * // Request body metadata
1018
- * requestBody: {
1019
- * // request body parameters
1020
- * // {
1021
- * // "acceleratorType": "my_acceleratorType",
1022
- * // "apiVersion": "my_apiVersion",
1023
- * // "cidrBlock": "my_cidrBlock",
1024
- * // "createTime": "my_createTime",
1025
- * // "dataDisks": [],
1026
- * // "description": "my_description",
1027
- * // "health": "my_health",
1028
- * // "healthDescription": "my_healthDescription",
1029
- * // "id": "my_id",
1030
- * // "labels": {},
1031
- * // "metadata": {},
1032
- * // "name": "my_name",
1033
- * // "networkConfig": {},
1034
- * // "networkEndpoints": [],
1035
- * // "runtimeVersion": "my_runtimeVersion",
1036
- * // "schedulingConfig": {},
1037
- * // "serviceAccount": {},
1038
- * // "shieldedInstanceConfig": {},
1039
- * // "state": "my_state",
1040
- * // "symptoms": [],
1041
- * // "tags": []
1042
- * // }
1043
- * },
1044
- * });
1045
- * console.log(res.data);
1046
- *
1047
- * // Example response
1048
- * // {
1049
- * // "done": false,
1050
- * // "error": {},
1051
- * // "metadata": {},
1052
- * // "name": "my_name",
1053
- * // "response": {}
1054
- * // }
1055
- * }
1056
- *
1057
- * main().catch(e => {
1058
- * console.error(e);
1059
- * throw e;
1060
- * });
1061
- *
1062
- * ```
1063
778
  *
1064
779
  * @param params - Parameters for request
1065
780
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1074,52 +789,6 @@ export declare namespace tpu_v2 {
1074
789
  create(callback: BodyResponseCallback<Schema$Operation>): void;
1075
790
  /**
1076
791
  * Deletes a node.
1077
- * @example
1078
- * ```js
1079
- * // Before running the sample:
1080
- * // - Enable the API at:
1081
- * // https://console.developers.google.com/apis/api/tpu.googleapis.com
1082
- * // - Login into gcloud by running:
1083
- * // `$ gcloud auth application-default login`
1084
- * // - Install the npm module by running:
1085
- * // `$ npm install googleapis`
1086
- *
1087
- * const {google} = require('googleapis');
1088
- * const tpu = google.tpu('v2');
1089
- *
1090
- * async function main() {
1091
- * const auth = new google.auth.GoogleAuth({
1092
- * // Scopes can be specified either as an array or as a single, space-delimited string.
1093
- * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
1094
- * });
1095
- *
1096
- * // Acquire an auth client, and bind it to all future calls
1097
- * const authClient = await auth.getClient();
1098
- * google.options({auth: authClient});
1099
- *
1100
- * // Do the magic
1101
- * const res = await tpu.projects.locations.nodes.delete({
1102
- * // Required. The resource name.
1103
- * name: 'projects/my-project/locations/my-location/nodes/my-node',
1104
- * });
1105
- * console.log(res.data);
1106
- *
1107
- * // Example response
1108
- * // {
1109
- * // "done": false,
1110
- * // "error": {},
1111
- * // "metadata": {},
1112
- * // "name": "my_name",
1113
- * // "response": {}
1114
- * // }
1115
- * }
1116
- *
1117
- * main().catch(e => {
1118
- * console.error(e);
1119
- * throw e;
1120
- * });
1121
- *
1122
- * ```
1123
792
  *
1124
793
  * @param params - Parameters for request
1125
794
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1134,68 +803,6 @@ export declare namespace tpu_v2 {
1134
803
  delete(callback: BodyResponseCallback<Schema$Operation>): void;
1135
804
  /**
1136
805
  * Gets the details of a node.
1137
- * @example
1138
- * ```js
1139
- * // Before running the sample:
1140
- * // - Enable the API at:
1141
- * // https://console.developers.google.com/apis/api/tpu.googleapis.com
1142
- * // - Login into gcloud by running:
1143
- * // `$ gcloud auth application-default login`
1144
- * // - Install the npm module by running:
1145
- * // `$ npm install googleapis`
1146
- *
1147
- * const {google} = require('googleapis');
1148
- * const tpu = google.tpu('v2');
1149
- *
1150
- * async function main() {
1151
- * const auth = new google.auth.GoogleAuth({
1152
- * // Scopes can be specified either as an array or as a single, space-delimited string.
1153
- * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
1154
- * });
1155
- *
1156
- * // Acquire an auth client, and bind it to all future calls
1157
- * const authClient = await auth.getClient();
1158
- * google.options({auth: authClient});
1159
- *
1160
- * // Do the magic
1161
- * const res = await tpu.projects.locations.nodes.get({
1162
- * // Required. The resource name.
1163
- * name: 'projects/my-project/locations/my-location/nodes/my-node',
1164
- * });
1165
- * console.log(res.data);
1166
- *
1167
- * // Example response
1168
- * // {
1169
- * // "acceleratorType": "my_acceleratorType",
1170
- * // "apiVersion": "my_apiVersion",
1171
- * // "cidrBlock": "my_cidrBlock",
1172
- * // "createTime": "my_createTime",
1173
- * // "dataDisks": [],
1174
- * // "description": "my_description",
1175
- * // "health": "my_health",
1176
- * // "healthDescription": "my_healthDescription",
1177
- * // "id": "my_id",
1178
- * // "labels": {},
1179
- * // "metadata": {},
1180
- * // "name": "my_name",
1181
- * // "networkConfig": {},
1182
- * // "networkEndpoints": [],
1183
- * // "runtimeVersion": "my_runtimeVersion",
1184
- * // "schedulingConfig": {},
1185
- * // "serviceAccount": {},
1186
- * // "shieldedInstanceConfig": {},
1187
- * // "state": "my_state",
1188
- * // "symptoms": [],
1189
- * // "tags": []
1190
- * // }
1191
- * }
1192
- *
1193
- * main().catch(e => {
1194
- * console.error(e);
1195
- * throw e;
1196
- * });
1197
- *
1198
- * ```
1199
806
  *
1200
807
  * @param params - Parameters for request
1201
808
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1210,57 +817,6 @@ export declare namespace tpu_v2 {
1210
817
  get(callback: BodyResponseCallback<Schema$Node>): void;
1211
818
  /**
1212
819
  * Retrieves the guest attributes for the node.
1213
- * @example
1214
- * ```js
1215
- * // Before running the sample:
1216
- * // - Enable the API at:
1217
- * // https://console.developers.google.com/apis/api/tpu.googleapis.com
1218
- * // - Login into gcloud by running:
1219
- * // `$ gcloud auth application-default login`
1220
- * // - Install the npm module by running:
1221
- * // `$ npm install googleapis`
1222
- *
1223
- * const {google} = require('googleapis');
1224
- * const tpu = google.tpu('v2');
1225
- *
1226
- * async function main() {
1227
- * const auth = new google.auth.GoogleAuth({
1228
- * // Scopes can be specified either as an array or as a single, space-delimited string.
1229
- * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
1230
- * });
1231
- *
1232
- * // Acquire an auth client, and bind it to all future calls
1233
- * const authClient = await auth.getClient();
1234
- * google.options({auth: authClient});
1235
- *
1236
- * // Do the magic
1237
- * const res = await tpu.projects.locations.nodes.getGuestAttributes({
1238
- * // Required. The resource name.
1239
- * name: 'projects/my-project/locations/my-location/nodes/my-node',
1240
- *
1241
- * // Request body metadata
1242
- * requestBody: {
1243
- * // request body parameters
1244
- * // {
1245
- * // "queryPath": "my_queryPath",
1246
- * // "workerIds": []
1247
- * // }
1248
- * },
1249
- * });
1250
- * console.log(res.data);
1251
- *
1252
- * // Example response
1253
- * // {
1254
- * // "guestAttributes": []
1255
- * // }
1256
- * }
1257
- *
1258
- * main().catch(e => {
1259
- * console.error(e);
1260
- * throw e;
1261
- * });
1262
- *
1263
- * ```
1264
820
  *
1265
821
  * @param params - Parameters for request
1266
822
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1275,54 +831,6 @@ export declare namespace tpu_v2 {
1275
831
  getGuestAttributes(callback: BodyResponseCallback<Schema$GetGuestAttributesResponse>): void;
1276
832
  /**
1277
833
  * Lists nodes.
1278
- * @example
1279
- * ```js
1280
- * // Before running the sample:
1281
- * // - Enable the API at:
1282
- * // https://console.developers.google.com/apis/api/tpu.googleapis.com
1283
- * // - Login into gcloud by running:
1284
- * // `$ gcloud auth application-default login`
1285
- * // - Install the npm module by running:
1286
- * // `$ npm install googleapis`
1287
- *
1288
- * const {google} = require('googleapis');
1289
- * const tpu = google.tpu('v2');
1290
- *
1291
- * async function main() {
1292
- * const auth = new google.auth.GoogleAuth({
1293
- * // Scopes can be specified either as an array or as a single, space-delimited string.
1294
- * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
1295
- * });
1296
- *
1297
- * // Acquire an auth client, and bind it to all future calls
1298
- * const authClient = await auth.getClient();
1299
- * google.options({auth: authClient});
1300
- *
1301
- * // Do the magic
1302
- * const res = await tpu.projects.locations.nodes.list({
1303
- * // The maximum number of items to return.
1304
- * pageSize: 'placeholder-value',
1305
- * // The next_page_token value returned from a previous List request, if any.
1306
- * pageToken: 'placeholder-value',
1307
- * // Required. The parent resource name.
1308
- * parent: 'projects/my-project/locations/my-location',
1309
- * });
1310
- * console.log(res.data);
1311
- *
1312
- * // Example response
1313
- * // {
1314
- * // "nextPageToken": "my_nextPageToken",
1315
- * // "nodes": [],
1316
- * // "unreachable": []
1317
- * // }
1318
- * }
1319
- *
1320
- * main().catch(e => {
1321
- * console.error(e);
1322
- * throw e;
1323
- * });
1324
- *
1325
- * ```
1326
834
  *
1327
835
  * @param params - Parameters for request
1328
836
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1337,82 +845,6 @@ export declare namespace tpu_v2 {
1337
845
  list(callback: BodyResponseCallback<Schema$ListNodesResponse>): void;
1338
846
  /**
1339
847
  * Updates the configurations of a node.
1340
- * @example
1341
- * ```js
1342
- * // Before running the sample:
1343
- * // - Enable the API at:
1344
- * // https://console.developers.google.com/apis/api/tpu.googleapis.com
1345
- * // - Login into gcloud by running:
1346
- * // `$ gcloud auth application-default login`
1347
- * // - Install the npm module by running:
1348
- * // `$ npm install googleapis`
1349
- *
1350
- * const {google} = require('googleapis');
1351
- * const tpu = google.tpu('v2');
1352
- *
1353
- * async function main() {
1354
- * const auth = new google.auth.GoogleAuth({
1355
- * // Scopes can be specified either as an array or as a single, space-delimited string.
1356
- * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
1357
- * });
1358
- *
1359
- * // Acquire an auth client, and bind it to all future calls
1360
- * const authClient = await auth.getClient();
1361
- * google.options({auth: authClient});
1362
- *
1363
- * // Do the magic
1364
- * const res = await tpu.projects.locations.nodes.patch({
1365
- * // Output only. Immutable. The name of the TPU.
1366
- * name: 'projects/my-project/locations/my-location/nodes/my-node',
1367
- * // Required. Mask of fields from Node to update. Supported fields: [description, tags, labels, metadata, network_config.enable_external_ips].
1368
- * updateMask: 'placeholder-value',
1369
- *
1370
- * // Request body metadata
1371
- * requestBody: {
1372
- * // request body parameters
1373
- * // {
1374
- * // "acceleratorType": "my_acceleratorType",
1375
- * // "apiVersion": "my_apiVersion",
1376
- * // "cidrBlock": "my_cidrBlock",
1377
- * // "createTime": "my_createTime",
1378
- * // "dataDisks": [],
1379
- * // "description": "my_description",
1380
- * // "health": "my_health",
1381
- * // "healthDescription": "my_healthDescription",
1382
- * // "id": "my_id",
1383
- * // "labels": {},
1384
- * // "metadata": {},
1385
- * // "name": "my_name",
1386
- * // "networkConfig": {},
1387
- * // "networkEndpoints": [],
1388
- * // "runtimeVersion": "my_runtimeVersion",
1389
- * // "schedulingConfig": {},
1390
- * // "serviceAccount": {},
1391
- * // "shieldedInstanceConfig": {},
1392
- * // "state": "my_state",
1393
- * // "symptoms": [],
1394
- * // "tags": []
1395
- * // }
1396
- * },
1397
- * });
1398
- * console.log(res.data);
1399
- *
1400
- * // Example response
1401
- * // {
1402
- * // "done": false,
1403
- * // "error": {},
1404
- * // "metadata": {},
1405
- * // "name": "my_name",
1406
- * // "response": {}
1407
- * // }
1408
- * }
1409
- *
1410
- * main().catch(e => {
1411
- * console.error(e);
1412
- * throw e;
1413
- * });
1414
- *
1415
- * ```
1416
848
  *
1417
849
  * @param params - Parameters for request
1418
850
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1427,58 +859,6 @@ export declare namespace tpu_v2 {
1427
859
  patch(callback: BodyResponseCallback<Schema$Operation>): void;
1428
860
  /**
1429
861
  * Starts a node.
1430
- * @example
1431
- * ```js
1432
- * // Before running the sample:
1433
- * // - Enable the API at:
1434
- * // https://console.developers.google.com/apis/api/tpu.googleapis.com
1435
- * // - Login into gcloud by running:
1436
- * // `$ gcloud auth application-default login`
1437
- * // - Install the npm module by running:
1438
- * // `$ npm install googleapis`
1439
- *
1440
- * const {google} = require('googleapis');
1441
- * const tpu = google.tpu('v2');
1442
- *
1443
- * async function main() {
1444
- * const auth = new google.auth.GoogleAuth({
1445
- * // Scopes can be specified either as an array or as a single, space-delimited string.
1446
- * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
1447
- * });
1448
- *
1449
- * // Acquire an auth client, and bind it to all future calls
1450
- * const authClient = await auth.getClient();
1451
- * google.options({auth: authClient});
1452
- *
1453
- * // Do the magic
1454
- * const res = await tpu.projects.locations.nodes.start({
1455
- * // The resource name.
1456
- * name: 'projects/my-project/locations/my-location/nodes/my-node',
1457
- *
1458
- * // Request body metadata
1459
- * requestBody: {
1460
- * // request body parameters
1461
- * // {}
1462
- * },
1463
- * });
1464
- * console.log(res.data);
1465
- *
1466
- * // Example response
1467
- * // {
1468
- * // "done": false,
1469
- * // "error": {},
1470
- * // "metadata": {},
1471
- * // "name": "my_name",
1472
- * // "response": {}
1473
- * // }
1474
- * }
1475
- *
1476
- * main().catch(e => {
1477
- * console.error(e);
1478
- * throw e;
1479
- * });
1480
- *
1481
- * ```
1482
862
  *
1483
863
  * @param params - Parameters for request
1484
864
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1493,58 +873,6 @@ export declare namespace tpu_v2 {
1493
873
  start(callback: BodyResponseCallback<Schema$Operation>): void;
1494
874
  /**
1495
875
  * Stops a node. This operation is only available with single TPU nodes.
1496
- * @example
1497
- * ```js
1498
- * // Before running the sample:
1499
- * // - Enable the API at:
1500
- * // https://console.developers.google.com/apis/api/tpu.googleapis.com
1501
- * // - Login into gcloud by running:
1502
- * // `$ gcloud auth application-default login`
1503
- * // - Install the npm module by running:
1504
- * // `$ npm install googleapis`
1505
- *
1506
- * const {google} = require('googleapis');
1507
- * const tpu = google.tpu('v2');
1508
- *
1509
- * async function main() {
1510
- * const auth = new google.auth.GoogleAuth({
1511
- * // Scopes can be specified either as an array or as a single, space-delimited string.
1512
- * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
1513
- * });
1514
- *
1515
- * // Acquire an auth client, and bind it to all future calls
1516
- * const authClient = await auth.getClient();
1517
- * google.options({auth: authClient});
1518
- *
1519
- * // Do the magic
1520
- * const res = await tpu.projects.locations.nodes.stop({
1521
- * // The resource name.
1522
- * name: 'projects/my-project/locations/my-location/nodes/my-node',
1523
- *
1524
- * // Request body metadata
1525
- * requestBody: {
1526
- * // request body parameters
1527
- * // {}
1528
- * },
1529
- * });
1530
- * console.log(res.data);
1531
- *
1532
- * // Example response
1533
- * // {
1534
- * // "done": false,
1535
- * // "error": {},
1536
- * // "metadata": {},
1537
- * // "name": "my_name",
1538
- * // "response": {}
1539
- * // }
1540
- * }
1541
- *
1542
- * main().catch(e => {
1543
- * console.error(e);
1544
- * throw e;
1545
- * });
1546
- *
1547
- * ```
1548
876
  *
1549
877
  * @param params - Parameters for request
1550
878
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1624,7 +952,7 @@ export declare namespace tpu_v2 {
1624
952
  }
1625
953
  export interface Params$Resource$Projects$Locations$Nodes$Start extends StandardParameters {
1626
954
  /**
1627
- * The resource name.
955
+ * Required. The resource name.
1628
956
  */
1629
957
  name?: string;
1630
958
  /**
@@ -1634,7 +962,7 @@ export declare namespace tpu_v2 {
1634
962
  }
1635
963
  export interface Params$Resource$Projects$Locations$Nodes$Stop extends StandardParameters {
1636
964
  /**
1637
- * The resource name.
965
+ * Required. The resource name.
1638
966
  */
1639
967
  name?: string;
1640
968
  /**
@@ -1647,46 +975,6 @@ export declare namespace tpu_v2 {
1647
975
  constructor(context: APIRequestContext);
1648
976
  /**
1649
977
  * 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`.
1650
- * @example
1651
- * ```js
1652
- * // Before running the sample:
1653
- * // - Enable the API at:
1654
- * // https://console.developers.google.com/apis/api/tpu.googleapis.com
1655
- * // - Login into gcloud by running:
1656
- * // `$ gcloud auth application-default login`
1657
- * // - Install the npm module by running:
1658
- * // `$ npm install googleapis`
1659
- *
1660
- * const {google} = require('googleapis');
1661
- * const tpu = google.tpu('v2');
1662
- *
1663
- * async function main() {
1664
- * const auth = new google.auth.GoogleAuth({
1665
- * // Scopes can be specified either as an array or as a single, space-delimited string.
1666
- * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
1667
- * });
1668
- *
1669
- * // Acquire an auth client, and bind it to all future calls
1670
- * const authClient = await auth.getClient();
1671
- * google.options({auth: authClient});
1672
- *
1673
- * // Do the magic
1674
- * const res = await tpu.projects.locations.operations.cancel({
1675
- * // The name of the operation resource to be cancelled.
1676
- * name: 'projects/my-project/locations/my-location/operations/my-operation',
1677
- * });
1678
- * console.log(res.data);
1679
- *
1680
- * // Example response
1681
- * // {}
1682
- * }
1683
- *
1684
- * main().catch(e => {
1685
- * console.error(e);
1686
- * throw e;
1687
- * });
1688
- *
1689
- * ```
1690
978
  *
1691
979
  * @param params - Parameters for request
1692
980
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1701,46 +989,6 @@ export declare namespace tpu_v2 {
1701
989
  cancel(callback: BodyResponseCallback<Schema$Empty>): void;
1702
990
  /**
1703
991
  * 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`.
1704
- * @example
1705
- * ```js
1706
- * // Before running the sample:
1707
- * // - Enable the API at:
1708
- * // https://console.developers.google.com/apis/api/tpu.googleapis.com
1709
- * // - Login into gcloud by running:
1710
- * // `$ gcloud auth application-default login`
1711
- * // - Install the npm module by running:
1712
- * // `$ npm install googleapis`
1713
- *
1714
- * const {google} = require('googleapis');
1715
- * const tpu = google.tpu('v2');
1716
- *
1717
- * async function main() {
1718
- * const auth = new google.auth.GoogleAuth({
1719
- * // Scopes can be specified either as an array or as a single, space-delimited string.
1720
- * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
1721
- * });
1722
- *
1723
- * // Acquire an auth client, and bind it to all future calls
1724
- * const authClient = await auth.getClient();
1725
- * google.options({auth: authClient});
1726
- *
1727
- * // Do the magic
1728
- * const res = await tpu.projects.locations.operations.delete({
1729
- * // The name of the operation resource to be deleted.
1730
- * name: 'projects/my-project/locations/my-location/operations/my-operation',
1731
- * });
1732
- * console.log(res.data);
1733
- *
1734
- * // Example response
1735
- * // {}
1736
- * }
1737
- *
1738
- * main().catch(e => {
1739
- * console.error(e);
1740
- * throw e;
1741
- * });
1742
- *
1743
- * ```
1744
992
  *
1745
993
  * @param params - Parameters for request
1746
994
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1755,52 +1003,6 @@ export declare namespace tpu_v2 {
1755
1003
  delete(callback: BodyResponseCallback<Schema$Empty>): void;
1756
1004
  /**
1757
1005
  * 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.
1758
- * @example
1759
- * ```js
1760
- * // Before running the sample:
1761
- * // - Enable the API at:
1762
- * // https://console.developers.google.com/apis/api/tpu.googleapis.com
1763
- * // - Login into gcloud by running:
1764
- * // `$ gcloud auth application-default login`
1765
- * // - Install the npm module by running:
1766
- * // `$ npm install googleapis`
1767
- *
1768
- * const {google} = require('googleapis');
1769
- * const tpu = google.tpu('v2');
1770
- *
1771
- * async function main() {
1772
- * const auth = new google.auth.GoogleAuth({
1773
- * // Scopes can be specified either as an array or as a single, space-delimited string.
1774
- * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
1775
- * });
1776
- *
1777
- * // Acquire an auth client, and bind it to all future calls
1778
- * const authClient = await auth.getClient();
1779
- * google.options({auth: authClient});
1780
- *
1781
- * // Do the magic
1782
- * const res = await tpu.projects.locations.operations.get({
1783
- * // The name of the operation resource.
1784
- * name: 'projects/my-project/locations/my-location/operations/my-operation',
1785
- * });
1786
- * console.log(res.data);
1787
- *
1788
- * // Example response
1789
- * // {
1790
- * // "done": false,
1791
- * // "error": {},
1792
- * // "metadata": {},
1793
- * // "name": "my_name",
1794
- * // "response": {}
1795
- * // }
1796
- * }
1797
- *
1798
- * main().catch(e => {
1799
- * console.error(e);
1800
- * throw e;
1801
- * });
1802
- *
1803
- * ```
1804
1006
  *
1805
1007
  * @param params - Parameters for request
1806
1008
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1814,56 +1016,7 @@ export declare namespace tpu_v2 {
1814
1016
  get(params: Params$Resource$Projects$Locations$Operations$Get, callback: BodyResponseCallback<Schema$Operation>): void;
1815
1017
  get(callback: BodyResponseCallback<Schema$Operation>): void;
1816
1018
  /**
1817
- * 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.
1818
- * @example
1819
- * ```js
1820
- * // Before running the sample:
1821
- * // - Enable the API at:
1822
- * // https://console.developers.google.com/apis/api/tpu.googleapis.com
1823
- * // - Login into gcloud by running:
1824
- * // `$ gcloud auth application-default login`
1825
- * // - Install the npm module by running:
1826
- * // `$ npm install googleapis`
1827
- *
1828
- * const {google} = require('googleapis');
1829
- * const tpu = google.tpu('v2');
1830
- *
1831
- * async function main() {
1832
- * const auth = new google.auth.GoogleAuth({
1833
- * // Scopes can be specified either as an array or as a single, space-delimited string.
1834
- * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
1835
- * });
1836
- *
1837
- * // Acquire an auth client, and bind it to all future calls
1838
- * const authClient = await auth.getClient();
1839
- * google.options({auth: authClient});
1840
- *
1841
- * // Do the magic
1842
- * const res = await tpu.projects.locations.operations.list({
1843
- * // The standard list filter.
1844
- * filter: 'placeholder-value',
1845
- * // The name of the operation's parent resource.
1846
- * name: 'projects/my-project/locations/my-location',
1847
- * // The standard list page size.
1848
- * pageSize: 'placeholder-value',
1849
- * // The standard list page token.
1850
- * pageToken: 'placeholder-value',
1851
- * });
1852
- * console.log(res.data);
1853
- *
1854
- * // Example response
1855
- * // {
1856
- * // "nextPageToken": "my_nextPageToken",
1857
- * // "operations": []
1858
- * // }
1859
- * }
1860
- *
1861
- * main().catch(e => {
1862
- * console.error(e);
1863
- * throw e;
1864
- * });
1865
- *
1866
- * ```
1019
+ * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
1867
1020
  *
1868
1021
  * @param params - Parameters for request
1869
1022
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1918,49 +1071,6 @@ export declare namespace tpu_v2 {
1918
1071
  constructor(context: APIRequestContext);
1919
1072
  /**
1920
1073
  * Gets a runtime version.
1921
- * @example
1922
- * ```js
1923
- * // Before running the sample:
1924
- * // - Enable the API at:
1925
- * // https://console.developers.google.com/apis/api/tpu.googleapis.com
1926
- * // - Login into gcloud by running:
1927
- * // `$ gcloud auth application-default login`
1928
- * // - Install the npm module by running:
1929
- * // `$ npm install googleapis`
1930
- *
1931
- * const {google} = require('googleapis');
1932
- * const tpu = google.tpu('v2');
1933
- *
1934
- * async function main() {
1935
- * const auth = new google.auth.GoogleAuth({
1936
- * // Scopes can be specified either as an array or as a single, space-delimited string.
1937
- * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
1938
- * });
1939
- *
1940
- * // Acquire an auth client, and bind it to all future calls
1941
- * const authClient = await auth.getClient();
1942
- * google.options({auth: authClient});
1943
- *
1944
- * // Do the magic
1945
- * const res = await tpu.projects.locations.runtimeVersions.get({
1946
- * // Required. The resource name.
1947
- * name: 'projects/my-project/locations/my-location/runtimeVersions/my-runtimeVersion',
1948
- * });
1949
- * console.log(res.data);
1950
- *
1951
- * // Example response
1952
- * // {
1953
- * // "name": "my_name",
1954
- * // "version": "my_version"
1955
- * // }
1956
- * }
1957
- *
1958
- * main().catch(e => {
1959
- * console.error(e);
1960
- * throw e;
1961
- * });
1962
- *
1963
- * ```
1964
1074
  *
1965
1075
  * @param params - Parameters for request
1966
1076
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1975,58 +1085,6 @@ export declare namespace tpu_v2 {
1975
1085
  get(callback: BodyResponseCallback<Schema$RuntimeVersion>): void;
1976
1086
  /**
1977
1087
  * Lists runtime versions supported by this API.
1978
- * @example
1979
- * ```js
1980
- * // Before running the sample:
1981
- * // - Enable the API at:
1982
- * // https://console.developers.google.com/apis/api/tpu.googleapis.com
1983
- * // - Login into gcloud by running:
1984
- * // `$ gcloud auth application-default login`
1985
- * // - Install the npm module by running:
1986
- * // `$ npm install googleapis`
1987
- *
1988
- * const {google} = require('googleapis');
1989
- * const tpu = google.tpu('v2');
1990
- *
1991
- * async function main() {
1992
- * const auth = new google.auth.GoogleAuth({
1993
- * // Scopes can be specified either as an array or as a single, space-delimited string.
1994
- * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
1995
- * });
1996
- *
1997
- * // Acquire an auth client, and bind it to all future calls
1998
- * const authClient = await auth.getClient();
1999
- * google.options({auth: authClient});
2000
- *
2001
- * // Do the magic
2002
- * const res = await tpu.projects.locations.runtimeVersions.list({
2003
- * // List filter.
2004
- * filter: 'placeholder-value',
2005
- * // Sort results.
2006
- * orderBy: 'placeholder-value',
2007
- * // The maximum number of items to return.
2008
- * pageSize: 'placeholder-value',
2009
- * // The next_page_token value returned from a previous List request, if any.
2010
- * pageToken: 'placeholder-value',
2011
- * // Required. The parent resource name.
2012
- * parent: 'projects/my-project/locations/my-location',
2013
- * });
2014
- * console.log(res.data);
2015
- *
2016
- * // Example response
2017
- * // {
2018
- * // "nextPageToken": "my_nextPageToken",
2019
- * // "runtimeVersions": [],
2020
- * // "unreachable": []
2021
- * // }
2022
- * }
2023
- *
2024
- * main().catch(e => {
2025
- * console.error(e);
2026
- * throw e;
2027
- * });
2028
- *
2029
- * ```
2030
1088
  *
2031
1089
  * @param params - Parameters for request
2032
1090
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.