@maxim_mazurok/gapi.client.testing-v1 0.0.20231113 → 0.0.20231201

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (6) hide show
  1. package/index.d.ts +1203 -1817
  2. package/package.json +6 -6
  3. package/readme.md +22 -17
  4. package/tests.ts +0 -679
  5. package/tsconfig.json +0 -18
  6. package/tslint.json +0 -6
package/index.d.ts CHANGED
@@ -9,1829 +9,1215 @@
9
9
  // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
10
10
  // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
11
11
  // Generated from: https://testing.googleapis.com/$discovery/rest?version=v1
12
- // Revision: 20231113
12
+ // Revision: 20231201
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
16
16
  declare namespace gapi.client {
17
- /** Load Cloud Testing API v1 */
18
- function load(urlOrObject: "https://testing.googleapis.com/$discovery/rest?version=v1"): Promise<void>;
19
- /** @deprecated Please load APIs with discovery documents. */
20
- function load(name: "testing", version: "v1"): Promise<void>;
21
- /** @deprecated Please load APIs with discovery documents. */
22
- function load(name: "testing", version: "v1", callback: () => any): void;
17
+ /** Load Cloud Testing API v1 */
18
+ function load(
19
+ urlOrObject: 'https://testing.googleapis.com/$discovery/rest?version=v1'
20
+ ): Promise<void>;
21
+ /** @deprecated Please load APIs with discovery documents. */
22
+ function load(name: 'testing', version: 'v1'): Promise<void>;
23
+ /** @deprecated Please load APIs with discovery documents. */
24
+ function load(name: 'testing', version: 'v1', callback: () => any): void;
23
25
 
24
- namespace testing {
25
- interface Account {
26
- /** An automatic google login account. */
27
- googleAuto?:
28
- any;
29
- }
30
- interface AndroidDevice {
31
- /** Required. The id of the Android device to be used. Use the TestEnvironmentDiscoveryService to get supported options. */
32
- androidModelId?:
33
- string;
34
- /** Required. The id of the Android OS version to be used. Use the TestEnvironmentDiscoveryService to get supported options. */
35
- androidVersionId?:
36
- string;
37
- /** Required. The locale the test device used for testing. Use the TestEnvironmentDiscoveryService to get supported options. */
38
- locale?:
39
- string;
40
- /** Required. How the device is oriented during the test. Use the TestEnvironmentDiscoveryService to get supported options. */
41
- orientation?:
42
- string;
43
- }
44
- interface AndroidDeviceCatalog {
45
- /** The set of supported Android device models. */
46
- models?:
47
- AndroidModel[];
48
- /** The set of supported runtime configurations. */
49
- runtimeConfiguration?:
50
- AndroidRuntimeConfiguration;
51
- /** The set of supported Android OS versions. */
52
- versions?:
53
- AndroidVersion[];
54
- }
55
- interface AndroidDeviceList {
56
- /** Required. A list of Android devices. */
57
- androidDevices?:
58
- AndroidDevice[];
59
- }
60
- interface AndroidInstrumentationTest {
61
- /** The APK for the application under test. */
62
- appApk?:
63
- FileReference;
64
- /** A multi-apk app bundle for the application under test. */
65
- appBundle?:
66
- AppBundle;
67
- /** The java package for the application under test. The default value is determined by examining the application's manifest. */
68
- appPackageId?:
69
- string;
70
- /**
71
- * The option of whether running each test within its own invocation of instrumentation with Android Test Orchestrator or not. ** Orchestrator is only compatible with
72
- * AndroidJUnitRunner version 1.1 or higher! ** Orchestrator offers the following benefits: - No shared state - Crashes are isolated - Logs are scoped per test See for more information
73
- * about Android Test Orchestrator. If not set, the test will be run without the orchestrator.
74
- */
75
- orchestratorOption?:
76
- string;
77
- /** The option to run tests in multiple shards in parallel. */
78
- shardingOption?:
79
- ShardingOption;
80
- /** Required. The APK containing the test code to be executed. */
81
- testApk?:
82
- FileReference;
83
- /** The java package for the test to be executed. The default value is determined by examining the application's manifest. */
84
- testPackageId?:
85
- string;
86
- /** The InstrumentationTestRunner class. The default value is determined by examining the application's manifest. */
87
- testRunnerClass?:
88
- string;
89
- /**
90
- * 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
91
- * package_name.class_name#method_name" If empty, all targets in the module will be run.
92
- */
93
- testTargets?:
94
- string[];
95
- }
96
- interface AndroidMatrix {
97
- /** Required. The ids of the set of Android device to be used. Use the TestEnvironmentDiscoveryService to get supported options. */
98
- androidModelIds?:
99
- string[];
100
- /** Required. The ids of the set of Android OS version to be used. Use the TestEnvironmentDiscoveryService to get supported options. */
101
- androidVersionIds?:
102
- string[];
103
- /** Required. The set of locales the test device will enable for testing. Use the TestEnvironmentDiscoveryService to get supported options. */
104
- locales?:
105
- string[];
106
- /** Required. The set of orientations to test with. Use the TestEnvironmentDiscoveryService to get supported options. */
107
- orientations?:
108
- string[];
109
- }
110
- interface AndroidModel {
111
- /** The company that this device is branded with. Example: "Google", "Samsung". */
112
- brand?:
113
- string;
114
- /** The name of the industrial design. This corresponds to android.os.Build.DEVICE. */
115
- codename?:
116
- string;
117
- /** Whether this device is virtual or physical. */
118
- form?:
119
- string;
120
- /** Whether this device is a phone, tablet, wearable, etc. */
121
- formFactor?:
122
- string;
123
- /** The unique opaque id for this model. Use this for invoking the TestExecutionService. */
124
- id?:
125
- string;
126
- /** True if and only if tests with this model are recorded by stitching together screenshots. See use_low_spec_video_recording in device config. */
127
- lowFpsVideoRecording?:
128
- boolean;
129
- /** The manufacturer of this device. */
130
- manufacturer?:
131
- string;
132
- /** The human-readable marketing name for this device model. Examples: "Nexus 5", "Galaxy S5". */
133
- name?:
134
- string;
135
- /** Version-specific information of an Android model. */
136
- perVersionInfo?:
137
- PerAndroidVersionInfo[];
138
- /** Screen density in DPI. This corresponds to ro.sf.lcd_density */
139
- screenDensity?:
140
- number;
141
- /** Screen size in the horizontal (X) dimension measured in pixels. */
142
- screenX?:
143
- number;
144
- /** Screen size in the vertical (Y) dimension measured in pixels. */
145
- screenY?:
146
- number;
147
- /**
148
- * 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
149
- * 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
150
- * supported only on a particular version.
151
- */
152
- supportedAbis?:
153
- string[];
154
- /** The set of Android versions this device supports. */
155
- supportedVersionIds?:
156
- string[];
157
- /** Tags for this dimension. Examples: "default", "preview", "deprecated". */
158
- tags?:
159
- string[];
160
- /** URL of a thumbnail image (photo) of the device. */
161
- thumbnailUrl?:
162
- string;
163
- }
164
- interface AndroidRoboTest {
165
- /** The APK for the application under test. */
166
- appApk?:
167
- FileReference;
168
- /** A multi-apk app bundle for the application under test. */
169
- appBundle?:
170
- AppBundle;
171
- /** The initial activity that should be used to start the app. */
172
- appInitialActivity?:
173
- string;
174
- /** The java package for the application under test. The default value is determined by examining the application's manifest. */
175
- appPackageId?:
176
- string;
177
- /** 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. */
178
- maxDepth?:
179
- number;
180
- /** The max number of steps Robo can execute. Default is no limit. */
181
- maxSteps?:
182
- number;
183
- /** 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. */
184
- roboDirectives?:
185
- RoboDirective[];
186
- /** The mode in which Robo should run. Most clients should allow the server to populate this field automatically. */
187
- roboMode?:
188
- string;
189
- /** A JSON file with a sequence of actions Robo should perform as a prologue for the crawl. */
190
- roboScript?:
191
- FileReference;
192
- /**
193
- * 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
194
- * main launcher activity must be provided explicitly).
195
- */
196
- startingIntents?:
197
- RoboStartingIntent[];
198
- }
199
- interface AndroidRuntimeConfiguration {
200
- /** The set of available locales. */
201
- locales?:
202
- Locale[];
203
- /** The set of available orientations. */
204
- orientations?:
205
- Orientation[];
206
- }
207
- interface AndroidTestLoop {
208
- /** The APK for the application under test. */
209
- appApk?:
210
- FileReference;
211
- /** A multi-apk app bundle for the application under test. */
212
- appBundle?:
213
- AppBundle;
214
- /** The java package for the application under test. The default is determined by examining the application's manifest. */
215
- appPackageId?:
216
- string;
217
- /**
218
- * 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
219
- * 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
220
- * specified in the scenarios field.
221
- */
222
- scenarioLabels?:
223
- string[];
224
- /** The list of scenarios that should be run during the test. The default is all test loops, derived from the application's manifest. */
225
- scenarios?:
226
- number[];
227
- }
228
- interface AndroidVersion {
229
- /** The API level for this Android version. Examples: 18, 19. */
230
- apiLevel?:
231
- number;
232
- /** The code name for this Android version. Examples: "JellyBean", "KitKat". */
233
- codeName?:
234
- string;
235
- /** Market share for this version. */
236
- distribution?:
237
- Distribution;
238
- /** An opaque id for this Android version. Use this id to invoke the TestExecutionService. */
239
- id?:
240
- string;
241
- /** The date this Android version became available in the market. */
242
- releaseDate?:
243
- Date;
244
- /** Tags for this dimension. Examples: "default", "preview", "deprecated". */
245
- tags?:
246
- string[];
247
- /** A string representing this version of the Android OS. Examples: "4.3", "4.4". */
248
- versionString?:
249
- string;
250
- }
251
- interface Apk {
252
- /** The path to an APK to be installed on the device before the test begins. */
253
- location?:
254
- FileReference;
255
- /** The java package for the APK to be installed. Value is determined by examining the application's manifest. */
256
- packageName?:
257
- string;
258
- }
259
- interface ApkDetail {
260
- apkManifest?:
261
- ApkManifest;
262
- }
263
- interface ApkManifest {
264
- /** User-readable name for the application. */
265
- applicationLabel?:
266
- string;
267
- intentFilters?:
268
- IntentFilter[];
269
- /** Maximum API level on which the application is designed to run. */
270
- maxSdkVersion?:
271
- number;
272
- /** Meta-data tags defined in the manifest. */
273
- metadata?:
274
- Metadata[];
275
- /** Minimum API level required for the application to run. */
276
- minSdkVersion?:
277
- number;
278
- /** Full Java-style package name for this application, e.g. "com.example.foo". */
279
- packageName?:
280
- string;
281
- /** Services contained in the tag. */
282
- services?:
283
- Service[];
284
- /** Specifies the API Level on which the application is designed to run. */
285
- targetSdkVersion?:
286
- number;
287
- /** Feature usage tags defined in the manifest. */
288
- usesFeature?:
289
- UsesFeature[];
290
- /** Permissions declared to be used by the application */
291
- usesPermission?:
292
- string[];
293
- /** Version number used internally by the app. */
294
- versionCode?:
295
- string;
296
- /** Version number shown to users. */
297
- versionName?:
298
- string;
299
- }
300
- interface AppBundle {
301
- /** .aab file representing the app bundle under test. */
302
- bundleLocation?:
303
- FileReference;
304
- }
305
- // tslint:disable-next-line:no-empty-interface
306
- interface CancelDeviceSessionRequest {
307
- }
308
- interface CancelTestMatrixResponse {
309
- /** The current rolled-up state of the test matrix. If this state is already final, then the cancelation request will have no effect. */
310
- testState?:
311
- string;
312
- }
313
- interface ClientInfo {
314
- /** The list of detailed information about client. */
315
- clientInfoDetails?:
316
- ClientInfoDetail[];
317
- /** Required. Client name, such as gcloud. */
318
- name?:
319
- string;
320
- }
321
- interface ClientInfoDetail {
322
- /** Required. The key of detailed client information. */
323
- key?:
324
- string;
325
- /** Required. The value of detailed client information. */
326
- value?:
327
- string;
328
- }
329
- interface Date {
330
- /** 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. */
331
- day?:
332
- number;
333
- /** Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. */
334
- month?:
335
- number;
336
- /** Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. */
337
- year?:
338
- number;
339
- }
340
- interface DeviceFile {
341
- /** A reference to an opaque binary blob file. */
342
- obbFile?:
343
- ObbFile;
344
- /** A reference to a regular file. */
345
- regularFile?:
346
- RegularFile;
347
- }
348
- interface DeviceIpBlock {
349
- /** The date this block was added to Firebase Test Lab */
350
- addedDate?:
351
- Date;
352
- /** An IP address block in CIDR notation eg: 34.68.194.64/29 */
353
- block?:
354
- string;
355
- /** Whether this block is used by physical or virtual devices */
356
- form?:
357
- string;
358
- }
359
- interface DeviceIpBlockCatalog {
360
- /** The device IP blocks used by Firebase Test Lab */
361
- ipBlocks?:
362
- DeviceIpBlock[];
363
- }
364
- interface DeviceSession {
365
- /** Output only. The timestamp that the session first became ACTIVE. */
366
- activeStartTime?:
367
- string;
368
- /** Required. The requested device */
369
- androidDevice?:
370
- AndroidDevice;
371
- /** Output only. The time that the Session was created. */
372
- createTime?:
373
- string;
374
- /** Output only. The title of the DeviceSession to be presented in the UI. */
375
- displayName?:
376
- string;
377
- /** Optional. If the device is still in use at this time, any connections will be ended and the SessionState will transition from ACTIVE to FINISHED. */
378
- expireTime?:
379
- string;
380
- /** Output only. The interval of time that this device must be interacted with before it transitions from ACTIVE to TIMEOUT_INACTIVITY. */
381
- inactivityTimeout?:
382
- string;
383
- /** Optional. Name of the DeviceSession, e.g. "projects/{project_id}/deviceSessions/{session_id}" */
384
- name?:
385
- string;
386
- /** Output only. Current state of the DeviceSession. */
387
- state?:
388
- string;
389
- /** Output only. The historical state transitions of the session_state message including the current session state. */
390
- stateHistories?:
391
- SessionStateEvent[];
392
- /** Optional. The amount of time that a device will be initially allocated for. This can eventually be extended with the UpdateDeviceSession RPC. Default: 30 minutes. */
393
- ttl?:
394
- string;
395
- }
396
- interface DirectAccessVersionInfo {
397
- /**
398
- * Whether direct access is supported at all. Clients are expected to filter down the device list to only android models and versions which support Direct Access when that is the user
399
- * intent.
400
- */
401
- directAccessSupported?:
402
- boolean;
403
- /**
404
- * Output only. Indicates client-device compatibility, where a device is known to work only with certain workarounds implemented in the Android Studio client. Expected format
405
- * "major.minor.micro.patch", e.g. "5921.22.2211.8881706".
406
- */
407
- minimumAndroidStudioVersion?:
408
- string;
409
- }
410
- interface Distribution {
411
- /** Output only. The estimated fraction (0-1) of the total market with this configuration. */
412
- marketShare?:
413
- number;
414
- /** Output only. The time this distribution was measured. */
415
- measurementTime?:
416
- string;
417
- }
418
- // tslint:disable-next-line:no-empty-interface
419
- interface Empty {
420
- }
421
- interface Environment {
422
- /** An Android device which must be used with an Android test. */
423
- androidDevice?:
424
- AndroidDevice;
425
- /** An iOS device which must be used with an iOS test. */
426
- iosDevice?:
427
- IosDevice;
428
- }
429
- interface EnvironmentMatrix {
430
- /** A list of Android devices; the test will be run only on the specified devices. */
431
- androidDeviceList?:
432
- AndroidDeviceList;
433
- /** A matrix of Android devices. */
434
- androidMatrix?:
435
- AndroidMatrix;
436
- /** A list of iOS devices. */
437
- iosDeviceList?:
438
- IosDeviceList;
439
- }
440
- interface EnvironmentVariable {
441
- /** Key for the environment variable. */
442
- key?:
443
- string;
444
- /** Value for the environment variable. */
445
- value?:
446
- string;
447
- }
448
- interface FileReference {
449
- /** 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) */
450
- gcsPath?:
451
- string;
452
- }
453
- interface GetApkDetailsResponse {
454
- /** Details of the Android APK. */
455
- apkDetail?:
456
- ApkDetail;
457
- }
458
- // tslint:disable-next-line:no-empty-interface
459
- interface GoogleAuto {
460
- }
461
- interface GoogleCloudStorage {
462
- /** 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. */
463
- gcsPath?:
464
- string;
465
- }
466
- interface IntentFilter {
467
- /** The android:name value of the tag. */
468
- actionNames?:
469
- string[];
470
- /** The android:name value of the tag. */
471
- categoryNames?:
472
- string[];
473
- /** The android:mimeType value of the tag. */
474
- mimeType?:
475
- string;
476
- }
477
- interface IosDevice {
478
- /** Required. The id of the iOS device to be used. Use the TestEnvironmentDiscoveryService to get supported options. */
479
- iosModelId?:
480
- string;
481
- /** Required. The id of the iOS major software version to be used. Use the TestEnvironmentDiscoveryService to get supported options. */
482
- iosVersionId?:
483
- string;
484
- /** Required. The locale the test device used for testing. Use the TestEnvironmentDiscoveryService to get supported options. */
485
- locale?:
486
- string;
487
- /** Required. How the device is oriented during the test. Use the TestEnvironmentDiscoveryService to get supported options. */
488
- orientation?:
489
- string;
490
- }
491
- interface IosDeviceCatalog {
492
- /** The set of supported iOS device models. */
493
- models?:
494
- IosModel[];
495
- /** The set of supported runtime configurations. */
496
- runtimeConfiguration?:
497
- IosRuntimeConfiguration;
498
- /** The set of supported iOS software versions. */
499
- versions?:
500
- IosVersion[];
501
- /** The set of supported Xcode versions. */
502
- xcodeVersions?:
503
- XcodeVersion[];
504
- }
505
- interface IosDeviceFile {
506
- /** 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. */
507
- bundleId?:
508
- string;
509
- /** The source file */
510
- content?:
511
- FileReference;
512
- /** Location of the file on the device, inside the app's sandboxed filesystem */
513
- devicePath?:
514
- string;
515
- }
516
- interface IosDeviceList {
517
- /** Required. A list of iOS devices. */
518
- iosDevices?:
519
- IosDevice[];
520
- }
521
- interface IosModel {
522
- /**
523
- * Device capabilities. Copied from
524
- * https://developer.apple.com/library/archive/documentation/DeviceInformation/Reference/iOSDeviceCompatibility/DeviceCompatibilityMatrix/DeviceCompatibilityMatrix.html
525
- */
526
- deviceCapabilities?:
527
- string[];
528
- /** Whether this device is a phone, tablet, wearable, etc. */
529
- formFactor?:
530
- string;
531
- /** The unique opaque id for this model. Use this for invoking the TestExecutionService. */
532
- id?:
533
- string;
534
- /** The human-readable name for this device model. Examples: "iPhone 4s", "iPad Mini 2". */
535
- name?:
536
- string;
537
- /** Version-specific information of an iOS model. */
538
- perVersionInfo?:
539
- PerIosVersionInfo[];
540
- /** Screen density in DPI. */
541
- screenDensity?:
542
- number;
543
- /** Screen size in the horizontal (X) dimension measured in pixels. */
544
- screenX?:
545
- number;
546
- /** Screen size in the vertical (Y) dimension measured in pixels. */
547
- screenY?:
548
- number;
549
- /** The set of iOS major software versions this device supports. */
550
- supportedVersionIds?:
551
- string[];
552
- /** Tags for this dimension. Examples: "default", "preview", "deprecated". */
553
- tags?:
554
- string[];
555
- }
556
- interface IosRoboTest {
557
- /** The bundle ID for the app-under-test. This is determined by examining the application's "Info.plist" file. */
558
- appBundleId?:
559
- string;
560
- /** Required. The ipa stored at this file should be used to run the test. */
561
- appIpa?:
562
- FileReference;
563
- /** An optional Roboscript to customize the crawl. See https://firebase.google.com/docs/test-lab/android/robo-scripts-reference for more information about Roboscripts. */
564
- roboScript?:
565
- FileReference;
566
- }
567
- interface IosRuntimeConfiguration {
568
- /** The set of available locales. */
569
- locales?:
570
- Locale[];
571
- /** The set of available orientations. */
572
- orientations?:
573
- Orientation[];
574
- }
575
- interface IosTestLoop {
576
- /** Output only. The bundle id for the application under test. */
577
- appBundleId?:
578
- string;
579
- /** Required. The .ipa of the application to test. */
580
- appIpa?:
581
- FileReference;
582
- /** The list of scenarios that should be run during the test. Defaults to the single scenario 0 if unspecified. */
583
- scenarios?:
584
- number[];
585
- }
586
- interface IosTestSetup {
587
- /** iOS apps to install in addition to those being directly tested. */
588
- additionalIpas?:
589
- FileReference[];
590
- /**
591
- * The network traffic profile used for running the test. Available network profiles can be queried by using the NETWORK_CONFIGURATION environment type when calling
592
- * TestEnvironmentDiscoveryService.GetTestEnvironmentCatalog.
593
- */
594
- networkProfile?:
595
- string;
596
- /**
597
- * 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 (such as /private/var/mobile/Media) or within
598
- * an accessible directory inside the app's filesystem (such as /Documents) by specifying the bundle ID.
599
- */
600
- pullDirectories?:
601
- IosDeviceFile[];
602
- /** List of files to push to the device before starting the test. */
603
- pushFiles?:
604
- IosDeviceFile[];
605
- }
606
- interface IosVersion {
607
- /** An opaque id for this iOS version. Use this id to invoke the TestExecutionService. */
608
- id?:
609
- string;
610
- /** An integer representing the major iOS version. Examples: "8", "9". */
611
- majorVersion?:
612
- number;
613
- /** An integer representing the minor iOS version. Examples: "1", "2". */
614
- minorVersion?:
615
- number;
616
- /** The available Xcode versions for this version. */
617
- supportedXcodeVersionIds?:
618
- string[];
619
- /** Tags for this dimension. Examples: "default", "preview", "deprecated". */
620
- tags?:
621
- string[];
622
- }
623
- interface IosXcTest {
624
- /** Output only. The bundle id for the application under test. */
625
- appBundleId?:
626
- string;
627
- /**
628
- * 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
629
- * aps-environment entitlement.
630
- */
631
- testSpecialEntitlements?:
632
- boolean;
633
- /**
634
- * 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
635
- * specified.
636
- */
637
- testsZip?:
638
- FileReference;
639
- /**
640
- * 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
641
- * supports.
642
- */
643
- xcodeVersion?:
644
- string;
645
- /**
646
- * 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,
647
- * this can be useful for sharding tests. Default is taken from the tests zip.
648
- */
649
- xctestrun?:
650
- FileReference;
651
- }
652
- // tslint:disable-next-line:no-empty-interface
653
- interface LauncherActivityIntent {
654
- }
655
- interface ListDeviceSessionsResponse {
656
- /** The sessions matching the specified filter in the given cloud project. */
657
- deviceSessions?:
658
- DeviceSession[];
659
- /** A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. */
660
- nextPageToken?:
661
- string;
662
- }
663
- interface Locale {
664
- /** The id for this locale. Example: "en_US". */
665
- id?:
666
- string;
667
- /** A human-friendly name for this language/locale. Example: "English". */
668
- name?:
669
- string;
670
- /** A human-friendly string representing the region for this locale. Example: "United States". Not present for every locale. */
671
- region?:
672
- string;
673
- /** Tags for this dimension. Example: "default". */
674
- tags?:
675
- string[];
676
- }
677
- interface ManualSharding {
678
- /**
679
- * Required. Group of packages, classes, and/or test methods to be run for each manually-created shard. You must specify at least one shard if this field is present. When you select
680
- * one or more physical devices, the number of repeated test_targets_for_shard must be <= 50. When you select one or more ARM virtual devices, it must be <= 200. When you select only
681
- * x86 virtual devices, it must be <= 500.
682
- */
683
- testTargetsForShard?:
684
- TestTargetsForShard[];
685
- }
686
- interface Metadata {
687
- /** The android:name value */
688
- name?:
689
- string;
690
- /** The android:value value */
691
- value?:
692
- string;
693
- }
694
- interface NetworkConfiguration {
695
- /** The emulation rule applying to the download traffic. */
696
- downRule?:
697
- TrafficRule;
698
- /** The unique opaque id for this network traffic configuration. */
699
- id?:
700
- string;
701
- /** The emulation rule applying to the upload traffic. */
702
- upRule?:
703
- TrafficRule;
704
- }
705
- interface NetworkConfigurationCatalog {
706
- configurations?:
707
- NetworkConfiguration[];
708
- }
709
- // tslint:disable-next-line:no-empty-interface
710
- interface NoActivityIntent {
711
- }
712
- interface ObbFile {
713
- /** Required. Opaque Binary Blob (OBB) file(s) to install on the device. */
714
- obb?:
715
- FileReference;
716
- /**
717
- * 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
718
- * the device.
719
- */
720
- obbFileName?:
721
- string;
722
- }
723
- interface Orientation {
724
- /** The id for this orientation. Example: "portrait". */
725
- id?:
726
- string;
727
- /** A human-friendly name for this orientation. Example: "portrait". */
728
- name?:
729
- string;
730
- /** Tags for this dimension. Example: "default". */
731
- tags?:
732
- string[];
733
- }
734
- interface PerAndroidVersionInfo {
735
- /** The number of online devices for an Android version. */
736
- deviceCapacity?:
737
- string;
738
- /** Output only. Identifies supported clients for DirectAccess for this Android version. */
739
- directAccessVersionInfo?:
740
- DirectAccessVersionInfo;
741
- /** An Android version. */
742
- versionId?:
743
- string;
744
- }
745
- interface PerIosVersionInfo {
746
- /** The number of online devices for an iOS version. */
747
- deviceCapacity?:
748
- string;
749
- /** An iOS version. */
750
- versionId?:
751
- string;
752
- }
753
- interface ProvidedSoftwareCatalog {
754
- /**
755
- * A string representing the current version of AndroidX Test Orchestrator that is used in the environment. The package is available at
756
- * https://maven.google.com/web/index.html#androidx.test:orchestrator.
757
- */
758
- androidxOrchestratorVersion?:
759
- string;
760
- /**
761
- * Deprecated: Use AndroidX Test Orchestrator going forward. A string representing the current version of Android Test Orchestrator that is used in the environment. The package is
762
- * available at https://maven.google.com/web/index.html#com.android.support.test:orchestrator.
763
- */
764
- orchestratorVersion?:
765
- string;
766
- }
767
- interface RegularFile {
768
- /** Required. The source file. */
769
- content?:
770
- FileReference;
771
- /**
772
- * 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
773
- * 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
774
- * 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
775
- * 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
776
- * access files on the device in a portable way.
777
- */
778
- devicePath?:
779
- string;
780
- }
781
- interface ResultStorage {
782
- /** Required. */
783
- googleCloudStorage?:
784
- GoogleCloudStorage;
785
- /** Output only. URL to the results in the Firebase Web Console. */
786
- resultsUrl?:
787
- string;
788
- /** Output only. The tool results execution that results are written to. */
789
- toolResultsExecution?:
790
- ToolResultsExecution;
791
- /** 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. */
792
- toolResultsHistory?:
793
- ToolResultsHistory;
794
- }
795
- interface RoboDirective {
796
- /** Required. The type of action that Robo should perform on the specified element. */
797
- actionType?:
798
- string;
799
- /** 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. */
800
- inputText?:
801
- string;
802
- /**
803
- * 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:
804
- * https://developer.android.com/guide/topics/resources/accessing-resources.html
805
- */
806
- resourceName?:
807
- string;
808
- }
809
- interface RoboStartingIntent {
810
- /** An intent that starts the main launcher activity. */
811
- launcherActivity?:
812
- any;
813
- /** Skips the starting activity */
814
- noActivity?:
815
- any;
816
- /** An intent that starts an activity with specific details. */
817
- startActivity?:
818
- StartActivityIntent;
819
- /** Timeout in seconds for each intent. */
820
- timeout?:
821
- string;
822
- }
823
- interface Service {
824
- /** Intent filters in the service */
825
- intentFilter?:
826
- IntentFilter[];
827
- /** The android:name value */
828
- name?:
829
- string;
830
- }
831
- interface SessionStateEvent {
832
- /** Output only. The time that the session_state first encountered that state. */
833
- eventTime?:
834
- string;
835
- /** Output only. The session_state tracked by this event */
836
- sessionState?:
837
- string;
838
- /** Output only. A human-readable message to explain the state. */
839
- stateMessage?:
840
- string;
841
- }
842
- interface Shard {
843
- /** Output only. The estimated shard duration based on previous test case timing records, if available. */
844
- estimatedShardDuration?:
845
- string;
846
- /** Output only. The total number of shards. */
847
- numShards?:
848
- number;
849
- /** Output only. The index of the shard among all the shards. */
850
- shardIndex?:
851
- number;
852
- /** Output only. Test targets for each shard. Only set for manual sharding. */
853
- testTargetsForShard?:
854
- TestTargetsForShard;
855
- }
856
- interface ShardingOption {
857
- /** Shards test cases into the specified groups of packages, classes, and/or methods. */
858
- manualSharding?:
859
- ManualSharding;
860
- /** Shards test based on previous test case timing records. */
861
- smartSharding?:
862
- SmartSharding;
863
- /** Uniformly shards test cases given a total number of shards. */
864
- uniformSharding?:
865
- UniformSharding;
866
- }
867
- interface SmartSharding {
868
- /**
869
- * The amount of time tests within a shard should take. Default: 300 seconds (5 minutes). The minimum allowed: 120 seconds (2 minutes). The shard count is dynamically set based on
870
- * time, up to the maximum shard limit (described below). To guarantee at least one test case for each shard, the number of shards will not exceed the number of test cases. Shard
871
- * duration will be exceeded if: - The maximum shard limit is reached and there is more calculated test time remaining to allocate into shards. - Any individual test is estimated to be
872
- * longer than the targeted shard duration. Shard duration is not guaranteed because smart sharding uses test case history and default durations which may not be accurate. The rules
873
- * for finding the test case timing records are: - If the service has processed a test case in the last 30 days, the record of the latest successful test case will be used. - For new
874
- * test cases, the average duration of other known test cases will be used. - If there are no previous test case timing records available, the default test case duration is 15 seconds.
875
- * Because the actual shard duration can exceed the targeted shard duration, we recommend that you set the targeted value at least 5 minutes less than the maximum allowed test timeout
876
- * (45 minutes for physical devices and 60 minutes for virtual), or that you use the custom test timeout value that you set. This approach avoids cancelling the shard before all tests
877
- * can finish. Note that there is a limit for maximum number of shards. When you select one or more physical devices, the number of shards must be <= 50. When you select one or more
878
- * ARM virtual devices, it must be <= 200. When you select only x86 virtual devices, it must be <= 500. To guarantee at least one test case for per shard, the number of shards will not
879
- * exceed the number of test cases. Each shard created counts toward daily test quota.
880
- */
881
- targetedShardDuration?:
882
- string;
883
- }
884
- interface StartActivityIntent {
885
- /** Action name. Required for START_ACTIVITY. */
886
- action?:
887
- string;
888
- /** Intent categories to set on the intent. */
889
- categories?:
890
- string[];
891
- /** URI for the action. */
892
- uri?:
893
- string;
894
- }
895
- interface SystraceSetup {
896
- /** Systrace duration in seconds. Should be between 1 and 30 seconds. 0 disables systrace. */
897
- durationSeconds?:
898
- number;
899
- }
900
- interface TestDetails {
901
- /** Output only. If the TestState is ERROR, then this string will contain human-readable details about the error. */
902
- errorMessage?:
903
- string;
904
- /**
905
- * 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
906
- * appended to the end of progress_messages.
907
- */
908
- progressMessages?:
909
- string[];
910
- }
911
- interface TestEnvironmentCatalog {
912
- /** Supported Android devices. */
913
- androidDeviceCatalog?:
914
- AndroidDeviceCatalog;
915
- /** The IP blocks used by devices in the test environment. */
916
- deviceIpBlockCatalog?:
917
- DeviceIpBlockCatalog;
918
- /** Supported iOS devices. */
919
- iosDeviceCatalog?:
920
- IosDeviceCatalog;
921
- /** Supported network configurations. */
922
- networkConfigurationCatalog?:
923
- NetworkConfigurationCatalog;
924
- /** The software test environment provided by TestExecutionService. */
925
- softwareCatalog?:
926
- ProvidedSoftwareCatalog;
927
- }
928
- interface TestExecution {
929
- /** Output only. How the host machine(s) are configured. */
930
- environment?:
931
- Environment;
932
- /** Output only. Unique id set by the service. */
933
- id?:
934
- string;
935
- /** Output only. Id of the containing TestMatrix. */
936
- matrixId?:
937
- string;
938
- /** Output only. The cloud project that owns the test execution. */
939
- projectId?:
940
- string;
941
- /** Output only. Details about the shard. */
942
- shard?:
943
- Shard;
944
- /** Output only. Indicates the current progress of the test execution (e.g., FINISHED). */
945
- state?:
946
- string;
947
- /** Output only. Additional details about the running test. */
948
- testDetails?:
949
- TestDetails;
950
- /** Output only. How to run the test. */
951
- testSpecification?:
952
- TestSpecification;
953
- /** Output only. The time this test execution was initially created. */
954
- timestamp?:
955
- string;
956
- /** Output only. Where the results for this execution are written. */
957
- toolResultsStep?:
958
- ToolResultsStep;
959
- }
960
- interface TestMatrix {
961
- /** Information about the client which invoked the test. */
962
- clientInfo?:
963
- ClientInfo;
964
- /** Required. The devices the tests are being executed on. */
965
- environmentMatrix?:
966
- EnvironmentMatrix;
967
- /**
968
- * 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
969
- * 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
970
- * and support is more limited because of that expectation.
971
- */
972
- failFast?:
973
- boolean;
974
- /**
975
- * 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
976
- * implies no reruns.
977
- */
978
- flakyTestAttempts?:
979
- number;
980
- /** Output only. Describes why the matrix is considered invalid. Only useful for matrices in the INVALID state. */
981
- invalidMatrixDetails?:
982
- string;
983
- /** Output Only. The overall outcome of the test. Only set when the test matrix state is FINISHED. */
984
- outcomeSummary?:
985
- string;
986
- /** The cloud project that owns the test matrix. */
987
- projectId?:
988
- string;
989
- /** Required. Where the results for the matrix are written. */
990
- resultStorage?:
991
- ResultStorage;
992
- /** Output only. Indicates the current progress of the test matrix. */
993
- state?:
994
- string;
995
- /** Output only. The list of test executions that the service creates for this matrix. */
996
- testExecutions?:
997
- TestExecution[];
998
- /** Output only. Unique id set by the service. */
999
- testMatrixId?:
1000
- string;
1001
- /** Required. How to run the test. */
1002
- testSpecification?:
1003
- TestSpecification;
1004
- /** Output only. The time this test matrix was initially created. */
1005
- timestamp?:
1006
- string;
1007
- }
1008
- interface TestSetup {
1009
- /** The device will be logged in on this account for the duration of the test. */
1010
- account?:
1011
- Account;
1012
- /** APKs to install in addition to those being directly tested. These will be installed after the app under test. Currently capped at 100. */
1013
- additionalApks?:
1014
- Apk[];
1015
- /**
1016
- * 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
1017
- * 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
1018
- * not map to external storage, the system will replace it with the external storage path prefix for that device.
1019
- */
1020
- directoriesToPull?:
1021
- string[];
1022
- /** Whether to prevent all runtime permissions to be granted at app install */
1023
- dontAutograntPermissions?:
1024
- boolean;
1025
- /** Environment variables to set for the test (only applicable for instrumentation tests). */
1026
- environmentVariables?:
1027
- EnvironmentVariable[];
1028
- /** List of files to push to the device before starting the test. */
1029
- filesToPush?:
1030
- DeviceFile[];
1031
- /** Optional. Initial setup APKs to install before the app under test is installed. Currently capped at 100. */
1032
- initialSetupApks?:
1033
- Apk[];
1034
- /**
1035
- * The network traffic profile used for running the test. Available network profiles can be queried by using the NETWORK_CONFIGURATION environment type when calling
1036
- * TestEnvironmentDiscoveryService.GetTestEnvironmentCatalog.
1037
- */
1038
- networkProfile?:
1039
- string;
1040
- /**
1041
- * Systrace configuration for the run. Deprecated: Systrace used Python 2 which was sunsetted on 2020-01-01. Systrace is no longer supported in the Cloud Testing API, and no Systrace
1042
- * file will be provided in the results.
1043
- */
1044
- systrace?:
1045
- SystraceSetup;
1046
- }
1047
- interface TestSpecification {
1048
- /** An Android instrumentation test. */
1049
- androidInstrumentationTest?:
1050
- AndroidInstrumentationTest;
1051
- /** An Android robo test. */
1052
- androidRoboTest?:
1053
- AndroidRoboTest;
1054
- /** An Android Application with a Test Loop. */
1055
- androidTestLoop?:
1056
- AndroidTestLoop;
1057
- /** Disables performance metrics recording. May reduce test latency. */
1058
- disablePerformanceMetrics?:
1059
- boolean;
1060
- /** Disables video recording. May reduce test latency. */
1061
- disableVideoRecording?:
1062
- boolean;
1063
- /** An iOS Robo test. */
1064
- iosRoboTest?:
1065
- IosRoboTest;
1066
- /** An iOS application with a test loop. */
1067
- iosTestLoop?:
1068
- IosTestLoop;
1069
- /** Test setup requirements for iOS. */
1070
- iosTestSetup?:
1071
- IosTestSetup;
1072
- /** An iOS XCTest, via an .xctestrun file. */
1073
- iosXcTest?:
1074
- IosXcTest;
1075
- /** Test setup requirements for Android e.g. files to install, bootstrap scripts. */
1076
- testSetup?:
1077
- TestSetup;
1078
- /** Max time a test execution is allowed to run before it is automatically cancelled. The default value is 5 min. */
1079
- testTimeout?:
1080
- string;
1081
- }
1082
- interface TestTargetsForShard {
1083
- /**
1084
- * 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
1085
- * com.my.packages" "class com.my.package.MyClass". The number of test_targets must be greater than 0.
1086
- */
1087
- testTargets?:
1088
- string[];
1089
- }
1090
- interface ToolResultsExecution {
1091
- /** Output only. A tool results execution ID. */
1092
- executionId?:
1093
- string;
1094
- /** Output only. A tool results history ID. */
1095
- historyId?:
1096
- string;
1097
- /** Output only. The cloud project that owns the tool results execution. */
1098
- projectId?:
1099
- string;
1100
- }
1101
- interface ToolResultsHistory {
1102
- /** Required. A tool results history ID. */
1103
- historyId?:
1104
- string;
1105
- /** Required. The cloud project that owns the tool results history. */
1106
- projectId?:
1107
- string;
1108
- }
1109
- interface ToolResultsStep {
1110
- /** Output only. A tool results execution ID. */
1111
- executionId?:
1112
- string;
1113
- /** Output only. A tool results history ID. */
1114
- historyId?:
1115
- string;
1116
- /** Output only. The cloud project that owns the tool results step. */
1117
- projectId?:
1118
- string;
1119
- /** Output only. A tool results step ID. */
1120
- stepId?:
1121
- string;
1122
- }
1123
- interface TrafficRule {
1124
- /** Bandwidth in kbits/second. */
1125
- bandwidth?:
1126
- number;
1127
- /** Burst size in kbits. */
1128
- burst?:
1129
- number;
1130
- /** Packet delay, must be >= 0. */
1131
- delay?:
1132
- string;
1133
- /** Packet duplication ratio (0.0 - 1.0). */
1134
- packetDuplicationRatio?:
1135
- number;
1136
- /** Packet loss ratio (0.0 - 1.0). */
1137
- packetLossRatio?:
1138
- number;
1139
- }
1140
- interface UniformSharding {
1141
- /**
1142
- * Required. The total number of shards to create. This must always be a positive number that is no greater than the total number of test cases. When you select one or more physical
1143
- * devices, the number of shards must be <= 50. When you select one or more ARM virtual devices, it must be <= 200. When you select only x86 virtual devices, it must be <= 500.
1144
- */
1145
- numShards?:
1146
- number;
1147
- }
1148
- interface UsesFeature {
1149
- /** The android:required value */
1150
- isRequired?:
1151
- boolean;
1152
- /** The android:name value */
1153
- name?:
1154
- string;
1155
- }
1156
- interface XcodeVersion {
1157
- /** Tags for this Xcode version. Example: "default". */
1158
- tags?:
1159
- string[];
1160
- /** The id for this version. Example: "9.2". */
1161
- version?:
1162
- string;
1163
- }
1164
- interface ApplicationDetailServiceResource {
1165
- /** Gets the details of an Android application APK. */
1166
- getApkDetails(request: {
1167
- /** V1 error format. */
1168
- "$.xgafv"?:
1169
- string;
1170
- /** OAuth access token. */
1171
- access_token?:
1172
- string;
1173
- /** Data format for response. */
1174
- alt?:
1175
- string;
1176
- /** JSONP */
1177
- callback?:
1178
- string;
1179
- /** Selector specifying which fields to include in a partial response. */
1180
- fields?:
1181
- string;
1182
- /** 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. */
1183
- key?:
1184
- string;
1185
- /** OAuth 2.0 token for the current user. */
1186
- oauth_token?:
1187
- string;
1188
- /** Returns response with indentations and line breaks. */
1189
- prettyPrint?:
1190
- boolean;
1191
- /** 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. */
1192
- quotaUser?:
1193
- string;
1194
- /** Upload protocol for media (e.g. "raw", "multipart"). */
1195
- upload_protocol?:
1196
- string;
1197
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1198
- uploadType?:
1199
- string;
1200
- /** Request body */
1201
- resource:
1202
- FileReference;
1203
- }): Request<GetApkDetailsResponse>;
1204
- getApkDetails(request: {
1205
- /** V1 error format. */
1206
- "$.xgafv"?:
1207
- string;
1208
- /** OAuth access token. */
1209
- access_token?:
1210
- string;
1211
- /** Data format for response. */
1212
- alt?:
1213
- string;
1214
- /** JSONP */
1215
- callback?:
1216
- string;
1217
- /** Selector specifying which fields to include in a partial response. */
1218
- fields?:
1219
- string;
1220
- /** 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. */
1221
- key?:
1222
- string;
1223
- /** OAuth 2.0 token for the current user. */
1224
- oauth_token?:
1225
- string;
1226
- /** Returns response with indentations and line breaks. */
1227
- prettyPrint?:
1228
- boolean;
1229
- /** 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. */
1230
- quotaUser?:
1231
- string;
1232
- /** Upload protocol for media (e.g. "raw", "multipart"). */
1233
- upload_protocol?:
1234
- string;
1235
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1236
- uploadType?:
1237
- string;
1238
- },
1239
- body: FileReference): Request<GetApkDetailsResponse>;
1240
- }
1241
- interface DeviceSessionsResource {
1242
- /**
1243
- * POST /v1/projects/{project_id}/deviceSessions/{device_session_id}:cancel Changes the DeviceSession to state FINISHED and terminates all connections. Canceled sessions are not
1244
- * deleted and can be retrieved or listed by the user until they expire based on the 28 day deletion policy.
1245
- */
1246
- cancel(request: {
1247
- /** V1 error format. */
1248
- "$.xgafv"?:
1249
- string;
1250
- /** OAuth access token. */
1251
- access_token?:
1252
- string;
1253
- /** Data format for response. */
1254
- alt?:
1255
- string;
1256
- /** JSONP */
1257
- callback?:
1258
- string;
1259
- /** Selector specifying which fields to include in a partial response. */
1260
- fields?:
1261
- string;
1262
- /** 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. */
1263
- key?:
1264
- string;
1265
- /** Required. Name of the DeviceSession, e.g. "projects/{project_id}/deviceSessions/{session_id}" */
1266
- name:
1267
- string;
1268
- /** OAuth 2.0 token for the current user. */
1269
- oauth_token?:
1270
- string;
1271
- /** Returns response with indentations and line breaks. */
1272
- prettyPrint?:
1273
- boolean;
1274
- /** 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. */
1275
- quotaUser?:
1276
- string;
1277
- /** Upload protocol for media (e.g. "raw", "multipart"). */
1278
- upload_protocol?:
1279
- string;
1280
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1281
- uploadType?:
1282
- string;
1283
- /** Request body */
1284
- resource:
1285
- CancelDeviceSessionRequest;
1286
- }): Request<{}>;
1287
- cancel(request: {
1288
- /** V1 error format. */
1289
- "$.xgafv"?:
1290
- string;
1291
- /** OAuth access token. */
1292
- access_token?:
1293
- string;
1294
- /** Data format for response. */
1295
- alt?:
1296
- string;
1297
- /** JSONP */
1298
- callback?:
1299
- string;
1300
- /** Selector specifying which fields to include in a partial response. */
1301
- fields?:
1302
- string;
1303
- /** 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. */
1304
- key?:
1305
- string;
1306
- /** Required. Name of the DeviceSession, e.g. "projects/{project_id}/deviceSessions/{session_id}" */
1307
- name:
1308
- string;
1309
- /** OAuth 2.0 token for the current user. */
1310
- oauth_token?:
1311
- string;
1312
- /** Returns response with indentations and line breaks. */
1313
- prettyPrint?:
1314
- boolean;
1315
- /** 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. */
1316
- quotaUser?:
1317
- string;
1318
- /** Upload protocol for media (e.g. "raw", "multipart"). */
1319
- upload_protocol?:
1320
- string;
1321
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1322
- uploadType?:
1323
- string;
1324
- },
1325
- body: CancelDeviceSessionRequest): Request<{}>;
1326
- /** POST /v1/projects/{project_id}/deviceSessions */
1327
- create(request: {
1328
- /** V1 error format. */
1329
- "$.xgafv"?:
1330
- string;
1331
- /** OAuth access token. */
1332
- access_token?:
1333
- string;
1334
- /** Data format for response. */
1335
- alt?:
1336
- string;
1337
- /** JSONP */
1338
- callback?:
1339
- string;
1340
- /** Selector specifying which fields to include in a partial response. */
1341
- fields?:
1342
- string;
1343
- /** 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. */
1344
- key?:
1345
- string;
1346
- /** OAuth 2.0 token for the current user. */
1347
- oauth_token?:
1348
- string;
1349
- /** Required. The Compute Engine project under which this device will be allocated. "projects/{project_id}" */
1350
- parent:
1351
- string;
1352
- /** Returns response with indentations and line breaks. */
1353
- prettyPrint?:
1354
- boolean;
1355
- /** 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. */
1356
- quotaUser?:
1357
- string;
1358
- /** Upload protocol for media (e.g. "raw", "multipart"). */
1359
- upload_protocol?:
1360
- string;
1361
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1362
- uploadType?:
1363
- string;
1364
- /** Request body */
1365
- resource:
1366
- DeviceSession;
1367
- }): Request<DeviceSession>;
1368
- create(request: {
1369
- /** V1 error format. */
1370
- "$.xgafv"?:
1371
- string;
1372
- /** OAuth access token. */
1373
- access_token?:
1374
- string;
1375
- /** Data format for response. */
1376
- alt?:
1377
- string;
1378
- /** JSONP */
1379
- callback?:
1380
- string;
1381
- /** Selector specifying which fields to include in a partial response. */
1382
- fields?:
1383
- string;
1384
- /** 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. */
1385
- key?:
1386
- string;
1387
- /** OAuth 2.0 token for the current user. */
1388
- oauth_token?:
1389
- string;
1390
- /** Required. The Compute Engine project under which this device will be allocated. "projects/{project_id}" */
1391
- parent:
1392
- string;
1393
- /** Returns response with indentations and line breaks. */
1394
- prettyPrint?:
1395
- boolean;
1396
- /** 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. */
1397
- quotaUser?:
1398
- string;
1399
- /** Upload protocol for media (e.g. "raw", "multipart"). */
1400
- upload_protocol?:
1401
- string;
1402
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1403
- uploadType?:
1404
- string;
1405
- },
1406
- body: DeviceSession): Request<DeviceSession>;
1407
- /**
1408
- * GET /v1/projects/{project_id}/deviceSessions/{device_session_id} Return a DeviceSession, which documents the allocation status and whether the device is allocated. Clients making
1409
- * requests from this API must poll GetDeviceSession.
1410
- */
1411
- get(request?: {
1412
- /** V1 error format. */
1413
- "$.xgafv"?:
1414
- string;
1415
- /** OAuth access token. */
1416
- access_token?:
1417
- string;
1418
- /** Data format for response. */
1419
- alt?:
1420
- string;
1421
- /** JSONP */
1422
- callback?:
1423
- string;
1424
- /** Selector specifying which fields to include in a partial response. */
1425
- fields?:
1426
- string;
1427
- /** 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. */
1428
- key?:
1429
- string;
1430
- /** Required. Name of the DeviceSession, e.g. "projects/{project_id}/deviceSessions/{session_id}" */
1431
- name:
1432
- string;
1433
- /** OAuth 2.0 token for the current user. */
1434
- oauth_token?:
1435
- string;
1436
- /** Returns response with indentations and line breaks. */
1437
- prettyPrint?:
1438
- boolean;
1439
- /** 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. */
1440
- quotaUser?:
1441
- string;
1442
- /** Upload protocol for media (e.g. "raw", "multipart"). */
1443
- upload_protocol?:
1444
- string;
1445
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1446
- uploadType?:
1447
- string;
1448
- }): Request<DeviceSession>;
1449
- /** GET /v1/projects/{project_id}/deviceSessions Lists device Sessions owned by the project user. */
1450
- list(request?: {
1451
- /** V1 error format. */
1452
- "$.xgafv"?:
1453
- string;
1454
- /** OAuth access token. */
1455
- access_token?:
1456
- string;
1457
- /** Data format for response. */
1458
- alt?:
1459
- string;
1460
- /** JSONP */
1461
- callback?:
1462
- string;
1463
- /** Selector specifying which fields to include in a partial response. */
1464
- fields?:
1465
- string;
1466
- /** Optional. If specified, responses will be filtered by the given filter. Allowed fields are: session_state. */
1467
- filter?:
1468
- string;
1469
- /** 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. */
1470
- key?:
1471
- string;
1472
- /** OAuth 2.0 token for the current user. */
1473
- oauth_token?:
1474
- string;
1475
- /** Optional. The maximum number of DeviceSessions to return. */
1476
- pageSize?:
1477
- number;
1478
- /** Optional. A continuation token for paging. */
1479
- pageToken?:
1480
- string;
1481
- /** Required. The name of the parent to request, e.g. "projects/{project_id}" */
1482
- parent:
1483
- string;
1484
- /** Returns response with indentations and line breaks. */
1485
- prettyPrint?:
1486
- boolean;
1487
- /** 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. */
1488
- quotaUser?:
1489
- string;
1490
- /** Upload protocol for media (e.g. "raw", "multipart"). */
1491
- upload_protocol?:
1492
- string;
1493
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1494
- uploadType?:
1495
- string;
1496
- }): Request<ListDeviceSessionsResponse>;
1497
- /** PATCH /v1/projects/{projectId}/deviceSessions/deviceSessionId}:updateDeviceSession Updates the current device session to the fields described by the update_mask. */
1498
- patch(request: {
1499
- /** V1 error format. */
1500
- "$.xgafv"?:
1501
- string;
1502
- /** OAuth access token. */
1503
- access_token?:
1504
- string;
1505
- /** Data format for response. */
1506
- alt?:
1507
- string;
1508
- /** JSONP */
1509
- callback?:
1510
- string;
1511
- /** Selector specifying which fields to include in a partial response. */
1512
- fields?:
1513
- string;
1514
- /** 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. */
1515
- key?:
1516
- string;
1517
- /** Optional. Name of the DeviceSession, e.g. "projects/{project_id}/deviceSessions/{session_id}" */
1518
- name:
1519
- string;
1520
- /** OAuth 2.0 token for the current user. */
1521
- oauth_token?:
1522
- string;
1523
- /** Returns response with indentations and line breaks. */
1524
- prettyPrint?:
1525
- boolean;
1526
- /** 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. */
1527
- quotaUser?:
1528
- string;
1529
- /** Required. The list of fields to update. */
1530
- updateMask?:
1531
- string;
1532
- /** Upload protocol for media (e.g. "raw", "multipart"). */
1533
- upload_protocol?:
1534
- string;
1535
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1536
- uploadType?:
1537
- string;
1538
- /** Request body */
1539
- resource:
1540
- DeviceSession;
1541
- }): Request<DeviceSession>;
1542
- patch(request: {
1543
- /** V1 error format. */
1544
- "$.xgafv"?:
1545
- string;
1546
- /** OAuth access token. */
1547
- access_token?:
1548
- string;
1549
- /** Data format for response. */
1550
- alt?:
1551
- string;
1552
- /** JSONP */
1553
- callback?:
1554
- string;
1555
- /** Selector specifying which fields to include in a partial response. */
1556
- fields?:
1557
- string;
1558
- /** 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. */
1559
- key?:
1560
- string;
1561
- /** Optional. Name of the DeviceSession, e.g. "projects/{project_id}/deviceSessions/{session_id}" */
1562
- name:
1563
- string;
1564
- /** OAuth 2.0 token for the current user. */
1565
- oauth_token?:
1566
- string;
1567
- /** Returns response with indentations and line breaks. */
1568
- prettyPrint?:
1569
- boolean;
1570
- /** 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. */
1571
- quotaUser?:
1572
- string;
1573
- /** Required. The list of fields to update. */
1574
- updateMask?:
1575
- string;
1576
- /** Upload protocol for media (e.g. "raw", "multipart"). */
1577
- upload_protocol?:
1578
- string;
1579
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1580
- uploadType?:
1581
- string;
1582
- },
1583
- body: DeviceSession): Request<DeviceSession>;
1584
- }
1585
- interface TestMatricesResource {
1586
- /**
1587
- * 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
1588
- * 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
1589
- * malformed - NOT_FOUND - if the Test Matrix does not exist
1590
- */
1591
- cancel(request?: {
1592
- /** V1 error format. */
1593
- "$.xgafv"?:
1594
- string;
1595
- /** OAuth access token. */
1596
- access_token?:
1597
- string;
1598
- /** Data format for response. */
1599
- alt?:
1600
- string;
1601
- /** JSONP */
1602
- callback?:
1603
- string;
1604
- /** Selector specifying which fields to include in a partial response. */
1605
- fields?:
1606
- string;
1607
- /** 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. */
1608
- key?:
1609
- string;
1610
- /** OAuth 2.0 token for the current user. */
1611
- oauth_token?:
1612
- string;
1613
- /** Returns response with indentations and line breaks. */
1614
- prettyPrint?:
1615
- boolean;
1616
- /** Cloud project that owns the test. */
1617
- projectId:
1618
- string;
1619
- /** 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. */
1620
- quotaUser?:
1621
- string;
1622
- /** Test matrix that will be canceled. */
1623
- testMatrixId:
1624
- string;
1625
- /** Upload protocol for media (e.g. "raw", "multipart"). */
1626
- upload_protocol?:
1627
- string;
1628
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1629
- uploadType?:
1630
- string;
1631
- }): Request<CancelTestMatrixResponse>;
1632
- /**
1633
- * 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
1634
- * 2000 devices in parallel. The returned matrix will not yet contain the executions that will be created for this matrix. Execution creation happens later on and will require a call
1635
- * to GetTestMatrix. 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
1636
- * is malformed or if the matrix tries to use too many simultaneous devices.
1637
- */
1638
- create(request: {
1639
- /** V1 error format. */
1640
- "$.xgafv"?:
1641
- string;
1642
- /** OAuth access token. */
1643
- access_token?:
1644
- string;
1645
- /** Data format for response. */
1646
- alt?:
1647
- string;
1648
- /** JSONP */
1649
- callback?:
1650
- string;
1651
- /** Selector specifying which fields to include in a partial response. */
1652
- fields?:
1653
- string;
1654
- /** 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. */
1655
- key?:
1656
- string;
1657
- /** OAuth 2.0 token for the current user. */
1658
- oauth_token?:
1659
- string;
1660
- /** Returns response with indentations and line breaks. */
1661
- prettyPrint?:
1662
- boolean;
1663
- /** The GCE project under which this job will run. */
1664
- projectId:
1665
- string;
1666
- /** 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. */
1667
- quotaUser?:
1668
- string;
1669
- /**
1670
- * 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,
1671
- * but strongly recommended.
1672
- */
1673
- requestId?:
1674
- string;
1675
- /** Upload protocol for media (e.g. "raw", "multipart"). */
1676
- upload_protocol?:
1677
- string;
1678
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1679
- uploadType?:
1680
- string;
1681
- /** Request body */
1682
- resource:
1683
- TestMatrix;
1684
- }): Request<TestMatrix>;
1685
- create(request: {
1686
- /** V1 error format. */
1687
- "$.xgafv"?:
1688
- string;
1689
- /** OAuth access token. */
1690
- access_token?:
1691
- string;
1692
- /** Data format for response. */
1693
- alt?:
1694
- string;
1695
- /** JSONP */
1696
- callback?:
1697
- string;
1698
- /** Selector specifying which fields to include in a partial response. */
1699
- fields?:
1700
- string;
1701
- /** 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. */
1702
- key?:
1703
- string;
1704
- /** OAuth 2.0 token for the current user. */
1705
- oauth_token?:
1706
- string;
1707
- /** Returns response with indentations and line breaks. */
1708
- prettyPrint?:
1709
- boolean;
1710
- /** The GCE project under which this job will run. */
1711
- projectId:
1712
- string;
1713
- /** 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. */
1714
- quotaUser?:
1715
- string;
1716
- /**
1717
- * 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,
1718
- * but strongly recommended.
1719
- */
1720
- requestId?:
1721
- string;
1722
- /** Upload protocol for media (e.g. "raw", "multipart"). */
1723
- upload_protocol?:
1724
- string;
1725
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1726
- uploadType?:
1727
- string;
1728
- },
1729
- body: TestMatrix): Request<TestMatrix>;
1730
- /**
1731
- * Checks the status of a test matrix and the executions once they are created. The test matrix will contain the list of test executions to run if and only if the
1732
- * resultStorage.toolResultsExecution fields have been populated. Note: Flaky test executions may be added to the matrix at a later stage. May return any of the following canonical
1733
- * 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
1734
- */
1735
- get(request?: {
1736
- /** V1 error format. */
1737
- "$.xgafv"?:
1738
- string;
1739
- /** OAuth access token. */
1740
- access_token?:
1741
- string;
1742
- /** Data format for response. */
1743
- alt?:
1744
- string;
1745
- /** JSONP */
1746
- callback?:
1747
- string;
1748
- /** Selector specifying which fields to include in a partial response. */
1749
- fields?:
1750
- string;
1751
- /** 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. */
1752
- key?:
1753
- string;
1754
- /** OAuth 2.0 token for the current user. */
1755
- oauth_token?:
1756
- string;
1757
- /** Returns response with indentations and line breaks. */
1758
- prettyPrint?:
1759
- boolean;
1760
- /** Cloud project that owns the test matrix. */
1761
- projectId:
1762
- string;
1763
- /** 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. */
1764
- quotaUser?:
1765
- string;
1766
- /** Unique test matrix id which was assigned by the service. */
1767
- testMatrixId:
1768
- string;
1769
- /** Upload protocol for media (e.g. "raw", "multipart"). */
1770
- upload_protocol?:
1771
- string;
1772
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1773
- uploadType?:
1774
- string;
1775
- }): Request<TestMatrix>;
1776
- }
1777
- interface ProjectsResource {
1778
- deviceSessions:
1779
- DeviceSessionsResource;
1780
- testMatrices:
1781
- TestMatricesResource;
1782
- }
1783
- interface TestEnvironmentCatalogResource {
1784
- /**
1785
- * 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
1786
- * environment type does not exist - INTERNAL - if an internal error occurred
1787
- */
1788
- get(request?: {
1789
- /** V1 error format. */
1790
- "$.xgafv"?:
1791
- string;
1792
- /** OAuth access token. */
1793
- access_token?:
1794
- string;
1795
- /** Data format for response. */
1796
- alt?:
1797
- string;
1798
- /** JSONP */
1799
- callback?:
1800
- string;
1801
- /** Required. The type of environment that should be listed. */
1802
- environmentType:
1803
- string;
1804
- /** Selector specifying which fields to include in a partial response. */
1805
- fields?:
1806
- string;
1807
- /** 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. */
1808
- key?:
1809
- string;
1810
- /** OAuth 2.0 token for the current user. */
1811
- oauth_token?:
1812
- string;
1813
- /** Returns response with indentations and line breaks. */
1814
- prettyPrint?:
1815
- boolean;
1816
- /** For authorization, the cloud project requesting the TestEnvironmentCatalog. */
1817
- projectId?:
1818
- string;
1819
- /** 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. */
1820
- quotaUser?:
1821
- string;
1822
- /** Upload protocol for media (e.g. "raw", "multipart"). */
1823
- upload_protocol?:
1824
- string;
1825
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1826
- uploadType?:
1827
- string;
1828
- }): Request<TestEnvironmentCatalog>;
1829
- }
26
+ namespace testing {
27
+ interface Account {
28
+ /** An automatic google login account. */
29
+ googleAuto?: any;
30
+ }
31
+ interface AndroidDevice {
32
+ /** Required. The id of the Android device to be used. Use the TestEnvironmentDiscoveryService to get supported options. */
33
+ androidModelId?: string;
34
+ /** Required. The id of the Android OS version to be used. Use the TestEnvironmentDiscoveryService to get supported options. */
35
+ androidVersionId?: string;
36
+ /** Required. The locale the test device used for testing. Use the TestEnvironmentDiscoveryService to get supported options. */
37
+ locale?: string;
38
+ /** Required. How the device is oriented during the test. Use the TestEnvironmentDiscoveryService to get supported options. */
39
+ orientation?: string;
40
+ }
41
+ interface AndroidDeviceCatalog {
42
+ /** The set of supported Android device models. */
43
+ models?: AndroidModel[];
44
+ /** The set of supported runtime configurations. */
45
+ runtimeConfiguration?: AndroidRuntimeConfiguration;
46
+ /** The set of supported Android OS versions. */
47
+ versions?: AndroidVersion[];
48
+ }
49
+ interface AndroidDeviceList {
50
+ /** Required. A list of Android devices. */
51
+ androidDevices?: AndroidDevice[];
52
+ }
53
+ interface AndroidInstrumentationTest {
54
+ /** The APK for the application under test. */
55
+ appApk?: FileReference;
56
+ /** A multi-apk app bundle for the application under test. */
57
+ appBundle?: AppBundle;
58
+ /** The java package for the application under test. The default value is determined by examining the application's manifest. */
59
+ appPackageId?: string;
60
+ /** 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.1 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. */
61
+ orchestratorOption?: string;
62
+ /** The option to run tests in multiple shards in parallel. */
63
+ shardingOption?: ShardingOption;
64
+ /** Required. The APK containing the test code to be executed. */
65
+ testApk?: FileReference;
66
+ /** The java package for the test to be executed. The default value is determined by examining the application's manifest. */
67
+ testPackageId?: string;
68
+ /** The InstrumentationTestRunner class. The default value is determined by examining the application's manifest. */
69
+ testRunnerClass?: string;
70
+ /** 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. */
71
+ testTargets?: string[];
72
+ }
73
+ interface AndroidMatrix {
74
+ /** Required. The ids of the set of Android device to be used. Use the TestEnvironmentDiscoveryService to get supported options. */
75
+ androidModelIds?: string[];
76
+ /** Required. The ids of the set of Android OS version to be used. Use the TestEnvironmentDiscoveryService to get supported options. */
77
+ androidVersionIds?: string[];
78
+ /** Required. The set of locales the test device will enable for testing. Use the TestEnvironmentDiscoveryService to get supported options. */
79
+ locales?: string[];
80
+ /** Required. The set of orientations to test with. Use the TestEnvironmentDiscoveryService to get supported options. */
81
+ orientations?: string[];
82
+ }
83
+ interface AndroidModel {
84
+ /** The company that this device is branded with. Example: "Google", "Samsung". */
85
+ brand?: string;
86
+ /** The name of the industrial design. This corresponds to android.os.Build.DEVICE. */
87
+ codename?: string;
88
+ /** Whether this device is virtual or physical. */
89
+ form?: string;
90
+ /** Whether this device is a phone, tablet, wearable, etc. */
91
+ formFactor?: string;
92
+ /** The unique opaque id for this model. Use this for invoking the TestExecutionService. */
93
+ id?: string;
94
+ /** True if and only if tests with this model are recorded by stitching together screenshots. See use_low_spec_video_recording in device config. */
95
+ lowFpsVideoRecording?: boolean;
96
+ /** The manufacturer of this device. */
97
+ manufacturer?: string;
98
+ /** The human-readable marketing name for this device model. Examples: "Nexus 5", "Galaxy S5". */
99
+ name?: string;
100
+ /** Version-specific information of an Android model. */
101
+ perVersionInfo?: PerAndroidVersionInfo[];
102
+ /** Screen density in DPI. This corresponds to ro.sf.lcd_density */
103
+ screenDensity?: number;
104
+ /** Screen size in the horizontal (X) dimension measured in pixels. */
105
+ screenX?: number;
106
+ /** Screen size in the vertical (Y) dimension measured in pixels. */
107
+ screenY?: number;
108
+ /** 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. */
109
+ supportedAbis?: string[];
110
+ /** The set of Android versions this device supports. */
111
+ supportedVersionIds?: string[];
112
+ /** Tags for this dimension. Examples: "default", "preview", "deprecated". */
113
+ tags?: string[];
114
+ /** URL of a thumbnail image (photo) of the device. */
115
+ thumbnailUrl?: string;
116
+ }
117
+ interface AndroidRoboTest {
118
+ /** The APK for the application under test. */
119
+ appApk?: FileReference;
120
+ /** A multi-apk app bundle for the application under test. */
121
+ appBundle?: AppBundle;
122
+ /** The initial activity that should be used to start the app. */
123
+ appInitialActivity?: string;
124
+ /** The java package for the application under test. The default value is determined by examining the application's manifest. */
125
+ appPackageId?: string;
126
+ /** 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. */
127
+ maxDepth?: number;
128
+ /** The max number of steps Robo can execute. Default is no limit. */
129
+ maxSteps?: number;
130
+ /** 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. */
131
+ roboDirectives?: RoboDirective[];
132
+ /** The mode in which Robo should run. Most clients should allow the server to populate this field automatically. */
133
+ roboMode?: string;
134
+ /** A JSON file with a sequence of actions Robo should perform as a prologue for the crawl. */
135
+ roboScript?: FileReference;
136
+ /** 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). */
137
+ startingIntents?: RoboStartingIntent[];
138
+ }
139
+ interface AndroidRuntimeConfiguration {
140
+ /** The set of available locales. */
141
+ locales?: Locale[];
142
+ /** The set of available orientations. */
143
+ orientations?: Orientation[];
144
+ }
145
+ interface AndroidTestLoop {
146
+ /** The APK for the application under test. */
147
+ appApk?: FileReference;
148
+ /** A multi-apk app bundle for the application under test. */
149
+ appBundle?: AppBundle;
150
+ /** The java package for the application under test. The default is determined by examining the application's manifest. */
151
+ appPackageId?: string;
152
+ /** 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. */
153
+ scenarioLabels?: string[];
154
+ /** The list of scenarios that should be run during the test. The default is all test loops, derived from the application's manifest. */
155
+ scenarios?: number[];
156
+ }
157
+ interface AndroidVersion {
158
+ /** The API level for this Android version. Examples: 18, 19. */
159
+ apiLevel?: number;
160
+ /** The code name for this Android version. Examples: "JellyBean", "KitKat". */
161
+ codeName?: string;
162
+ /** Market share for this version. */
163
+ distribution?: Distribution;
164
+ /** An opaque id for this Android version. Use this id to invoke the TestExecutionService. */
165
+ id?: string;
166
+ /** The date this Android version became available in the market. */
167
+ releaseDate?: Date;
168
+ /** Tags for this dimension. Examples: "default", "preview", "deprecated". */
169
+ tags?: string[];
170
+ /** A string representing this version of the Android OS. Examples: "4.3", "4.4". */
171
+ versionString?: string;
172
+ }
173
+ interface Apk {
174
+ /** The path to an APK to be installed on the device before the test begins. */
175
+ location?: FileReference;
176
+ /** The java package for the APK to be installed. Value is determined by examining the application's manifest. */
177
+ packageName?: string;
178
+ }
179
+ interface ApkDetail {
180
+ apkManifest?: ApkManifest;
181
+ }
182
+ interface ApkManifest {
183
+ /** User-readable name for the application. */
184
+ applicationLabel?: string;
185
+ intentFilters?: IntentFilter[];
186
+ /** Maximum API level on which the application is designed to run. */
187
+ maxSdkVersion?: number;
188
+ /** Meta-data tags defined in the manifest. */
189
+ metadata?: Metadata[];
190
+ /** Minimum API level required for the application to run. */
191
+ minSdkVersion?: number;
192
+ /** Full Java-style package name for this application, e.g. "com.example.foo". */
193
+ packageName?: string;
194
+ /** Services contained in the tag. */
195
+ services?: Service[];
196
+ /** Specifies the API Level on which the application is designed to run. */
197
+ targetSdkVersion?: number;
198
+ /** Feature usage tags defined in the manifest. */
199
+ usesFeature?: UsesFeature[];
200
+ /** Permissions declared to be used by the application */
201
+ usesPermission?: string[];
202
+ /** Version number used internally by the app. */
203
+ versionCode?: string;
204
+ /** Version number shown to users. */
205
+ versionName?: string;
206
+ }
207
+ interface AppBundle {
208
+ /** .aab file representing the app bundle under test. */
209
+ bundleLocation?: FileReference;
210
+ }
211
+ interface CancelDeviceSessionRequest {}
212
+ interface CancelTestMatrixResponse {
213
+ /** The current rolled-up state of the test matrix. If this state is already final, then the cancelation request will have no effect. */
214
+ testState?: string;
215
+ }
216
+ interface ClientInfo {
217
+ /** The list of detailed information about client. */
218
+ clientInfoDetails?: ClientInfoDetail[];
219
+ /** Required. Client name, such as gcloud. */
220
+ name?: string;
221
+ }
222
+ interface ClientInfoDetail {
223
+ /** Required. The key of detailed client information. */
224
+ key?: string;
225
+ /** Required. The value of detailed client information. */
226
+ value?: string;
227
+ }
228
+ interface Date {
229
+ /** 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. */
230
+ day?: number;
231
+ /** Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. */
232
+ month?: number;
233
+ /** Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. */
234
+ year?: number;
235
+ }
236
+ interface DeviceFile {
237
+ /** A reference to an opaque binary blob file. */
238
+ obbFile?: ObbFile;
239
+ /** A reference to a regular file. */
240
+ regularFile?: RegularFile;
241
+ }
242
+ interface DeviceIpBlock {
243
+ /** The date this block was added to Firebase Test Lab */
244
+ addedDate?: Date;
245
+ /** An IP address block in CIDR notation eg: 34.68.194.64/29 */
246
+ block?: string;
247
+ /** Whether this block is used by physical or virtual devices */
248
+ form?: string;
249
+ }
250
+ interface DeviceIpBlockCatalog {
251
+ /** The device IP blocks used by Firebase Test Lab */
252
+ ipBlocks?: DeviceIpBlock[];
253
+ }
254
+ interface DeviceSession {
255
+ /** Output only. The timestamp that the session first became ACTIVE. */
256
+ activeStartTime?: string;
257
+ /** Required. The requested device */
258
+ androidDevice?: AndroidDevice;
259
+ /** Output only. The time that the Session was created. */
260
+ createTime?: string;
261
+ /** Output only. The title of the DeviceSession to be presented in the UI. */
262
+ displayName?: string;
263
+ /** Optional. If the device is still in use at this time, any connections will be ended and the SessionState will transition from ACTIVE to FINISHED. */
264
+ expireTime?: string;
265
+ /** Output only. The interval of time that this device must be interacted with before it transitions from ACTIVE to TIMEOUT_INACTIVITY. */
266
+ inactivityTimeout?: string;
267
+ /** Optional. Name of the DeviceSession, e.g. "projects/{project_id}/deviceSessions/{session_id}" */
268
+ name?: string;
269
+ /** Output only. Current state of the DeviceSession. */
270
+ state?: string;
271
+ /** Output only. The historical state transitions of the session_state message including the current session state. */
272
+ stateHistories?: SessionStateEvent[];
273
+ /** Optional. The amount of time that a device will be initially allocated for. This can eventually be extended with the UpdateDeviceSession RPC. Default: 30 minutes. */
274
+ ttl?: string;
275
+ }
276
+ interface DirectAccessVersionInfo {
277
+ /** Whether direct access is supported at all. Clients are expected to filter down the device list to only android models and versions which support Direct Access when that is the user intent. */
278
+ directAccessSupported?: boolean;
279
+ /** Output only. Indicates client-device compatibility, where a device is known to work only with certain workarounds implemented in the Android Studio client. Expected format "major.minor.micro.patch", e.g. "5921.22.2211.8881706". */
280
+ minimumAndroidStudioVersion?: string;
281
+ }
282
+ interface Distribution {
283
+ /** Output only. The estimated fraction (0-1) of the total market with this configuration. */
284
+ marketShare?: number;
285
+ /** Output only. The time this distribution was measured. */
286
+ measurementTime?: string;
287
+ }
288
+ interface Empty {}
289
+ interface Environment {
290
+ /** An Android device which must be used with an Android test. */
291
+ androidDevice?: AndroidDevice;
292
+ /** An iOS device which must be used with an iOS test. */
293
+ iosDevice?: IosDevice;
294
+ }
295
+ interface EnvironmentMatrix {
296
+ /** A list of Android devices; the test will be run only on the specified devices. */
297
+ androidDeviceList?: AndroidDeviceList;
298
+ /** A matrix of Android devices. */
299
+ androidMatrix?: AndroidMatrix;
300
+ /** A list of iOS devices. */
301
+ iosDeviceList?: IosDeviceList;
302
+ }
303
+ interface EnvironmentVariable {
304
+ /** Key for the environment variable. */
305
+ key?: string;
306
+ /** Value for the environment variable. */
307
+ value?: string;
308
+ }
309
+ interface FileReference {
310
+ /** 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) */
311
+ gcsPath?: string;
312
+ }
313
+ interface GetApkDetailsResponse {
314
+ /** Details of the Android APK. */
315
+ apkDetail?: ApkDetail;
316
+ }
317
+ interface GoogleAuto {}
318
+ interface GoogleCloudStorage {
319
+ /** 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. */
320
+ gcsPath?: string;
321
+ }
322
+ interface IntentFilter {
323
+ /** The android:name value of the tag. */
324
+ actionNames?: string[];
325
+ /** The android:name value of the tag. */
326
+ categoryNames?: string[];
327
+ /** The android:mimeType value of the tag. */
328
+ mimeType?: string;
329
+ }
330
+ interface IosDevice {
331
+ /** Required. The id of the iOS device to be used. Use the TestEnvironmentDiscoveryService to get supported options. */
332
+ iosModelId?: string;
333
+ /** Required. The id of the iOS major software version to be used. Use the TestEnvironmentDiscoveryService to get supported options. */
334
+ iosVersionId?: string;
335
+ /** Required. The locale the test device used for testing. Use the TestEnvironmentDiscoveryService to get supported options. */
336
+ locale?: string;
337
+ /** Required. How the device is oriented during the test. Use the TestEnvironmentDiscoveryService to get supported options. */
338
+ orientation?: string;
339
+ }
340
+ interface IosDeviceCatalog {
341
+ /** The set of supported iOS device models. */
342
+ models?: IosModel[];
343
+ /** The set of supported runtime configurations. */
344
+ runtimeConfiguration?: IosRuntimeConfiguration;
345
+ /** The set of supported iOS software versions. */
346
+ versions?: IosVersion[];
347
+ /** The set of supported Xcode versions. */
348
+ xcodeVersions?: XcodeVersion[];
349
+ }
350
+ interface IosDeviceFile {
351
+ /** 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. */
352
+ bundleId?: string;
353
+ /** The source file */
354
+ content?: FileReference;
355
+ /** Location of the file on the device, inside the app's sandboxed filesystem */
356
+ devicePath?: string;
357
+ }
358
+ interface IosDeviceList {
359
+ /** Required. A list of iOS devices. */
360
+ iosDevices?: IosDevice[];
361
+ }
362
+ interface IosModel {
363
+ /** Device capabilities. Copied from https://developer.apple.com/library/archive/documentation/DeviceInformation/Reference/iOSDeviceCompatibility/DeviceCompatibilityMatrix/DeviceCompatibilityMatrix.html */
364
+ deviceCapabilities?: string[];
365
+ /** Whether this device is a phone, tablet, wearable, etc. */
366
+ formFactor?: string;
367
+ /** The unique opaque id for this model. Use this for invoking the TestExecutionService. */
368
+ id?: string;
369
+ /** The human-readable name for this device model. Examples: "iPhone 4s", "iPad Mini 2". */
370
+ name?: string;
371
+ /** Version-specific information of an iOS model. */
372
+ perVersionInfo?: PerIosVersionInfo[];
373
+ /** Screen density in DPI. */
374
+ screenDensity?: number;
375
+ /** Screen size in the horizontal (X) dimension measured in pixels. */
376
+ screenX?: number;
377
+ /** Screen size in the vertical (Y) dimension measured in pixels. */
378
+ screenY?: number;
379
+ /** The set of iOS major software versions this device supports. */
380
+ supportedVersionIds?: string[];
381
+ /** Tags for this dimension. Examples: "default", "preview", "deprecated". */
382
+ tags?: string[];
383
+ }
384
+ interface IosRoboTest {
385
+ /** The bundle ID for the app-under-test. This is determined by examining the application's "Info.plist" file. */
386
+ appBundleId?: string;
387
+ /** Required. The ipa stored at this file should be used to run the test. */
388
+ appIpa?: FileReference;
389
+ /** An optional Roboscript to customize the crawl. See https://firebase.google.com/docs/test-lab/android/robo-scripts-reference for more information about Roboscripts. */
390
+ roboScript?: FileReference;
391
+ }
392
+ interface IosRuntimeConfiguration {
393
+ /** The set of available locales. */
394
+ locales?: Locale[];
395
+ /** The set of available orientations. */
396
+ orientations?: Orientation[];
397
+ }
398
+ interface IosTestLoop {
399
+ /** Output only. The bundle id for the application under test. */
400
+ appBundleId?: string;
401
+ /** Required. The .ipa of the application to test. */
402
+ appIpa?: FileReference;
403
+ /** The list of scenarios that should be run during the test. Defaults to the single scenario 0 if unspecified. */
404
+ scenarios?: number[];
405
+ }
406
+ interface IosTestSetup {
407
+ /** iOS apps to install in addition to those being directly tested. */
408
+ additionalIpas?: FileReference[];
409
+ /** 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. */
410
+ networkProfile?: string;
411
+ /** 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 (such as /private/var/mobile/Media) or within an accessible directory inside the app's filesystem (such as /Documents) by specifying the bundle ID. */
412
+ pullDirectories?: IosDeviceFile[];
413
+ /** List of files to push to the device before starting the test. */
414
+ pushFiles?: IosDeviceFile[];
415
+ }
416
+ interface IosVersion {
417
+ /** An opaque id for this iOS version. Use this id to invoke the TestExecutionService. */
418
+ id?: string;
419
+ /** An integer representing the major iOS version. Examples: "8", "9". */
420
+ majorVersion?: number;
421
+ /** An integer representing the minor iOS version. Examples: "1", "2". */
422
+ minorVersion?: number;
423
+ /** The available Xcode versions for this version. */
424
+ supportedXcodeVersionIds?: string[];
425
+ /** Tags for this dimension. Examples: "default", "preview", "deprecated". */
426
+ tags?: string[];
427
+ }
428
+ interface IosXcTest {
429
+ /** Output only. The bundle id for the application under test. */
430
+ appBundleId?: string;
431
+ /** 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. */
432
+ testSpecialEntitlements?: boolean;
433
+ /** 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. */
434
+ testsZip?: FileReference;
435
+ /** 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. */
436
+ xcodeVersion?: string;
437
+ /** 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. */
438
+ xctestrun?: FileReference;
439
+ }
440
+ interface LauncherActivityIntent {}
441
+ interface ListDeviceSessionsResponse {
442
+ /** The sessions matching the specified filter in the given cloud project. */
443
+ deviceSessions?: DeviceSession[];
444
+ /** A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. */
445
+ nextPageToken?: string;
446
+ }
447
+ interface Locale {
448
+ /** The id for this locale. Example: "en_US". */
449
+ id?: string;
450
+ /** A human-friendly name for this language/locale. Example: "English". */
451
+ name?: string;
452
+ /** A human-friendly string representing the region for this locale. Example: "United States". Not present for every locale. */
453
+ region?: string;
454
+ /** Tags for this dimension. Example: "default". */
455
+ tags?: string[];
456
+ }
457
+ interface ManualSharding {
458
+ /** Required. Group of packages, classes, and/or test methods to be run for each manually-created shard. You must specify at least one shard if this field is present. When you select one or more physical devices, the number of repeated test_targets_for_shard must be <= 50. When you select one or more ARM virtual devices, it must be <= 200. When you select only x86 virtual devices, it must be <= 500. */
459
+ testTargetsForShard?: TestTargetsForShard[];
460
+ }
461
+ interface Metadata {
462
+ /** The android:name value */
463
+ name?: string;
464
+ /** The android:value value */
465
+ value?: string;
466
+ }
467
+ interface NetworkConfiguration {
468
+ /** The emulation rule applying to the download traffic. */
469
+ downRule?: TrafficRule;
470
+ /** The unique opaque id for this network traffic configuration. */
471
+ id?: string;
472
+ /** The emulation rule applying to the upload traffic. */
473
+ upRule?: TrafficRule;
474
+ }
475
+ interface NetworkConfigurationCatalog {
476
+ configurations?: NetworkConfiguration[];
477
+ }
478
+ interface NoActivityIntent {}
479
+ interface ObbFile {
480
+ /** Required. Opaque Binary Blob (OBB) file(s) to install on the device. */
481
+ obb?: FileReference;
482
+ /** 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. */
483
+ obbFileName?: string;
484
+ }
485
+ interface Orientation {
486
+ /** The id for this orientation. Example: "portrait". */
487
+ id?: string;
488
+ /** A human-friendly name for this orientation. Example: "portrait". */
489
+ name?: string;
490
+ /** Tags for this dimension. Example: "default". */
491
+ tags?: string[];
492
+ }
493
+ interface PerAndroidVersionInfo {
494
+ /** The number of online devices for an Android version. */
495
+ deviceCapacity?: string;
496
+ /** Output only. Identifies supported clients for DirectAccess for this Android version. */
497
+ directAccessVersionInfo?: DirectAccessVersionInfo;
498
+ /** An Android version. */
499
+ versionId?: string;
500
+ }
501
+ interface PerIosVersionInfo {
502
+ /** The number of online devices for an iOS version. */
503
+ deviceCapacity?: string;
504
+ /** An iOS version. */
505
+ versionId?: string;
506
+ }
507
+ interface ProvidedSoftwareCatalog {
508
+ /** 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. */
509
+ androidxOrchestratorVersion?: string;
510
+ /** Deprecated: Use AndroidX Test Orchestrator going forward. 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. */
511
+ orchestratorVersion?: string;
512
+ }
513
+ interface RegularFile {
514
+ /** Required. The source file. */
515
+ content?: FileReference;
516
+ /** 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. */
517
+ devicePath?: string;
518
+ }
519
+ interface ResultStorage {
520
+ /** Required. */
521
+ googleCloudStorage?: GoogleCloudStorage;
522
+ /** Output only. URL to the results in the Firebase Web Console. */
523
+ resultsUrl?: string;
524
+ /** Output only. The tool results execution that results are written to. */
525
+ toolResultsExecution?: ToolResultsExecution;
526
+ /** 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. */
527
+ toolResultsHistory?: ToolResultsHistory;
528
+ }
529
+ interface RoboDirective {
530
+ /** Required. The type of action that Robo should perform on the specified element. */
531
+ actionType?: string;
532
+ /** 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. */
533
+ inputText?: string;
534
+ /** 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 */
535
+ resourceName?: string;
536
+ }
537
+ interface RoboStartingIntent {
538
+ /** An intent that starts the main launcher activity. */
539
+ launcherActivity?: any;
540
+ /** Skips the starting activity */
541
+ noActivity?: any;
542
+ /** An intent that starts an activity with specific details. */
543
+ startActivity?: StartActivityIntent;
544
+ /** Timeout in seconds for each intent. */
545
+ timeout?: string;
546
+ }
547
+ interface Service {
548
+ /** Intent filters in the service */
549
+ intentFilter?: IntentFilter[];
550
+ /** The android:name value */
551
+ name?: string;
552
+ }
553
+ interface SessionStateEvent {
554
+ /** Output only. The time that the session_state first encountered that state. */
555
+ eventTime?: string;
556
+ /** Output only. The session_state tracked by this event */
557
+ sessionState?: string;
558
+ /** Output only. A human-readable message to explain the state. */
559
+ stateMessage?: string;
560
+ }
561
+ interface Shard {
562
+ /** Output only. The estimated shard duration based on previous test case timing records, if available. */
563
+ estimatedShardDuration?: string;
564
+ /** Output only. The total number of shards. */
565
+ numShards?: number;
566
+ /** Output only. The index of the shard among all the shards. */
567
+ shardIndex?: number;
568
+ /** Output only. Test targets for each shard. Only set for manual sharding. */
569
+ testTargetsForShard?: TestTargetsForShard;
570
+ }
571
+ interface ShardingOption {
572
+ /** Shards test cases into the specified groups of packages, classes, and/or methods. */
573
+ manualSharding?: ManualSharding;
574
+ /** Shards test based on previous test case timing records. */
575
+ smartSharding?: SmartSharding;
576
+ /** Uniformly shards test cases given a total number of shards. */
577
+ uniformSharding?: UniformSharding;
578
+ }
579
+ interface SmartSharding {
580
+ /** The amount of time tests within a shard should take. Default: 300 seconds (5 minutes). The minimum allowed: 120 seconds (2 minutes). The shard count is dynamically set based on time, up to the maximum shard limit (described below). To guarantee at least one test case for each shard, the number of shards will not exceed the number of test cases. Shard duration will be exceeded if: - The maximum shard limit is reached and there is more calculated test time remaining to allocate into shards. - Any individual test is estimated to be longer than the targeted shard duration. Shard duration is not guaranteed because smart sharding uses test case history and default durations which may not be accurate. The rules for finding the test case timing records are: - If the service has processed a test case in the last 30 days, the record of the latest successful test case will be used. - For new test cases, the average duration of other known test cases will be used. - If there are no previous test case timing records available, the default test case duration is 15 seconds. Because the actual shard duration can exceed the targeted shard duration, we recommend that you set the targeted value at least 5 minutes less than the maximum allowed test timeout (45 minutes for physical devices and 60 minutes for virtual), or that you use the custom test timeout value that you set. This approach avoids cancelling the shard before all tests can finish. Note that there is a limit for maximum number of shards. When you select one or more physical devices, the number of shards must be <= 50. When you select one or more ARM virtual devices, it must be <= 200. When you select only x86 virtual devices, it must be <= 500. To guarantee at least one test case for per shard, the number of shards will not exceed the number of test cases. Each shard created counts toward daily test quota. */
581
+ targetedShardDuration?: string;
582
+ }
583
+ interface StartActivityIntent {
584
+ /** Action name. Required for START_ACTIVITY. */
585
+ action?: string;
586
+ /** Intent categories to set on the intent. */
587
+ categories?: string[];
588
+ /** URI for the action. */
589
+ uri?: string;
590
+ }
591
+ interface SystraceSetup {
592
+ /** Systrace duration in seconds. Should be between 1 and 30 seconds. 0 disables systrace. */
593
+ durationSeconds?: number;
594
+ }
595
+ interface TestDetails {
596
+ /** Output only. If the TestState is ERROR, then this string will contain human-readable details about the error. */
597
+ errorMessage?: string;
598
+ /** 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. */
599
+ progressMessages?: string[];
600
+ }
601
+ interface TestEnvironmentCatalog {
602
+ /** Supported Android devices. */
603
+ androidDeviceCatalog?: AndroidDeviceCatalog;
604
+ /** The IP blocks used by devices in the test environment. */
605
+ deviceIpBlockCatalog?: DeviceIpBlockCatalog;
606
+ /** Supported iOS devices. */
607
+ iosDeviceCatalog?: IosDeviceCatalog;
608
+ /** Supported network configurations. */
609
+ networkConfigurationCatalog?: NetworkConfigurationCatalog;
610
+ /** The software test environment provided by TestExecutionService. */
611
+ softwareCatalog?: ProvidedSoftwareCatalog;
612
+ }
613
+ interface TestExecution {
614
+ /** Output only. How the host machine(s) are configured. */
615
+ environment?: Environment;
616
+ /** Output only. Unique id set by the service. */
617
+ id?: string;
618
+ /** Output only. Id of the containing TestMatrix. */
619
+ matrixId?: string;
620
+ /** Output only. The cloud project that owns the test execution. */
621
+ projectId?: string;
622
+ /** Output only. Details about the shard. */
623
+ shard?: Shard;
624
+ /** Output only. Indicates the current progress of the test execution (e.g., FINISHED). */
625
+ state?: string;
626
+ /** Output only. Additional details about the running test. */
627
+ testDetails?: TestDetails;
628
+ /** Output only. How to run the test. */
629
+ testSpecification?: TestSpecification;
630
+ /** Output only. The time this test execution was initially created. */
631
+ timestamp?: string;
632
+ /** Output only. Where the results for this execution are written. */
633
+ toolResultsStep?: ToolResultsStep;
634
+ }
635
+ interface TestMatrix {
636
+ /** Information about the client which invoked the test. */
637
+ clientInfo?: ClientInfo;
638
+ /** Required. The devices the tests are being executed on. */
639
+ environmentMatrix?: EnvironmentMatrix;
640
+ /** 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. */
641
+ failFast?: boolean;
642
+ /** 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. */
643
+ flakyTestAttempts?: number;
644
+ /** Output only. Describes why the matrix is considered invalid. Only useful for matrices in the INVALID state. */
645
+ invalidMatrixDetails?: string;
646
+ /** Output Only. The overall outcome of the test. Only set when the test matrix state is FINISHED. */
647
+ outcomeSummary?: string;
648
+ /** The cloud project that owns the test matrix. */
649
+ projectId?: string;
650
+ /** Required. Where the results for the matrix are written. */
651
+ resultStorage?: ResultStorage;
652
+ /** Output only. Indicates the current progress of the test matrix. */
653
+ state?: string;
654
+ /** Output only. The list of test executions that the service creates for this matrix. */
655
+ testExecutions?: TestExecution[];
656
+ /** Output only. Unique id set by the service. */
657
+ testMatrixId?: string;
658
+ /** Required. How to run the test. */
659
+ testSpecification?: TestSpecification;
660
+ /** Output only. The time this test matrix was initially created. */
661
+ timestamp?: string;
662
+ }
663
+ interface TestSetup {
664
+ /** The device will be logged in on this account for the duration of the test. */
665
+ account?: Account;
666
+ /** APKs to install in addition to those being directly tested. These will be installed after the app under test. Currently capped at 100. */
667
+ additionalApks?: Apk[];
668
+ /** 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. */
669
+ directoriesToPull?: string[];
670
+ /** Whether to prevent all runtime permissions to be granted at app install */
671
+ dontAutograntPermissions?: boolean;
672
+ /** Environment variables to set for the test (only applicable for instrumentation tests). */
673
+ environmentVariables?: EnvironmentVariable[];
674
+ /** List of files to push to the device before starting the test. */
675
+ filesToPush?: DeviceFile[];
676
+ /** Optional. Initial setup APKs to install before the app under test is installed. Currently capped at 100. */
677
+ initialSetupApks?: Apk[];
678
+ /** 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. */
679
+ networkProfile?: string;
680
+ /** Systrace configuration for the run. Deprecated: Systrace used Python 2 which was sunsetted on 2020-01-01. Systrace is no longer supported in the Cloud Testing API, and no Systrace file will be provided in the results. */
681
+ systrace?: SystraceSetup;
682
+ }
683
+ interface TestSpecification {
684
+ /** An Android instrumentation test. */
685
+ androidInstrumentationTest?: AndroidInstrumentationTest;
686
+ /** An Android robo test. */
687
+ androidRoboTest?: AndroidRoboTest;
688
+ /** An Android Application with a Test Loop. */
689
+ androidTestLoop?: AndroidTestLoop;
690
+ /** Disables performance metrics recording. May reduce test latency. */
691
+ disablePerformanceMetrics?: boolean;
692
+ /** Disables video recording. May reduce test latency. */
693
+ disableVideoRecording?: boolean;
694
+ /** An iOS Robo test. */
695
+ iosRoboTest?: IosRoboTest;
696
+ /** An iOS application with a test loop. */
697
+ iosTestLoop?: IosTestLoop;
698
+ /** Test setup requirements for iOS. */
699
+ iosTestSetup?: IosTestSetup;
700
+ /** An iOS XCTest, via an .xctestrun file. */
701
+ iosXcTest?: IosXcTest;
702
+ /** Test setup requirements for Android e.g. files to install, bootstrap scripts. */
703
+ testSetup?: TestSetup;
704
+ /** Max time a test execution is allowed to run before it is automatically cancelled. The default value is 5 min. */
705
+ testTimeout?: string;
706
+ }
707
+ interface TestTargetsForShard {
708
+ /** 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 test_targets must be greater than 0. */
709
+ testTargets?: string[];
710
+ }
711
+ interface ToolResultsExecution {
712
+ /** Output only. A tool results execution ID. */
713
+ executionId?: string;
714
+ /** Output only. A tool results history ID. */
715
+ historyId?: string;
716
+ /** Output only. The cloud project that owns the tool results execution. */
717
+ projectId?: string;
718
+ }
719
+ interface ToolResultsHistory {
720
+ /** Required. A tool results history ID. */
721
+ historyId?: string;
722
+ /** Required. The cloud project that owns the tool results history. */
723
+ projectId?: string;
724
+ }
725
+ interface ToolResultsStep {
726
+ /** Output only. A tool results execution ID. */
727
+ executionId?: string;
728
+ /** Output only. A tool results history ID. */
729
+ historyId?: string;
730
+ /** Output only. The cloud project that owns the tool results step. */
731
+ projectId?: string;
732
+ /** Output only. A tool results step ID. */
733
+ stepId?: string;
734
+ }
735
+ interface TrafficRule {
736
+ /** Bandwidth in kbits/second. */
737
+ bandwidth?: number;
738
+ /** Burst size in kbits. */
739
+ burst?: number;
740
+ /** Packet delay, must be >= 0. */
741
+ delay?: string;
742
+ /** Packet duplication ratio (0.0 - 1.0). */
743
+ packetDuplicationRatio?: number;
744
+ /** Packet loss ratio (0.0 - 1.0). */
745
+ packetLossRatio?: number;
746
+ }
747
+ interface UniformSharding {
748
+ /** Required. The total number of shards to create. This must always be a positive number that is no greater than the total number of test cases. When you select one or more physical devices, the number of shards must be <= 50. When you select one or more ARM virtual devices, it must be <= 200. When you select only x86 virtual devices, it must be <= 500. */
749
+ numShards?: number;
750
+ }
751
+ interface UsesFeature {
752
+ /** The android:required value */
753
+ isRequired?: boolean;
754
+ /** The android:name value */
755
+ name?: string;
756
+ }
757
+ interface XcodeVersion {
758
+ /** Tags for this Xcode version. Example: "default". */
759
+ tags?: string[];
760
+ /** The id for this version. Example: "9.2". */
761
+ version?: string;
762
+ }
763
+ interface ApplicationDetailServiceResource {
764
+ /** Gets the details of an Android application APK. */
765
+ getApkDetails(request: {
766
+ /** V1 error format. */
767
+ '$.xgafv'?: string;
768
+ /** OAuth access token. */
769
+ access_token?: string;
770
+ /** Data format for response. */
771
+ alt?: string;
772
+ /** JSONP */
773
+ callback?: string;
774
+ /** Selector specifying which fields to include in a partial response. */
775
+ fields?: string;
776
+ /** 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. */
777
+ key?: string;
778
+ /** OAuth 2.0 token for the current user. */
779
+ oauth_token?: string;
780
+ /** Returns response with indentations and line breaks. */
781
+ prettyPrint?: boolean;
782
+ /** 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. */
783
+ quotaUser?: string;
784
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
785
+ upload_protocol?: string;
786
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
787
+ uploadType?: string;
788
+ /** Request body */
789
+ resource: FileReference;
790
+ }): Request<GetApkDetailsResponse>;
791
+ getApkDetails(
792
+ request: {
793
+ /** V1 error format. */
794
+ '$.xgafv'?: string;
795
+ /** OAuth access token. */
796
+ access_token?: string;
797
+ /** Data format for response. */
798
+ alt?: string;
799
+ /** JSONP */
800
+ callback?: string;
801
+ /** Selector specifying which fields to include in a partial response. */
802
+ fields?: string;
803
+ /** 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. */
804
+ key?: string;
805
+ /** OAuth 2.0 token for the current user. */
806
+ oauth_token?: string;
807
+ /** Returns response with indentations and line breaks. */
808
+ prettyPrint?: boolean;
809
+ /** 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. */
810
+ quotaUser?: string;
811
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
812
+ upload_protocol?: string;
813
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
814
+ uploadType?: string;
815
+ },
816
+ body: FileReference
817
+ ): Request<GetApkDetailsResponse>;
818
+ }
819
+ interface DeviceSessionsResource {
820
+ /** POST /v1/projects/{project_id}/deviceSessions/{device_session_id}:cancel Changes the DeviceSession to state FINISHED and terminates all connections. Canceled sessions are not deleted and can be retrieved or listed by the user until they expire based on the 28 day deletion policy. */
821
+ cancel(request: {
822
+ /** V1 error format. */
823
+ '$.xgafv'?: string;
824
+ /** OAuth access token. */
825
+ access_token?: string;
826
+ /** Data format for response. */
827
+ alt?: string;
828
+ /** JSONP */
829
+ callback?: string;
830
+ /** Selector specifying which fields to include in a partial response. */
831
+ fields?: string;
832
+ /** 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. */
833
+ key?: string;
834
+ /** Required. Name of the DeviceSession, e.g. "projects/{project_id}/deviceSessions/{session_id}" */
835
+ name: string;
836
+ /** OAuth 2.0 token for the current user. */
837
+ oauth_token?: string;
838
+ /** Returns response with indentations and line breaks. */
839
+ prettyPrint?: boolean;
840
+ /** 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. */
841
+ quotaUser?: string;
842
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
843
+ upload_protocol?: string;
844
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
845
+ uploadType?: string;
846
+ /** Request body */
847
+ resource: CancelDeviceSessionRequest;
848
+ }): Request<{}>;
849
+ cancel(
850
+ request: {
851
+ /** V1 error format. */
852
+ '$.xgafv'?: string;
853
+ /** OAuth access token. */
854
+ access_token?: string;
855
+ /** Data format for response. */
856
+ alt?: string;
857
+ /** JSONP */
858
+ callback?: string;
859
+ /** Selector specifying which fields to include in a partial response. */
860
+ fields?: string;
861
+ /** 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. */
862
+ key?: string;
863
+ /** Required. Name of the DeviceSession, e.g. "projects/{project_id}/deviceSessions/{session_id}" */
864
+ name: string;
865
+ /** OAuth 2.0 token for the current user. */
866
+ oauth_token?: string;
867
+ /** Returns response with indentations and line breaks. */
868
+ prettyPrint?: boolean;
869
+ /** 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. */
870
+ quotaUser?: string;
871
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
872
+ upload_protocol?: string;
873
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
874
+ uploadType?: string;
875
+ },
876
+ body: CancelDeviceSessionRequest
877
+ ): Request<{}>;
878
+ /** POST /v1/projects/{project_id}/deviceSessions */
879
+ create(request: {
880
+ /** V1 error format. */
881
+ '$.xgafv'?: string;
882
+ /** OAuth access token. */
883
+ access_token?: string;
884
+ /** Data format for response. */
885
+ alt?: string;
886
+ /** JSONP */
887
+ callback?: string;
888
+ /** Selector specifying which fields to include in a partial response. */
889
+ fields?: string;
890
+ /** 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. */
891
+ key?: string;
892
+ /** OAuth 2.0 token for the current user. */
893
+ oauth_token?: string;
894
+ /** Required. The Compute Engine project under which this device will be allocated. "projects/{project_id}" */
895
+ parent: string;
896
+ /** Returns response with indentations and line breaks. */
897
+ prettyPrint?: boolean;
898
+ /** 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. */
899
+ quotaUser?: string;
900
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
901
+ upload_protocol?: string;
902
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
903
+ uploadType?: string;
904
+ /** Request body */
905
+ resource: DeviceSession;
906
+ }): Request<DeviceSession>;
907
+ create(
908
+ request: {
909
+ /** V1 error format. */
910
+ '$.xgafv'?: string;
911
+ /** OAuth access token. */
912
+ access_token?: string;
913
+ /** Data format for response. */
914
+ alt?: string;
915
+ /** JSONP */
916
+ callback?: string;
917
+ /** Selector specifying which fields to include in a partial response. */
918
+ fields?: string;
919
+ /** 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. */
920
+ key?: string;
921
+ /** OAuth 2.0 token for the current user. */
922
+ oauth_token?: string;
923
+ /** Required. The Compute Engine project under which this device will be allocated. "projects/{project_id}" */
924
+ parent: string;
925
+ /** Returns response with indentations and line breaks. */
926
+ prettyPrint?: boolean;
927
+ /** 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. */
928
+ quotaUser?: string;
929
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
930
+ upload_protocol?: string;
931
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
932
+ uploadType?: string;
933
+ },
934
+ body: DeviceSession
935
+ ): Request<DeviceSession>;
936
+ /** GET /v1/projects/{project_id}/deviceSessions/{device_session_id} Return a DeviceSession, which documents the allocation status and whether the device is allocated. Clients making requests from this API must poll GetDeviceSession. */
937
+ get(request?: {
938
+ /** V1 error format. */
939
+ '$.xgafv'?: string;
940
+ /** OAuth access token. */
941
+ access_token?: string;
942
+ /** Data format for response. */
943
+ alt?: string;
944
+ /** JSONP */
945
+ callback?: string;
946
+ /** Selector specifying which fields to include in a partial response. */
947
+ fields?: string;
948
+ /** 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. */
949
+ key?: string;
950
+ /** Required. Name of the DeviceSession, e.g. "projects/{project_id}/deviceSessions/{session_id}" */
951
+ name: string;
952
+ /** OAuth 2.0 token for the current user. */
953
+ oauth_token?: string;
954
+ /** Returns response with indentations and line breaks. */
955
+ prettyPrint?: boolean;
956
+ /** 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. */
957
+ quotaUser?: string;
958
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
959
+ upload_protocol?: string;
960
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
961
+ uploadType?: string;
962
+ }): Request<DeviceSession>;
963
+ /** GET /v1/projects/{project_id}/deviceSessions Lists device Sessions owned by the project user. */
964
+ list(request?: {
965
+ /** V1 error format. */
966
+ '$.xgafv'?: string;
967
+ /** OAuth access token. */
968
+ access_token?: string;
969
+ /** Data format for response. */
970
+ alt?: string;
971
+ /** JSONP */
972
+ callback?: string;
973
+ /** Selector specifying which fields to include in a partial response. */
974
+ fields?: string;
975
+ /** Optional. If specified, responses will be filtered by the given filter. Allowed fields are: session_state. */
976
+ filter?: string;
977
+ /** 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. */
978
+ key?: string;
979
+ /** OAuth 2.0 token for the current user. */
980
+ oauth_token?: string;
981
+ /** Optional. The maximum number of DeviceSessions to return. */
982
+ pageSize?: number;
983
+ /** Optional. A continuation token for paging. */
984
+ pageToken?: string;
985
+ /** Required. The name of the parent to request, e.g. "projects/{project_id}" */
986
+ parent: string;
987
+ /** Returns response with indentations and line breaks. */
988
+ prettyPrint?: boolean;
989
+ /** 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. */
990
+ quotaUser?: string;
991
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
992
+ upload_protocol?: string;
993
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
994
+ uploadType?: string;
995
+ }): Request<ListDeviceSessionsResponse>;
996
+ /** PATCH /v1/projects/{projectId}/deviceSessions/deviceSessionId}:updateDeviceSession Updates the current device session to the fields described by the update_mask. */
997
+ patch(request: {
998
+ /** V1 error format. */
999
+ '$.xgafv'?: string;
1000
+ /** OAuth access token. */
1001
+ access_token?: string;
1002
+ /** Data format for response. */
1003
+ alt?: string;
1004
+ /** JSONP */
1005
+ callback?: string;
1006
+ /** Selector specifying which fields to include in a partial response. */
1007
+ fields?: string;
1008
+ /** 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. */
1009
+ key?: string;
1010
+ /** Optional. Name of the DeviceSession, e.g. "projects/{project_id}/deviceSessions/{session_id}" */
1011
+ name: string;
1012
+ /** OAuth 2.0 token for the current user. */
1013
+ oauth_token?: string;
1014
+ /** Returns response with indentations and line breaks. */
1015
+ prettyPrint?: boolean;
1016
+ /** 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. */
1017
+ quotaUser?: string;
1018
+ /** Required. The list of fields to update. */
1019
+ updateMask?: string;
1020
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1021
+ upload_protocol?: string;
1022
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1023
+ uploadType?: string;
1024
+ /** Request body */
1025
+ resource: DeviceSession;
1026
+ }): Request<DeviceSession>;
1027
+ patch(
1028
+ request: {
1029
+ /** V1 error format. */
1030
+ '$.xgafv'?: string;
1031
+ /** OAuth access token. */
1032
+ access_token?: string;
1033
+ /** Data format for response. */
1034
+ alt?: string;
1035
+ /** JSONP */
1036
+ callback?: string;
1037
+ /** Selector specifying which fields to include in a partial response. */
1038
+ fields?: string;
1039
+ /** 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. */
1040
+ key?: string;
1041
+ /** Optional. Name of the DeviceSession, e.g. "projects/{project_id}/deviceSessions/{session_id}" */
1042
+ name: string;
1043
+ /** OAuth 2.0 token for the current user. */
1044
+ oauth_token?: string;
1045
+ /** Returns response with indentations and line breaks. */
1046
+ prettyPrint?: boolean;
1047
+ /** 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. */
1048
+ quotaUser?: string;
1049
+ /** Required. The list of fields to update. */
1050
+ updateMask?: string;
1051
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1052
+ upload_protocol?: string;
1053
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1054
+ uploadType?: string;
1055
+ },
1056
+ body: DeviceSession
1057
+ ): Request<DeviceSession>;
1058
+ }
1059
+ interface TestMatricesResource {
1060
+ /** 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 */
1061
+ cancel(request?: {
1062
+ /** V1 error format. */
1063
+ '$.xgafv'?: string;
1064
+ /** OAuth access token. */
1065
+ access_token?: string;
1066
+ /** Data format for response. */
1067
+ alt?: string;
1068
+ /** JSONP */
1069
+ callback?: string;
1070
+ /** Selector specifying which fields to include in a partial response. */
1071
+ fields?: string;
1072
+ /** 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. */
1073
+ key?: string;
1074
+ /** OAuth 2.0 token for the current user. */
1075
+ oauth_token?: string;
1076
+ /** Returns response with indentations and line breaks. */
1077
+ prettyPrint?: boolean;
1078
+ /** Cloud project that owns the test. */
1079
+ projectId: string;
1080
+ /** 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. */
1081
+ quotaUser?: string;
1082
+ /** Test matrix that will be canceled. */
1083
+ testMatrixId: string;
1084
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1085
+ upload_protocol?: string;
1086
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1087
+ uploadType?: string;
1088
+ }): Request<CancelTestMatrixResponse>;
1089
+ /** 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. The returned matrix will not yet contain the executions that will be created for this matrix. Execution creation happens later on and will require a call to GetTestMatrix. 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. */
1090
+ create(request: {
1091
+ /** V1 error format. */
1092
+ '$.xgafv'?: string;
1093
+ /** OAuth access token. */
1094
+ access_token?: string;
1095
+ /** Data format for response. */
1096
+ alt?: string;
1097
+ /** JSONP */
1098
+ callback?: string;
1099
+ /** Selector specifying which fields to include in a partial response. */
1100
+ fields?: string;
1101
+ /** 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. */
1102
+ key?: string;
1103
+ /** OAuth 2.0 token for the current user. */
1104
+ oauth_token?: string;
1105
+ /** Returns response with indentations and line breaks. */
1106
+ prettyPrint?: boolean;
1107
+ /** The GCE project under which this job will run. */
1108
+ projectId: string;
1109
+ /** 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. */
1110
+ quotaUser?: string;
1111
+ /** 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. */
1112
+ requestId?: string;
1113
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1114
+ upload_protocol?: string;
1115
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1116
+ uploadType?: string;
1117
+ /** Request body */
1118
+ resource: TestMatrix;
1119
+ }): Request<TestMatrix>;
1120
+ create(
1121
+ request: {
1122
+ /** V1 error format. */
1123
+ '$.xgafv'?: string;
1124
+ /** OAuth access token. */
1125
+ access_token?: string;
1126
+ /** Data format for response. */
1127
+ alt?: string;
1128
+ /** JSONP */
1129
+ callback?: string;
1130
+ /** Selector specifying which fields to include in a partial response. */
1131
+ fields?: string;
1132
+ /** 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. */
1133
+ key?: string;
1134
+ /** OAuth 2.0 token for the current user. */
1135
+ oauth_token?: string;
1136
+ /** Returns response with indentations and line breaks. */
1137
+ prettyPrint?: boolean;
1138
+ /** The GCE project under which this job will run. */
1139
+ projectId: string;
1140
+ /** 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. */
1141
+ quotaUser?: string;
1142
+ /** 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. */
1143
+ requestId?: string;
1144
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1145
+ upload_protocol?: string;
1146
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1147
+ uploadType?: string;
1148
+ },
1149
+ body: TestMatrix
1150
+ ): Request<TestMatrix>;
1151
+ /** Checks the status of a test matrix and the executions once they are created. The test matrix will contain the list of test executions to run if and only if the resultStorage.toolResultsExecution fields have been populated. Note: Flaky test executions may be added to the matrix at a later stage. 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 */
1152
+ get(request?: {
1153
+ /** V1 error format. */
1154
+ '$.xgafv'?: string;
1155
+ /** OAuth access token. */
1156
+ access_token?: string;
1157
+ /** Data format for response. */
1158
+ alt?: string;
1159
+ /** JSONP */
1160
+ callback?: string;
1161
+ /** Selector specifying which fields to include in a partial response. */
1162
+ fields?: string;
1163
+ /** 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. */
1164
+ key?: string;
1165
+ /** OAuth 2.0 token for the current user. */
1166
+ oauth_token?: string;
1167
+ /** Returns response with indentations and line breaks. */
1168
+ prettyPrint?: boolean;
1169
+ /** Cloud project that owns the test matrix. */
1170
+ projectId: string;
1171
+ /** 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. */
1172
+ quotaUser?: string;
1173
+ /** Unique test matrix id which was assigned by the service. */
1174
+ testMatrixId: string;
1175
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1176
+ upload_protocol?: string;
1177
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1178
+ uploadType?: string;
1179
+ }): Request<TestMatrix>;
1180
+ }
1181
+ interface ProjectsResource {
1182
+ deviceSessions: DeviceSessionsResource;
1183
+ testMatrices: TestMatricesResource;
1184
+ }
1185
+ interface TestEnvironmentCatalogResource {
1186
+ /** 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 */
1187
+ get(request?: {
1188
+ /** V1 error format. */
1189
+ '$.xgafv'?: string;
1190
+ /** OAuth access token. */
1191
+ access_token?: string;
1192
+ /** Data format for response. */
1193
+ alt?: string;
1194
+ /** JSONP */
1195
+ callback?: string;
1196
+ /** Required. The type of environment that should be listed. */
1197
+ environmentType: string;
1198
+ /** Selector specifying which fields to include in a partial response. */
1199
+ fields?: string;
1200
+ /** 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. */
1201
+ key?: string;
1202
+ /** OAuth 2.0 token for the current user. */
1203
+ oauth_token?: string;
1204
+ /** Returns response with indentations and line breaks. */
1205
+ prettyPrint?: boolean;
1206
+ /** For authorization, the cloud project requesting the TestEnvironmentCatalog. */
1207
+ projectId?: string;
1208
+ /** 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. */
1209
+ quotaUser?: string;
1210
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1211
+ upload_protocol?: string;
1212
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1213
+ uploadType?: string;
1214
+ }): Request<TestEnvironmentCatalog>;
1215
+ }
1830
1216
 
1831
- const applicationDetailService: ApplicationDetailServiceResource;
1217
+ const applicationDetailService: ApplicationDetailServiceResource;
1832
1218
 
1833
- const projects: ProjectsResource;
1219
+ const projects: ProjectsResource;
1834
1220
 
1835
- const testEnvironmentCatalog: TestEnvironmentCatalogResource;
1836
- }
1221
+ const testEnvironmentCatalog: TestEnvironmentCatalogResource;
1222
+ }
1837
1223
  }