v2.d.ts
107 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
/**
* Copyright 2019 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { OAuth2Client, JWT, Compute, UserRefreshClient } from 'google-auth-library';
import { GoogleConfigurable, MethodOptions, GlobalOptions, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { GaxiosPromise } from 'gaxios';
export declare namespace remotebuildexecution_v2 {
export interface Options extends GlobalOptions {
version: 'v2';
}
interface StandardParameters {
/**
* V1 error format.
*/
'$.xgafv'?: string;
/**
* OAuth access token.
*/
access_token?: string;
/**
* Data format for response.
*/
alt?: string;
/**
* JSONP
*/
callback?: string;
/**
* Selector specifying which fields to include in a partial response.
*/
fields?: string;
/**
* API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
*/
key?: string;
/**
* OAuth 2.0 token for the current user.
*/
oauth_token?: string;
/**
* Returns response with indentations and line breaks.
*/
prettyPrint?: boolean;
/**
* Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
*/
quotaUser?: string;
/**
* Legacy upload protocol for media (e.g. "media", "multipart").
*/
uploadType?: string;
/**
* Upload protocol for media (e.g. "raw", "multipart").
*/
upload_protocol?: string;
}
/**
* Remote Build Execution API
*
* Supplies a Remote Execution API service for tools such as bazel.
*
* @example
* const {google} = require('googleapis');
* const remotebuildexecution = google.remotebuildexecution('v2');
*
* @namespace remotebuildexecution
* @type {Function}
* @version v2
* @variation v2
* @param {object=} options Options for Remotebuildexecution
*/
export class Remotebuildexecution {
context: APIRequestContext;
actionResults: Resource$Actionresults;
actions: Resource$Actions;
blobs: Resource$Blobs;
operations: Resource$Operations;
v2: Resource$V2;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* An `Action` captures all the information about an execution which is required to reproduce it. `Action`s are the core component of the [Execution] service. A single `Action` represents a repeatable action that can be performed by the execution service. `Action`s can be succinctly identified by the digest of their wire format encoding and, once an `Action` has been executed, will be cached in the action cache. Future requests can then use the cached result rather than needing to run afresh. When a server completes execution of an Action, it MAY choose to cache the result in the ActionCache unless `do_not_cache` is `true`. Clients SHOULD expect the server to do so. By default, future calls to Execute the same `Action` will also serve their results from the cache. Clients must take care to understand the caching behaviour. Ideally, all `Action`s will be reproducible so that serving a result from cache is always desirable and correct.
*/
export interface Schema$BuildBazelRemoteExecutionV2Action {
/**
* The digest of the Command to run, which MUST be present in the ContentAddressableStorage.
*/
commandDigest?: Schema$BuildBazelRemoteExecutionV2Digest;
/**
* If true, then the `Action`'s result cannot be cached, and in-flight requests for the same `Action` may not be merged.
*/
doNotCache?: boolean | null;
/**
* The digest of the root Directory for the input files. The files in the directory tree are available in the correct location on the build machine before the command is executed. The root directory, as well as every subdirectory and content blob referred to, MUST be in the ContentAddressableStorage.
*/
inputRootDigest?: Schema$BuildBazelRemoteExecutionV2Digest;
/**
* A timeout after which the execution should be killed. If the timeout is absent, then the client is specifying that the execution should continue as long as the server will let it. The server SHOULD impose a timeout if the client does not specify one, however, if the client does specify a timeout that is longer than the server's maximum timeout, the server MUST reject the request. The timeout is a part of the Action message, and therefore two `Actions` with different timeouts are different, even if they are otherwise identical. This is because, if they were not, running an `Action` with a lower timeout than is required might result in a cache hit from an execution run with a longer timeout, hiding the fact that the timeout is too short. By encoding it directly in the `Action`, a lower timeout will result in a cache miss and the execution timeout will fail immediately, rather than whenever the cache entry gets evicted.
*/
timeout?: string | null;
}
/**
* Describes the server/instance capabilities for updating the action cache.
*/
export interface Schema$BuildBazelRemoteExecutionV2ActionCacheUpdateCapabilities {
updateEnabled?: boolean | null;
}
/**
* An ActionResult represents the result of an Action being run.
*/
export interface Schema$BuildBazelRemoteExecutionV2ActionResult {
/**
* The details of the execution that originally produced this result.
*/
executionMetadata?: Schema$BuildBazelRemoteExecutionV2ExecutedActionMetadata;
/**
* The exit code of the command.
*/
exitCode?: number | null;
/**
* The output directories of the action. For each output directory requested in the `output_directories` field of the Action, if the corresponding directory existed after the action completed, a single entry will be present in the output list, which will contain the digest of a Tree message containing the directory tree, and the path equal exactly to the corresponding Action output_directories member. As an example, suppose the Action had an output directory `a/b/dir` and the execution produced the following contents in `a/b/dir`: a file named `bar` and a directory named `foo` with an executable file named `baz`. Then, output_directory will contain (hashes shortened for readability): ```json // OutputDirectory proto: { path: "a/b/dir" tree_digest: { hash: "4a73bc9d03...", size: 55 } } // Tree proto with hash "4a73bc9d03..." and size 55: { root: { files: [ { name: "bar", digest: { hash: "4a73bc9d03...", size: 65534 } } ], directories: [ { name: "foo", digest: { hash: "4cf2eda940...", size: 43 } } ] } children : { // (Directory proto with hash "4cf2eda940..." and size 43) files: [ { name: "baz", digest: { hash: "b2c941073e...", size: 1294, }, is_executable: true } ] } } ``` If an output of the same name was found, but was not a directory, the server will return a FAILED_PRECONDITION.
*/
outputDirectories?: Schema$BuildBazelRemoteExecutionV2OutputDirectory[];
/**
* The output directories of the action that are symbolic links to other directories. Those may be links to other output directories, or input directories, or even absolute paths outside of the working directory, if the server supports SymlinkAbsolutePathStrategy.ALLOWED. For each output directory requested in the `output_directories` field of the Action, if the directory existed after the action completed, a single entry will be present either in this field, or in the `output_directories` field, if the directory was not a symbolic link. If an output of the same name was found, but was a symbolic link to a file instead of a directory, the server will return a FAILED_PRECONDITION. If the action does not produce the requested output, then that output will be omitted from the list. The server is free to arrange the output list as desired; clients MUST NOT assume that the output list is sorted.
*/
outputDirectorySymlinks?: Schema$BuildBazelRemoteExecutionV2OutputSymlink[];
/**
* The output files of the action. For each output file requested in the `output_files` field of the Action, if the corresponding file existed after the action completed, a single entry will be present either in this field, or the `output_file_symlinks` field if the file was a symbolic link to another file. If an output of the same name was found, but was a directory rather than a regular file, the server will return a FAILED_PRECONDITION. If the action does not produce the requested output, then that output will be omitted from the list. The server is free to arrange the output list as desired; clients MUST NOT assume that the output list is sorted.
*/
outputFiles?: Schema$BuildBazelRemoteExecutionV2OutputFile[];
/**
* The output files of the action that are symbolic links to other files. Those may be links to other output files, or input files, or even absolute paths outside of the working directory, if the server supports SymlinkAbsolutePathStrategy.ALLOWED. For each output file requested in the `output_files` field of the Action, if the corresponding file existed after the action completed, a single entry will be present either in this field, or in the `output_files` field, if the file was not a symbolic link. If an output symbolic link of the same name was found, but its target type was not a regular file, the server will return a FAILED_PRECONDITION. If the action does not produce the requested output, then that output will be omitted from the list. The server is free to arrange the output list as desired; clients MUST NOT assume that the output list is sorted.
*/
outputFileSymlinks?: Schema$BuildBazelRemoteExecutionV2OutputSymlink[];
/**
* The digest for a blob containing the standard error of the action, which can be retrieved from the ContentAddressableStorage.
*/
stderrDigest?: Schema$BuildBazelRemoteExecutionV2Digest;
/**
* The standard error buffer of the action. The server SHOULD NOT inline stderr unless requested by the client in the GetActionResultRequest message. The server MAY omit inlining, even if requested, and MUST do so if inlining would cause the response to exceed message size limits.
*/
stderrRaw?: string | null;
/**
* The digest for a blob containing the standard output of the action, which can be retrieved from the ContentAddressableStorage.
*/
stdoutDigest?: Schema$BuildBazelRemoteExecutionV2Digest;
/**
* The standard output buffer of the action. The server SHOULD NOT inline stdout unless requested by the client in the GetActionResultRequest message. The server MAY omit inlining, even if requested, and MUST do so if inlining would cause the response to exceed message size limits.
*/
stdoutRaw?: string | null;
}
/**
* A request message for ContentAddressableStorage.BatchReadBlobs.
*/
export interface Schema$BuildBazelRemoteExecutionV2BatchReadBlobsRequest {
/**
* The individual blob digests.
*/
digests?: Schema$BuildBazelRemoteExecutionV2Digest[];
}
/**
* A response message for ContentAddressableStorage.BatchReadBlobs.
*/
export interface Schema$BuildBazelRemoteExecutionV2BatchReadBlobsResponse {
/**
* The responses to the requests.
*/
responses?: Schema$BuildBazelRemoteExecutionV2BatchReadBlobsResponseResponse[];
}
/**
* A response corresponding to a single blob that the client tried to download.
*/
export interface Schema$BuildBazelRemoteExecutionV2BatchReadBlobsResponseResponse {
/**
* The raw binary data.
*/
data?: string | null;
/**
* The digest to which this response corresponds.
*/
digest?: Schema$BuildBazelRemoteExecutionV2Digest;
/**
* The result of attempting to download that blob.
*/
status?: Schema$GoogleRpcStatus;
}
/**
* A request message for ContentAddressableStorage.BatchUpdateBlobs.
*/
export interface Schema$BuildBazelRemoteExecutionV2BatchUpdateBlobsRequest {
/**
* The individual upload requests.
*/
requests?: Schema$BuildBazelRemoteExecutionV2BatchUpdateBlobsRequestRequest[];
}
/**
* A request corresponding to a single blob that the client wants to upload.
*/
export interface Schema$BuildBazelRemoteExecutionV2BatchUpdateBlobsRequestRequest {
/**
* The raw binary data.
*/
data?: string | null;
/**
* The digest of the blob. This MUST be the digest of `data`.
*/
digest?: Schema$BuildBazelRemoteExecutionV2Digest;
}
/**
* A response message for ContentAddressableStorage.BatchUpdateBlobs.
*/
export interface Schema$BuildBazelRemoteExecutionV2BatchUpdateBlobsResponse {
/**
* The responses to the requests.
*/
responses?: Schema$BuildBazelRemoteExecutionV2BatchUpdateBlobsResponseResponse[];
}
/**
* A response corresponding to a single blob that the client tried to upload.
*/
export interface Schema$BuildBazelRemoteExecutionV2BatchUpdateBlobsResponseResponse {
/**
* The blob digest to which this response corresponds.
*/
digest?: Schema$BuildBazelRemoteExecutionV2Digest;
/**
* The result of attempting to upload that blob.
*/
status?: Schema$GoogleRpcStatus;
}
/**
* Capabilities of the remote cache system.
*/
export interface Schema$BuildBazelRemoteExecutionV2CacheCapabilities {
/**
* Capabilities for updating the action cache.
*/
actionCacheUpdateCapabilities?: Schema$BuildBazelRemoteExecutionV2ActionCacheUpdateCapabilities;
/**
* Supported cache priority range for both CAS and ActionCache.
*/
cachePriorityCapabilities?: Schema$BuildBazelRemoteExecutionV2PriorityCapabilities;
/**
* All the digest functions supported by the remote cache. Remote cache may support multiple digest functions simultaneously.
*/
digestFunction?: string[] | null;
/**
* Maximum total size of blobs to be uploaded/downloaded using batch methods. A value of 0 means no limit is set, although in practice there will always be a message size limitation of the protocol in use, e.g. GRPC.
*/
maxBatchTotalSizeBytes?: string | null;
/**
* Whether absolute symlink targets are supported.
*/
symlinkAbsolutePathStrategy?: string | null;
}
/**
* A `Command` is the actual command executed by a worker running an Action and specifications of its environment. Except as otherwise required, the environment (such as which system libraries or binaries are available, and what filesystems are mounted where) is defined by and specific to the implementation of the remote execution API.
*/
export interface Schema$BuildBazelRemoteExecutionV2Command {
/**
* The arguments to the command. The first argument must be the path to the executable, which must be either a relative path, in which case it is evaluated with respect to the input root, or an absolute path.
*/
arguments?: string[] | null;
/**
* The environment variables to set when running the program. The worker may provide its own default environment variables; these defaults can be overridden using this field. Additional variables can also be specified. In order to ensure that equivalent Commands always hash to the same value, the environment variables MUST be lexicographically sorted by name. Sorting of strings is done by code point, equivalently, by the UTF-8 bytes.
*/
environmentVariables?: Schema$BuildBazelRemoteExecutionV2CommandEnvironmentVariable[];
/**
* A list of the output directories that the client expects to retrieve from the action. Only the listed directories will be returned (an entire directory structure will be returned as a Tree message digest, see OutputDirectory), as well as files listed in `output_files`. Other files or directories that may be created during command execution are discarded. The paths are relative to the working directory of the action execution. The paths are specified using a single forward slash (`/`) as a path separator, even if the execution platform natively uses a different separator. The path MUST NOT include a trailing slash, nor a leading slash, being a relative path. The special value of empty string is allowed, although not recommended, and can be used to capture the entire working directory tree, including inputs. In order to ensure consistent hashing of the same Action, the output paths MUST be sorted lexicographically by code point (or, equivalently, by UTF-8 bytes). An output directory cannot be duplicated or have the same path as any of the listed output files. An output directory is allowed to be a parent of another output directory. Directories leading up to the output directories (but not the output directories themselves) are created by the worker prior to execution, even if they are not explicitly part of the input root.
*/
outputDirectories?: string[] | null;
/**
* A list of the output files that the client expects to retrieve from the action. Only the listed files, as well as directories listed in `output_directories`, will be returned to the client as output. Other files or directories that may be created during command execution are discarded. The paths are relative to the working directory of the action execution. The paths are specified using a single forward slash (`/`) as a path separator, even if the execution platform natively uses a different separator. The path MUST NOT include a trailing slash, nor a leading slash, being a relative path. In order to ensure consistent hashing of the same Action, the output paths MUST be sorted lexicographically by code point (or, equivalently, by UTF-8 bytes). An output file cannot be duplicated, be a parent of another output file, or have the same path as any of the listed output directories. Directories leading up to the output files are created by the worker prior to execution, even if they are not explicitly part of the input root.
*/
outputFiles?: string[] | null;
/**
* The platform requirements for the execution environment. The server MAY choose to execute the action on any worker satisfying the requirements, so the client SHOULD ensure that running the action on any such worker will have the same result. A detailed lexicon for this can be found in the accompanying platform.md.
*/
platform?: Schema$BuildBazelRemoteExecutionV2Platform;
/**
* The working directory, relative to the input root, for the command to run in. It must be a directory which exists in the input tree. If it is left empty, then the action is run in the input root.
*/
workingDirectory?: string | null;
}
/**
* An `EnvironmentVariable` is one variable to set in the running program's environment.
*/
export interface Schema$BuildBazelRemoteExecutionV2CommandEnvironmentVariable {
/**
* The variable name.
*/
name?: string | null;
/**
* The variable value.
*/
value?: string | null;
}
/**
* A content digest. A digest for a given blob consists of the size of the blob and its hash. The hash algorithm to use is defined by the server, but servers SHOULD use SHA-256. The size is considered to be an integral part of the digest and cannot be separated. That is, even if the `hash` field is correctly specified but `size_bytes` is not, the server MUST reject the request. The reason for including the size in the digest is as follows: in a great many cases, the server needs to know the size of the blob it is about to work with prior to starting an operation with it, such as flattening Merkle tree structures or streaming it to a worker. Technically, the server could implement a separate metadata store, but this results in a significantly more complicated implementation as opposed to having the client specify the size up-front (or storing the size along with the digest in every message where digests are embedded). This does mean that the API leaks some implementation details of (what we consider to be) a reasonable server implementation, but we consider this to be a worthwhile tradeoff. When a `Digest` is used to refer to a proto message, it always refers to the message in binary encoded form. To ensure consistent hashing, clients and servers MUST ensure that they serialize messages according to the following rules, even if there are alternate valid encodings for the same message: * Fields are serialized in tag order. * There are no unknown fields. * There are no duplicate fields. * Fields are serialized according to the default semantics for their type. Most protocol buffer implementations will always follow these rules when serializing, but care should be taken to avoid shortcuts. For instance, concatenating two messages to merge them may produce duplicate fields.
*/
export interface Schema$BuildBazelRemoteExecutionV2Digest {
/**
* The hash. In the case of SHA-256, it will always be a lowercase hex string exactly 64 characters long.
*/
hash?: string | null;
/**
* The size of the blob, in bytes.
*/
sizeBytes?: string | null;
}
/**
* A `Directory` represents a directory node in a file tree, containing zero or more children FileNodes, DirectoryNodes and SymlinkNodes. Each `Node` contains its name in the directory, either the digest of its content (either a file blob or a `Directory` proto) or a symlink target, as well as possibly some metadata about the file or directory. In order to ensure that two equivalent directory trees hash to the same value, the following restrictions MUST be obeyed when constructing a a `Directory`: * Every child in the directory must have a path of exactly one segment. Multiple levels of directory hierarchy may not be collapsed. * Each child in the directory must have a unique path segment (file name). Note that while the API itself is case-sensitive, the environment where the Action is executed may or may not be case-sensitive. That is, it is legal to call the API with a Directory that has both "Foo" and "foo" as children, but the Action may be rejected by the remote system upon execution. * The files, directories and symlinks in the directory must each be sorted in lexicographical order by path. The path strings must be sorted by code point, equivalently, by UTF-8 bytes. A `Directory` that obeys the restrictions is said to be in canonical form. As an example, the following could be used for a file named `bar` and a directory named `foo` with an executable file named `baz` (hashes shortened for readability): ```json // (Directory proto) { files: [ { name: "bar", digest: { hash: "4a73bc9d03...", size: 65534 } } ], directories: [ { name: "foo", digest: { hash: "4cf2eda940...", size: 43 } } ] } // (Directory proto with hash "4cf2eda940..." and size 43) { files: [ { name: "baz", digest: { hash: "b2c941073e...", size: 1294, }, is_executable: true } ] } ```
*/
export interface Schema$BuildBazelRemoteExecutionV2Directory {
/**
* The subdirectories in the directory.
*/
directories?: Schema$BuildBazelRemoteExecutionV2DirectoryNode[];
/**
* The files in the directory.
*/
files?: Schema$BuildBazelRemoteExecutionV2FileNode[];
/**
* The symlinks in the directory.
*/
symlinks?: Schema$BuildBazelRemoteExecutionV2SymlinkNode[];
}
/**
* A `DirectoryNode` represents a child of a Directory which is itself a `Directory` and its associated metadata.
*/
export interface Schema$BuildBazelRemoteExecutionV2DirectoryNode {
/**
* The digest of the Directory object represented. See Digest for information about how to take the digest of a proto message.
*/
digest?: Schema$BuildBazelRemoteExecutionV2Digest;
/**
* The name of the directory.
*/
name?: string | null;
}
/**
* ExecutedActionMetadata contains details about a completed execution.
*/
export interface Schema$BuildBazelRemoteExecutionV2ExecutedActionMetadata {
/**
* When the worker completed executing the action command.
*/
executionCompletedTimestamp?: string | null;
/**
* When the worker started executing the action command.
*/
executionStartTimestamp?: string | null;
/**
* When the worker finished fetching action inputs.
*/
inputFetchCompletedTimestamp?: string | null;
/**
* When the worker started fetching action inputs.
*/
inputFetchStartTimestamp?: string | null;
/**
* When the worker finished uploading action outputs.
*/
outputUploadCompletedTimestamp?: string | null;
/**
* When the worker started uploading action outputs.
*/
outputUploadStartTimestamp?: string | null;
/**
* When was the action added to the queue.
*/
queuedTimestamp?: string | null;
/**
* The name of the worker which ran the execution.
*/
worker?: string | null;
/**
* When the worker completed the action, including all stages.
*/
workerCompletedTimestamp?: string | null;
/**
* When the worker received the action.
*/
workerStartTimestamp?: string | null;
}
/**
* Metadata about an ongoing execution, which will be contained in the metadata field of the Operation.
*/
export interface Schema$BuildBazelRemoteExecutionV2ExecuteOperationMetadata {
/**
* The digest of the Action being executed.
*/
actionDigest?: Schema$BuildBazelRemoteExecutionV2Digest;
/**
* The current stage of execution.
*/
stage?: string | null;
/**
* If set, the client can use this name with ByteStream.Read to stream the standard error.
*/
stderrStreamName?: string | null;
/**
* If set, the client can use this name with ByteStream.Read to stream the standard output.
*/
stdoutStreamName?: string | null;
}
/**
* A request message for Execution.Execute.
*/
export interface Schema$BuildBazelRemoteExecutionV2ExecuteRequest {
/**
* The digest of the Action to execute.
*/
actionDigest?: Schema$BuildBazelRemoteExecutionV2Digest;
/**
* An optional policy for execution of the action. The server will have a default policy if this is not provided.
*/
executionPolicy?: Schema$BuildBazelRemoteExecutionV2ExecutionPolicy;
/**
* An optional policy for the results of this execution in the remote cache. The server will have a default policy if this is not provided. This may be applied to both the ActionResult and the associated blobs.
*/
resultsCachePolicy?: Schema$BuildBazelRemoteExecutionV2ResultsCachePolicy;
/**
* If true, the action will be executed even if its result is already present in the ActionCache. The execution is still allowed to be merged with other in-flight executions of the same action, however - semantically, the service MUST only guarantee that the results of an execution with this field set were not visible before the corresponding execution request was sent. Note that actions from execution requests setting this field set are still eligible to be entered into the action cache upon completion, and services SHOULD overwrite any existing entries that may exist. This allows skip_cache_lookup requests to be used as a mechanism for replacing action cache entries that reference outputs no longer available or that are poisoned in any way. If false, the result may be served from the action cache.
*/
skipCacheLookup?: boolean | null;
}
/**
* The response message for Execution.Execute, which will be contained in the response field of the Operation.
*/
export interface Schema$BuildBazelRemoteExecutionV2ExecuteResponse {
/**
* True if the result was served from cache, false if it was executed.
*/
cachedResult?: boolean | null;
/**
* Freeform informational message with details on the execution of the action that may be displayed to the user upon failure or when requested explicitly.
*/
message?: string | null;
/**
* The result of the action.
*/
result?: Schema$BuildBazelRemoteExecutionV2ActionResult;
/**
* An optional list of additional log outputs the server wishes to provide. A server can use this to return execution-specific logs however it wishes. This is intended primarily to make it easier for users to debug issues that may be outside of the actual job execution, such as by identifying the worker executing the action or by providing logs from the worker's setup phase. The keys SHOULD be human readable so that a client can display them to a user.
*/
serverLogs?: {
[key: string]: Schema$BuildBazelRemoteExecutionV2LogFile;
} | null;
/**
* If the status has a code other than `OK`, it indicates that the action did not finish execution. For example, if the operation times out during execution, the status will have a `DEADLINE_EXCEEDED` code. Servers MUST use this field for errors in execution, rather than the error field on the `Operation` object. If the status code is other than `OK`, then the result MUST NOT be cached. For an error status, the `result` field is optional; the server may populate the output-, stdout-, and stderr-related fields if it has any information available, such as the stdout and stderr of a timed-out action.
*/
status?: Schema$GoogleRpcStatus;
}
/**
* Capabilities of the remote execution system.
*/
export interface Schema$BuildBazelRemoteExecutionV2ExecutionCapabilities {
/**
* Remote execution may only support a single digest function.
*/
digestFunction?: string | null;
/**
* Whether remote execution is enabled for the particular server/instance.
*/
execEnabled?: boolean | null;
/**
* Supported execution priority range.
*/
executionPriorityCapabilities?: Schema$BuildBazelRemoteExecutionV2PriorityCapabilities;
}
/**
* An `ExecutionPolicy` can be used to control the scheduling of the action.
*/
export interface Schema$BuildBazelRemoteExecutionV2ExecutionPolicy {
/**
* The priority (relative importance) of this action. Generally, a lower value means that the action should be run sooner than actions having a greater priority value, but the interpretation of a given value is server- dependent. A priority of 0 means the *default* priority. Priorities may be positive or negative, and such actions should run later or sooner than actions having the default priority, respectively. The particular semantics of this field is up to the server. In particular, every server will have their own supported range of priorities, and will decide how these map into scheduling policy.
*/
priority?: number | null;
}
/**
* A `FileNode` represents a single file and associated metadata.
*/
export interface Schema$BuildBazelRemoteExecutionV2FileNode {
/**
* The digest of the file's content.
*/
digest?: Schema$BuildBazelRemoteExecutionV2Digest;
/**
* True if file is executable, false otherwise.
*/
isExecutable?: boolean | null;
/**
* The name of the file.
*/
name?: string | null;
}
/**
* A request message for ContentAddressableStorage.FindMissingBlobs.
*/
export interface Schema$BuildBazelRemoteExecutionV2FindMissingBlobsRequest {
/**
* A list of the blobs to check.
*/
blobDigests?: Schema$BuildBazelRemoteExecutionV2Digest[];
}
/**
* A response message for ContentAddressableStorage.FindMissingBlobs.
*/
export interface Schema$BuildBazelRemoteExecutionV2FindMissingBlobsResponse {
/**
* A list of the blobs requested *not* present in the storage.
*/
missingBlobDigests?: Schema$BuildBazelRemoteExecutionV2Digest[];
}
/**
* A response message for ContentAddressableStorage.GetTree.
*/
export interface Schema$BuildBazelRemoteExecutionV2GetTreeResponse {
/**
* The directories descended from the requested root.
*/
directories?: Schema$BuildBazelRemoteExecutionV2Directory[];
/**
* If present, signifies that there are more results which the client can retrieve by passing this as the page_token in a subsequent request. If empty, signifies that this is the last page of results.
*/
nextPageToken?: string | null;
}
/**
* A `LogFile` is a log stored in the CAS.
*/
export interface Schema$BuildBazelRemoteExecutionV2LogFile {
/**
* The digest of the log contents.
*/
digest?: Schema$BuildBazelRemoteExecutionV2Digest;
/**
* This is a hint as to the purpose of the log, and is set to true if the log is human-readable text that can be usefully displayed to a user, and false otherwise. For instance, if a command-line client wishes to print the server logs to the terminal for a failed action, this allows it to avoid displaying a binary file.
*/
humanReadable?: boolean | null;
}
/**
* An `OutputDirectory` is the output in an `ActionResult` corresponding to a directory's full contents rather than a single file.
*/
export interface Schema$BuildBazelRemoteExecutionV2OutputDirectory {
/**
* The full path of the directory relative to the working directory. The path separator is a forward slash `/`. Since this is a relative path, it MUST NOT begin with a leading forward slash. The empty string value is allowed, and it denotes the entire working directory.
*/
path?: string | null;
/**
* The digest of the encoded Tree proto containing the directory's contents.
*/
treeDigest?: Schema$BuildBazelRemoteExecutionV2Digest;
}
/**
* An `OutputFile` is similar to a FileNode, but it is used as an output in an `ActionResult`. It allows a full file path rather than only a name.
*/
export interface Schema$BuildBazelRemoteExecutionV2OutputFile {
/**
* The contents of the file if inlining was requested. The server SHOULD NOT inline file contents unless requested by the client in the GetActionResultRequest message. The server MAY omit inlining, even if requested, and MUST do so if inlining would cause the response to exceed message size limits.
*/
contents?: string | null;
/**
* The digest of the file's content.
*/
digest?: Schema$BuildBazelRemoteExecutionV2Digest;
/**
* True if file is executable, false otherwise.
*/
isExecutable?: boolean | null;
/**
* The full path of the file relative to the working directory, including the filename. The path separator is a forward slash `/`. Since this is a relative path, it MUST NOT begin with a leading forward slash.
*/
path?: string | null;
}
/**
* An `OutputSymlink` is similar to a Symlink, but it is used as an output in an `ActionResult`. `OutputSymlink` is binary-compatible with `SymlinkNode`.
*/
export interface Schema$BuildBazelRemoteExecutionV2OutputSymlink {
/**
* The full path of the symlink relative to the working directory, including the filename. The path separator is a forward slash `/`. Since this is a relative path, it MUST NOT begin with a leading forward slash.
*/
path?: string | null;
/**
* The target path of the symlink. The path separator is a forward slash `/`. The target path can be relative to the parent directory of the symlink or it can be an absolute path starting with `/`. Support for absolute paths can be checked using the Capabilities API. The canonical form forbids the substrings `/./` and `//` in the target path. `..` components are allowed anywhere in the target path.
*/
target?: string | null;
}
/**
* A `Platform` is a set of requirements, such as hardware, operating system, or compiler toolchain, for an Action's execution environment. A `Platform` is represented as a series of key-value pairs representing the properties that are required of the platform.
*/
export interface Schema$BuildBazelRemoteExecutionV2Platform {
/**
* The properties that make up this platform. In order to ensure that equivalent `Platform`s always hash to the same value, the properties MUST be lexicographically sorted by name, and then by value. Sorting of strings is done by code point, equivalently, by the UTF-8 bytes.
*/
properties?: Schema$BuildBazelRemoteExecutionV2PlatformProperty[];
}
/**
* A single property for the environment. The server is responsible for specifying the property `name`s that it accepts. If an unknown `name` is provided in the requirements for an Action, the server SHOULD reject the execution request. If permitted by the server, the same `name` may occur multiple times. The server is also responsible for specifying the interpretation of property `value`s. For instance, a property describing how much RAM must be available may be interpreted as allowing a worker with 16GB to fulfill a request for 8GB, while a property describing the OS environment on which the action must be performed may require an exact match with the worker's OS. The server MAY use the `value` of one or more properties to determine how it sets up the execution environment, such as by making specific system files available to the worker.
*/
export interface Schema$BuildBazelRemoteExecutionV2PlatformProperty {
/**
* The property name.
*/
name?: string | null;
/**
* The property value.
*/
value?: string | null;
}
/**
* Allowed values for priority in ResultsCachePolicy Used for querying both cache and execution valid priority ranges.
*/
export interface Schema$BuildBazelRemoteExecutionV2PriorityCapabilities {
priorities?: Schema$BuildBazelRemoteExecutionV2PriorityCapabilitiesPriorityRange[];
}
/**
* Supported range of priorities, including boundaries.
*/
export interface Schema$BuildBazelRemoteExecutionV2PriorityCapabilitiesPriorityRange {
maxPriority?: number | null;
minPriority?: number | null;
}
/**
* An optional Metadata to attach to any RPC request to tell the server about an external context of the request. The server may use this for logging or other purposes. To use it, the client attaches the header to the call using the canonical proto serialization: * name: `build.bazel.remote.execution.v2.requestmetadata-bin` * contents: the base64 encoded binary `RequestMetadata` message. Note: the gRPC library serializes binary headers encoded in base 64 by default (https://github.com/grpc/grpc/blob/master/doc/PROTOCOL-HTTP2.md#requests). Therefore, if the gRPC library is used to pass/retrieve this metadata, the user may ignore the base64 encoding and assume it is simply serialized as a binary message.
*/
export interface Schema$BuildBazelRemoteExecutionV2RequestMetadata {
/**
* An identifier that ties multiple requests to the same action. For example, multiple requests to the CAS, Action Cache, and Execution API are used in order to compile foo.cc.
*/
actionId?: string | null;
/**
* An identifier to tie multiple tool invocations together. For example, runs of foo_test, bar_test and baz_test on a post-submit of a given patch.
*/
correlatedInvocationsId?: string | null;
/**
* The details for the tool invoking the requests.
*/
toolDetails?: Schema$BuildBazelRemoteExecutionV2ToolDetails;
/**
* An identifier that ties multiple actions together to a final result. For example, multiple actions are required to build and run foo_test.
*/
toolInvocationId?: string | null;
}
/**
* A `ResultsCachePolicy` is used for fine-grained control over how action outputs are stored in the CAS and Action Cache.
*/
export interface Schema$BuildBazelRemoteExecutionV2ResultsCachePolicy {
/**
* The priority (relative importance) of this content in the overall cache. Generally, a lower value means a longer retention time or other advantage, but the interpretation of a given value is server-dependent. A priority of 0 means a *default* value, decided by the server. The particular semantics of this field is up to the server. In particular, every server will have their own supported range of priorities, and will decide how these map into retention/eviction policy.
*/
priority?: number | null;
}
/**
* A response message for Capabilities.GetCapabilities.
*/
export interface Schema$BuildBazelRemoteExecutionV2ServerCapabilities {
/**
* Capabilities of the remote cache system.
*/
cacheCapabilities?: Schema$BuildBazelRemoteExecutionV2CacheCapabilities;
/**
* Earliest RE API version supported, including deprecated versions.
*/
deprecatedApiVersion?: Schema$BuildBazelSemverSemVer;
/**
* Capabilities of the remote execution system.
*/
executionCapabilities?: Schema$BuildBazelRemoteExecutionV2ExecutionCapabilities;
/**
* Latest RE API version supported.
*/
highApiVersion?: Schema$BuildBazelSemverSemVer;
/**
* Earliest non-deprecated RE API version supported.
*/
lowApiVersion?: Schema$BuildBazelSemverSemVer;
}
/**
* A `SymlinkNode` represents a symbolic link.
*/
export interface Schema$BuildBazelRemoteExecutionV2SymlinkNode {
/**
* The name of the symlink.
*/
name?: string | null;
/**
* The target path of the symlink. The path separator is a forward slash `/`. The target path can be relative to the parent directory of the symlink or it can be an absolute path starting with `/`. Support for absolute paths can be checked using the Capabilities API. The canonical form forbids the substrings `/./` and `//` in the target path. `..` components are allowed anywhere in the target path.
*/
target?: string | null;
}
/**
* Details for the tool used to call the API.
*/
export interface Schema$BuildBazelRemoteExecutionV2ToolDetails {
/**
* Name of the tool, e.g. bazel.
*/
toolName?: string | null;
/**
* Version of the tool used for the request, e.g. 5.0.3.
*/
toolVersion?: string | null;
}
/**
* A `Tree` contains all the Directory protos in a single directory Merkle tree, compressed into one message.
*/
export interface Schema$BuildBazelRemoteExecutionV2Tree {
/**
* All the child directories: the directories referred to by the root and, recursively, all its children. In order to reconstruct the directory tree, the client must take the digests of each of the child directories and then build up a tree starting from the `root`.
*/
children?: Schema$BuildBazelRemoteExecutionV2Directory[];
/**
* The root directory in the tree.
*/
root?: Schema$BuildBazelRemoteExecutionV2Directory;
}
/**
* A request message for WaitExecution.
*/
export interface Schema$BuildBazelRemoteExecutionV2WaitExecutionRequest {
}
/**
* The full version of a given tool.
*/
export interface Schema$BuildBazelSemverSemVer {
/**
* The major version, e.g 10 for 10.2.3.
*/
major?: number | null;
/**
* The minor version, e.g. 2 for 10.2.3.
*/
minor?: number | null;
/**
* The patch version, e.g 3 for 10.2.3.
*/
patch?: number | null;
/**
* The pre-release version. Either this field or major/minor/patch fields must be filled. They are mutually exclusive. Pre-release versions are assumed to be earlier than any released versions.
*/
prerelease?: string | null;
}
/**
* CommandDuration contains the various duration metrics tracked when a bot performs a command.
*/
export interface Schema$GoogleDevtoolsRemotebuildbotCommandDurations {
/**
* The time spent preparing the command to be run in a Docker container (includes pulling the Docker image, if necessary).
*/
dockerPrep?: string | null;
/**
* The timestamp when docker prepartion begins.
*/
dockerPrepStartTime?: string | null;
/**
* The time spent downloading the input files and constructing the working directory.
*/
download?: string | null;
/**
* The timestamp when downloading the input files begins.
*/
downloadStartTime?: string | null;
/**
* The timestamp when execution begins.
*/
execStartTime?: string | null;
/**
* The time spent executing the command (i.e., doing useful work).
*/
execution?: string | null;
/**
* The timestamp when preparation is done and bot starts downloading files.
*/
isoPrepDone?: string | null;
/**
* The time spent completing the command, in total.
*/
overall?: string | null;
/**
* The time spent uploading the stdout logs.
*/
stdout?: string | null;
/**
* The time spent uploading the output files.
*/
upload?: string | null;
/**
* The timestamp when uploading the output files begins.
*/
uploadStartTime?: string | null;
}
/**
* CommandEvents contains counters for the number of warnings and errors that occurred during the execution of a command.
*/
export interface Schema$GoogleDevtoolsRemotebuildbotCommandEvents {
/**
* Indicates whether we are using a cached Docker image (true) or had to pull the Docker image (false) for this command.
*/
dockerCacheHit?: boolean | null;
/**
* The input cache miss ratio.
*/
inputCacheMiss?: number | null;
/**
* The number of errors reported.
*/
numErrors?: string | null;
/**
* The number of warnings reported.
*/
numWarnings?: string | null;
}
/**
* The internal status of the command result.
*/
export interface Schema$GoogleDevtoolsRemotebuildbotCommandStatus {
/**
* The status code.
*/
code?: string | null;
/**
* The error message.
*/
message?: string | null;
}
/**
* AcceleratorConfig defines the accelerator cards to attach to the VM.
*/
export interface Schema$GoogleDevtoolsRemotebuildexecutionAdminV1alphaAcceleratorConfig {
/**
* The number of guest accelerator cards exposed to each VM.
*/
acceleratorCount?: string | null;
/**
* The type of accelerator to attach to each VM, e.g. "nvidia-tesla-k80" for nVidia Tesla K80.
*/
acceleratorType?: string | null;
}
/**
* The request used for `CreateInstance`.
*/
export interface Schema$GoogleDevtoolsRemotebuildexecutionAdminV1alphaCreateInstanceRequest {
/**
* Specifies the instance to create. The name in the instance, if specified in the instance, is ignored.
*/
instance?: Schema$GoogleDevtoolsRemotebuildexecutionAdminV1alphaInstance;
/**
* ID of the created instance. A valid `instance_id` must: be 6-50 characters long, contain only lowercase letters, digits, hyphens and underscores, start with a lowercase letter, and end with a lowercase letter or a digit.
*/
instanceId?: string | null;
/**
* Resource name of the project containing the instance. Format: `projects/[PROJECT_ID]`.
*/
parent?: string | null;
}
/**
* The request used for `CreateWorkerPool`.
*/
export interface Schema$GoogleDevtoolsRemotebuildexecutionAdminV1alphaCreateWorkerPoolRequest {
/**
* Resource name of the instance in which to create the new worker pool. Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`.
*/
parent?: string | null;
/**
* ID of the created worker pool. A valid pool ID must: be 6-50 characters long, contain only lowercase letters, digits, hyphens and underscores, start with a lowercase letter, and end with a lowercase letter or a digit.
*/
poolId?: string | null;
/**
* Specifies the worker pool to create. The name in the worker pool, if specified, is ignored.
*/
workerPool?: Schema$GoogleDevtoolsRemotebuildexecutionAdminV1alphaWorkerPool;
}
/**
* The request used for `DeleteInstance`.
*/
export interface Schema$GoogleDevtoolsRemotebuildexecutionAdminV1alphaDeleteInstanceRequest {
/**
* Name of the instance to delete. Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`.
*/
name?: string | null;
}
/**
* The request used for DeleteWorkerPool.
*/
export interface Schema$GoogleDevtoolsRemotebuildexecutionAdminV1alphaDeleteWorkerPoolRequest {
/**
* Name of the worker pool to delete. Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]/workerpools/[POOL_ID]`.
*/
name?: string | null;
}
/**
* The request used for `GetInstance`.
*/
export interface Schema$GoogleDevtoolsRemotebuildexecutionAdminV1alphaGetInstanceRequest {
/**
* Name of the instance to retrieve. Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`.
*/
name?: string | null;
}
/**
* The request used for GetWorkerPool.
*/
export interface Schema$GoogleDevtoolsRemotebuildexecutionAdminV1alphaGetWorkerPoolRequest {
/**
* Name of the worker pool to retrieve. Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]/workerpools/[POOL_ID]`.
*/
name?: string | null;
}
/**
* Instance conceptually encapsulates all Remote Build Execution resources for remote builds. An instance consists of storage and compute resources (for example, `ContentAddressableStorage`, `ActionCache`, `WorkerPools`) used for running remote builds. All Remote Build Execution API calls are scoped to an instance.
*/
export interface Schema$GoogleDevtoolsRemotebuildexecutionAdminV1alphaInstance {
/**
* The location is a GCP region. Currently only `us-central1` is supported.
*/
location?: string | null;
/**
* Output only. Whether stack driver logging is enabled for the instance.
*/
loggingEnabled?: boolean | null;
/**
* Output only. Instance resource name formatted as: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. Name should not be populated when creating an instance since it is provided in the `instance_id` field.
*/
name?: string | null;
/**
* Output only. State of the instance.
*/
state?: string | null;
}
export interface Schema$GoogleDevtoolsRemotebuildexecutionAdminV1alphaListInstancesRequest {
/**
* Resource name of the project. Format: `projects/[PROJECT_ID]`.
*/
parent?: string | null;
}
export interface Schema$GoogleDevtoolsRemotebuildexecutionAdminV1alphaListInstancesResponse {
/**
* The list of instances in a given project.
*/
instances?: Schema$GoogleDevtoolsRemotebuildexecutionAdminV1alphaInstance[];
}
export interface Schema$GoogleDevtoolsRemotebuildexecutionAdminV1alphaListWorkerPoolsRequest {
/**
* Optional. A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. String values are case-insensitive. The comparison operator must be either `:`, `=`, `!=`, `>`, `>=`, `<=` or `<`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. You can also filter on nested fields. To filter on multiple expressions, you can separate expression using `AND` and `OR` operators, using parentheses to specify precedence. If neither operator is specified, `AND` is assumed. Examples: Include only pools with more than 100 reserved workers: `(worker_count > 100) (worker_config.reserved = true)` Include only pools with a certain label or machines of the n1-standard family: `worker_config.labels.key1 : * OR worker_config.machine_type: n1-standard`
*/
filter?: string | null;
/**
* Resource name of the instance. Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`.
*/
parent?: string | null;
}
export interface Schema$GoogleDevtoolsRemotebuildexecutionAdminV1alphaListWorkerPoolsResponse {
/**
* The list of worker pools in a given instance.
*/
workerPools?: Schema$GoogleDevtoolsRemotebuildexecutionAdminV1alphaWorkerPool[];
}
/**
* The request used for UpdateWorkerPool.
*/
export interface Schema$GoogleDevtoolsRemotebuildexecutionAdminV1alphaUpdateWorkerPoolRequest {
/**
* The update mask applies to worker_pool. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask If an empty update_mask is provided, only the non-default valued field in the worker pool field will be updated. Note that in order to update a field to the default value (zero, false, empty string) an explicit update_mask must be provided.
*/
updateMask?: string | null;
/**
* Specifies the worker pool to update.
*/
workerPool?: Schema$GoogleDevtoolsRemotebuildexecutionAdminV1alphaWorkerPool;
}
/**
* Defines the configuration to be used for a creating workers in the worker pool.
*/
export interface Schema$GoogleDevtoolsRemotebuildexecutionAdminV1alphaWorkerConfig {
/**
* The accelerator card attached to each VM.
*/
accelerator?: Schema$GoogleDevtoolsRemotebuildexecutionAdminV1alphaAcceleratorConfig;
/**
* Required. Size of the disk attached to the worker, in GB. See https://cloud.google.com/compute/docs/disks/
*/
diskSizeGb?: string | null;
/**
* Required. Disk Type to use for the worker. See [Storage options](https://cloud.google.com/compute/docs/disks/#introduction). Currently only `pd-standard` is supported.
*/
diskType?: string | null;
/**
* Labels associated with the workers. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International letters are permitted. Label keys must start with a letter. Label values are optional. There can not be more than 64 labels per resource.
*/
labels?: {
[key: string]: string;
} | null;
/**
* Required. Machine type of the worker, such as `n1-standard-2`. See https://cloud.google.com/compute/docs/machine-types for a list of supported machine types. Note that `f1-micro` and `g1-small` are not yet supported.
*/
machineType?: string | null;
/**
* Minimum CPU platform to use when creating the worker. See [CPU Platforms](https://cloud.google.com/compute/docs/cpu-platforms).
*/
minCpuPlatform?: string | null;
/**
* Determines the type of network access granted to workers. Possible values: - "public": Workers can connect to the public internet. - "private": Workers can only connect to Google APIs and services. - "restricted-private": Workers can only connect to Google APIs that are reachable through `restricted.googleapis.com` (`199.36.153.4/30`).
*/
networkAccess?: string | null;
/**
* Determines whether the worker is reserved (equivalent to a Compute Engine on-demand VM and therefore won't be preempted). See [Preemptible VMs](https://cloud.google.com/preemptible-vms/) for more details.
*/
reserved?: boolean | null;
}
/**
* A worker pool resource in the Remote Build Execution API.
*/
export interface Schema$GoogleDevtoolsRemotebuildexecutionAdminV1alphaWorkerPool {
/**
* WorkerPool resource name formatted as: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]/workerpools/[POOL_ID]`. name should not be populated when creating a worker pool since it is provided in the `poolId` field.
*/
name?: string | null;
/**
* Output only. State of the worker pool.
*/
state?: string | null;
/**
* Specifies the properties, such as machine type and disk size, used for creating workers in a worker pool.
*/
workerConfig?: Schema$GoogleDevtoolsRemotebuildexecutionAdminV1alphaWorkerConfig;
/**
* The desired number of workers in the worker pool. Must be a value between 0 and 1000.
*/
workerCount?: string | null;
}
/**
* AdminTemp is a prelimiary set of administration tasks. It's called "Temp" because we do not yet know the best way to represent admin tasks; it's possible that this will be entirely replaced in later versions of this API. If this message proves to be sufficient, it will be renamed in the alpha or beta release of this API. This message (suitably marshalled into a protobuf.Any) can be used as the inline_assignment field in a lease; the lease assignment field should simply be `"admin"` in these cases. This message is heavily based on Swarming administration tasks from the LUCI project (http://github.com/luci/luci-py/appengine/swarming).
*/
export interface Schema$GoogleDevtoolsRemoteworkersV1test2AdminTemp {
/**
* The argument to the admin action; see `Command` for semantics.
*/
arg?: string | null;
/**
* The admin action; see `Command` for legal values.
*/
command?: string | null;
}
/**
* Describes a blob of binary content with its digest.
*/
export interface Schema$GoogleDevtoolsRemoteworkersV1test2Blob {
/**
* The contents of the blob.
*/
contents?: string | null;
/**
* The digest of the blob. This should be verified by the receiver.
*/
digest?: Schema$GoogleDevtoolsRemoteworkersV1test2Digest;
}
/**
* DEPRECATED - use CommandResult instead. Describes the actual outputs from the task.
*/
export interface Schema$GoogleDevtoolsRemoteworkersV1test2CommandOutputs {
/**
* exit_code is only fully reliable if the status' code is OK. If the task exceeded its deadline or was cancelled, the process may still produce an exit code as it is cancelled, and this will be populated, but a successful (zero) is unlikely to be correct unless the status code is OK.
*/
exitCode?: number | null;
/**
* The output files. The blob referenced by the digest should contain one of the following (implementation-dependent): * A marshalled DirectoryMetadata of the returned filesystem * A LUCI-style .isolated file
*/
outputs?: Schema$GoogleDevtoolsRemoteworkersV1test2Digest;
}
/**
* DEPRECATED - use CommandResult instead. Can be used as part of CompleteRequest.metadata, or are part of a more sophisticated message.
*/
export interface Schema$GoogleDevtoolsRemoteworkersV1test2CommandOverhead {
/**
* The elapsed time between calling Accept and Complete. The server will also have its own idea of what this should be, but this excludes the overhead of the RPCs and the bot response time.
*/
duration?: string | null;
/**
* The amount of time *not* spent executing the command (ie uploading/downloading files).
*/
overhead?: string | null;
}
/**
* All information about the execution of a command, suitable for providing as the Bots interface's `Lease.result` field.
*/
export interface Schema$GoogleDevtoolsRemoteworkersV1test2CommandResult {
/**
* The elapsed time between calling Accept and Complete. The server will also have its own idea of what this should be, but this excludes the overhead of the RPCs and the bot response time.
*/
duration?: string | null;
/**
* The exit code of the process. An exit code of "0" should only be trusted if `status` has a code of OK (otherwise it may simply be unset).
*/
exitCode?: number | null;
/**
* Implementation-dependent metadata about the task. Both servers and bots may define messages which can be encoded here; bots are free to provide metadata in multiple formats, and servers are free to choose one or more of the values to process and ignore others. In particular, it is *not* considered an error for the bot to provide the server with a field that it doesn't know about.
*/
metadata?: Array<{
[key: string]: any;
}> | null;
/**
* The output files. The blob referenced by the digest should contain one of the following (implementation-dependent): * A marshalled DirectoryMetadata of the returned filesystem * A LUCI-style .isolated file
*/
outputs?: Schema$GoogleDevtoolsRemoteworkersV1test2Digest;
/**
* The amount of time *not* spent executing the command (ie uploading/downloading files).
*/
overhead?: string | null;
/**
* An overall status for the command. For example, if the command timed out, this might have a code of DEADLINE_EXCEEDED; if it was killed by the OS for memory exhaustion, it might have a code of RESOURCE_EXHAUSTED.
*/
status?: Schema$GoogleRpcStatus;
}
/**
* Describes a shell-style task to execute, suitable for providing as the Bots interface's `Lease.payload` field.
*/
export interface Schema$GoogleDevtoolsRemoteworkersV1test2CommandTask {
/**
* The expected outputs from the task.
*/
expectedOutputs?: Schema$GoogleDevtoolsRemoteworkersV1test2CommandTaskOutputs;
/**
* The inputs to the task.
*/
inputs?: Schema$GoogleDevtoolsRemoteworkersV1test2CommandTaskInputs;
/**
* The timeouts of this task.
*/
timeouts?: Schema$GoogleDevtoolsRemoteworkersV1test2CommandTaskTimeouts;
}
/**
* Describes the inputs to a shell-style task.
*/
export interface Schema$GoogleDevtoolsRemoteworkersV1test2CommandTaskInputs {
/**
* The command itself to run (e.g., argv). This field should be passed directly to the underlying operating system, and so it must be sensible to that operating system. For example, on Windows, the first argument might be "C:\Windows\System32\ping.exe" - that is, using drive letters and backslashes. A command for a *nix system, on the other hand, would use forward slashes. All other fields in the RWAPI must consistently use forward slashes, since those fields may be interpretted by both the service and the bot.
*/
arguments?: string[] | null;
/**
* All environment variables required by the task.
*/
environmentVariables?: Schema$GoogleDevtoolsRemoteworkersV1test2CommandTaskInputsEnvironmentVariable[];
/**
* The input filesystem to be set up prior to the task beginning. The contents should be a repeated set of FileMetadata messages though other formats are allowed if better for the implementation (eg, a LUCI-style .isolated file). This field is repeated since implementations might want to cache the metadata, in which case it may be useful to break up portions of the filesystem that change frequently (eg, specific input files) from those that don't (eg, standard header files).
*/
files?: Schema$GoogleDevtoolsRemoteworkersV1test2Digest[];
/**
* Inline contents for blobs expected to be needed by the bot to execute the task. For example, contents of entries in `files` or blobs that are indirectly referenced by an entry there. The bot should check against this list before downloading required task inputs to reduce the number of communications between itself and the remote CAS server.
*/
inlineBlobs?: Schema$GoogleDevtoolsRemoteworkersV1test2Blob[];
/**
* Directory from which a command is executed. It is a relative directory with respect to the bot's working directory (i.e., "./"). If it is non-empty, then it must exist under "./". Otherwise, "./" will be used.
*/
workingDirectory?: string | null;
}
/**
* An environment variable required by this task.
*/
export interface Schema$GoogleDevtoolsRemoteworkersV1test2CommandTaskInputsEnvironmentVariable {
/**
* The envvar name.
*/
name?: string | null;
/**
* The envvar value.
*/
value?: string | null;
}
/**
* Describes the expected outputs of the command.
*/
export interface Schema$GoogleDevtoolsRemoteworkersV1test2CommandTaskOutputs {
/**
* A list of expected directories, relative to the execution root. All paths MUST be delimited by forward slashes.
*/
directories?: string[] | null;
/**
* A list of expected files, relative to the execution root. All paths MUST be delimited by forward slashes.
*/
files?: string[] | null;
/**
* The destination to which any stderr should be sent. The method by which the bot should send the stream contents to that destination is not defined in this API. As examples, the destination could be a file referenced in the `files` field in this message, or it could be a URI that must be written via the ByteStream API.
*/
stderrDestination?: string | null;
/**
* The destination to which any stdout should be sent. The method by which the bot should send the stream contents to that destination is not defined in this API. As examples, the destination could be a file referenced in the `files` field in this message, or it could be a URI that must be written via the ByteStream API.
*/
stdoutDestination?: string | null;
}
/**
* Describes the timeouts associated with this task.
*/
export interface Schema$GoogleDevtoolsRemoteworkersV1test2CommandTaskTimeouts {
/**
* This specifies the maximum time that the task can run, excluding the time required to download inputs or upload outputs. That is, the worker will terminate the task if it runs longer than this.
*/
execution?: string | null;
/**
* This specifies the maximum amount of time the task can be idle - that is, go without generating some output in either stdout or stderr. If the process is silent for more than the specified time, the worker will terminate the task.
*/
idle?: string | null;
/**
* If the execution or IO timeouts are exceeded, the worker will try to gracefully terminate the task and return any existing logs. However, tasks may be hard-frozen in which case this process will fail. This timeout specifies how long to wait for a terminated task to shut down gracefully (e.g. via SIGTERM) before we bring down the hammer (e.g. SIGKILL on *nix, CTRL_BREAK_EVENT on Windows).
*/
shutdown?: string | null;
}
/**
* The CommandTask and CommandResult messages assume the existence of a service that can serve blobs of content, identified by a hash and size known as a "digest." The method by which these blobs may be retrieved is not specified here, but a model implementation is in the Remote Execution API's "ContentAddressibleStorage" interface. In the context of the RWAPI, a Digest will virtually always refer to the contents of a file or a directory. The latter is represented by the byte-encoded Directory message.
*/
export interface Schema$GoogleDevtoolsRemoteworkersV1test2Digest {
/**
* A string-encoded hash (eg "1a2b3c", not the byte array [0x1a, 0x2b, 0x3c]) using an implementation-defined hash algorithm (eg SHA-256).
*/
hash?: string | null;
/**
* The size of the contents. While this is not strictly required as part of an identifier (after all, any given hash will have exactly one canonical size), it's useful in almost all cases when one might want to send or retrieve blobs of content and is included here for this reason.
*/
sizeBytes?: string | null;
}
/**
* The contents of a directory. Similar to the equivalent message in the Remote Execution API.
*/
export interface Schema$GoogleDevtoolsRemoteworkersV1test2Directory {
/**
* Any subdirectories
*/
directories?: Schema$GoogleDevtoolsRemoteworkersV1test2DirectoryMetadata[];
/**
* The files in this directory
*/
files?: Schema$GoogleDevtoolsRemoteworkersV1test2FileMetadata[];
}
/**
* The metadata for a directory. Similar to the equivalent message in the Remote Execution API.
*/
export interface Schema$GoogleDevtoolsRemoteworkersV1test2DirectoryMetadata {
/**
* A pointer to the contents of the directory, in the form of a marshalled Directory message.
*/
digest?: Schema$GoogleDevtoolsRemoteworkersV1test2Digest;
/**
* The path of the directory, as in FileMetadata.path.
*/
path?: string | null;
}
/**
* The metadata for a file. Similar to the equivalent message in the Remote Execution API.
*/
export interface Schema$GoogleDevtoolsRemoteworkersV1test2FileMetadata {
/**
* If the file is small enough, its contents may also or alternatively be listed here.
*/
contents?: string | null;
/**
* A pointer to the contents of the file. The method by which a client retrieves the contents from a CAS system is not defined here.
*/
digest?: Schema$GoogleDevtoolsRemoteworkersV1test2Digest;
/**
* Properties of the file
*/
isExecutable?: boolean | null;
/**
* The path of this file. If this message is part of the CommandOutputs.outputs fields, the path is relative to the execution root and must correspond to an entry in CommandTask.outputs.files. If this message is part of a Directory message, then the path is relative to the root of that directory. All paths MUST be delimited by forward slashes.
*/
path?: string | null;
}
/**
* This resource represents a long-running operation that is the result of a network API call.
*/
export interface Schema$GoogleLongrunningOperation {
/**
* If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
*/
done?: boolean | null;
/**
* The error result of the operation in case of failure or cancellation.
*/
error?: Schema$GoogleRpcStatus;
/**
* Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
*/
metadata?: {
[key: string]: any;
} | null;
/**
* The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
*/
name?: string | null;
/**
* 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`.
*/
response?: {
[key: string]: any;
} | null;
}
/**
* The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
*/
export interface Schema$GoogleRpcStatus {
/**
* The status code, which should be an enum value of google.rpc.Code.
*/
code?: number | null;
/**
* A list of messages that carry the error details. There is a common set of message types for APIs to use.
*/
details?: Array<{
[key: string]: any;
}> | null;
/**
* A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
*/
message?: string | null;
}
export class Resource$Actionresults {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* remotebuildexecution.actionResults.get
* @desc Retrieve a cached execution result. Implementations SHOULD ensure that any blobs referenced from the ContentAddressableStorage are available at the time of returning the ActionResult and will be for some period of time afterwards. The TTLs of the referenced blobs SHOULD be increased if necessary and applicable. Errors: * `NOT_FOUND`: The requested `ActionResult` is not in the cache.
* @alias remotebuildexecution.actionResults.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.hash The hash. In the case of SHA-256, it will always be a lowercase hex string exactly 64 characters long.
* @param {string=} params.inlineOutputFiles A hint to the server to inline the contents of the listed output files. Each path needs to exactly match one path in `output_files` in the Command message.
* @param {boolean=} params.inlineStderr A hint to the server to request inlining stderr in the ActionResult message.
* @param {boolean=} params.inlineStdout A hint to the server to request inlining stdout in the ActionResult message.
* @param {string} params.instanceName The instance of the execution system to operate against. A server may support multiple instances of the execution system (with their own workers, storage, caches, etc.). The server MAY require use of this field to select between them in an implementation-defined fashion, otherwise it can be omitted.
* @param {string} params.sizeBytes The size of the blob, in bytes.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Actionresults$Get, options?: MethodOptions): GaxiosPromise<Schema$BuildBazelRemoteExecutionV2ActionResult>;
get(params: Params$Resource$Actionresults$Get, options: MethodOptions | BodyResponseCallback<Schema$BuildBazelRemoteExecutionV2ActionResult>, callback: BodyResponseCallback<Schema$BuildBazelRemoteExecutionV2ActionResult>): void;
get(params: Params$Resource$Actionresults$Get, callback: BodyResponseCallback<Schema$BuildBazelRemoteExecutionV2ActionResult>): void;
get(callback: BodyResponseCallback<Schema$BuildBazelRemoteExecutionV2ActionResult>): void;
/**
* remotebuildexecution.actionResults.update
* @desc Upload a new execution result. In order to allow the server to perform access control based on the type of action, and to assist with client debugging, the client MUST first upload the Action that produced the result, along with its Command, into the `ContentAddressableStorage`. Errors: * `INVALID_ARGUMENT`: One or more arguments are invalid. * `FAILED_PRECONDITION`: One or more errors occurred in updating the action result, such as a missing command or action. * `RESOURCE_EXHAUSTED`: There is insufficient storage space to add the entry to the cache.
* @alias remotebuildexecution.actionResults.update
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.hash The hash. In the case of SHA-256, it will always be a lowercase hex string exactly 64 characters long.
* @param {string} params.instanceName The instance of the execution system to operate against. A server may support multiple instances of the execution system (with their own workers, storage, caches, etc.). The server MAY require use of this field to select between them in an implementation-defined fashion, otherwise it can be omitted.
* @param {integer=} params.resultsCachePolicy.priority The priority (relative importance) of this content in the overall cache. Generally, a lower value means a longer retention time or other advantage, but the interpretation of a given value is server-dependent. A priority of 0 means a *default* value, decided by the server. The particular semantics of this field is up to the server. In particular, every server will have their own supported range of priorities, and will decide how these map into retention/eviction policy.
* @param {string} params.sizeBytes The size of the blob, in bytes.
* @param {().BuildBazelRemoteExecutionV2ActionResult} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
update(params?: Params$Resource$Actionresults$Update, options?: MethodOptions): GaxiosPromise<Schema$BuildBazelRemoteExecutionV2ActionResult>;
update(params: Params$Resource$Actionresults$Update, options: MethodOptions | BodyResponseCallback<Schema$BuildBazelRemoteExecutionV2ActionResult>, callback: BodyResponseCallback<Schema$BuildBazelRemoteExecutionV2ActionResult>): void;
update(params: Params$Resource$Actionresults$Update, callback: BodyResponseCallback<Schema$BuildBazelRemoteExecutionV2ActionResult>): void;
update(callback: BodyResponseCallback<Schema$BuildBazelRemoteExecutionV2ActionResult>): void;
}
export interface Params$Resource$Actionresults$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The hash. In the case of SHA-256, it will always be a lowercase hex string exactly 64 characters long.
*/
hash?: string;
/**
* A hint to the server to inline the contents of the listed output files. Each path needs to exactly match one path in `output_files` in the Command message.
*/
inlineOutputFiles?: string[];
/**
* A hint to the server to request inlining stderr in the ActionResult message.
*/
inlineStderr?: boolean;
/**
* A hint to the server to request inlining stdout in the ActionResult message.
*/
inlineStdout?: boolean;
/**
* The instance of the execution system to operate against. A server may support multiple instances of the execution system (with their own workers, storage, caches, etc.). The server MAY require use of this field to select between them in an implementation-defined fashion, otherwise it can be omitted.
*/
instanceName?: string;
/**
* The size of the blob, in bytes.
*/
sizeBytes?: string;
}
export interface Params$Resource$Actionresults$Update extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The hash. In the case of SHA-256, it will always be a lowercase hex string exactly 64 characters long.
*/
hash?: string;
/**
* The instance of the execution system to operate against. A server may support multiple instances of the execution system (with their own workers, storage, caches, etc.). The server MAY require use of this field to select between them in an implementation-defined fashion, otherwise it can be omitted.
*/
instanceName?: string;
/**
* The priority (relative importance) of this content in the overall cache. Generally, a lower value means a longer retention time or other advantage, but the interpretation of a given value is server-dependent. A priority of 0 means a *default* value, decided by the server. The particular semantics of this field is up to the server. In particular, every server will have their own supported range of priorities, and will decide how these map into retention/eviction policy.
*/
'resultsCachePolicy.priority'?: number;
/**
* The size of the blob, in bytes.
*/
sizeBytes?: string;
/**
* Request body metadata
*/
requestBody?: Schema$BuildBazelRemoteExecutionV2ActionResult;
}
export class Resource$Actions {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* remotebuildexecution.actions.execute
* @desc Execute an action remotely. In order to execute an action, the client must first upload all of the inputs, the Command to run, and the Action into the ContentAddressableStorage. It then calls `Execute` with an `action_digest` referring to them. The server will run the action and eventually return the result. The input `Action`'s fields MUST meet the various canonicalization requirements specified in the documentation for their types so that it has the same digest as other logically equivalent `Action`s. The server MAY enforce the requirements and return errors if a non-canonical input is received. It MAY also proceed without verifying some or all of the requirements, such as for performance reasons. If the server does not verify the requirement, then it will treat the `Action` as distinct from another logically equivalent action if they hash differently. Returns a stream of google.longrunning.Operation messages describing the resulting execution, with eventual `response` ExecuteResponse. The `metadata` on the operation is of type ExecuteOperationMetadata. If the client remains connected after the first response is returned after the server, then updates are streamed as if the client had called WaitExecution until the execution completes or the request reaches an error. The operation can also be queried using Operations API. The server NEED NOT implement other methods or functionality of the Operations API. Errors discovered during creation of the `Operation` will be reported as gRPC Status errors, while errors that occurred while running the action will be reported in the `status` field of the `ExecuteResponse`. The server MUST NOT set the `error` field of the `Operation` proto. The possible errors include: * `INVALID_ARGUMENT`: One or more arguments are invalid. * `FAILED_PRECONDITION`: One or more errors occurred in setting up the action requested, such as a missing input or command or no worker being available. The client may be able to fix the errors and retry. * `RESOURCE_EXHAUSTED`: There is insufficient quota of some resource to run the action. * `UNAVAILABLE`: Due to a transient condition, such as all workers being occupied (and the server does not support a queue), the action could not be started. The client should retry. * `INTERNAL`: An internal error occurred in the execution engine or the worker. * `DEADLINE_EXCEEDED`: The execution timed out. * `CANCELLED`: The operation was cancelled by the client. This status is only possible if the server implements the Operations API CancelOperation method, and it was called for the current execution. In the case of a missing input or command, the server SHOULD additionally send a PreconditionFailure error detail where, for each requested blob not present in the CAS, there is a `Violation` with a `type` of `MISSING` and a `subject` of `"blobs/{hash}/{size}"` indicating the digest of the missing blob.
* @alias remotebuildexecution.actions.execute
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.instanceName The instance of the execution system to operate against. A server may support multiple instances of the execution system (with their own workers, storage, caches, etc.). The server MAY require use of this field to select between them in an implementation-defined fashion, otherwise it can be omitted.
* @param {().BuildBazelRemoteExecutionV2ExecuteRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
execute(params?: Params$Resource$Actions$Execute, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
execute(params: Params$Resource$Actions$Execute, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
execute(params: Params$Resource$Actions$Execute, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
execute(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
}
export interface Params$Resource$Actions$Execute extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The instance of the execution system to operate against. A server may support multiple instances of the execution system (with their own workers, storage, caches, etc.). The server MAY require use of this field to select between them in an implementation-defined fashion, otherwise it can be omitted.
*/
instanceName?: string;
/**
* Request body metadata
*/
requestBody?: Schema$BuildBazelRemoteExecutionV2ExecuteRequest;
}
export class Resource$Blobs {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* remotebuildexecution.blobs.batchRead
* @desc Download many blobs at once. The server may enforce a limit of the combined total size of blobs to be downloaded using this API. This limit may be obtained using the Capabilities API. Requests exceeding the limit should either be split into smaller chunks or downloaded using the ByteStream API, as appropriate. This request is equivalent to calling a Bytestream `Read` request on each individual blob, in parallel. The requests may succeed or fail independently. Errors: * `INVALID_ARGUMENT`: The client attempted to read more than the server supported limit. Every error on individual read will be returned in the corresponding digest status.
* @alias remotebuildexecution.blobs.batchRead
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.instanceName The instance of the execution system to operate against. A server may support multiple instances of the execution system (with their own workers, storage, caches, etc.). The server MAY require use of this field to select between them in an implementation-defined fashion, otherwise it can be omitted.
* @param {().BuildBazelRemoteExecutionV2BatchReadBlobsRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
batchRead(params?: Params$Resource$Blobs$Batchread, options?: MethodOptions): GaxiosPromise<Schema$BuildBazelRemoteExecutionV2BatchReadBlobsResponse>;
batchRead(params: Params$Resource$Blobs$Batchread, options: MethodOptions | BodyResponseCallback<Schema$BuildBazelRemoteExecutionV2BatchReadBlobsResponse>, callback: BodyResponseCallback<Schema$BuildBazelRemoteExecutionV2BatchReadBlobsResponse>): void;
batchRead(params: Params$Resource$Blobs$Batchread, callback: BodyResponseCallback<Schema$BuildBazelRemoteExecutionV2BatchReadBlobsResponse>): void;
batchRead(callback: BodyResponseCallback<Schema$BuildBazelRemoteExecutionV2BatchReadBlobsResponse>): void;
/**
* remotebuildexecution.blobs.batchUpdate
* @desc Upload many blobs at once. The server may enforce a limit of the combined total size of blobs to be uploaded using this API. This limit may be obtained using the Capabilities API. Requests exceeding the limit should either be split into smaller chunks or uploaded using the ByteStream API, as appropriate. This request is equivalent to calling a Bytestream `Write` request on each individual blob, in parallel. The requests may succeed or fail independently. Errors: * `INVALID_ARGUMENT`: The client attempted to upload more than the server supported limit. Individual requests may return the following errors, additionally: * `RESOURCE_EXHAUSTED`: There is insufficient disk quota to store the blob. * `INVALID_ARGUMENT`: The Digest does not match the provided data.
* @alias remotebuildexecution.blobs.batchUpdate
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.instanceName The instance of the execution system to operate against. A server may support multiple instances of the execution system (with their own workers, storage, caches, etc.). The server MAY require use of this field to select between them in an implementation-defined fashion, otherwise it can be omitted.
* @param {().BuildBazelRemoteExecutionV2BatchUpdateBlobsRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
batchUpdate(params?: Params$Resource$Blobs$Batchupdate, options?: MethodOptions): GaxiosPromise<Schema$BuildBazelRemoteExecutionV2BatchUpdateBlobsResponse>;
batchUpdate(params: Params$Resource$Blobs$Batchupdate, options: MethodOptions | BodyResponseCallback<Schema$BuildBazelRemoteExecutionV2BatchUpdateBlobsResponse>, callback: BodyResponseCallback<Schema$BuildBazelRemoteExecutionV2BatchUpdateBlobsResponse>): void;
batchUpdate(params: Params$Resource$Blobs$Batchupdate, callback: BodyResponseCallback<Schema$BuildBazelRemoteExecutionV2BatchUpdateBlobsResponse>): void;
batchUpdate(callback: BodyResponseCallback<Schema$BuildBazelRemoteExecutionV2BatchUpdateBlobsResponse>): void;
/**
* remotebuildexecution.blobs.findMissing
* @desc Determine if blobs are present in the CAS. Clients can use this API before uploading blobs to determine which ones are already present in the CAS and do not need to be uploaded again. There are no method-specific errors.
* @alias remotebuildexecution.blobs.findMissing
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.instanceName The instance of the execution system to operate against. A server may support multiple instances of the execution system (with their own workers, storage, caches, etc.). The server MAY require use of this field to select between them in an implementation-defined fashion, otherwise it can be omitted.
* @param {().BuildBazelRemoteExecutionV2FindMissingBlobsRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
findMissing(params?: Params$Resource$Blobs$Findmissing, options?: MethodOptions): GaxiosPromise<Schema$BuildBazelRemoteExecutionV2FindMissingBlobsResponse>;
findMissing(params: Params$Resource$Blobs$Findmissing, options: MethodOptions | BodyResponseCallback<Schema$BuildBazelRemoteExecutionV2FindMissingBlobsResponse>, callback: BodyResponseCallback<Schema$BuildBazelRemoteExecutionV2FindMissingBlobsResponse>): void;
findMissing(params: Params$Resource$Blobs$Findmissing, callback: BodyResponseCallback<Schema$BuildBazelRemoteExecutionV2FindMissingBlobsResponse>): void;
findMissing(callback: BodyResponseCallback<Schema$BuildBazelRemoteExecutionV2FindMissingBlobsResponse>): void;
/**
* remotebuildexecution.blobs.getTree
* @desc Fetch the entire directory tree rooted at a node. This request must be targeted at a Directory stored in the ContentAddressableStorage (CAS). The server will enumerate the `Directory` tree recursively and return every node descended from the root. The GetTreeRequest.page_token parameter can be used to skip ahead in the stream (e.g. when retrying a partially completed and aborted request), by setting it to a value taken from GetTreeResponse.next_page_token of the last successfully processed GetTreeResponse). The exact traversal order is unspecified and, unless retrieving subsequent pages from an earlier request, is not guaranteed to be stable across multiple invocations of `GetTree`. If part of the tree is missing from the CAS, the server will return the portion present and omit the rest. * `NOT_FOUND`: The requested tree root is not present in the CAS.
* @alias remotebuildexecution.blobs.getTree
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.hash The hash. In the case of SHA-256, it will always be a lowercase hex string exactly 64 characters long.
* @param {string} params.instanceName The instance of the execution system to operate against. A server may support multiple instances of the execution system (with their own workers, storage, caches, etc.). The server MAY require use of this field to select between them in an implementation-defined fashion, otherwise it can be omitted.
* @param {integer=} params.pageSize A maximum page size to request. If present, the server will request no more than this many items. Regardless of whether a page size is specified, the server may place its own limit on the number of items to be returned and require the client to retrieve more items using a subsequent request.
* @param {string=} params.pageToken A page token, which must be a value received in a previous GetTreeResponse. If present, the server will use it to return the following page of results.
* @param {string} params.sizeBytes The size of the blob, in bytes.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
getTree(params?: Params$Resource$Blobs$Gettree, options?: MethodOptions): GaxiosPromise<Schema$BuildBazelRemoteExecutionV2GetTreeResponse>;
getTree(params: Params$Resource$Blobs$Gettree, options: MethodOptions | BodyResponseCallback<Schema$BuildBazelRemoteExecutionV2GetTreeResponse>, callback: BodyResponseCallback<Schema$BuildBazelRemoteExecutionV2GetTreeResponse>): void;
getTree(params: Params$Resource$Blobs$Gettree, callback: BodyResponseCallback<Schema$BuildBazelRemoteExecutionV2GetTreeResponse>): void;
getTree(callback: BodyResponseCallback<Schema$BuildBazelRemoteExecutionV2GetTreeResponse>): void;
}
export interface Params$Resource$Blobs$Batchread extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The instance of the execution system to operate against. A server may support multiple instances of the execution system (with their own workers, storage, caches, etc.). The server MAY require use of this field to select between them in an implementation-defined fashion, otherwise it can be omitted.
*/
instanceName?: string;
/**
* Request body metadata
*/
requestBody?: Schema$BuildBazelRemoteExecutionV2BatchReadBlobsRequest;
}
export interface Params$Resource$Blobs$Batchupdate extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The instance of the execution system to operate against. A server may support multiple instances of the execution system (with their own workers, storage, caches, etc.). The server MAY require use of this field to select between them in an implementation-defined fashion, otherwise it can be omitted.
*/
instanceName?: string;
/**
* Request body metadata
*/
requestBody?: Schema$BuildBazelRemoteExecutionV2BatchUpdateBlobsRequest;
}
export interface Params$Resource$Blobs$Findmissing extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The instance of the execution system to operate against. A server may support multiple instances of the execution system (with their own workers, storage, caches, etc.). The server MAY require use of this field to select between them in an implementation-defined fashion, otherwise it can be omitted.
*/
instanceName?: string;
/**
* Request body metadata
*/
requestBody?: Schema$BuildBazelRemoteExecutionV2FindMissingBlobsRequest;
}
export interface Params$Resource$Blobs$Gettree extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The hash. In the case of SHA-256, it will always be a lowercase hex string exactly 64 characters long.
*/
hash?: string;
/**
* The instance of the execution system to operate against. A server may support multiple instances of the execution system (with their own workers, storage, caches, etc.). The server MAY require use of this field to select between them in an implementation-defined fashion, otherwise it can be omitted.
*/
instanceName?: string;
/**
* A maximum page size to request. If present, the server will request no more than this many items. Regardless of whether a page size is specified, the server may place its own limit on the number of items to be returned and require the client to retrieve more items using a subsequent request.
*/
pageSize?: number;
/**
* A page token, which must be a value received in a previous GetTreeResponse. If present, the server will use it to return the following page of results.
*/
pageToken?: string;
/**
* The size of the blob, in bytes.
*/
sizeBytes?: string;
}
export class Resource$Operations {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* remotebuildexecution.operations.waitExecution
* @desc Wait for an execution operation to complete. When the client initially makes the request, the server immediately responds with the current status of the execution. The server will leave the request stream open until the operation completes, and then respond with the completed operation. The server MAY choose to stream additional updates as execution progresses, such as to provide an update as to the state of the execution.
* @alias remotebuildexecution.operations.waitExecution
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The name of the Operation returned by Execute.
* @param {().BuildBazelRemoteExecutionV2WaitExecutionRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
waitExecution(params?: Params$Resource$Operations$Waitexecution, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
waitExecution(params: Params$Resource$Operations$Waitexecution, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
waitExecution(params: Params$Resource$Operations$Waitexecution, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
waitExecution(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
}
export interface Params$Resource$Operations$Waitexecution extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The name of the Operation returned by Execute.
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$BuildBazelRemoteExecutionV2WaitExecutionRequest;
}
export class Resource$V2 {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* remotebuildexecution.getCapabilities
* @desc GetCapabilities returns the server capabilities configuration of the remote endpoint. Only the capabilities of the services supported by the endpoint will be returned: * Execution + CAS + Action Cache endpoints should return both CacheCapabilities and ExecutionCapabilities. * Execution only endpoints should return ExecutionCapabilities. * CAS + Action Cache only endpoints should return CacheCapabilities.
* @alias remotebuildexecution.getCapabilities
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.instanceName The instance of the execution system to operate against. A server may support multiple instances of the execution system (with their own workers, storage, caches, etc.). The server MAY require use of this field to select between them in an implementation-defined fashion, otherwise it can be omitted.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
getCapabilities(params?: Params$Resource$V2$Getcapabilities, options?: MethodOptions): GaxiosPromise<Schema$BuildBazelRemoteExecutionV2ServerCapabilities>;
getCapabilities(params: Params$Resource$V2$Getcapabilities, options: MethodOptions | BodyResponseCallback<Schema$BuildBazelRemoteExecutionV2ServerCapabilities>, callback: BodyResponseCallback<Schema$BuildBazelRemoteExecutionV2ServerCapabilities>): void;
getCapabilities(params: Params$Resource$V2$Getcapabilities, callback: BodyResponseCallback<Schema$BuildBazelRemoteExecutionV2ServerCapabilities>): void;
getCapabilities(callback: BodyResponseCallback<Schema$BuildBazelRemoteExecutionV2ServerCapabilities>): void;
}
export interface Params$Resource$V2$Getcapabilities extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The instance of the execution system to operate against. A server may support multiple instances of the execution system (with their own workers, storage, caches, etc.). The server MAY require use of this field to select between them in an implementation-defined fashion, otherwise it can be omitted.
*/
instanceName?: string;
}
export {};
}