@googleapis/tpu 1.1.0 → 2.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.
@@ -71,19 +71,41 @@ export declare namespace tpu_v2alpha1 {
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
  }
104
+ /**
105
+ * Further data for the accepted state.
106
+ */
107
+ export interface Schema$AcceptedData {
108
+ }
87
109
  /**
88
110
  * An access config attached to the TPU worker.
89
111
  */
@@ -93,6 +115,11 @@ export declare namespace tpu_v2alpha1 {
93
115
  */
94
116
  externalIp?: string | null;
95
117
  }
118
+ /**
119
+ * Further data for the active state.
120
+ */
121
+ export interface Schema$ActiveData {
122
+ }
96
123
  /**
97
124
  * A node-attached disk resource. Next ID: 8;
98
125
  */
@@ -106,11 +133,35 @@ export declare namespace tpu_v2alpha1 {
106
133
  */
107
134
  sourceDisk?: string | null;
108
135
  }
136
+ /**
137
+ * BestEffort tier definition.
138
+ */
139
+ export interface Schema$BestEffort {
140
+ }
141
+ /**
142
+ * Further data for the creating state.
143
+ */
144
+ export interface Schema$CreatingData {
145
+ }
146
+ /**
147
+ * Further data for the deleting state.
148
+ */
149
+ export interface Schema$DeletingData {
150
+ }
109
151
  /**
110
152
  * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); \}
111
153
  */
112
154
  export interface Schema$Empty {
113
155
  }
156
+ /**
157
+ * Further data for the failed state.
158
+ */
159
+ export interface Schema$FailedData {
160
+ /**
161
+ * The error that caused the queued resource to enter the FAILED state.
162
+ */
163
+ error?: Schema$Status;
164
+ }
114
165
  /**
115
166
  * Request for GenerateServiceIdentity.
116
167
  */
@@ -147,6 +198,19 @@ export declare namespace tpu_v2alpha1 {
147
198
  */
148
199
  guestAttributes?: Schema$GuestAttributes[];
149
200
  }
201
+ /**
202
+ * Guaranteed tier definition.
203
+ */
204
+ export interface Schema$Guaranteed {
205
+ /**
206
+ * Optional. Defines the minimum duration of the guarantee. If specified, the requested resources will only be provisioned if they can be allocated for at least the given duration.
207
+ */
208
+ minDuration?: string | null;
209
+ /**
210
+ * Optional. Specifies the request should be scheduled on reserved capacity.
211
+ */
212
+ reserved?: boolean | null;
213
+ }
150
214
  /**
151
215
  * A guest attributes.
152
216
  */
@@ -186,6 +250,19 @@ export declare namespace tpu_v2alpha1 {
186
250
  */
187
251
  items?: Schema$GuestAttributesEntry[];
188
252
  }
253
+ /**
254
+ * Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time.
255
+ */
256
+ export interface Schema$Interval {
257
+ /**
258
+ * Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
259
+ */
260
+ endTime?: string | null;
261
+ /**
262
+ * Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
263
+ */
264
+ startTime?: string | null;
265
+ }
189
266
  /**
190
267
  * Response for ListAcceleratorTypes.
191
268
  */
@@ -246,6 +323,23 @@ export declare namespace tpu_v2alpha1 {
246
323
  */
247
324
  operations?: Schema$Operation[];
248
325
  }
326
+ /**
327
+ * Response for ListQueuedResources.
328
+ */
329
+ export interface Schema$ListQueuedResourcesResponse {
330
+ /**
331
+ * The next page token or empty if none.
332
+ */
333
+ nextPageToken?: string | null;
334
+ /**
335
+ * The listed queued resources.
336
+ */
337
+ queuedResources?: Schema$QueuedResource[];
338
+ /**
339
+ * Locations that could not be reached.
340
+ */
341
+ unreachable?: string[] | null;
342
+ }
249
343
  /**
250
344
  * Response for ListRuntimeVersions.
251
345
  */
@@ -264,7 +358,7 @@ export declare namespace tpu_v2alpha1 {
264
358
  unreachable?: string[] | null;
265
359
  }
266
360
  /**
267
- * A resource that represents Google Cloud Platform location.
361
+ * A resource that represents a Google Cloud location.
268
362
  */
269
363
  export interface Schema$Location {
270
364
  /**
@@ -292,6 +386,19 @@ export declare namespace tpu_v2alpha1 {
292
386
  */
293
387
  name?: string | null;
294
388
  }
389
+ /**
390
+ * Parameters to specify for multi-node QueuedResource requests. This field must be populated in case of multi-node requests instead of node_id. It's an error to specify both node_id and multi_node_params.
391
+ */
392
+ export interface Schema$MultiNodeParams {
393
+ /**
394
+ * Required. Number of nodes with this spec. The system will attempt to provison "node_count" nodes as part of the request. This needs to be \> 1.
395
+ */
396
+ nodeCount?: number | null;
397
+ /**
398
+ * Prefix of node_ids in case of multi-node request Should follow the `^[A-Za-z0-9_.~+%-]+$` regex format. If node_count = 3 and node_id_prefix = "np", node ids of nodes created will be "np-0", "np-1", "np-2". If this field is not provided we use queued_resource_id as the node_id_prefix.
399
+ */
400
+ nodeIdPrefix?: string | null;
401
+ }
295
402
  /**
296
403
  * Network related configurations.
297
404
  */
@@ -334,6 +441,10 @@ export declare namespace tpu_v2alpha1 {
334
441
  * A TPU instance.
335
442
  */
336
443
  export interface Schema$Node {
444
+ /**
445
+ * The AccleratorConfig for the TPU Node.
446
+ */
447
+ acceleratorConfig?: Schema$AcceleratorConfig;
337
448
  /**
338
449
  * The type of hardware accelerators associated with this node.
339
450
  */
@@ -382,6 +493,10 @@ export declare namespace tpu_v2alpha1 {
382
493
  metadata?: {
383
494
  [key: string]: string;
384
495
  } | null;
496
+ /**
497
+ * Output only. Whether the Node belongs to a Multislice group.
498
+ */
499
+ multisliceNode?: boolean | null;
385
500
  /**
386
501
  * Output only. Immutable. The name of the TPU.
387
502
  */
@@ -394,6 +509,10 @@ export declare namespace tpu_v2alpha1 {
394
509
  * 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
510
  */
396
511
  networkEndpoints?: Schema$NetworkEndpoint[];
512
+ /**
513
+ * Output only. The qualified name of the QueuedResource that requested this Node.
514
+ */
515
+ queuedResource?: string | null;
397
516
  /**
398
517
  * Required. The runtime version running in the Node.
399
518
  */
@@ -406,6 +525,10 @@ export declare namespace tpu_v2alpha1 {
406
525
  * The Google Cloud Platform Service Account to be used by the TPU node VMs. If None is specified, the default compute service account will be used.
407
526
  */
408
527
  serviceAccount?: Schema$ServiceAccount;
528
+ /**
529
+ * Shielded Instance options.
530
+ */
531
+ shieldedInstanceConfig?: Schema$ShieldedInstanceConfig;
409
532
  /**
410
533
  * Output only. The current state for the TPU Node.
411
534
  */
@@ -419,6 +542,27 @@ export declare namespace tpu_v2alpha1 {
419
542
  */
420
543
  tags?: string[] | null;
421
544
  }
545
+ /**
546
+ * Details of the TPU node(s) being requested. Users can request either a single node or multiple nodes. NodeSpec provides the specification for node(s) to be created.
547
+ */
548
+ export interface Schema$NodeSpec {
549
+ /**
550
+ * Optional. Fields to specify in case of multi-node request.
551
+ */
552
+ multiNodeParams?: Schema$MultiNodeParams;
553
+ /**
554
+ * Required. The node.
555
+ */
556
+ node?: Schema$Node;
557
+ /**
558
+ * The unqualified resource name. Should follow the `^[A-Za-z0-9_.~+%-]+$` regex format. This is only specified when requesting a single node. In case of multi-node requests, multi_node_params must be populated instead. It's an error to specify both node_id and multi_node_params.
559
+ */
560
+ nodeId?: string | null;
561
+ /**
562
+ * Required. The parent resource name.
563
+ */
564
+ parent?: string | null;
565
+ }
422
566
  /**
423
567
  * This resource represents a long-running operation that is the result of a network API call.
424
568
  */
@@ -442,7 +586,7 @@ export declare namespace tpu_v2alpha1 {
442
586
  */
443
587
  name?: string | null;
444
588
  /**
445
- * 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`.
589
+ * 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`.
446
590
  */
447
591
  response?: {
448
592
  [key: string]: any;
@@ -481,6 +625,123 @@ export declare namespace tpu_v2alpha1 {
481
625
  */
482
626
  verb?: string | null;
483
627
  }
628
+ /**
629
+ * Further data for the provisioning state.
630
+ */
631
+ export interface Schema$ProvisioningData {
632
+ }
633
+ /**
634
+ * A QueuedResource represents a request for resources that will be placed in a queue and fulfilled when the necessary resources are available.
635
+ */
636
+ export interface Schema$QueuedResource {
637
+ /**
638
+ * The BestEffort tier.
639
+ */
640
+ bestEffort?: Schema$BestEffort;
641
+ /**
642
+ * The Guaranteed tier.
643
+ */
644
+ guaranteed?: Schema$Guaranteed;
645
+ /**
646
+ * Output only. Immutable. The name of the QueuedResource.
647
+ */
648
+ name?: string | null;
649
+ /**
650
+ * The queueing policy of the QueuedRequest.
651
+ */
652
+ queueingPolicy?: Schema$QueueingPolicy;
653
+ /**
654
+ * Name of the reservation in which the resource should be provisioned. Format: projects/{project\}/locations/{zone\}/reservations/{reservation\}
655
+ */
656
+ reservationName?: string | null;
657
+ /**
658
+ * Optional. The Spot tier.
659
+ */
660
+ spot?: Schema$Spot;
661
+ /**
662
+ * Output only. State of the QueuedResource request.
663
+ */
664
+ state?: Schema$QueuedResourceState;
665
+ /**
666
+ * Defines a TPU resource.
667
+ */
668
+ tpu?: Schema$Tpu;
669
+ }
670
+ /**
671
+ * QueuedResourceState defines the details of the QueuedResource request.
672
+ */
673
+ export interface Schema$QueuedResourceState {
674
+ /**
675
+ * Further data for the accepted state.
676
+ */
677
+ acceptedData?: Schema$AcceptedData;
678
+ /**
679
+ * Further data for the active state.
680
+ */
681
+ activeData?: Schema$ActiveData;
682
+ /**
683
+ * Further data for the creating state.
684
+ */
685
+ creatingData?: Schema$CreatingData;
686
+ /**
687
+ * Further data for the deleting state.
688
+ */
689
+ deletingData?: Schema$DeletingData;
690
+ /**
691
+ * Further data for the failed state.
692
+ */
693
+ failedData?: Schema$FailedData;
694
+ /**
695
+ * Further data for the provisioning state.
696
+ */
697
+ provisioningData?: Schema$ProvisioningData;
698
+ /**
699
+ * State of the QueuedResource request.
700
+ */
701
+ state?: string | null;
702
+ /**
703
+ * Output only. The initiator of the QueuedResources's current state.
704
+ */
705
+ stateInitiator?: string | null;
706
+ /**
707
+ * Further data for the suspended state.
708
+ */
709
+ suspendedData?: Schema$SuspendedData;
710
+ /**
711
+ * Further data for the suspending state.
712
+ */
713
+ suspendingData?: Schema$SuspendingData;
714
+ }
715
+ /**
716
+ * Defines the policy of the QueuedRequest.
717
+ */
718
+ export interface Schema$QueueingPolicy {
719
+ /**
720
+ * A relative time after which resources may be created.
721
+ */
722
+ validAfterDuration?: string | null;
723
+ /**
724
+ * An absolute time at which resources may be created.
725
+ */
726
+ validAfterTime?: string | null;
727
+ /**
728
+ * An absolute time interval within which resources may be created.
729
+ */
730
+ validInterval?: Schema$Interval;
731
+ /**
732
+ * A relative time after which resources should not be created. If the request cannot be fulfilled by this time the request will be failed.
733
+ */
734
+ validUntilDuration?: string | null;
735
+ /**
736
+ * An absolute time after which resources should not be created. If the request cannot be fulfilled by this time the request will be failed.
737
+ */
738
+ validUntilTime?: string | null;
739
+ }
740
+ /**
741
+ * Request for ResetQueuedResource.
742
+ */
743
+ export interface Schema$ResetQueuedResourceRequest {
744
+ }
484
745
  /**
485
746
  * A runtime version that a Node can be configured with.
486
747
  */
@@ -529,6 +790,15 @@ export declare namespace tpu_v2alpha1 {
529
790
  */
530
791
  email?: string | null;
531
792
  }
793
+ /**
794
+ * A set of Shielded Instance options.
795
+ */
796
+ export interface Schema$ShieldedInstanceConfig {
797
+ /**
798
+ * Defines whether the instance has Secure Boot enabled.
799
+ */
800
+ enableSecureBoot?: boolean | null;
801
+ }
532
802
  /**
533
803
  * Request for SimulateMaintenanceEvent.
534
804
  */
@@ -538,6 +808,11 @@ export declare namespace tpu_v2alpha1 {
538
808
  */
539
809
  workerIds?: string[] | null;
540
810
  }
811
+ /**
812
+ * Spot tier definition.
813
+ */
814
+ export interface Schema$Spot {
815
+ }
541
816
  /**
542
817
  * Request for StartNode.
543
818
  */
@@ -567,6 +842,16 @@ export declare namespace tpu_v2alpha1 {
567
842
  */
568
843
  export interface Schema$StopNodeRequest {
569
844
  }
845
+ /**
846
+ * Further data for the suspended state.
847
+ */
848
+ export interface Schema$SuspendedData {
849
+ }
850
+ /**
851
+ * Further data for the suspending state.
852
+ */
853
+ export interface Schema$SuspendingData {
854
+ }
570
855
  /**
571
856
  * A Symptom instance.
572
857
  */
@@ -588,6 +873,15 @@ export declare namespace tpu_v2alpha1 {
588
873
  */
589
874
  workerId?: string | null;
590
875
  }
876
+ /**
877
+ * Details of the TPU resource(s) being requested.
878
+ */
879
+ export interface Schema$Tpu {
880
+ /**
881
+ * The TPU node(s) being requested.
882
+ */
883
+ nodeSpec?: Schema$NodeSpec[];
884
+ }
591
885
  export class Resource$Projects {
592
886
  context: APIRequestContext;
593
887
  locations: Resource$Projects$Locations;
@@ -598,58 +892,11 @@ export declare namespace tpu_v2alpha1 {
598
892
  acceleratorTypes: Resource$Projects$Locations$Acceleratortypes;
599
893
  nodes: Resource$Projects$Locations$Nodes;
600
894
  operations: Resource$Projects$Locations$Operations;
895
+ queuedResources: Resource$Projects$Locations$Queuedresources;
601
896
  runtimeVersions: Resource$Projects$Locations$Runtimeversions;
602
897
  constructor(context: APIRequestContext);
603
898
  /**
604
899
  * Generates the Cloud TPU service identity for the project.
605
- * @example
606
- * ```js
607
- * // Before running the sample:
608
- * // - Enable the API at:
609
- * // https://console.developers.google.com/apis/api/tpu.googleapis.com
610
- * // - Login into gcloud by running:
611
- * // `$ gcloud auth application-default login`
612
- * // - Install the npm module by running:
613
- * // `$ npm install googleapis`
614
- *
615
- * const {google} = require('googleapis');
616
- * const tpu = google.tpu('v2alpha1');
617
- *
618
- * async function main() {
619
- * const auth = new google.auth.GoogleAuth({
620
- * // Scopes can be specified either as an array or as a single, space-delimited string.
621
- * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
622
- * });
623
- *
624
- * // Acquire an auth client, and bind it to all future calls
625
- * const authClient = await auth.getClient();
626
- * google.options({auth: authClient});
627
- *
628
- * // Do the magic
629
- * const res = await tpu.projects.locations.generateServiceIdentity({
630
- * // Required. The parent resource name.
631
- * parent: 'projects/my-project/locations/my-location',
632
- *
633
- * // Request body metadata
634
- * requestBody: {
635
- * // request body parameters
636
- * // {}
637
- * },
638
- * });
639
- * console.log(res.data);
640
- *
641
- * // Example response
642
- * // {
643
- * // "identity": {}
644
- * // }
645
- * }
646
- *
647
- * main().catch(e => {
648
- * console.error(e);
649
- * throw e;
650
- * });
651
- *
652
- * ```
653
900
  *
654
901
  * @param params - Parameters for request
655
902
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -664,52 +911,6 @@ export declare namespace tpu_v2alpha1 {
664
911
  generateServiceIdentity(callback: BodyResponseCallback<Schema$GenerateServiceIdentityResponse>): void;
665
912
  /**
666
913
  * Gets information about a location.
667
- * @example
668
- * ```js
669
- * // Before running the sample:
670
- * // - Enable the API at:
671
- * // https://console.developers.google.com/apis/api/tpu.googleapis.com
672
- * // - Login into gcloud by running:
673
- * // `$ gcloud auth application-default login`
674
- * // - Install the npm module by running:
675
- * // `$ npm install googleapis`
676
- *
677
- * const {google} = require('googleapis');
678
- * const tpu = google.tpu('v2alpha1');
679
- *
680
- * async function main() {
681
- * const auth = new google.auth.GoogleAuth({
682
- * // Scopes can be specified either as an array or as a single, space-delimited string.
683
- * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
684
- * });
685
- *
686
- * // Acquire an auth client, and bind it to all future calls
687
- * const authClient = await auth.getClient();
688
- * google.options({auth: authClient});
689
- *
690
- * // Do the magic
691
- * const res = await tpu.projects.locations.get({
692
- * // Resource name for the location.
693
- * name: 'projects/my-project/locations/my-location',
694
- * });
695
- * console.log(res.data);
696
- *
697
- * // Example response
698
- * // {
699
- * // "displayName": "my_displayName",
700
- * // "labels": {},
701
- * // "locationId": "my_locationId",
702
- * // "metadata": {},
703
- * // "name": "my_name"
704
- * // }
705
- * }
706
- *
707
- * main().catch(e => {
708
- * console.error(e);
709
- * throw e;
710
- * });
711
- *
712
- * ```
713
914
  *
714
915
  * @param params - Parameters for request
715
916
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -724,55 +925,6 @@ export declare namespace tpu_v2alpha1 {
724
925
  get(callback: BodyResponseCallback<Schema$Location>): void;
725
926
  /**
726
927
  * Lists information about the supported locations for this service.
727
- * @example
728
- * ```js
729
- * // Before running the sample:
730
- * // - Enable the API at:
731
- * // https://console.developers.google.com/apis/api/tpu.googleapis.com
732
- * // - Login into gcloud by running:
733
- * // `$ gcloud auth application-default login`
734
- * // - Install the npm module by running:
735
- * // `$ npm install googleapis`
736
- *
737
- * const {google} = require('googleapis');
738
- * const tpu = google.tpu('v2alpha1');
739
- *
740
- * async function main() {
741
- * const auth = new google.auth.GoogleAuth({
742
- * // Scopes can be specified either as an array or as a single, space-delimited string.
743
- * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
744
- * });
745
- *
746
- * // Acquire an auth client, and bind it to all future calls
747
- * const authClient = await auth.getClient();
748
- * google.options({auth: authClient});
749
- *
750
- * // Do the magic
751
- * const res = await tpu.projects.locations.list({
752
- * // 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).
753
- * filter: 'placeholder-value',
754
- * // The resource that owns the locations collection, if applicable.
755
- * name: 'projects/my-project',
756
- * // The maximum number of results to return. If not set, the service selects a default.
757
- * pageSize: 'placeholder-value',
758
- * // A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
759
- * pageToken: 'placeholder-value',
760
- * });
761
- * console.log(res.data);
762
- *
763
- * // Example response
764
- * // {
765
- * // "locations": [],
766
- * // "nextPageToken": "my_nextPageToken"
767
- * // }
768
- * }
769
- *
770
- * main().catch(e => {
771
- * console.error(e);
772
- * throw e;
773
- * });
774
- *
775
- * ```
776
928
  *
777
929
  * @param params - Parameters for request
778
930
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -825,49 +977,6 @@ export declare namespace tpu_v2alpha1 {
825
977
  constructor(context: APIRequestContext);
826
978
  /**
827
979
  * Gets AcceleratorType.
828
- * @example
829
- * ```js
830
- * // Before running the sample:
831
- * // - Enable the API at:
832
- * // https://console.developers.google.com/apis/api/tpu.googleapis.com
833
- * // - Login into gcloud by running:
834
- * // `$ gcloud auth application-default login`
835
- * // - Install the npm module by running:
836
- * // `$ npm install googleapis`
837
- *
838
- * const {google} = require('googleapis');
839
- * const tpu = google.tpu('v2alpha1');
840
- *
841
- * async function main() {
842
- * const auth = new google.auth.GoogleAuth({
843
- * // Scopes can be specified either as an array or as a single, space-delimited string.
844
- * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
845
- * });
846
- *
847
- * // Acquire an auth client, and bind it to all future calls
848
- * const authClient = await auth.getClient();
849
- * google.options({auth: authClient});
850
- *
851
- * // Do the magic
852
- * const res = await tpu.projects.locations.acceleratorTypes.get({
853
- * // Required. The resource name.
854
- * name: 'projects/my-project/locations/my-location/acceleratorTypes/my-acceleratorType',
855
- * });
856
- * console.log(res.data);
857
- *
858
- * // Example response
859
- * // {
860
- * // "name": "my_name",
861
- * // "type": "my_type"
862
- * // }
863
- * }
864
- *
865
- * main().catch(e => {
866
- * console.error(e);
867
- * throw e;
868
- * });
869
- *
870
- * ```
871
980
  *
872
981
  * @param params - Parameters for request
873
982
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -882,58 +991,6 @@ export declare namespace tpu_v2alpha1 {
882
991
  get(callback: BodyResponseCallback<Schema$AcceleratorType>): void;
883
992
  /**
884
993
  * Lists accelerator types supported by this API.
885
- * @example
886
- * ```js
887
- * // Before running the sample:
888
- * // - Enable the API at:
889
- * // https://console.developers.google.com/apis/api/tpu.googleapis.com
890
- * // - Login into gcloud by running:
891
- * // `$ gcloud auth application-default login`
892
- * // - Install the npm module by running:
893
- * // `$ npm install googleapis`
894
- *
895
- * const {google} = require('googleapis');
896
- * const tpu = google.tpu('v2alpha1');
897
- *
898
- * async function main() {
899
- * const auth = new google.auth.GoogleAuth({
900
- * // Scopes can be specified either as an array or as a single, space-delimited string.
901
- * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
902
- * });
903
- *
904
- * // Acquire an auth client, and bind it to all future calls
905
- * const authClient = await auth.getClient();
906
- * google.options({auth: authClient});
907
- *
908
- * // Do the magic
909
- * const res = await tpu.projects.locations.acceleratorTypes.list({
910
- * // List filter.
911
- * filter: 'placeholder-value',
912
- * // Sort results.
913
- * orderBy: 'placeholder-value',
914
- * // The maximum number of items to return.
915
- * pageSize: 'placeholder-value',
916
- * // The next_page_token value returned from a previous List request, if any.
917
- * pageToken: 'placeholder-value',
918
- * // Required. The parent resource name.
919
- * parent: 'projects/my-project/locations/my-location',
920
- * });
921
- * console.log(res.data);
922
- *
923
- * // Example response
924
- * // {
925
- * // "acceleratorTypes": [],
926
- * // "nextPageToken": "my_nextPageToken",
927
- * // "unreachable": []
928
- * // }
929
- * }
930
- *
931
- * main().catch(e => {
932
- * console.error(e);
933
- * throw e;
934
- * });
935
- *
936
- * ```
937
994
  *
938
995
  * @param params - Parameters for request
939
996
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -980,83 +1037,6 @@ export declare namespace tpu_v2alpha1 {
980
1037
  constructor(context: APIRequestContext);
981
1038
  /**
982
1039
  * Creates a node.
983
- * @example
984
- * ```js
985
- * // Before running the sample:
986
- * // - Enable the API at:
987
- * // https://console.developers.google.com/apis/api/tpu.googleapis.com
988
- * // - Login into gcloud by running:
989
- * // `$ gcloud auth application-default login`
990
- * // - Install the npm module by running:
991
- * // `$ npm install googleapis`
992
- *
993
- * const {google} = require('googleapis');
994
- * const tpu = google.tpu('v2alpha1');
995
- *
996
- * async function main() {
997
- * const auth = new google.auth.GoogleAuth({
998
- * // Scopes can be specified either as an array or as a single, space-delimited string.
999
- * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
1000
- * });
1001
- *
1002
- * // Acquire an auth client, and bind it to all future calls
1003
- * const authClient = await auth.getClient();
1004
- * google.options({auth: authClient});
1005
- *
1006
- * // Do the magic
1007
- * const res = await tpu.projects.locations.nodes.create({
1008
- * // The unqualified resource name.
1009
- * nodeId: 'placeholder-value',
1010
- * // Required. The parent resource name.
1011
- * parent: 'projects/my-project/locations/my-location',
1012
- * // Idempotent request UUID.
1013
- * requestId: 'placeholder-value',
1014
- *
1015
- * // Request body metadata
1016
- * requestBody: {
1017
- * // request body parameters
1018
- * // {
1019
- * // "acceleratorType": "my_acceleratorType",
1020
- * // "apiVersion": "my_apiVersion",
1021
- * // "cidrBlock": "my_cidrBlock",
1022
- * // "createTime": "my_createTime",
1023
- * // "dataDisks": [],
1024
- * // "description": "my_description",
1025
- * // "health": "my_health",
1026
- * // "healthDescription": "my_healthDescription",
1027
- * // "id": "my_id",
1028
- * // "labels": {},
1029
- * // "metadata": {},
1030
- * // "name": "my_name",
1031
- * // "networkConfig": {},
1032
- * // "networkEndpoints": [],
1033
- * // "runtimeVersion": "my_runtimeVersion",
1034
- * // "schedulingConfig": {},
1035
- * // "serviceAccount": {},
1036
- * // "state": "my_state",
1037
- * // "symptoms": [],
1038
- * // "tags": []
1039
- * // }
1040
- * },
1041
- * });
1042
- * console.log(res.data);
1043
- *
1044
- * // Example response
1045
- * // {
1046
- * // "done": false,
1047
- * // "error": {},
1048
- * // "metadata": {},
1049
- * // "name": "my_name",
1050
- * // "response": {}
1051
- * // }
1052
- * }
1053
- *
1054
- * main().catch(e => {
1055
- * console.error(e);
1056
- * throw e;
1057
- * });
1058
- *
1059
- * ```
1060
1040
  *
1061
1041
  * @param params - Parameters for request
1062
1042
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1071,54 +1051,6 @@ export declare namespace tpu_v2alpha1 {
1071
1051
  create(callback: BodyResponseCallback<Schema$Operation>): void;
1072
1052
  /**
1073
1053
  * Deletes a node.
1074
- * @example
1075
- * ```js
1076
- * // Before running the sample:
1077
- * // - Enable the API at:
1078
- * // https://console.developers.google.com/apis/api/tpu.googleapis.com
1079
- * // - Login into gcloud by running:
1080
- * // `$ gcloud auth application-default login`
1081
- * // - Install the npm module by running:
1082
- * // `$ npm install googleapis`
1083
- *
1084
- * const {google} = require('googleapis');
1085
- * const tpu = google.tpu('v2alpha1');
1086
- *
1087
- * async function main() {
1088
- * const auth = new google.auth.GoogleAuth({
1089
- * // Scopes can be specified either as an array or as a single, space-delimited string.
1090
- * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
1091
- * });
1092
- *
1093
- * // Acquire an auth client, and bind it to all future calls
1094
- * const authClient = await auth.getClient();
1095
- * google.options({auth: authClient});
1096
- *
1097
- * // Do the magic
1098
- * const res = await tpu.projects.locations.nodes.delete({
1099
- * // Required. The resource name.
1100
- * name: 'projects/my-project/locations/my-location/nodes/my-node',
1101
- * // Idempotent request UUID.
1102
- * requestId: 'placeholder-value',
1103
- * });
1104
- * console.log(res.data);
1105
- *
1106
- * // Example response
1107
- * // {
1108
- * // "done": false,
1109
- * // "error": {},
1110
- * // "metadata": {},
1111
- * // "name": "my_name",
1112
- * // "response": {}
1113
- * // }
1114
- * }
1115
- *
1116
- * main().catch(e => {
1117
- * console.error(e);
1118
- * throw e;
1119
- * });
1120
- *
1121
- * ```
1122
1054
  *
1123
1055
  * @param params - Parameters for request
1124
1056
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1133,67 +1065,6 @@ export declare namespace tpu_v2alpha1 {
1133
1065
  delete(callback: BodyResponseCallback<Schema$Operation>): void;
1134
1066
  /**
1135
1067
  * Gets the details of a node.
1136
- * @example
1137
- * ```js
1138
- * // Before running the sample:
1139
- * // - Enable the API at:
1140
- * // https://console.developers.google.com/apis/api/tpu.googleapis.com
1141
- * // - Login into gcloud by running:
1142
- * // `$ gcloud auth application-default login`
1143
- * // - Install the npm module by running:
1144
- * // `$ npm install googleapis`
1145
- *
1146
- * const {google} = require('googleapis');
1147
- * const tpu = google.tpu('v2alpha1');
1148
- *
1149
- * async function main() {
1150
- * const auth = new google.auth.GoogleAuth({
1151
- * // Scopes can be specified either as an array or as a single, space-delimited string.
1152
- * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
1153
- * });
1154
- *
1155
- * // Acquire an auth client, and bind it to all future calls
1156
- * const authClient = await auth.getClient();
1157
- * google.options({auth: authClient});
1158
- *
1159
- * // Do the magic
1160
- * const res = await tpu.projects.locations.nodes.get({
1161
- * // Required. The resource name.
1162
- * name: 'projects/my-project/locations/my-location/nodes/my-node',
1163
- * });
1164
- * console.log(res.data);
1165
- *
1166
- * // Example response
1167
- * // {
1168
- * // "acceleratorType": "my_acceleratorType",
1169
- * // "apiVersion": "my_apiVersion",
1170
- * // "cidrBlock": "my_cidrBlock",
1171
- * // "createTime": "my_createTime",
1172
- * // "dataDisks": [],
1173
- * // "description": "my_description",
1174
- * // "health": "my_health",
1175
- * // "healthDescription": "my_healthDescription",
1176
- * // "id": "my_id",
1177
- * // "labels": {},
1178
- * // "metadata": {},
1179
- * // "name": "my_name",
1180
- * // "networkConfig": {},
1181
- * // "networkEndpoints": [],
1182
- * // "runtimeVersion": "my_runtimeVersion",
1183
- * // "schedulingConfig": {},
1184
- * // "serviceAccount": {},
1185
- * // "state": "my_state",
1186
- * // "symptoms": [],
1187
- * // "tags": []
1188
- * // }
1189
- * }
1190
- *
1191
- * main().catch(e => {
1192
- * console.error(e);
1193
- * throw e;
1194
- * });
1195
- *
1196
- * ```
1197
1068
  *
1198
1069
  * @param params - Parameters for request
1199
1070
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1208,57 +1079,6 @@ export declare namespace tpu_v2alpha1 {
1208
1079
  get(callback: BodyResponseCallback<Schema$Node>): void;
1209
1080
  /**
1210
1081
  * Retrieves the guest attributes for the node.
1211
- * @example
1212
- * ```js
1213
- * // Before running the sample:
1214
- * // - Enable the API at:
1215
- * // https://console.developers.google.com/apis/api/tpu.googleapis.com
1216
- * // - Login into gcloud by running:
1217
- * // `$ gcloud auth application-default login`
1218
- * // - Install the npm module by running:
1219
- * // `$ npm install googleapis`
1220
- *
1221
- * const {google} = require('googleapis');
1222
- * const tpu = google.tpu('v2alpha1');
1223
- *
1224
- * async function main() {
1225
- * const auth = new google.auth.GoogleAuth({
1226
- * // Scopes can be specified either as an array or as a single, space-delimited string.
1227
- * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
1228
- * });
1229
- *
1230
- * // Acquire an auth client, and bind it to all future calls
1231
- * const authClient = await auth.getClient();
1232
- * google.options({auth: authClient});
1233
- *
1234
- * // Do the magic
1235
- * const res = await tpu.projects.locations.nodes.getGuestAttributes({
1236
- * // Required. The resource name.
1237
- * name: 'projects/my-project/locations/my-location/nodes/my-node',
1238
- *
1239
- * // Request body metadata
1240
- * requestBody: {
1241
- * // request body parameters
1242
- * // {
1243
- * // "queryPath": "my_queryPath",
1244
- * // "workerIds": []
1245
- * // }
1246
- * },
1247
- * });
1248
- * console.log(res.data);
1249
- *
1250
- * // Example response
1251
- * // {
1252
- * // "guestAttributes": []
1253
- * // }
1254
- * }
1255
- *
1256
- * main().catch(e => {
1257
- * console.error(e);
1258
- * throw e;
1259
- * });
1260
- *
1261
- * ```
1262
1082
  *
1263
1083
  * @param params - Parameters for request
1264
1084
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1273,54 +1093,6 @@ export declare namespace tpu_v2alpha1 {
1273
1093
  getGuestAttributes(callback: BodyResponseCallback<Schema$GetGuestAttributesResponse>): void;
1274
1094
  /**
1275
1095
  * Lists nodes.
1276
- * @example
1277
- * ```js
1278
- * // Before running the sample:
1279
- * // - Enable the API at:
1280
- * // https://console.developers.google.com/apis/api/tpu.googleapis.com
1281
- * // - Login into gcloud by running:
1282
- * // `$ gcloud auth application-default login`
1283
- * // - Install the npm module by running:
1284
- * // `$ npm install googleapis`
1285
- *
1286
- * const {google} = require('googleapis');
1287
- * const tpu = google.tpu('v2alpha1');
1288
- *
1289
- * async function main() {
1290
- * const auth = new google.auth.GoogleAuth({
1291
- * // Scopes can be specified either as an array or as a single, space-delimited string.
1292
- * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
1293
- * });
1294
- *
1295
- * // Acquire an auth client, and bind it to all future calls
1296
- * const authClient = await auth.getClient();
1297
- * google.options({auth: authClient});
1298
- *
1299
- * // Do the magic
1300
- * const res = await tpu.projects.locations.nodes.list({
1301
- * // The maximum number of items to return.
1302
- * pageSize: 'placeholder-value',
1303
- * // The next_page_token value returned from a previous List request, if any.
1304
- * pageToken: 'placeholder-value',
1305
- * // Required. The parent resource name.
1306
- * parent: 'projects/my-project/locations/my-location',
1307
- * });
1308
- * console.log(res.data);
1309
- *
1310
- * // Example response
1311
- * // {
1312
- * // "nextPageToken": "my_nextPageToken",
1313
- * // "nodes": [],
1314
- * // "unreachable": []
1315
- * // }
1316
- * }
1317
- *
1318
- * main().catch(e => {
1319
- * console.error(e);
1320
- * throw e;
1321
- * });
1322
- *
1323
- * ```
1324
1096
  *
1325
1097
  * @param params - Parameters for request
1326
1098
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1335,81 +1107,6 @@ export declare namespace tpu_v2alpha1 {
1335
1107
  list(callback: BodyResponseCallback<Schema$ListNodesResponse>): void;
1336
1108
  /**
1337
1109
  * Updates the configurations of a node.
1338
- * @example
1339
- * ```js
1340
- * // Before running the sample:
1341
- * // - Enable the API at:
1342
- * // https://console.developers.google.com/apis/api/tpu.googleapis.com
1343
- * // - Login into gcloud by running:
1344
- * // `$ gcloud auth application-default login`
1345
- * // - Install the npm module by running:
1346
- * // `$ npm install googleapis`
1347
- *
1348
- * const {google} = require('googleapis');
1349
- * const tpu = google.tpu('v2alpha1');
1350
- *
1351
- * async function main() {
1352
- * const auth = new google.auth.GoogleAuth({
1353
- * // Scopes can be specified either as an array or as a single, space-delimited string.
1354
- * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
1355
- * });
1356
- *
1357
- * // Acquire an auth client, and bind it to all future calls
1358
- * const authClient = await auth.getClient();
1359
- * google.options({auth: authClient});
1360
- *
1361
- * // Do the magic
1362
- * const res = await tpu.projects.locations.nodes.patch({
1363
- * // Output only. Immutable. The name of the TPU.
1364
- * name: 'projects/my-project/locations/my-location/nodes/my-node',
1365
- * // Required. Mask of fields from Node to update. Supported fields: [description, tags, labels, metadata, network_config.enable_external_ips].
1366
- * updateMask: 'placeholder-value',
1367
- *
1368
- * // Request body metadata
1369
- * requestBody: {
1370
- * // request body parameters
1371
- * // {
1372
- * // "acceleratorType": "my_acceleratorType",
1373
- * // "apiVersion": "my_apiVersion",
1374
- * // "cidrBlock": "my_cidrBlock",
1375
- * // "createTime": "my_createTime",
1376
- * // "dataDisks": [],
1377
- * // "description": "my_description",
1378
- * // "health": "my_health",
1379
- * // "healthDescription": "my_healthDescription",
1380
- * // "id": "my_id",
1381
- * // "labels": {},
1382
- * // "metadata": {},
1383
- * // "name": "my_name",
1384
- * // "networkConfig": {},
1385
- * // "networkEndpoints": [],
1386
- * // "runtimeVersion": "my_runtimeVersion",
1387
- * // "schedulingConfig": {},
1388
- * // "serviceAccount": {},
1389
- * // "state": "my_state",
1390
- * // "symptoms": [],
1391
- * // "tags": []
1392
- * // }
1393
- * },
1394
- * });
1395
- * console.log(res.data);
1396
- *
1397
- * // Example response
1398
- * // {
1399
- * // "done": false,
1400
- * // "error": {},
1401
- * // "metadata": {},
1402
- * // "name": "my_name",
1403
- * // "response": {}
1404
- * // }
1405
- * }
1406
- *
1407
- * main().catch(e => {
1408
- * console.error(e);
1409
- * throw e;
1410
- * });
1411
- *
1412
- * ```
1413
1110
  *
1414
1111
  * @param params - Parameters for request
1415
1112
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1424,60 +1121,6 @@ export declare namespace tpu_v2alpha1 {
1424
1121
  patch(callback: BodyResponseCallback<Schema$Operation>): void;
1425
1122
  /**
1426
1123
  * Simulates a maintenance event.
1427
- * @example
1428
- * ```js
1429
- * // Before running the sample:
1430
- * // - Enable the API at:
1431
- * // https://console.developers.google.com/apis/api/tpu.googleapis.com
1432
- * // - Login into gcloud by running:
1433
- * // `$ gcloud auth application-default login`
1434
- * // - Install the npm module by running:
1435
- * // `$ npm install googleapis`
1436
- *
1437
- * const {google} = require('googleapis');
1438
- * const tpu = google.tpu('v2alpha1');
1439
- *
1440
- * async function main() {
1441
- * const auth = new google.auth.GoogleAuth({
1442
- * // Scopes can be specified either as an array or as a single, space-delimited string.
1443
- * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
1444
- * });
1445
- *
1446
- * // Acquire an auth client, and bind it to all future calls
1447
- * const authClient = await auth.getClient();
1448
- * google.options({auth: authClient});
1449
- *
1450
- * // Do the magic
1451
- * const res = await tpu.projects.locations.nodes.simulateMaintenanceEvent({
1452
- * // Required. The resource name.
1453
- * name: 'projects/my-project/locations/my-location/nodes/my-node',
1454
- *
1455
- * // Request body metadata
1456
- * requestBody: {
1457
- * // request body parameters
1458
- * // {
1459
- * // "workerIds": []
1460
- * // }
1461
- * },
1462
- * });
1463
- * console.log(res.data);
1464
- *
1465
- * // Example response
1466
- * // {
1467
- * // "done": false,
1468
- * // "error": {},
1469
- * // "metadata": {},
1470
- * // "name": "my_name",
1471
- * // "response": {}
1472
- * // }
1473
- * }
1474
- *
1475
- * main().catch(e => {
1476
- * console.error(e);
1477
- * throw e;
1478
- * });
1479
- *
1480
- * ```
1481
1124
  *
1482
1125
  * @param params - Parameters for request
1483
1126
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1492,58 +1135,6 @@ export declare namespace tpu_v2alpha1 {
1492
1135
  simulateMaintenanceEvent(callback: BodyResponseCallback<Schema$Operation>): void;
1493
1136
  /**
1494
1137
  * Starts a node.
1495
- * @example
1496
- * ```js
1497
- * // Before running the sample:
1498
- * // - Enable the API at:
1499
- * // https://console.developers.google.com/apis/api/tpu.googleapis.com
1500
- * // - Login into gcloud by running:
1501
- * // `$ gcloud auth application-default login`
1502
- * // - Install the npm module by running:
1503
- * // `$ npm install googleapis`
1504
- *
1505
- * const {google} = require('googleapis');
1506
- * const tpu = google.tpu('v2alpha1');
1507
- *
1508
- * async function main() {
1509
- * const auth = new google.auth.GoogleAuth({
1510
- * // Scopes can be specified either as an array or as a single, space-delimited string.
1511
- * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
1512
- * });
1513
- *
1514
- * // Acquire an auth client, and bind it to all future calls
1515
- * const authClient = await auth.getClient();
1516
- * google.options({auth: authClient});
1517
- *
1518
- * // Do the magic
1519
- * const res = await tpu.projects.locations.nodes.start({
1520
- * // The resource name.
1521
- * name: 'projects/my-project/locations/my-location/nodes/my-node',
1522
- *
1523
- * // Request body metadata
1524
- * requestBody: {
1525
- * // request body parameters
1526
- * // {}
1527
- * },
1528
- * });
1529
- * console.log(res.data);
1530
- *
1531
- * // Example response
1532
- * // {
1533
- * // "done": false,
1534
- * // "error": {},
1535
- * // "metadata": {},
1536
- * // "name": "my_name",
1537
- * // "response": {}
1538
- * // }
1539
- * }
1540
- *
1541
- * main().catch(e => {
1542
- * console.error(e);
1543
- * throw e;
1544
- * });
1545
- *
1546
- * ```
1547
1138
  *
1548
1139
  * @param params - Parameters for request
1549
1140
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1558,58 +1149,6 @@ export declare namespace tpu_v2alpha1 {
1558
1149
  start(callback: BodyResponseCallback<Schema$Operation>): void;
1559
1150
  /**
1560
1151
  * Stops a node. This operation is only available with single TPU nodes.
1561
- * @example
1562
- * ```js
1563
- * // Before running the sample:
1564
- * // - Enable the API at:
1565
- * // https://console.developers.google.com/apis/api/tpu.googleapis.com
1566
- * // - Login into gcloud by running:
1567
- * // `$ gcloud auth application-default login`
1568
- * // - Install the npm module by running:
1569
- * // `$ npm install googleapis`
1570
- *
1571
- * const {google} = require('googleapis');
1572
- * const tpu = google.tpu('v2alpha1');
1573
- *
1574
- * async function main() {
1575
- * const auth = new google.auth.GoogleAuth({
1576
- * // Scopes can be specified either as an array or as a single, space-delimited string.
1577
- * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
1578
- * });
1579
- *
1580
- * // Acquire an auth client, and bind it to all future calls
1581
- * const authClient = await auth.getClient();
1582
- * google.options({auth: authClient});
1583
- *
1584
- * // Do the magic
1585
- * const res = await tpu.projects.locations.nodes.stop({
1586
- * // The resource name.
1587
- * name: 'projects/my-project/locations/my-location/nodes/my-node',
1588
- *
1589
- * // Request body metadata
1590
- * requestBody: {
1591
- * // request body parameters
1592
- * // {}
1593
- * },
1594
- * });
1595
- * console.log(res.data);
1596
- *
1597
- * // Example response
1598
- * // {
1599
- * // "done": false,
1600
- * // "error": {},
1601
- * // "metadata": {},
1602
- * // "name": "my_name",
1603
- * // "response": {}
1604
- * // }
1605
- * }
1606
- *
1607
- * main().catch(e => {
1608
- * console.error(e);
1609
- * throw e;
1610
- * });
1611
- *
1612
- * ```
1613
1152
  *
1614
1153
  * @param params - Parameters for request
1615
1154
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1707,7 +1246,7 @@ export declare namespace tpu_v2alpha1 {
1707
1246
  }
1708
1247
  export interface Params$Resource$Projects$Locations$Nodes$Start extends StandardParameters {
1709
1248
  /**
1710
- * The resource name.
1249
+ * Required. The resource name.
1711
1250
  */
1712
1251
  name?: string;
1713
1252
  /**
@@ -1717,7 +1256,7 @@ export declare namespace tpu_v2alpha1 {
1717
1256
  }
1718
1257
  export interface Params$Resource$Projects$Locations$Nodes$Stop extends StandardParameters {
1719
1258
  /**
1720
- * The resource name.
1259
+ * Required. The resource name.
1721
1260
  */
1722
1261
  name?: string;
1723
1262
  /**
@@ -1730,46 +1269,6 @@ export declare namespace tpu_v2alpha1 {
1730
1269
  constructor(context: APIRequestContext);
1731
1270
  /**
1732
1271
  * 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`.
1733
- * @example
1734
- * ```js
1735
- * // Before running the sample:
1736
- * // - Enable the API at:
1737
- * // https://console.developers.google.com/apis/api/tpu.googleapis.com
1738
- * // - Login into gcloud by running:
1739
- * // `$ gcloud auth application-default login`
1740
- * // - Install the npm module by running:
1741
- * // `$ npm install googleapis`
1742
- *
1743
- * const {google} = require('googleapis');
1744
- * const tpu = google.tpu('v2alpha1');
1745
- *
1746
- * async function main() {
1747
- * const auth = new google.auth.GoogleAuth({
1748
- * // Scopes can be specified either as an array or as a single, space-delimited string.
1749
- * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
1750
- * });
1751
- *
1752
- * // Acquire an auth client, and bind it to all future calls
1753
- * const authClient = await auth.getClient();
1754
- * google.options({auth: authClient});
1755
- *
1756
- * // Do the magic
1757
- * const res = await tpu.projects.locations.operations.cancel({
1758
- * // The name of the operation resource to be cancelled.
1759
- * name: 'projects/my-project/locations/my-location/operations/my-operation',
1760
- * });
1761
- * console.log(res.data);
1762
- *
1763
- * // Example response
1764
- * // {}
1765
- * }
1766
- *
1767
- * main().catch(e => {
1768
- * console.error(e);
1769
- * throw e;
1770
- * });
1771
- *
1772
- * ```
1773
1272
  *
1774
1273
  * @param params - Parameters for request
1775
1274
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1784,46 +1283,6 @@ export declare namespace tpu_v2alpha1 {
1784
1283
  cancel(callback: BodyResponseCallback<Schema$Empty>): void;
1785
1284
  /**
1786
1285
  * 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`.
1787
- * @example
1788
- * ```js
1789
- * // Before running the sample:
1790
- * // - Enable the API at:
1791
- * // https://console.developers.google.com/apis/api/tpu.googleapis.com
1792
- * // - Login into gcloud by running:
1793
- * // `$ gcloud auth application-default login`
1794
- * // - Install the npm module by running:
1795
- * // `$ npm install googleapis`
1796
- *
1797
- * const {google} = require('googleapis');
1798
- * const tpu = google.tpu('v2alpha1');
1799
- *
1800
- * async function main() {
1801
- * const auth = new google.auth.GoogleAuth({
1802
- * // Scopes can be specified either as an array or as a single, space-delimited string.
1803
- * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
1804
- * });
1805
- *
1806
- * // Acquire an auth client, and bind it to all future calls
1807
- * const authClient = await auth.getClient();
1808
- * google.options({auth: authClient});
1809
- *
1810
- * // Do the magic
1811
- * const res = await tpu.projects.locations.operations.delete({
1812
- * // The name of the operation resource to be deleted.
1813
- * name: 'projects/my-project/locations/my-location/operations/my-operation',
1814
- * });
1815
- * console.log(res.data);
1816
- *
1817
- * // Example response
1818
- * // {}
1819
- * }
1820
- *
1821
- * main().catch(e => {
1822
- * console.error(e);
1823
- * throw e;
1824
- * });
1825
- *
1826
- * ```
1827
1286
  *
1828
1287
  * @param params - Parameters for request
1829
1288
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1838,52 +1297,6 @@ export declare namespace tpu_v2alpha1 {
1838
1297
  delete(callback: BodyResponseCallback<Schema$Empty>): void;
1839
1298
  /**
1840
1299
  * 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.
1841
- * @example
1842
- * ```js
1843
- * // Before running the sample:
1844
- * // - Enable the API at:
1845
- * // https://console.developers.google.com/apis/api/tpu.googleapis.com
1846
- * // - Login into gcloud by running:
1847
- * // `$ gcloud auth application-default login`
1848
- * // - Install the npm module by running:
1849
- * // `$ npm install googleapis`
1850
- *
1851
- * const {google} = require('googleapis');
1852
- * const tpu = google.tpu('v2alpha1');
1853
- *
1854
- * async function main() {
1855
- * const auth = new google.auth.GoogleAuth({
1856
- * // Scopes can be specified either as an array or as a single, space-delimited string.
1857
- * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
1858
- * });
1859
- *
1860
- * // Acquire an auth client, and bind it to all future calls
1861
- * const authClient = await auth.getClient();
1862
- * google.options({auth: authClient});
1863
- *
1864
- * // Do the magic
1865
- * const res = await tpu.projects.locations.operations.get({
1866
- * // The name of the operation resource.
1867
- * name: 'projects/my-project/locations/my-location/operations/my-operation',
1868
- * });
1869
- * console.log(res.data);
1870
- *
1871
- * // Example response
1872
- * // {
1873
- * // "done": false,
1874
- * // "error": {},
1875
- * // "metadata": {},
1876
- * // "name": "my_name",
1877
- * // "response": {}
1878
- * // }
1879
- * }
1880
- *
1881
- * main().catch(e => {
1882
- * console.error(e);
1883
- * throw e;
1884
- * });
1885
- *
1886
- * ```
1887
1300
  *
1888
1301
  * @param params - Parameters for request
1889
1302
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1897,56 +1310,7 @@ export declare namespace tpu_v2alpha1 {
1897
1310
  get(params: Params$Resource$Projects$Locations$Operations$Get, callback: BodyResponseCallback<Schema$Operation>): void;
1898
1311
  get(callback: BodyResponseCallback<Schema$Operation>): void;
1899
1312
  /**
1900
- * 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.
1901
- * @example
1902
- * ```js
1903
- * // Before running the sample:
1904
- * // - Enable the API at:
1905
- * // https://console.developers.google.com/apis/api/tpu.googleapis.com
1906
- * // - Login into gcloud by running:
1907
- * // `$ gcloud auth application-default login`
1908
- * // - Install the npm module by running:
1909
- * // `$ npm install googleapis`
1910
- *
1911
- * const {google} = require('googleapis');
1912
- * const tpu = google.tpu('v2alpha1');
1913
- *
1914
- * async function main() {
1915
- * const auth = new google.auth.GoogleAuth({
1916
- * // Scopes can be specified either as an array or as a single, space-delimited string.
1917
- * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
1918
- * });
1919
- *
1920
- * // Acquire an auth client, and bind it to all future calls
1921
- * const authClient = await auth.getClient();
1922
- * google.options({auth: authClient});
1923
- *
1924
- * // Do the magic
1925
- * const res = await tpu.projects.locations.operations.list({
1926
- * // The standard list filter.
1927
- * filter: 'placeholder-value',
1928
- * // The name of the operation's parent resource.
1929
- * name: 'projects/my-project/locations/my-location',
1930
- * // The standard list page size.
1931
- * pageSize: 'placeholder-value',
1932
- * // The standard list page token.
1933
- * pageToken: 'placeholder-value',
1934
- * });
1935
- * console.log(res.data);
1936
- *
1937
- * // Example response
1938
- * // {
1939
- * // "nextPageToken": "my_nextPageToken",
1940
- * // "operations": []
1941
- * // }
1942
- * }
1943
- *
1944
- * main().catch(e => {
1945
- * console.error(e);
1946
- * throw e;
1947
- * });
1948
- *
1949
- * ```
1313
+ * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
1950
1314
  *
1951
1315
  * @param params - Parameters for request
1952
1316
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1996,54 +1360,147 @@ export declare namespace tpu_v2alpha1 {
1996
1360
  */
1997
1361
  pageToken?: string;
1998
1362
  }
1999
- export class Resource$Projects$Locations$Runtimeversions {
1363
+ export class Resource$Projects$Locations$Queuedresources {
2000
1364
  context: APIRequestContext;
2001
1365
  constructor(context: APIRequestContext);
2002
1366
  /**
2003
- * Gets a runtime version.
2004
- * @example
2005
- * ```js
2006
- * // Before running the sample:
2007
- * // - Enable the API at:
2008
- * // https://console.developers.google.com/apis/api/tpu.googleapis.com
2009
- * // - Login into gcloud by running:
2010
- * // `$ gcloud auth application-default login`
2011
- * // - Install the npm module by running:
2012
- * // `$ npm install googleapis`
2013
- *
2014
- * const {google} = require('googleapis');
2015
- * const tpu = google.tpu('v2alpha1');
2016
- *
2017
- * async function main() {
2018
- * const auth = new google.auth.GoogleAuth({
2019
- * // Scopes can be specified either as an array or as a single, space-delimited string.
2020
- * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
2021
- * });
1367
+ * Creates a QueuedResource TPU instance.
2022
1368
  *
2023
- * // Acquire an auth client, and bind it to all future calls
2024
- * const authClient = await auth.getClient();
2025
- * google.options({auth: authClient});
1369
+ * @param params - Parameters for request
1370
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
1371
+ * @param callback - Optional callback that handles the response.
1372
+ * @returns A promise if used with async/await, or void if used with a callback.
1373
+ */
1374
+ create(params: Params$Resource$Projects$Locations$Queuedresources$Create, options: StreamMethodOptions): GaxiosPromise<Readable>;
1375
+ create(params?: Params$Resource$Projects$Locations$Queuedresources$Create, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
1376
+ create(params: Params$Resource$Projects$Locations$Queuedresources$Create, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
1377
+ create(params: Params$Resource$Projects$Locations$Queuedresources$Create, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
1378
+ create(params: Params$Resource$Projects$Locations$Queuedresources$Create, callback: BodyResponseCallback<Schema$Operation>): void;
1379
+ create(callback: BodyResponseCallback<Schema$Operation>): void;
1380
+ /**
1381
+ * Deletes a QueuedResource TPU instance.
2026
1382
  *
2027
- * // Do the magic
2028
- * const res = await tpu.projects.locations.runtimeVersions.get({
2029
- * // Required. The resource name.
2030
- * name: 'projects/my-project/locations/my-location/runtimeVersions/my-runtimeVersion',
2031
- * });
2032
- * console.log(res.data);
1383
+ * @param params - Parameters for request
1384
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
1385
+ * @param callback - Optional callback that handles the response.
1386
+ * @returns A promise if used with async/await, or void if used with a callback.
1387
+ */
1388
+ delete(params: Params$Resource$Projects$Locations$Queuedresources$Delete, options: StreamMethodOptions): GaxiosPromise<Readable>;
1389
+ delete(params?: Params$Resource$Projects$Locations$Queuedresources$Delete, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
1390
+ delete(params: Params$Resource$Projects$Locations$Queuedresources$Delete, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
1391
+ delete(params: Params$Resource$Projects$Locations$Queuedresources$Delete, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
1392
+ delete(params: Params$Resource$Projects$Locations$Queuedresources$Delete, callback: BodyResponseCallback<Schema$Operation>): void;
1393
+ delete(callback: BodyResponseCallback<Schema$Operation>): void;
1394
+ /**
1395
+ * Gets details of a queued resource.
2033
1396
  *
2034
- * // Example response
2035
- * // {
2036
- * // "name": "my_name",
2037
- * // "version": "my_version"
2038
- * // }
2039
- * }
1397
+ * @param params - Parameters for request
1398
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
1399
+ * @param callback - Optional callback that handles the response.
1400
+ * @returns A promise if used with async/await, or void if used with a callback.
1401
+ */
1402
+ get(params: Params$Resource$Projects$Locations$Queuedresources$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
1403
+ get(params?: Params$Resource$Projects$Locations$Queuedresources$Get, options?: MethodOptions): GaxiosPromise<Schema$QueuedResource>;
1404
+ get(params: Params$Resource$Projects$Locations$Queuedresources$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
1405
+ get(params: Params$Resource$Projects$Locations$Queuedresources$Get, options: MethodOptions | BodyResponseCallback<Schema$QueuedResource>, callback: BodyResponseCallback<Schema$QueuedResource>): void;
1406
+ get(params: Params$Resource$Projects$Locations$Queuedresources$Get, callback: BodyResponseCallback<Schema$QueuedResource>): void;
1407
+ get(callback: BodyResponseCallback<Schema$QueuedResource>): void;
1408
+ /**
1409
+ * Lists queued resources.
2040
1410
  *
2041
- * main().catch(e => {
2042
- * console.error(e);
2043
- * throw e;
2044
- * });
1411
+ * @param params - Parameters for request
1412
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
1413
+ * @param callback - Optional callback that handles the response.
1414
+ * @returns A promise if used with async/await, or void if used with a callback.
1415
+ */
1416
+ list(params: Params$Resource$Projects$Locations$Queuedresources$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
1417
+ list(params?: Params$Resource$Projects$Locations$Queuedresources$List, options?: MethodOptions): GaxiosPromise<Schema$ListQueuedResourcesResponse>;
1418
+ list(params: Params$Resource$Projects$Locations$Queuedresources$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
1419
+ list(params: Params$Resource$Projects$Locations$Queuedresources$List, options: MethodOptions | BodyResponseCallback<Schema$ListQueuedResourcesResponse>, callback: BodyResponseCallback<Schema$ListQueuedResourcesResponse>): void;
1420
+ list(params: Params$Resource$Projects$Locations$Queuedresources$List, callback: BodyResponseCallback<Schema$ListQueuedResourcesResponse>): void;
1421
+ list(callback: BodyResponseCallback<Schema$ListQueuedResourcesResponse>): void;
1422
+ /**
1423
+ * Resets a QueuedResource TPU instance
2045
1424
  *
2046
- * ```
1425
+ * @param params - Parameters for request
1426
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
1427
+ * @param callback - Optional callback that handles the response.
1428
+ * @returns A promise if used with async/await, or void if used with a callback.
1429
+ */
1430
+ reset(params: Params$Resource$Projects$Locations$Queuedresources$Reset, options: StreamMethodOptions): GaxiosPromise<Readable>;
1431
+ reset(params?: Params$Resource$Projects$Locations$Queuedresources$Reset, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
1432
+ reset(params: Params$Resource$Projects$Locations$Queuedresources$Reset, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
1433
+ reset(params: Params$Resource$Projects$Locations$Queuedresources$Reset, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
1434
+ reset(params: Params$Resource$Projects$Locations$Queuedresources$Reset, callback: BodyResponseCallback<Schema$Operation>): void;
1435
+ reset(callback: BodyResponseCallback<Schema$Operation>): void;
1436
+ }
1437
+ export interface Params$Resource$Projects$Locations$Queuedresources$Create extends StandardParameters {
1438
+ /**
1439
+ * Required. The parent resource name.
1440
+ */
1441
+ parent?: string;
1442
+ /**
1443
+ * The unqualified resource name. Should follow the `^[A-Za-z0-9_.~+%-]+$` regex format.
1444
+ */
1445
+ queuedResourceId?: string;
1446
+ /**
1447
+ * Idempotent request UUID.
1448
+ */
1449
+ requestId?: string;
1450
+ /**
1451
+ * Request body metadata
1452
+ */
1453
+ requestBody?: Schema$QueuedResource;
1454
+ }
1455
+ export interface Params$Resource$Projects$Locations$Queuedresources$Delete extends StandardParameters {
1456
+ /**
1457
+ * 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.
1458
+ */
1459
+ force?: boolean;
1460
+ /**
1461
+ * Required. The resource name.
1462
+ */
1463
+ name?: string;
1464
+ /**
1465
+ * Idempotent request UUID.
1466
+ */
1467
+ requestId?: string;
1468
+ }
1469
+ export interface Params$Resource$Projects$Locations$Queuedresources$Get extends StandardParameters {
1470
+ /**
1471
+ * Required. The resource name.
1472
+ */
1473
+ name?: string;
1474
+ }
1475
+ export interface Params$Resource$Projects$Locations$Queuedresources$List extends StandardParameters {
1476
+ /**
1477
+ * The maximum number of items to return.
1478
+ */
1479
+ pageSize?: number;
1480
+ /**
1481
+ * The next_page_token value returned from a previous List request, if any.
1482
+ */
1483
+ pageToken?: string;
1484
+ /**
1485
+ * Required. The parent resource name.
1486
+ */
1487
+ parent?: string;
1488
+ }
1489
+ export interface Params$Resource$Projects$Locations$Queuedresources$Reset extends StandardParameters {
1490
+ /**
1491
+ * Required. The name of the queued resource.
1492
+ */
1493
+ name?: string;
1494
+ /**
1495
+ * Request body metadata
1496
+ */
1497
+ requestBody?: Schema$ResetQueuedResourceRequest;
1498
+ }
1499
+ export class Resource$Projects$Locations$Runtimeversions {
1500
+ context: APIRequestContext;
1501
+ constructor(context: APIRequestContext);
1502
+ /**
1503
+ * Gets a runtime version.
2047
1504
  *
2048
1505
  * @param params - Parameters for request
2049
1506
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2058,58 +1515,6 @@ export declare namespace tpu_v2alpha1 {
2058
1515
  get(callback: BodyResponseCallback<Schema$RuntimeVersion>): void;
2059
1516
  /**
2060
1517
  * Lists runtime versions supported by this API.
2061
- * @example
2062
- * ```js
2063
- * // Before running the sample:
2064
- * // - Enable the API at:
2065
- * // https://console.developers.google.com/apis/api/tpu.googleapis.com
2066
- * // - Login into gcloud by running:
2067
- * // `$ gcloud auth application-default login`
2068
- * // - Install the npm module by running:
2069
- * // `$ npm install googleapis`
2070
- *
2071
- * const {google} = require('googleapis');
2072
- * const tpu = google.tpu('v2alpha1');
2073
- *
2074
- * async function main() {
2075
- * const auth = new google.auth.GoogleAuth({
2076
- * // Scopes can be specified either as an array or as a single, space-delimited string.
2077
- * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
2078
- * });
2079
- *
2080
- * // Acquire an auth client, and bind it to all future calls
2081
- * const authClient = await auth.getClient();
2082
- * google.options({auth: authClient});
2083
- *
2084
- * // Do the magic
2085
- * const res = await tpu.projects.locations.runtimeVersions.list({
2086
- * // List filter.
2087
- * filter: 'placeholder-value',
2088
- * // Sort results.
2089
- * orderBy: 'placeholder-value',
2090
- * // The maximum number of items to return.
2091
- * pageSize: 'placeholder-value',
2092
- * // The next_page_token value returned from a previous List request, if any.
2093
- * pageToken: 'placeholder-value',
2094
- * // Required. The parent resource name.
2095
- * parent: 'projects/my-project/locations/my-location',
2096
- * });
2097
- * console.log(res.data);
2098
- *
2099
- * // Example response
2100
- * // {
2101
- * // "nextPageToken": "my_nextPageToken",
2102
- * // "runtimeVersions": [],
2103
- * // "unreachable": []
2104
- * // }
2105
- * }
2106
- *
2107
- * main().catch(e => {
2108
- * console.error(e);
2109
- * throw e;
2110
- * });
2111
- *
2112
- * ```
2113
1518
  *
2114
1519
  * @param params - Parameters for request
2115
1520
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.