v1.d.ts
72.9 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
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
/// <reference types="node" />
import { OAuth2Client, JWT, Compute, UserRefreshClient, BaseExternalAccountClient, GaxiosPromise, GoogleConfigurable, MethodOptions, StreamMethodOptions, GlobalOptions, GoogleAuth, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { Readable } from 'stream';
export declare namespace testing_v1 {
export interface Options extends GlobalOptions {
version: 'v1';
}
interface StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient | BaseExternalAccountClient | GoogleAuth;
/**
* 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;
}
/**
* Cloud Testing API
*
* Allows developers to run automated tests for their mobile applications on Google infrastructure.
*
* @example
* ```js
* const {google} = require('googleapis');
* const testing = google.testing('v1');
* ```
*/
export class Testing {
context: APIRequestContext;
applicationDetailService: Resource$Applicationdetailservice;
projects: Resource$Projects;
testEnvironmentCatalog: Resource$Testenvironmentcatalog;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* Identifies an account and how to log into it.
*/
export interface Schema$Account {
/**
* An automatic google login account.
*/
googleAuto?: Schema$GoogleAuto;
}
/**
* A single Android device.
*/
export interface Schema$AndroidDevice {
/**
* Required. The id of the Android device to be used. Use the TestEnvironmentDiscoveryService to get supported options.
*/
androidModelId?: string | null;
/**
* Required. The id of the Android OS version to be used. Use the TestEnvironmentDiscoveryService to get supported options.
*/
androidVersionId?: string | null;
/**
* Required. The locale the test device used for testing. Use the TestEnvironmentDiscoveryService to get supported options.
*/
locale?: string | null;
/**
* Required. How the device is oriented during the test. Use the TestEnvironmentDiscoveryService to get supported options.
*/
orientation?: string | null;
}
/**
* The currently supported Android devices.
*/
export interface Schema$AndroidDeviceCatalog {
/**
* The set of supported Android device models.
*/
models?: Schema$AndroidModel[];
/**
* The set of supported runtime configurations.
*/
runtimeConfiguration?: Schema$AndroidRuntimeConfiguration;
/**
* The set of supported Android OS versions.
*/
versions?: Schema$AndroidVersion[];
}
/**
* A list of Android device configurations in which the test is to be executed.
*/
export interface Schema$AndroidDeviceList {
/**
* Required. A list of Android devices.
*/
androidDevices?: Schema$AndroidDevice[];
}
/**
* A test of an Android application that can control an Android component independently of its normal lifecycle. Android instrumentation tests run an application APK and test APK inside the same process on a virtual or physical AndroidDevice. They also specify a test runner class, such as com.google.GoogleTestRunner, which can vary on the specific instrumentation framework chosen. See for more information on types of Android tests.
*/
export interface Schema$AndroidInstrumentationTest {
/**
* The APK for the application under test.
*/
appApk?: Schema$FileReference;
/**
* A multi-apk app bundle for the application under test.
*/
appBundle?: Schema$AppBundle;
/**
* The java package for the application under test. The default value is determined by examining the application's manifest.
*/
appPackageId?: string | null;
/**
* The option of whether running each test within its own invocation of instrumentation with Android Test Orchestrator or not. ** Orchestrator is only compatible with AndroidJUnitRunner version 1.0 or higher! ** Orchestrator offers the following benefits: - No shared state - Crashes are isolated - Logs are scoped per test See for more information about Android Test Orchestrator. If not set, the test will be run without the orchestrator.
*/
orchestratorOption?: string | null;
/**
* The option to run tests in multiple shards in parallel.
*/
shardingOption?: Schema$ShardingOption;
/**
* Required. The APK containing the test code to be executed.
*/
testApk?: Schema$FileReference;
/**
* The java package for the test to be executed. The default value is determined by examining the application's manifest.
*/
testPackageId?: string | null;
/**
* The InstrumentationTestRunner class. The default value is determined by examining the application's manifest.
*/
testRunnerClass?: string | null;
/**
* Each target must be fully qualified with the package name or class name, in one of these formats: - "package package_name" - "class package_name.class_name" - "class package_name.class_name#method_name" If empty, all targets in the module will be run.
*/
testTargets?: string[] | null;
}
/**
* A set of Android device configuration permutations is defined by the the cross-product of the given axes. Internally, the given AndroidMatrix will be expanded into a set of AndroidDevices. Only supported permutations will be instantiated. Invalid permutations (e.g., incompatible models/versions) are ignored.
*/
export interface Schema$AndroidMatrix {
/**
* Required. The ids of the set of Android device to be used. Use the TestEnvironmentDiscoveryService to get supported options.
*/
androidModelIds?: string[] | null;
/**
* Required. The ids of the set of Android OS version to be used. Use the TestEnvironmentDiscoveryService to get supported options.
*/
androidVersionIds?: string[] | null;
/**
* Required. The set of locales the test device will enable for testing. Use the TestEnvironmentDiscoveryService to get supported options.
*/
locales?: string[] | null;
/**
* Required. The set of orientations to test with. Use the TestEnvironmentDiscoveryService to get supported options.
*/
orientations?: string[] | null;
}
/**
* A description of an Android device tests may be run on.
*/
export interface Schema$AndroidModel {
/**
* The company that this device is branded with. Example: "Google", "Samsung".
*/
brand?: string | null;
/**
* The name of the industrial design. This corresponds to android.os.Build.DEVICE.
*/
codename?: string | null;
/**
* Whether this device is virtual or physical.
*/
form?: string | null;
/**
* Whether this device is a phone, tablet, wearable, etc.
*/
formFactor?: string | null;
/**
* The unique opaque id for this model. Use this for invoking the TestExecutionService.
*/
id?: string | null;
/**
* True if and only if tests with this model are recorded by stitching together screenshots. See use_low_spec_video_recording in device config.
*/
lowFpsVideoRecording?: boolean | null;
/**
* The manufacturer of this device.
*/
manufacturer?: string | null;
/**
* The human-readable marketing name for this device model. Examples: "Nexus 5", "Galaxy S5".
*/
name?: string | null;
/**
* Screen density in DPI. This corresponds to ro.sf.lcd_density
*/
screenDensity?: number | null;
/**
* Screen size in the horizontal (X) dimension measured in pixels.
*/
screenX?: number | null;
/**
* Screen size in the vertical (Y) dimension measured in pixels.
*/
screenY?: number | null;
/**
* The list of supported ABIs for this device. This corresponds to either android.os.Build.SUPPORTED_ABIS (for API level 21 and above) or android.os.Build.CPU_ABI/CPU_ABI2. The most preferred ABI is the first element in the list. Elements are optionally prefixed by "version_id:" (where version_id is the id of an AndroidVersion), denoting an ABI that is supported only on a particular version.
*/
supportedAbis?: string[] | null;
/**
* The set of Android versions this device supports.
*/
supportedVersionIds?: string[] | null;
/**
* Tags for this dimension. Examples: "default", "preview", "deprecated".
*/
tags?: string[] | null;
/**
* URL of a thumbnail image (photo) of the device. e.g. https://lh3.googleusercontent.com/90WcauuJiCYABEl8U0lcZeuS5STUbf2yW...
*/
thumbnailUrl?: string | null;
}
/**
* A test of an android application that explores the application on a virtual or physical Android Device, finding culprits and crashes as it goes. Next tag: 30
*/
export interface Schema$AndroidRoboTest {
/**
* The APK for the application under test.
*/
appApk?: Schema$FileReference;
/**
* A multi-apk app bundle for the application under test.
*/
appBundle?: Schema$AppBundle;
/**
* The initial activity that should be used to start the app.
*/
appInitialActivity?: string | null;
/**
* The java package for the application under test. The default value is determined by examining the application's manifest.
*/
appPackageId?: string | null;
/**
* The max depth of the traversal stack Robo can explore. Needs to be at least 2 to make Robo explore the app beyond the first activity. Default is 50.
*/
maxDepth?: number | null;
/**
* The max number of steps Robo can execute. Default is no limit.
*/
maxSteps?: number | null;
/**
* A set of directives Robo should apply during the crawl. This allows users to customize the crawl. For example, the username and password for a test account can be provided.
*/
roboDirectives?: Schema$RoboDirective[];
/**
* A JSON file with a sequence of actions Robo should perform as a prologue for the crawl.
*/
roboScript?: Schema$FileReference;
/**
* The intents used to launch the app for the crawl. If none are provided, then the main launcher activity is launched. If some are provided, then only those provided are launched (the main launcher activity must be provided explicitly).
*/
startingIntents?: Schema$RoboStartingIntent[];
}
/**
* Android configuration that can be selected at the time a test is run.
*/
export interface Schema$AndroidRuntimeConfiguration {
/**
* The set of available locales.
*/
locales?: Schema$Locale[];
/**
* The set of available orientations.
*/
orientations?: Schema$Orientation[];
}
/**
* A test of an Android Application with a Test Loop. The intent \ will be implicitly added, since Games is the only user of this api, for the time being.
*/
export interface Schema$AndroidTestLoop {
/**
* The APK for the application under test.
*/
appApk?: Schema$FileReference;
/**
* A multi-apk app bundle for the application under test.
*/
appBundle?: Schema$AppBundle;
/**
* The java package for the application under test. The default is determined by examining the application's manifest.
*/
appPackageId?: string | null;
/**
* The list of scenario labels that should be run during the test. The scenario labels should map to labels defined in the application's manifest. For example, player_experience and com.google.test.loops.player_experience add all of the loops labeled in the manifest with the com.google.test.loops.player_experience name to the execution. Scenarios can also be specified in the scenarios field.
*/
scenarioLabels?: string[] | null;
/**
* The list of scenarios that should be run during the test. The default is all test loops, derived from the application's manifest.
*/
scenarios?: number[] | null;
}
/**
* A version of the Android OS.
*/
export interface Schema$AndroidVersion {
/**
* The API level for this Android version. Examples: 18, 19.
*/
apiLevel?: number | null;
/**
* The code name for this Android version. Examples: "JellyBean", "KitKat".
*/
codeName?: string | null;
/**
* Market share for this version.
*/
distribution?: Schema$Distribution;
/**
* An opaque id for this Android version. Use this id to invoke the TestExecutionService.
*/
id?: string | null;
/**
* The date this Android version became available in the market.
*/
releaseDate?: Schema$Date;
/**
* Tags for this dimension. Examples: "default", "preview", "deprecated".
*/
tags?: string[] | null;
/**
* A string representing this version of the Android OS. Examples: "4.3", "4.4".
*/
versionString?: string | null;
}
/**
* An Android package file to install.
*/
export interface Schema$Apk {
/**
* The path to an APK to be installed on the device before the test begins.
*/
location?: Schema$FileReference;
/**
* The java package for the APK to be installed. Value is determined by examining the application's manifest.
*/
packageName?: string | null;
}
/**
* Android application details based on application manifest and apk archive contents.
*/
export interface Schema$ApkDetail {
apkManifest?: Schema$ApkManifest;
}
/**
* An Android app manifest. See http://developer.android.com/guide/topics/manifest/manifest-intro.html
*/
export interface Schema$ApkManifest {
/**
* User-readable name for the application.
*/
applicationLabel?: string | null;
intentFilters?: Schema$IntentFilter[];
/**
* Maximum API level on which the application is designed to run.
*/
maxSdkVersion?: number | null;
/**
* Minimum API level required for the application to run.
*/
minSdkVersion?: number | null;
/**
* Full Java-style package name for this application, e.g. "com.example.foo".
*/
packageName?: string | null;
/**
* Specifies the API Level on which the application is designed to run.
*/
targetSdkVersion?: number | null;
/**
* Permissions declared to be used by the application
*/
usesPermission?: string[] | null;
}
/**
* An Android App Bundle file format, containing a BundleConfig.pb file, a base module directory, zero or more dynamic feature module directories. See https://developer.android.com/guide/app-bundle/build for guidance on building App Bundles.
*/
export interface Schema$AppBundle {
/**
* .aab file representing the app bundle under test.
*/
bundleLocation?: Schema$FileReference;
}
/**
* Response containing the current state of the specified test matrix.
*/
export interface Schema$CancelTestMatrixResponse {
/**
* The current rolled-up state of the test matrix. If this state is already final, then the cancelation request will have no effect.
*/
testState?: string | null;
}
/**
* Information about the client which invoked the test.
*/
export interface Schema$ClientInfo {
/**
* The list of detailed information about client.
*/
clientInfoDetails?: Schema$ClientInfoDetail[];
/**
* Required. Client name, such as gcloud.
*/
name?: string | null;
}
/**
* Key-value pair of detailed information about the client which invoked the test. Examples: {'Version', '1.0'\}, {'Release Track', 'BETA'\}.
*/
export interface Schema$ClientInfoDetail {
/**
* Required. The key of detailed client information.
*/
key?: string | null;
/**
* Required. The value of detailed client information.
*/
value?: string | null;
}
/**
* Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
*/
export interface Schema$Date {
/**
* Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
*/
day?: number | null;
/**
* Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
*/
month?: number | null;
/**
* Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
*/
year?: number | null;
}
/**
* A single device file description.
*/
export interface Schema$DeviceFile {
/**
* A reference to an opaque binary blob file.
*/
obbFile?: Schema$ObbFile;
/**
* A reference to a regular file.
*/
regularFile?: Schema$RegularFile;
}
/**
* A single device IP block
*/
export interface Schema$DeviceIpBlock {
/**
* The date this block was added to Firebase Test Lab
*/
addedDate?: Schema$Date;
/**
* An IP address block in CIDR notation eg: 34.68.194.64/29
*/
block?: string | null;
/**
* Whether this block is used by physical or virtual devices
*/
form?: string | null;
}
/**
* List of IP blocks used by the Firebase Test Lab
*/
export interface Schema$DeviceIpBlockCatalog {
/**
* The device IP blocks used by Firebase Test Lab
*/
ipBlocks?: Schema$DeviceIpBlock[];
}
/**
* Data about the relative number of devices running a given configuration of the Android platform.
*/
export interface Schema$Distribution {
/**
* Output only. The estimated fraction (0-1) of the total market with this configuration.
*/
marketShare?: number | null;
/**
* Output only. The time this distribution was measured.
*/
measurementTime?: string | null;
}
/**
* The environment in which the test is run.
*/
export interface Schema$Environment {
/**
* An Android device which must be used with an Android test.
*/
androidDevice?: Schema$AndroidDevice;
/**
* An iOS device which must be used with an iOS test.
*/
iosDevice?: Schema$IosDevice;
}
/**
* The matrix of environments in which the test is to be executed.
*/
export interface Schema$EnvironmentMatrix {
/**
* A list of Android devices; the test will be run only on the specified devices.
*/
androidDeviceList?: Schema$AndroidDeviceList;
/**
* A matrix of Android devices.
*/
androidMatrix?: Schema$AndroidMatrix;
/**
* A list of iOS devices.
*/
iosDeviceList?: Schema$IosDeviceList;
}
/**
* A key-value pair passed as an environment variable to the test.
*/
export interface Schema$EnvironmentVariable {
/**
* Key for the environment variable.
*/
key?: string | null;
/**
* Value for the environment variable.
*/
value?: string | null;
}
/**
* A reference to a file, used for user inputs.
*/
export interface Schema$FileReference {
/**
* A path to a file in Google Cloud Storage. Example: gs://build-app-1414623860166/app%40debug-unaligned.apk These paths are expected to be url encoded (percent encoding)
*/
gcsPath?: string | null;
}
/**
* Response containing the details of the specified Android application APK.
*/
export interface Schema$GetApkDetailsResponse {
/**
* Details of the Android APK.
*/
apkDetail?: Schema$ApkDetail;
}
/**
* Enables automatic Google account login. If set, the service automatically generates a Google test account and adds it to the device, before executing the test. Note that test accounts might be reused. Many applications show their full set of functionalities when an account is present on the device. Logging into the device with these generated accounts allows testing more functionalities.
*/
export interface Schema$GoogleAuto {
}
/**
* A storage location within Google cloud storage (GCS).
*/
export interface Schema$GoogleCloudStorage {
/**
* Required. The path to a directory in GCS that will eventually contain the results for this test. The requesting user must have write access on the bucket in the supplied path.
*/
gcsPath?: string | null;
}
/**
* The section of an tag. https://developer.android.com/guide/topics/manifest/intent-filter-element.html
*/
export interface Schema$IntentFilter {
/**
* The android:name value of the tag.
*/
actionNames?: string[] | null;
/**
* The android:name value of the tag.
*/
categoryNames?: string[] | null;
/**
* The android:mimeType value of the tag.
*/
mimeType?: string | null;
}
/**
* A single iOS device.
*/
export interface Schema$IosDevice {
/**
* Required. The id of the iOS device to be used. Use the TestEnvironmentDiscoveryService to get supported options.
*/
iosModelId?: string | null;
/**
* Required. The id of the iOS major software version to be used. Use the TestEnvironmentDiscoveryService to get supported options.
*/
iosVersionId?: string | null;
/**
* Required. The locale the test device used for testing. Use the TestEnvironmentDiscoveryService to get supported options.
*/
locale?: string | null;
/**
* Required. How the device is oriented during the test. Use the TestEnvironmentDiscoveryService to get supported options.
*/
orientation?: string | null;
}
/**
* The currently supported iOS devices.
*/
export interface Schema$IosDeviceCatalog {
/**
* The set of supported iOS device models.
*/
models?: Schema$IosModel[];
/**
* The set of supported runtime configurations.
*/
runtimeConfiguration?: Schema$IosRuntimeConfiguration;
/**
* The set of supported iOS software versions.
*/
versions?: Schema$IosVersion[];
/**
* The set of supported Xcode versions.
*/
xcodeVersions?: Schema$XcodeVersion[];
}
/**
* A file or directory to install on the device before the test starts.
*/
export interface Schema$IosDeviceFile {
/**
* The bundle id of the app where this file lives. iOS apps sandbox their own filesystem, so app files must specify which app installed on the device.
*/
bundleId?: string | null;
/**
* The source file
*/
content?: Schema$FileReference;
/**
* Location of the file on the device, inside the app's sandboxed filesystem
*/
devicePath?: string | null;
}
/**
* A list of iOS device configurations in which the test is to be executed.
*/
export interface Schema$IosDeviceList {
/**
* Required. A list of iOS devices.
*/
iosDevices?: Schema$IosDevice[];
}
/**
* A description of an iOS device tests may be run on.
*/
export interface Schema$IosModel {
/**
* Device capabilities. Copied from https://developer.apple.com/library/archive/documentation/DeviceInformation/Reference/iOSDeviceCompatibility/DeviceCompatibilityMatrix/DeviceCompatibilityMatrix.html
*/
deviceCapabilities?: string[] | null;
/**
* Whether this device is a phone, tablet, wearable, etc.
*/
formFactor?: string | null;
/**
* The unique opaque id for this model. Use this for invoking the TestExecutionService.
*/
id?: string | null;
/**
* The human-readable name for this device model. Examples: "iPhone 4s", "iPad Mini 2".
*/
name?: string | null;
/**
* Screen density in DPI.
*/
screenDensity?: number | null;
/**
* Screen size in the horizontal (X) dimension measured in pixels.
*/
screenX?: number | null;
/**
* Screen size in the vertical (Y) dimension measured in pixels.
*/
screenY?: number | null;
/**
* The set of iOS major software versions this device supports.
*/
supportedVersionIds?: string[] | null;
/**
* Tags for this dimension. Examples: "default", "preview", "deprecated".
*/
tags?: string[] | null;
}
/**
* iOS configuration that can be selected at the time a test is run.
*/
export interface Schema$IosRuntimeConfiguration {
/**
* The set of available locales.
*/
locales?: Schema$Locale[];
/**
* The set of available orientations.
*/
orientations?: Schema$Orientation[];
}
/**
* A test of an iOS application that implements one or more game loop scenarios. This test type accepts an archived application (.ipa file) and a list of integer scenarios that will be executed on the app sequentially.
*/
export interface Schema$IosTestLoop {
/**
* Output only. The bundle id for the application under test.
*/
appBundleId?: string | null;
/**
* Required. The .ipa of the application to test.
*/
appIpa?: Schema$FileReference;
/**
* The list of scenarios that should be run during the test. Defaults to the single scenario 0 if unspecified.
*/
scenarios?: number[] | null;
}
/**
* A description of how to set up an iOS device prior to running the test.
*/
export interface Schema$IosTestSetup {
/**
* iOS apps to install in addition to those being directly tested.
*/
additionalIpas?: Schema$FileReference[];
/**
* The network traffic profile used for running the test. Available network profiles can be queried by using the NETWORK_CONFIGURATION environment type when calling TestEnvironmentDiscoveryService.GetTestEnvironmentCatalog.
*/
networkProfile?: string | null;
/**
* List of directories on the device to upload to Cloud Storage at the end of the test. Directories should either be in a shared directory (e.g. /private/var/mobile/Media) or within an accessible directory inside the app's filesystem (e.g. /Documents) by specifying the bundle id.
*/
pullDirectories?: Schema$IosDeviceFile[];
/**
* List of files to push to the device before starting the test.
*/
pushFiles?: Schema$IosDeviceFile[];
}
/**
* An iOS version.
*/
export interface Schema$IosVersion {
/**
* An opaque id for this iOS version. Use this id to invoke the TestExecutionService.
*/
id?: string | null;
/**
* An integer representing the major iOS version. Examples: "8", "9".
*/
majorVersion?: number | null;
/**
* An integer representing the minor iOS version. Examples: "1", "2".
*/
minorVersion?: number | null;
/**
* The available Xcode versions for this version.
*/
supportedXcodeVersionIds?: string[] | null;
/**
* Tags for this dimension. Examples: "default", "preview", "deprecated".
*/
tags?: string[] | null;
}
/**
* A test of an iOS application that uses the XCTest framework. Xcode supports the option to "build for testing", which generates an .xctestrun file that contains a test specification (arguments, test methods, etc). This test type accepts a zip file containing the .xctestrun file and the corresponding contents of the Build/Products directory that contains all the binaries needed to run the tests.
*/
export interface Schema$IosXcTest {
/**
* Output only. The bundle id for the application under test.
*/
appBundleId?: string | null;
/**
* The option to test special app entitlements. Setting this would re-sign the app having special entitlements with an explicit application-identifier. Currently supports testing aps-environment entitlement.
*/
testSpecialEntitlements?: boolean | null;
/**
* Required. The .zip containing the .xctestrun file and the contents of the DerivedData/Build/Products directory. The .xctestrun file in this zip is ignored if the xctestrun field is specified.
*/
testsZip?: Schema$FileReference;
/**
* The Xcode version that should be used for the test. Use the TestEnvironmentDiscoveryService to get supported options. Defaults to the latest Xcode version Firebase Test Lab supports.
*/
xcodeVersion?: string | null;
/**
* An .xctestrun file that will override the .xctestrun file in the tests zip. Because the .xctestrun file contains environment variables along with test methods to run and/or ignore, this can be useful for sharding tests. Default is taken from the tests zip.
*/
xctestrun?: Schema$FileReference;
}
/**
* Specifies an intent that starts the main launcher activity.
*/
export interface Schema$LauncherActivityIntent {
}
/**
* A location/region designation for language.
*/
export interface Schema$Locale {
/**
* The id for this locale. Example: "en_US".
*/
id?: string | null;
/**
* A human-friendly name for this language/locale. Example: "English".
*/
name?: string | null;
/**
* A human-friendly string representing the region for this locale. Example: "United States". Not present for every locale.
*/
region?: string | null;
/**
* Tags for this dimension. Example: "default".
*/
tags?: string[] | null;
}
/**
* Shards test cases into the specified groups of packages, classes, and/or methods. With manual sharding enabled, specifying test targets via environment_variables or in InstrumentationTest is invalid.
*/
export interface Schema$ManualSharding {
/**
* Required. Group of packages, classes, and/or test methods to be run for each shard. When any physical devices are selected, the number of test_targets_for_shard must be \>= 1 and <= 50. When no physical devices are selected, the number must be \>= 1 and <= 500.
*/
testTargetsForShard?: Schema$TestTargetsForShard[];
}
export interface Schema$NetworkConfiguration {
/**
* The emulation rule applying to the download traffic.
*/
downRule?: Schema$TrafficRule;
/**
* The unique opaque id for this network traffic configuration.
*/
id?: string | null;
/**
* The emulation rule applying to the upload traffic.
*/
upRule?: Schema$TrafficRule;
}
export interface Schema$NetworkConfigurationCatalog {
configurations?: Schema$NetworkConfiguration[];
}
/**
* An opaque binary blob file to install on the device before the test starts.
*/
export interface Schema$ObbFile {
/**
* Required. Opaque Binary Blob (OBB) file(s) to install on the device.
*/
obb?: Schema$FileReference;
/**
* Required. OBB file name which must conform to the format as specified by Android e.g. [main|patch].0300110.com.example.android.obb which will be installed into \/Android/obb/\/ on the device.
*/
obbFileName?: string | null;
}
/**
* Screen orientation of the device.
*/
export interface Schema$Orientation {
/**
* The id for this orientation. Example: "portrait".
*/
id?: string | null;
/**
* A human-friendly name for this orientation. Example: "portrait".
*/
name?: string | null;
/**
* Tags for this dimension. Example: "default".
*/
tags?: string[] | null;
}
/**
* The currently provided software environment on the devices under test.
*/
export interface Schema$ProvidedSoftwareCatalog {
/**
* A string representing the current version of AndroidX Test Orchestrator that is used in the environment. The package is available at https://maven.google.com/web/index.html#androidx.test:orchestrator.
*/
androidxOrchestratorVersion?: string | null;
/**
* A string representing the current version of Android Test Orchestrator that is used in the environment. The package is available at https://maven.google.com/web/index.html#com.android.support.test:orchestrator.
*/
orchestratorVersion?: string | null;
}
/**
* A file or directory to install on the device before the test starts.
*/
export interface Schema$RegularFile {
/**
* Required. The source file.
*/
content?: Schema$FileReference;
/**
* Required. Where to put the content on the device. Must be an absolute, allowlisted path. If the file exists, it will be replaced. The following device-side directories and any of their subdirectories are allowlisted: ${EXTERNAL_STORAGE\}, /sdcard, or /storage ${ANDROID_DATA\}/local/tmp, or /data/local/tmp Specifying a path outside of these directory trees is invalid. The paths /sdcard and /data will be made available and treated as implicit path substitutions. E.g. if /sdcard on a particular device does not map to external storage, the system will replace it with the external storage path prefix for that device and copy the file there. It is strongly advised to use the Environment API in app and test code to access files on the device in a portable way.
*/
devicePath?: string | null;
}
/**
* Locations where the results of running the test are stored.
*/
export interface Schema$ResultStorage {
/**
* Required.
*/
googleCloudStorage?: Schema$GoogleCloudStorage;
/**
* Output only. URL to the results in the Firebase Web Console.
*/
resultsUrl?: string | null;
/**
* Output only. The tool results execution that results are written to.
*/
toolResultsExecution?: Schema$ToolResultsExecution;
/**
* The tool results history that contains the tool results execution that results are written to. If not provided, the service will choose an appropriate value.
*/
toolResultsHistory?: Schema$ToolResultsHistory;
}
/**
* Directs Robo to interact with a specific UI element if it is encountered during the crawl. Currently, Robo can perform text entry or element click.
*/
export interface Schema$RoboDirective {
/**
* Required. The type of action that Robo should perform on the specified element.
*/
actionType?: string | null;
/**
* The text that Robo is directed to set. If left empty, the directive will be treated as a CLICK on the element matching the resource_name.
*/
inputText?: string | null;
/**
* Required. The android resource name of the target UI element. For example, in Java: R.string.foo in xml: @string/foo Only the "foo" part is needed. Reference doc: https://developer.android.com/guide/topics/resources/accessing-resources.html
*/
resourceName?: string | null;
}
/**
* Message for specifying the start activities to crawl.
*/
export interface Schema$RoboStartingIntent {
/**
* An intent that starts the main launcher activity.
*/
launcherActivity?: Schema$LauncherActivityIntent;
/**
* An intent that starts an activity with specific details.
*/
startActivity?: Schema$StartActivityIntent;
/**
* Timeout in seconds for each intent.
*/
timeout?: string | null;
}
/**
* Output only. Details about the shard.
*/
export interface Schema$Shard {
/**
* Output only. The total number of shards.
*/
numShards?: number | null;
/**
* Output only. The index of the shard among all the shards.
*/
shardIndex?: number | null;
/**
* Output only. Test targets for each shard.
*/
testTargetsForShard?: Schema$TestTargetsForShard;
}
/**
* Options for enabling sharding.
*/
export interface Schema$ShardingOption {
/**
* Shards test cases into the specified groups of packages, classes, and/or methods.
*/
manualSharding?: Schema$ManualSharding;
/**
* Uniformly shards test cases given a total number of shards.
*/
uniformSharding?: Schema$UniformSharding;
}
/**
* A starting intent specified by an action, uri, and categories.
*/
export interface Schema$StartActivityIntent {
/**
* Action name. Required for START_ACTIVITY.
*/
action?: string | null;
/**
* Intent categories to set on the intent.
*/
categories?: string[] | null;
/**
* URI for the action.
*/
uri?: string | null;
}
export interface Schema$SystraceSetup {
/**
* Systrace duration in seconds. Should be between 1 and 30 seconds. 0 disables systrace.
*/
durationSeconds?: number | null;
}
/**
* Additional details about the progress of the running test.
*/
export interface Schema$TestDetails {
/**
* Output only. If the TestState is ERROR, then this string will contain human-readable details about the error.
*/
errorMessage?: string | null;
/**
* Output only. Human-readable, detailed descriptions of the test's progress. For example: "Provisioning a device", "Starting Test". During the course of execution new data may be appended to the end of progress_messages.
*/
progressMessages?: string[] | null;
}
/**
* A description of a test environment.
*/
export interface Schema$TestEnvironmentCatalog {
/**
* Supported Android devices.
*/
androidDeviceCatalog?: Schema$AndroidDeviceCatalog;
/**
* The IP blocks used by devices in the test environment.
*/
deviceIpBlockCatalog?: Schema$DeviceIpBlockCatalog;
/**
* Supported iOS devices.
*/
iosDeviceCatalog?: Schema$IosDeviceCatalog;
/**
* Supported network configurations.
*/
networkConfigurationCatalog?: Schema$NetworkConfigurationCatalog;
/**
* The software test environment provided by TestExecutionService.
*/
softwareCatalog?: Schema$ProvidedSoftwareCatalog;
}
/**
* A single test executed in a single environment.
*/
export interface Schema$TestExecution {
/**
* Output only. How the host machine(s) are configured.
*/
environment?: Schema$Environment;
/**
* Output only. Unique id set by the service.
*/
id?: string | null;
/**
* Output only. Id of the containing TestMatrix.
*/
matrixId?: string | null;
/**
* Output only. The cloud project that owns the test execution.
*/
projectId?: string | null;
/**
* Output only. Details about the shard.
*/
shard?: Schema$Shard;
/**
* Output only. Indicates the current progress of the test execution (e.g., FINISHED).
*/
state?: string | null;
/**
* Output only. Additional details about the running test.
*/
testDetails?: Schema$TestDetails;
/**
* Output only. How to run the test.
*/
testSpecification?: Schema$TestSpecification;
/**
* Output only. The time this test execution was initially created.
*/
timestamp?: string | null;
/**
* Output only. Where the results for this execution are written.
*/
toolResultsStep?: Schema$ToolResultsStep;
}
/**
* TestMatrix captures all details about a test. It contains the environment configuration, test specification, test executions and overall state and outcome.
*/
export interface Schema$TestMatrix {
/**
* Information about the client which invoked the test.
*/
clientInfo?: Schema$ClientInfo;
/**
* Required. The devices the tests are being executed on.
*/
environmentMatrix?: Schema$EnvironmentMatrix;
/**
* If true, only a single attempt at most will be made to run each execution/shard in the matrix. Flaky test attempts are not affected. Normally, 2 or more attempts are made if a potential infrastructure issue is detected. This feature is for latency sensitive workloads. The incidence of execution failures may be significantly greater for fail-fast matrices and support is more limited because of that expectation.
*/
failFast?: boolean | null;
/**
* The number of times a TestExecution should be re-attempted if one or more of its test cases fail for any reason. The maximum number of reruns allowed is 10. Default is 0, which implies no reruns.
*/
flakyTestAttempts?: number | null;
/**
* Output only. Describes why the matrix is considered invalid. Only useful for matrices in the INVALID state.
*/
invalidMatrixDetails?: string | null;
/**
* Output Only. The overall outcome of the test. Only set when the test matrix state is FINISHED.
*/
outcomeSummary?: string | null;
/**
* The cloud project that owns the test matrix.
*/
projectId?: string | null;
/**
* Required. Where the results for the matrix are written.
*/
resultStorage?: Schema$ResultStorage;
/**
* Output only. Indicates the current progress of the test matrix.
*/
state?: string | null;
/**
* Output only. The list of test executions that the service creates for this matrix.
*/
testExecutions?: Schema$TestExecution[];
/**
* Output only. Unique id set by the service.
*/
testMatrixId?: string | null;
/**
* Required. How to run the test.
*/
testSpecification?: Schema$TestSpecification;
/**
* Output only. The time this test matrix was initially created.
*/
timestamp?: string | null;
}
/**
* A description of how to set up the Android device prior to running the test.
*/
export interface Schema$TestSetup {
/**
* The device will be logged in on this account for the duration of the test.
*/
account?: Schema$Account;
/**
* APKs to install in addition to those being directly tested. Currently capped at 100.
*/
additionalApks?: Schema$Apk[];
/**
* List of directories on the device to upload to GCS at the end of the test; they must be absolute paths under /sdcard, /storage or /data/local/tmp. Path names are restricted to characters a-z A-Z 0-9 _ - . + and / Note: The paths /sdcard and /data will be made available and treated as implicit path substitutions. E.g. if /sdcard on a particular device does not map to external storage, the system will replace it with the external storage path prefix for that device.
*/
directoriesToPull?: string[] | null;
/**
* Whether to prevent all runtime permissions to be granted at app install
*/
dontAutograntPermissions?: boolean | null;
/**
* Environment variables to set for the test (only applicable for instrumentation tests).
*/
environmentVariables?: Schema$EnvironmentVariable[];
/**
* List of files to push to the device before starting the test.
*/
filesToPush?: Schema$DeviceFile[];
/**
* The network traffic profile used for running the test. Available network profiles can be queried by using the NETWORK_CONFIGURATION environment type when calling TestEnvironmentDiscoveryService.GetTestEnvironmentCatalog.
*/
networkProfile?: string | null;
/**
* Systrace configuration for the run. If set a systrace will be taken, starting on test start and lasting for the configured duration. The systrace file thus obtained is put in the results bucket together with the other artifacts from the run.
*/
systrace?: Schema$SystraceSetup;
}
/**
* A description of how to run the test.
*/
export interface Schema$TestSpecification {
/**
* An Android instrumentation test.
*/
androidInstrumentationTest?: Schema$AndroidInstrumentationTest;
/**
* An Android robo test.
*/
androidRoboTest?: Schema$AndroidRoboTest;
/**
* An Android Application with a Test Loop.
*/
androidTestLoop?: Schema$AndroidTestLoop;
/**
* Disables performance metrics recording. May reduce test latency.
*/
disablePerformanceMetrics?: boolean | null;
/**
* Disables video recording. May reduce test latency.
*/
disableVideoRecording?: boolean | null;
/**
* An iOS application with a test loop.
*/
iosTestLoop?: Schema$IosTestLoop;
/**
* Test setup requirements for iOS.
*/
iosTestSetup?: Schema$IosTestSetup;
/**
* An iOS XCTest, via an .xctestrun file.
*/
iosXcTest?: Schema$IosXcTest;
/**
* Test setup requirements for Android e.g. files to install, bootstrap scripts.
*/
testSetup?: Schema$TestSetup;
/**
* Max time a test execution is allowed to run before it is automatically cancelled. The default value is 5 min.
*/
testTimeout?: string | null;
}
/**
* Test targets for a shard.
*/
export interface Schema$TestTargetsForShard {
/**
* Group of packages, classes, and/or test methods to be run for each shard. The targets need to be specified in AndroidJUnitRunner argument format. For example, "package com.my.packages" "class com.my.package.MyClass". The number of shard_test_targets must be greater than 0.
*/
testTargets?: string[] | null;
}
/**
* Represents a tool results execution resource. This has the results of a TestMatrix.
*/
export interface Schema$ToolResultsExecution {
/**
* Output only. A tool results execution ID.
*/
executionId?: string | null;
/**
* Output only. A tool results history ID.
*/
historyId?: string | null;
/**
* Output only. The cloud project that owns the tool results execution.
*/
projectId?: string | null;
}
/**
* Represents a tool results history resource.
*/
export interface Schema$ToolResultsHistory {
/**
* Required. A tool results history ID.
*/
historyId?: string | null;
/**
* Required. The cloud project that owns the tool results history.
*/
projectId?: string | null;
}
/**
* Represents a tool results step resource. This has the results of a TestExecution.
*/
export interface Schema$ToolResultsStep {
/**
* Output only. A tool results execution ID.
*/
executionId?: string | null;
/**
* Output only. A tool results history ID.
*/
historyId?: string | null;
/**
* Output only. The cloud project that owns the tool results step.
*/
projectId?: string | null;
/**
* Output only. A tool results step ID.
*/
stepId?: string | null;
}
/**
* Network emulation parameters.
*/
export interface Schema$TrafficRule {
/**
* Bandwidth in kbits/second.
*/
bandwidth?: number | null;
/**
* Burst size in kbits.
*/
burst?: number | null;
/**
* Packet delay, must be \>= 0.
*/
delay?: string | null;
/**
* Packet duplication ratio (0.0 - 1.0).
*/
packetDuplicationRatio?: number | null;
/**
* Packet loss ratio (0.0 - 1.0).
*/
packetLossRatio?: number | null;
}
/**
* Uniformly shards test cases given a total number of shards. For Instrumentation test, it will be translated to "-e numShard" "-e shardIndex" AndroidJUnitRunner arguments. With uniform sharding enabled, specifying these sharding arguments via environment_variables is invalid.
*/
export interface Schema$UniformSharding {
/**
* Required. Total number of shards. When any physical devices are selected, the number must be \>= 1 and <= 50. When no physical devices are selected, the number must be \>= 1 and <= 500.
*/
numShards?: number | null;
}
/**
* An Xcode version that an iOS version is compatible with.
*/
export interface Schema$XcodeVersion {
/**
* Tags for this Xcode version. Example: "default".
*/
tags?: string[] | null;
/**
* The id for this version. Example: "9.2".
*/
version?: string | null;
}
export class Resource$Applicationdetailservice {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* Gets the details of an Android application APK.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/testing.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const testing = google.testing('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await testing.applicationDetailService.getApkDetails({
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "gcsPath": "my_gcsPath"
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "apkDetail": {}
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
getApkDetails(params: Params$Resource$Applicationdetailservice$Getapkdetails, options: StreamMethodOptions): GaxiosPromise<Readable>;
getApkDetails(params?: Params$Resource$Applicationdetailservice$Getapkdetails, options?: MethodOptions): GaxiosPromise<Schema$GetApkDetailsResponse>;
getApkDetails(params: Params$Resource$Applicationdetailservice$Getapkdetails, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
getApkDetails(params: Params$Resource$Applicationdetailservice$Getapkdetails, options: MethodOptions | BodyResponseCallback<Schema$GetApkDetailsResponse>, callback: BodyResponseCallback<Schema$GetApkDetailsResponse>): void;
getApkDetails(params: Params$Resource$Applicationdetailservice$Getapkdetails, callback: BodyResponseCallback<Schema$GetApkDetailsResponse>): void;
getApkDetails(callback: BodyResponseCallback<Schema$GetApkDetailsResponse>): void;
}
export interface Params$Resource$Applicationdetailservice$Getapkdetails extends StandardParameters {
/**
* Request body metadata
*/
requestBody?: Schema$FileReference;
}
export class Resource$Projects {
context: APIRequestContext;
testMatrices: Resource$Projects$Testmatrices;
constructor(context: APIRequestContext);
}
export class Resource$Projects$Testmatrices {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* Cancels unfinished test executions in a test matrix. This call returns immediately and cancellation proceeds asynchronously. If the matrix is already final, this operation will have no effect. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to read project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the Test Matrix does not exist
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/testing.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const testing = google.testing('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await testing.projects.testMatrices.cancel({
* // Cloud project that owns the test.
* projectId: 'placeholder-value',
* // Test matrix that will be canceled.
* testMatrixId: 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "testState": "my_testState"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
cancel(params: Params$Resource$Projects$Testmatrices$Cancel, options: StreamMethodOptions): GaxiosPromise<Readable>;
cancel(params?: Params$Resource$Projects$Testmatrices$Cancel, options?: MethodOptions): GaxiosPromise<Schema$CancelTestMatrixResponse>;
cancel(params: Params$Resource$Projects$Testmatrices$Cancel, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
cancel(params: Params$Resource$Projects$Testmatrices$Cancel, options: MethodOptions | BodyResponseCallback<Schema$CancelTestMatrixResponse>, callback: BodyResponseCallback<Schema$CancelTestMatrixResponse>): void;
cancel(params: Params$Resource$Projects$Testmatrices$Cancel, callback: BodyResponseCallback<Schema$CancelTestMatrixResponse>): void;
cancel(callback: BodyResponseCallback<Schema$CancelTestMatrixResponse>): void;
/**
* Creates and runs a matrix of tests according to the given specifications. Unsupported environments will be returned in the state UNSUPPORTED. A test matrix is limited to use at most 2000 devices in parallel. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to write to project - INVALID_ARGUMENT - if the request is malformed or if the matrix tries to use too many simultaneous devices.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/testing.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const testing = google.testing('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await testing.projects.testMatrices.create({
* // The GCE project under which this job will run.
* projectId: 'placeholder-value',
* // A string id used to detect duplicated requests. Ids are automatically scoped to a project, so users should ensure the ID is unique per-project. A UUID is recommended. Optional, but strongly recommended.
* requestId: 'placeholder-value',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "clientInfo": {},
* // "environmentMatrix": {},
* // "failFast": false,
* // "flakyTestAttempts": 0,
* // "invalidMatrixDetails": "my_invalidMatrixDetails",
* // "outcomeSummary": "my_outcomeSummary",
* // "projectId": "my_projectId",
* // "resultStorage": {},
* // "state": "my_state",
* // "testExecutions": [],
* // "testMatrixId": "my_testMatrixId",
* // "testSpecification": {},
* // "timestamp": "my_timestamp"
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "clientInfo": {},
* // "environmentMatrix": {},
* // "failFast": false,
* // "flakyTestAttempts": 0,
* // "invalidMatrixDetails": "my_invalidMatrixDetails",
* // "outcomeSummary": "my_outcomeSummary",
* // "projectId": "my_projectId",
* // "resultStorage": {},
* // "state": "my_state",
* // "testExecutions": [],
* // "testMatrixId": "my_testMatrixId",
* // "testSpecification": {},
* // "timestamp": "my_timestamp"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
create(params: Params$Resource$Projects$Testmatrices$Create, options: StreamMethodOptions): GaxiosPromise<Readable>;
create(params?: Params$Resource$Projects$Testmatrices$Create, options?: MethodOptions): GaxiosPromise<Schema$TestMatrix>;
create(params: Params$Resource$Projects$Testmatrices$Create, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
create(params: Params$Resource$Projects$Testmatrices$Create, options: MethodOptions | BodyResponseCallback<Schema$TestMatrix>, callback: BodyResponseCallback<Schema$TestMatrix>): void;
create(params: Params$Resource$Projects$Testmatrices$Create, callback: BodyResponseCallback<Schema$TestMatrix>): void;
create(callback: BodyResponseCallback<Schema$TestMatrix>): void;
/**
* Checks the status of a test matrix. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to read project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the Test Matrix does not exist
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/testing.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const testing = google.testing('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/cloud-platform',
* 'https://www.googleapis.com/auth/cloud-platform.read-only',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await testing.projects.testMatrices.get({
* // Cloud project that owns the test matrix.
* projectId: 'placeholder-value',
* // Unique test matrix id which was assigned by the service.
* testMatrixId: 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "clientInfo": {},
* // "environmentMatrix": {},
* // "failFast": false,
* // "flakyTestAttempts": 0,
* // "invalidMatrixDetails": "my_invalidMatrixDetails",
* // "outcomeSummary": "my_outcomeSummary",
* // "projectId": "my_projectId",
* // "resultStorage": {},
* // "state": "my_state",
* // "testExecutions": [],
* // "testMatrixId": "my_testMatrixId",
* // "testSpecification": {},
* // "timestamp": "my_timestamp"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
get(params: Params$Resource$Projects$Testmatrices$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
get(params?: Params$Resource$Projects$Testmatrices$Get, options?: MethodOptions): GaxiosPromise<Schema$TestMatrix>;
get(params: Params$Resource$Projects$Testmatrices$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
get(params: Params$Resource$Projects$Testmatrices$Get, options: MethodOptions | BodyResponseCallback<Schema$TestMatrix>, callback: BodyResponseCallback<Schema$TestMatrix>): void;
get(params: Params$Resource$Projects$Testmatrices$Get, callback: BodyResponseCallback<Schema$TestMatrix>): void;
get(callback: BodyResponseCallback<Schema$TestMatrix>): void;
}
export interface Params$Resource$Projects$Testmatrices$Cancel extends StandardParameters {
/**
* Cloud project that owns the test.
*/
projectId?: string;
/**
* Test matrix that will be canceled.
*/
testMatrixId?: string;
}
export interface Params$Resource$Projects$Testmatrices$Create extends StandardParameters {
/**
* The GCE project under which this job will run.
*/
projectId?: string;
/**
* A string id used to detect duplicated requests. Ids are automatically scoped to a project, so users should ensure the ID is unique per-project. A UUID is recommended. Optional, but strongly recommended.
*/
requestId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$TestMatrix;
}
export interface Params$Resource$Projects$Testmatrices$Get extends StandardParameters {
/**
* Cloud project that owns the test matrix.
*/
projectId?: string;
/**
* Unique test matrix id which was assigned by the service.
*/
testMatrixId?: string;
}
export class Resource$Testenvironmentcatalog {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* Gets the catalog of supported test environments. May return any of the following canonical error codes: - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the environment type does not exist - INTERNAL - if an internal error occurred
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/testing.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const testing = google.testing('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/cloud-platform',
* 'https://www.googleapis.com/auth/cloud-platform.read-only',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await testing.testEnvironmentCatalog.get({
* // Required. The type of environment that should be listed.
* environmentType: 'placeholder-value',
* // For authorization, the cloud project requesting the TestEnvironmentCatalog.
* projectId: 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "androidDeviceCatalog": {},
* // "deviceIpBlockCatalog": {},
* // "iosDeviceCatalog": {},
* // "networkConfigurationCatalog": {},
* // "softwareCatalog": {}
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
get(params: Params$Resource$Testenvironmentcatalog$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
get(params?: Params$Resource$Testenvironmentcatalog$Get, options?: MethodOptions): GaxiosPromise<Schema$TestEnvironmentCatalog>;
get(params: Params$Resource$Testenvironmentcatalog$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
get(params: Params$Resource$Testenvironmentcatalog$Get, options: MethodOptions | BodyResponseCallback<Schema$TestEnvironmentCatalog>, callback: BodyResponseCallback<Schema$TestEnvironmentCatalog>): void;
get(params: Params$Resource$Testenvironmentcatalog$Get, callback: BodyResponseCallback<Schema$TestEnvironmentCatalog>): void;
get(callback: BodyResponseCallback<Schema$TestEnvironmentCatalog>): void;
}
export interface Params$Resource$Testenvironmentcatalog$Get extends StandardParameters {
/**
* Required. The type of environment that should be listed.
*/
environmentType?: string;
/**
* For authorization, the cloud project requesting the TestEnvironmentCatalog.
*/
projectId?: string;
}
export {};
}