@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/v1.d.ts CHANGED
@@ -167,7 +167,7 @@ export declare namespace tpu_v1 {
167
167
  unreachable?: string[] | null;
168
168
  }
169
169
  /**
170
- * A resource that represents Google Cloud Platform location.
170
+ * A resource that represents a Google Cloud location.
171
171
  */
172
172
  export interface Schema$Location {
173
173
  /**
@@ -314,7 +314,7 @@ export declare namespace tpu_v1 {
314
314
  */
315
315
  name?: string | null;
316
316
  /**
317
- * 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`.
317
+ * 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`.
318
318
  */
319
319
  response?: {
320
320
  [key: string]: any;
@@ -452,52 +452,6 @@ export declare namespace tpu_v1 {
452
452
  constructor(context: APIRequestContext);
453
453
  /**
454
454
  * Gets information about a location.
455
- * @example
456
- * ```js
457
- * // Before running the sample:
458
- * // - Enable the API at:
459
- * // https://console.developers.google.com/apis/api/tpu.googleapis.com
460
- * // - Login into gcloud by running:
461
- * // `$ gcloud auth application-default login`
462
- * // - Install the npm module by running:
463
- * // `$ npm install googleapis`
464
- *
465
- * const {google} = require('googleapis');
466
- * const tpu = google.tpu('v1');
467
- *
468
- * async function main() {
469
- * const auth = new google.auth.GoogleAuth({
470
- * // Scopes can be specified either as an array or as a single, space-delimited string.
471
- * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
472
- * });
473
- *
474
- * // Acquire an auth client, and bind it to all future calls
475
- * const authClient = await auth.getClient();
476
- * google.options({auth: authClient});
477
- *
478
- * // Do the magic
479
- * const res = await tpu.projects.locations.get({
480
- * // Resource name for the location.
481
- * name: 'projects/my-project/locations/my-location',
482
- * });
483
- * console.log(res.data);
484
- *
485
- * // Example response
486
- * // {
487
- * // "displayName": "my_displayName",
488
- * // "labels": {},
489
- * // "locationId": "my_locationId",
490
- * // "metadata": {},
491
- * // "name": "my_name"
492
- * // }
493
- * }
494
- *
495
- * main().catch(e => {
496
- * console.error(e);
497
- * throw e;
498
- * });
499
- *
500
- * ```
501
455
  *
502
456
  * @param params - Parameters for request
503
457
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -512,55 +466,6 @@ export declare namespace tpu_v1 {
512
466
  get(callback: BodyResponseCallback<Schema$Location>): void;
513
467
  /**
514
468
  * Lists information about the supported locations for this service.
515
- * @example
516
- * ```js
517
- * // Before running the sample:
518
- * // - Enable the API at:
519
- * // https://console.developers.google.com/apis/api/tpu.googleapis.com
520
- * // - Login into gcloud by running:
521
- * // `$ gcloud auth application-default login`
522
- * // - Install the npm module by running:
523
- * // `$ npm install googleapis`
524
- *
525
- * const {google} = require('googleapis');
526
- * const tpu = google.tpu('v1');
527
- *
528
- * async function main() {
529
- * const auth = new google.auth.GoogleAuth({
530
- * // Scopes can be specified either as an array or as a single, space-delimited string.
531
- * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
532
- * });
533
- *
534
- * // Acquire an auth client, and bind it to all future calls
535
- * const authClient = await auth.getClient();
536
- * google.options({auth: authClient});
537
- *
538
- * // Do the magic
539
- * const res = await tpu.projects.locations.list({
540
- * // 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).
541
- * filter: 'placeholder-value',
542
- * // The resource that owns the locations collection, if applicable.
543
- * name: 'projects/my-project',
544
- * // The maximum number of results to return. If not set, the service selects a default.
545
- * pageSize: 'placeholder-value',
546
- * // A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
547
- * pageToken: 'placeholder-value',
548
- * });
549
- * console.log(res.data);
550
- *
551
- * // Example response
552
- * // {
553
- * // "locations": [],
554
- * // "nextPageToken": "my_nextPageToken"
555
- * // }
556
- * }
557
- *
558
- * main().catch(e => {
559
- * console.error(e);
560
- * throw e;
561
- * });
562
- *
563
- * ```
564
469
  *
565
470
  * @param params - Parameters for request
566
471
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -603,49 +508,6 @@ export declare namespace tpu_v1 {
603
508
  constructor(context: APIRequestContext);
604
509
  /**
605
510
  * Gets AcceleratorType.
606
- * @example
607
- * ```js
608
- * // Before running the sample:
609
- * // - Enable the API at:
610
- * // https://console.developers.google.com/apis/api/tpu.googleapis.com
611
- * // - Login into gcloud by running:
612
- * // `$ gcloud auth application-default login`
613
- * // - Install the npm module by running:
614
- * // `$ npm install googleapis`
615
- *
616
- * const {google} = require('googleapis');
617
- * const tpu = google.tpu('v1');
618
- *
619
- * async function main() {
620
- * const auth = new google.auth.GoogleAuth({
621
- * // Scopes can be specified either as an array or as a single, space-delimited string.
622
- * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
623
- * });
624
- *
625
- * // Acquire an auth client, and bind it to all future calls
626
- * const authClient = await auth.getClient();
627
- * google.options({auth: authClient});
628
- *
629
- * // Do the magic
630
- * const res = await tpu.projects.locations.acceleratorTypes.get({
631
- * // Required. The resource name.
632
- * name: 'projects/my-project/locations/my-location/acceleratorTypes/my-acceleratorType',
633
- * });
634
- * console.log(res.data);
635
- *
636
- * // Example response
637
- * // {
638
- * // "name": "my_name",
639
- * // "type": "my_type"
640
- * // }
641
- * }
642
- *
643
- * main().catch(e => {
644
- * console.error(e);
645
- * throw e;
646
- * });
647
- *
648
- * ```
649
511
  *
650
512
  * @param params - Parameters for request
651
513
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -660,58 +522,6 @@ export declare namespace tpu_v1 {
660
522
  get(callback: BodyResponseCallback<Schema$AcceleratorType>): void;
661
523
  /**
662
524
  * Lists accelerator types supported by this API.
663
- * @example
664
- * ```js
665
- * // Before running the sample:
666
- * // - Enable the API at:
667
- * // https://console.developers.google.com/apis/api/tpu.googleapis.com
668
- * // - Login into gcloud by running:
669
- * // `$ gcloud auth application-default login`
670
- * // - Install the npm module by running:
671
- * // `$ npm install googleapis`
672
- *
673
- * const {google} = require('googleapis');
674
- * const tpu = google.tpu('v1');
675
- *
676
- * async function main() {
677
- * const auth = new google.auth.GoogleAuth({
678
- * // Scopes can be specified either as an array or as a single, space-delimited string.
679
- * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
680
- * });
681
- *
682
- * // Acquire an auth client, and bind it to all future calls
683
- * const authClient = await auth.getClient();
684
- * google.options({auth: authClient});
685
- *
686
- * // Do the magic
687
- * const res = await tpu.projects.locations.acceleratorTypes.list({
688
- * // List filter.
689
- * filter: 'placeholder-value',
690
- * // Sort results.
691
- * orderBy: 'placeholder-value',
692
- * // The maximum number of items to return.
693
- * pageSize: 'placeholder-value',
694
- * // The next_page_token value returned from a previous List request, if any.
695
- * pageToken: 'placeholder-value',
696
- * // Required. The parent resource name.
697
- * parent: 'projects/my-project/locations/my-location',
698
- * });
699
- * console.log(res.data);
700
- *
701
- * // Example response
702
- * // {
703
- * // "acceleratorTypes": [],
704
- * // "nextPageToken": "my_nextPageToken",
705
- * // "unreachable": []
706
- * // }
707
- * }
708
- *
709
- * main().catch(e => {
710
- * console.error(e);
711
- * throw e;
712
- * });
713
- *
714
- * ```
715
525
  *
716
526
  * @param params - Parameters for request
717
527
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -758,80 +568,6 @@ export declare namespace tpu_v1 {
758
568
  constructor(context: APIRequestContext);
759
569
  /**
760
570
  * Creates a node.
761
- * @example
762
- * ```js
763
- * // Before running the sample:
764
- * // - Enable the API at:
765
- * // https://console.developers.google.com/apis/api/tpu.googleapis.com
766
- * // - Login into gcloud by running:
767
- * // `$ gcloud auth application-default login`
768
- * // - Install the npm module by running:
769
- * // `$ npm install googleapis`
770
- *
771
- * const {google} = require('googleapis');
772
- * const tpu = google.tpu('v1');
773
- *
774
- * async function main() {
775
- * const auth = new google.auth.GoogleAuth({
776
- * // Scopes can be specified either as an array or as a single, space-delimited string.
777
- * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
778
- * });
779
- *
780
- * // Acquire an auth client, and bind it to all future calls
781
- * const authClient = await auth.getClient();
782
- * google.options({auth: authClient});
783
- *
784
- * // Do the magic
785
- * const res = await tpu.projects.locations.nodes.create({
786
- * // The unqualified resource name.
787
- * nodeId: 'placeholder-value',
788
- * // Required. The parent resource name.
789
- * parent: 'projects/my-project/locations/my-location',
790
- *
791
- * // Request body metadata
792
- * requestBody: {
793
- * // request body parameters
794
- * // {
795
- * // "acceleratorType": "my_acceleratorType",
796
- * // "apiVersion": "my_apiVersion",
797
- * // "cidrBlock": "my_cidrBlock",
798
- * // "createTime": "my_createTime",
799
- * // "description": "my_description",
800
- * // "health": "my_health",
801
- * // "healthDescription": "my_healthDescription",
802
- * // "ipAddress": "my_ipAddress",
803
- * // "labels": {},
804
- * // "name": "my_name",
805
- * // "network": "my_network",
806
- * // "networkEndpoints": [],
807
- * // "port": "my_port",
808
- * // "schedulingConfig": {},
809
- * // "serviceAccount": "my_serviceAccount",
810
- * // "state": "my_state",
811
- * // "symptoms": [],
812
- * // "tensorflowVersion": "my_tensorflowVersion",
813
- * // "useServiceNetworking": false
814
- * // }
815
- * },
816
- * });
817
- * console.log(res.data);
818
- *
819
- * // Example response
820
- * // {
821
- * // "done": false,
822
- * // "error": {},
823
- * // "metadata": {},
824
- * // "name": "my_name",
825
- * // "response": {}
826
- * // }
827
- * }
828
- *
829
- * main().catch(e => {
830
- * console.error(e);
831
- * throw e;
832
- * });
833
- *
834
- * ```
835
571
  *
836
572
  * @param params - Parameters for request
837
573
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -846,52 +582,6 @@ export declare namespace tpu_v1 {
846
582
  create(callback: BodyResponseCallback<Schema$Operation>): void;
847
583
  /**
848
584
  * Deletes a node.
849
- * @example
850
- * ```js
851
- * // Before running the sample:
852
- * // - Enable the API at:
853
- * // https://console.developers.google.com/apis/api/tpu.googleapis.com
854
- * // - Login into gcloud by running:
855
- * // `$ gcloud auth application-default login`
856
- * // - Install the npm module by running:
857
- * // `$ npm install googleapis`
858
- *
859
- * const {google} = require('googleapis');
860
- * const tpu = google.tpu('v1');
861
- *
862
- * async function main() {
863
- * const auth = new google.auth.GoogleAuth({
864
- * // Scopes can be specified either as an array or as a single, space-delimited string.
865
- * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
866
- * });
867
- *
868
- * // Acquire an auth client, and bind it to all future calls
869
- * const authClient = await auth.getClient();
870
- * google.options({auth: authClient});
871
- *
872
- * // Do the magic
873
- * const res = await tpu.projects.locations.nodes.delete({
874
- * // Required. The resource name.
875
- * name: 'projects/my-project/locations/my-location/nodes/my-node',
876
- * });
877
- * console.log(res.data);
878
- *
879
- * // Example response
880
- * // {
881
- * // "done": false,
882
- * // "error": {},
883
- * // "metadata": {},
884
- * // "name": "my_name",
885
- * // "response": {}
886
- * // }
887
- * }
888
- *
889
- * main().catch(e => {
890
- * console.error(e);
891
- * throw e;
892
- * });
893
- *
894
- * ```
895
585
  *
896
586
  * @param params - Parameters for request
897
587
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -906,66 +596,6 @@ export declare namespace tpu_v1 {
906
596
  delete(callback: BodyResponseCallback<Schema$Operation>): void;
907
597
  /**
908
598
  * Gets the details of a node.
909
- * @example
910
- * ```js
911
- * // Before running the sample:
912
- * // - Enable the API at:
913
- * // https://console.developers.google.com/apis/api/tpu.googleapis.com
914
- * // - Login into gcloud by running:
915
- * // `$ gcloud auth application-default login`
916
- * // - Install the npm module by running:
917
- * // `$ npm install googleapis`
918
- *
919
- * const {google} = require('googleapis');
920
- * const tpu = google.tpu('v1');
921
- *
922
- * async function main() {
923
- * const auth = new google.auth.GoogleAuth({
924
- * // Scopes can be specified either as an array or as a single, space-delimited string.
925
- * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
926
- * });
927
- *
928
- * // Acquire an auth client, and bind it to all future calls
929
- * const authClient = await auth.getClient();
930
- * google.options({auth: authClient});
931
- *
932
- * // Do the magic
933
- * const res = await tpu.projects.locations.nodes.get({
934
- * // Required. The resource name.
935
- * name: 'projects/my-project/locations/my-location/nodes/my-node',
936
- * });
937
- * console.log(res.data);
938
- *
939
- * // Example response
940
- * // {
941
- * // "acceleratorType": "my_acceleratorType",
942
- * // "apiVersion": "my_apiVersion",
943
- * // "cidrBlock": "my_cidrBlock",
944
- * // "createTime": "my_createTime",
945
- * // "description": "my_description",
946
- * // "health": "my_health",
947
- * // "healthDescription": "my_healthDescription",
948
- * // "ipAddress": "my_ipAddress",
949
- * // "labels": {},
950
- * // "name": "my_name",
951
- * // "network": "my_network",
952
- * // "networkEndpoints": [],
953
- * // "port": "my_port",
954
- * // "schedulingConfig": {},
955
- * // "serviceAccount": "my_serviceAccount",
956
- * // "state": "my_state",
957
- * // "symptoms": [],
958
- * // "tensorflowVersion": "my_tensorflowVersion",
959
- * // "useServiceNetworking": false
960
- * // }
961
- * }
962
- *
963
- * main().catch(e => {
964
- * console.error(e);
965
- * throw e;
966
- * });
967
- *
968
- * ```
969
599
  *
970
600
  * @param params - Parameters for request
971
601
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -980,54 +610,6 @@ export declare namespace tpu_v1 {
980
610
  get(callback: BodyResponseCallback<Schema$Node>): void;
981
611
  /**
982
612
  * Lists nodes.
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('v1');
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.list({
1008
- * // The maximum number of items to return.
1009
- * pageSize: 'placeholder-value',
1010
- * // The next_page_token value returned from a previous List request, if any.
1011
- * pageToken: 'placeholder-value',
1012
- * // Required. The parent resource name.
1013
- * parent: 'projects/my-project/locations/my-location',
1014
- * });
1015
- * console.log(res.data);
1016
- *
1017
- * // Example response
1018
- * // {
1019
- * // "nextPageToken": "my_nextPageToken",
1020
- * // "nodes": [],
1021
- * // "unreachable": []
1022
- * // }
1023
- * }
1024
- *
1025
- * main().catch(e => {
1026
- * console.error(e);
1027
- * throw e;
1028
- * });
1029
- *
1030
- * ```
1031
613
  *
1032
614
  * @param params - Parameters for request
1033
615
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1042,60 +624,6 @@ export declare namespace tpu_v1 {
1042
624
  list(callback: BodyResponseCallback<Schema$ListNodesResponse>): void;
1043
625
  /**
1044
626
  * Reimages a node's OS.
1045
- * @example
1046
- * ```js
1047
- * // Before running the sample:
1048
- * // - Enable the API at:
1049
- * // https://console.developers.google.com/apis/api/tpu.googleapis.com
1050
- * // - Login into gcloud by running:
1051
- * // `$ gcloud auth application-default login`
1052
- * // - Install the npm module by running:
1053
- * // `$ npm install googleapis`
1054
- *
1055
- * const {google} = require('googleapis');
1056
- * const tpu = google.tpu('v1');
1057
- *
1058
- * async function main() {
1059
- * const auth = new google.auth.GoogleAuth({
1060
- * // Scopes can be specified either as an array or as a single, space-delimited string.
1061
- * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
1062
- * });
1063
- *
1064
- * // Acquire an auth client, and bind it to all future calls
1065
- * const authClient = await auth.getClient();
1066
- * google.options({auth: authClient});
1067
- *
1068
- * // Do the magic
1069
- * const res = await tpu.projects.locations.nodes.reimage({
1070
- * // The resource name.
1071
- * name: 'projects/my-project/locations/my-location/nodes/my-node',
1072
- *
1073
- * // Request body metadata
1074
- * requestBody: {
1075
- * // request body parameters
1076
- * // {
1077
- * // "tensorflowVersion": "my_tensorflowVersion"
1078
- * // }
1079
- * },
1080
- * });
1081
- * console.log(res.data);
1082
- *
1083
- * // Example response
1084
- * // {
1085
- * // "done": false,
1086
- * // "error": {},
1087
- * // "metadata": {},
1088
- * // "name": "my_name",
1089
- * // "response": {}
1090
- * // }
1091
- * }
1092
- *
1093
- * main().catch(e => {
1094
- * console.error(e);
1095
- * throw e;
1096
- * });
1097
- *
1098
- * ```
1099
627
  *
1100
628
  * @param params - Parameters for request
1101
629
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1110,58 +638,6 @@ export declare namespace tpu_v1 {
1110
638
  reimage(callback: BodyResponseCallback<Schema$Operation>): void;
1111
639
  /**
1112
640
  * Starts a node.
1113
- * @example
1114
- * ```js
1115
- * // Before running the sample:
1116
- * // - Enable the API at:
1117
- * // https://console.developers.google.com/apis/api/tpu.googleapis.com
1118
- * // - Login into gcloud by running:
1119
- * // `$ gcloud auth application-default login`
1120
- * // - Install the npm module by running:
1121
- * // `$ npm install googleapis`
1122
- *
1123
- * const {google} = require('googleapis');
1124
- * const tpu = google.tpu('v1');
1125
- *
1126
- * async function main() {
1127
- * const auth = new google.auth.GoogleAuth({
1128
- * // Scopes can be specified either as an array or as a single, space-delimited string.
1129
- * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
1130
- * });
1131
- *
1132
- * // Acquire an auth client, and bind it to all future calls
1133
- * const authClient = await auth.getClient();
1134
- * google.options({auth: authClient});
1135
- *
1136
- * // Do the magic
1137
- * const res = await tpu.projects.locations.nodes.start({
1138
- * // The resource name.
1139
- * name: 'projects/my-project/locations/my-location/nodes/my-node',
1140
- *
1141
- * // Request body metadata
1142
- * requestBody: {
1143
- * // request body parameters
1144
- * // {}
1145
- * },
1146
- * });
1147
- * console.log(res.data);
1148
- *
1149
- * // Example response
1150
- * // {
1151
- * // "done": false,
1152
- * // "error": {},
1153
- * // "metadata": {},
1154
- * // "name": "my_name",
1155
- * // "response": {}
1156
- * // }
1157
- * }
1158
- *
1159
- * main().catch(e => {
1160
- * console.error(e);
1161
- * throw e;
1162
- * });
1163
- *
1164
- * ```
1165
641
  *
1166
642
  * @param params - Parameters for request
1167
643
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1176,58 +652,6 @@ export declare namespace tpu_v1 {
1176
652
  start(callback: BodyResponseCallback<Schema$Operation>): void;
1177
653
  /**
1178
654
  * Stops a node, this operation is only available with single TPU nodes.
1179
- * @example
1180
- * ```js
1181
- * // Before running the sample:
1182
- * // - Enable the API at:
1183
- * // https://console.developers.google.com/apis/api/tpu.googleapis.com
1184
- * // - Login into gcloud by running:
1185
- * // `$ gcloud auth application-default login`
1186
- * // - Install the npm module by running:
1187
- * // `$ npm install googleapis`
1188
- *
1189
- * const {google} = require('googleapis');
1190
- * const tpu = google.tpu('v1');
1191
- *
1192
- * async function main() {
1193
- * const auth = new google.auth.GoogleAuth({
1194
- * // Scopes can be specified either as an array or as a single, space-delimited string.
1195
- * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
1196
- * });
1197
- *
1198
- * // Acquire an auth client, and bind it to all future calls
1199
- * const authClient = await auth.getClient();
1200
- * google.options({auth: authClient});
1201
- *
1202
- * // Do the magic
1203
- * const res = await tpu.projects.locations.nodes.stop({
1204
- * // The resource name.
1205
- * name: 'projects/my-project/locations/my-location/nodes/my-node',
1206
- *
1207
- * // Request body metadata
1208
- * requestBody: {
1209
- * // request body parameters
1210
- * // {}
1211
- * },
1212
- * });
1213
- * console.log(res.data);
1214
- *
1215
- * // Example response
1216
- * // {
1217
- * // "done": false,
1218
- * // "error": {},
1219
- * // "metadata": {},
1220
- * // "name": "my_name",
1221
- * // "response": {}
1222
- * // }
1223
- * }
1224
- *
1225
- * main().catch(e => {
1226
- * console.error(e);
1227
- * throw e;
1228
- * });
1229
- *
1230
- * ```
1231
655
  *
1232
656
  * @param params - Parameters for request
1233
657
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1316,46 +740,6 @@ export declare namespace tpu_v1 {
1316
740
  constructor(context: APIRequestContext);
1317
741
  /**
1318
742
  * 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`.
1319
- * @example
1320
- * ```js
1321
- * // Before running the sample:
1322
- * // - Enable the API at:
1323
- * // https://console.developers.google.com/apis/api/tpu.googleapis.com
1324
- * // - Login into gcloud by running:
1325
- * // `$ gcloud auth application-default login`
1326
- * // - Install the npm module by running:
1327
- * // `$ npm install googleapis`
1328
- *
1329
- * const {google} = require('googleapis');
1330
- * const tpu = google.tpu('v1');
1331
- *
1332
- * async function main() {
1333
- * const auth = new google.auth.GoogleAuth({
1334
- * // Scopes can be specified either as an array or as a single, space-delimited string.
1335
- * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
1336
- * });
1337
- *
1338
- * // Acquire an auth client, and bind it to all future calls
1339
- * const authClient = await auth.getClient();
1340
- * google.options({auth: authClient});
1341
- *
1342
- * // Do the magic
1343
- * const res = await tpu.projects.locations.operations.cancel({
1344
- * // The name of the operation resource to be cancelled.
1345
- * name: 'projects/my-project/locations/my-location/operations/my-operation',
1346
- * });
1347
- * console.log(res.data);
1348
- *
1349
- * // Example response
1350
- * // {}
1351
- * }
1352
- *
1353
- * main().catch(e => {
1354
- * console.error(e);
1355
- * throw e;
1356
- * });
1357
- *
1358
- * ```
1359
743
  *
1360
744
  * @param params - Parameters for request
1361
745
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1370,46 +754,6 @@ export declare namespace tpu_v1 {
1370
754
  cancel(callback: BodyResponseCallback<Schema$Empty>): void;
1371
755
  /**
1372
756
  * 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`.
1373
- * @example
1374
- * ```js
1375
- * // Before running the sample:
1376
- * // - Enable the API at:
1377
- * // https://console.developers.google.com/apis/api/tpu.googleapis.com
1378
- * // - Login into gcloud by running:
1379
- * // `$ gcloud auth application-default login`
1380
- * // - Install the npm module by running:
1381
- * // `$ npm install googleapis`
1382
- *
1383
- * const {google} = require('googleapis');
1384
- * const tpu = google.tpu('v1');
1385
- *
1386
- * async function main() {
1387
- * const auth = new google.auth.GoogleAuth({
1388
- * // Scopes can be specified either as an array or as a single, space-delimited string.
1389
- * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
1390
- * });
1391
- *
1392
- * // Acquire an auth client, and bind it to all future calls
1393
- * const authClient = await auth.getClient();
1394
- * google.options({auth: authClient});
1395
- *
1396
- * // Do the magic
1397
- * const res = await tpu.projects.locations.operations.delete({
1398
- * // The name of the operation resource to be deleted.
1399
- * name: 'projects/my-project/locations/my-location/operations/my-operation',
1400
- * });
1401
- * console.log(res.data);
1402
- *
1403
- * // Example response
1404
- * // {}
1405
- * }
1406
- *
1407
- * main().catch(e => {
1408
- * console.error(e);
1409
- * throw e;
1410
- * });
1411
- *
1412
- * ```
1413
757
  *
1414
758
  * @param params - Parameters for request
1415
759
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1424,52 +768,6 @@ export declare namespace tpu_v1 {
1424
768
  delete(callback: BodyResponseCallback<Schema$Empty>): void;
1425
769
  /**
1426
770
  * 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.
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('v1');
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.operations.get({
1452
- * // The name of the operation resource.
1453
- * name: 'projects/my-project/locations/my-location/operations/my-operation',
1454
- * });
1455
- * console.log(res.data);
1456
- *
1457
- * // Example response
1458
- * // {
1459
- * // "done": false,
1460
- * // "error": {},
1461
- * // "metadata": {},
1462
- * // "name": "my_name",
1463
- * // "response": {}
1464
- * // }
1465
- * }
1466
- *
1467
- * main().catch(e => {
1468
- * console.error(e);
1469
- * throw e;
1470
- * });
1471
- *
1472
- * ```
1473
771
  *
1474
772
  * @param params - Parameters for request
1475
773
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1483,56 +781,7 @@ export declare namespace tpu_v1 {
1483
781
  get(params: Params$Resource$Projects$Locations$Operations$Get, callback: BodyResponseCallback<Schema$Operation>): void;
1484
782
  get(callback: BodyResponseCallback<Schema$Operation>): void;
1485
783
  /**
1486
- * 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.
1487
- * @example
1488
- * ```js
1489
- * // Before running the sample:
1490
- * // - Enable the API at:
1491
- * // https://console.developers.google.com/apis/api/tpu.googleapis.com
1492
- * // - Login into gcloud by running:
1493
- * // `$ gcloud auth application-default login`
1494
- * // - Install the npm module by running:
1495
- * // `$ npm install googleapis`
1496
- *
1497
- * const {google} = require('googleapis');
1498
- * const tpu = google.tpu('v1');
1499
- *
1500
- * async function main() {
1501
- * const auth = new google.auth.GoogleAuth({
1502
- * // Scopes can be specified either as an array or as a single, space-delimited string.
1503
- * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
1504
- * });
1505
- *
1506
- * // Acquire an auth client, and bind it to all future calls
1507
- * const authClient = await auth.getClient();
1508
- * google.options({auth: authClient});
1509
- *
1510
- * // Do the magic
1511
- * const res = await tpu.projects.locations.operations.list({
1512
- * // The standard list filter.
1513
- * filter: 'placeholder-value',
1514
- * // The name of the operation's parent resource.
1515
- * name: 'projects/my-project/locations/my-location',
1516
- * // The standard list page size.
1517
- * pageSize: 'placeholder-value',
1518
- * // The standard list page token.
1519
- * pageToken: 'placeholder-value',
1520
- * });
1521
- * console.log(res.data);
1522
- *
1523
- * // Example response
1524
- * // {
1525
- * // "nextPageToken": "my_nextPageToken",
1526
- * // "operations": []
1527
- * // }
1528
- * }
1529
- *
1530
- * main().catch(e => {
1531
- * console.error(e);
1532
- * throw e;
1533
- * });
1534
- *
1535
- * ```
784
+ * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
1536
785
  *
1537
786
  * @param params - Parameters for request
1538
787
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1587,49 +836,6 @@ export declare namespace tpu_v1 {
1587
836
  constructor(context: APIRequestContext);
1588
837
  /**
1589
838
  * Gets TensorFlow Version.
1590
- * @example
1591
- * ```js
1592
- * // Before running the sample:
1593
- * // - Enable the API at:
1594
- * // https://console.developers.google.com/apis/api/tpu.googleapis.com
1595
- * // - Login into gcloud by running:
1596
- * // `$ gcloud auth application-default login`
1597
- * // - Install the npm module by running:
1598
- * // `$ npm install googleapis`
1599
- *
1600
- * const {google} = require('googleapis');
1601
- * const tpu = google.tpu('v1');
1602
- *
1603
- * async function main() {
1604
- * const auth = new google.auth.GoogleAuth({
1605
- * // Scopes can be specified either as an array or as a single, space-delimited string.
1606
- * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
1607
- * });
1608
- *
1609
- * // Acquire an auth client, and bind it to all future calls
1610
- * const authClient = await auth.getClient();
1611
- * google.options({auth: authClient});
1612
- *
1613
- * // Do the magic
1614
- * const res = await tpu.projects.locations.tensorflowVersions.get({
1615
- * // Required. The resource name.
1616
- * name: 'projects/my-project/locations/my-location/tensorflowVersions/my-tensorflowVersion',
1617
- * });
1618
- * console.log(res.data);
1619
- *
1620
- * // Example response
1621
- * // {
1622
- * // "name": "my_name",
1623
- * // "version": "my_version"
1624
- * // }
1625
- * }
1626
- *
1627
- * main().catch(e => {
1628
- * console.error(e);
1629
- * throw e;
1630
- * });
1631
- *
1632
- * ```
1633
839
  *
1634
840
  * @param params - Parameters for request
1635
841
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1644,58 +850,6 @@ export declare namespace tpu_v1 {
1644
850
  get(callback: BodyResponseCallback<Schema$TensorFlowVersion>): void;
1645
851
  /**
1646
852
  * List TensorFlow versions supported by this API.
1647
- * @example
1648
- * ```js
1649
- * // Before running the sample:
1650
- * // - Enable the API at:
1651
- * // https://console.developers.google.com/apis/api/tpu.googleapis.com
1652
- * // - Login into gcloud by running:
1653
- * // `$ gcloud auth application-default login`
1654
- * // - Install the npm module by running:
1655
- * // `$ npm install googleapis`
1656
- *
1657
- * const {google} = require('googleapis');
1658
- * const tpu = google.tpu('v1');
1659
- *
1660
- * async function main() {
1661
- * const auth = new google.auth.GoogleAuth({
1662
- * // Scopes can be specified either as an array or as a single, space-delimited string.
1663
- * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
1664
- * });
1665
- *
1666
- * // Acquire an auth client, and bind it to all future calls
1667
- * const authClient = await auth.getClient();
1668
- * google.options({auth: authClient});
1669
- *
1670
- * // Do the magic
1671
- * const res = await tpu.projects.locations.tensorflowVersions.list({
1672
- * // List filter.
1673
- * filter: 'placeholder-value',
1674
- * // Sort results.
1675
- * orderBy: 'placeholder-value',
1676
- * // The maximum number of items to return.
1677
- * pageSize: 'placeholder-value',
1678
- * // The next_page_token value returned from a previous List request, if any.
1679
- * pageToken: 'placeholder-value',
1680
- * // Required. The parent resource name.
1681
- * parent: 'projects/my-project/locations/my-location',
1682
- * });
1683
- * console.log(res.data);
1684
- *
1685
- * // Example response
1686
- * // {
1687
- * // "nextPageToken": "my_nextPageToken",
1688
- * // "tensorflowVersions": [],
1689
- * // "unreachable": []
1690
- * // }
1691
- * }
1692
- *
1693
- * main().catch(e => {
1694
- * console.error(e);
1695
- * throw e;
1696
- * });
1697
- *
1698
- * ```
1699
853
  *
1700
854
  * @param params - Parameters for request
1701
855
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.