blob: 0149b98046dd2abfb94d2d7859eae7765392a6b0 [file] [log] [blame]
Bu Sun Kim65020912020-05-20 12:08:20 -07001<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="toolresults_v1beta3.html">Cloud Tool Results API</a> . <a href="toolresults_v1beta3.environments.html">environments</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#get">get(projectId, historyId, executionId, environmentId, x__xgafv=None)</a></code></p>
79<p class="firstline">Gets an Environment.</p>
80<p class="toc_element">
81 <code><a href="#list">list(projectId, historyId, executionId, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
82<p class="firstline">Lists Environments for a given Execution.</p>
83<p class="toc_element">
84 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
85<p class="firstline">Retrieves the next page of results.</p>
86<h3>Method Details</h3>
87<div class="method">
88 <code class="details" id="get">get(projectId, historyId, executionId, environmentId, x__xgafv=None)</code>
89 <pre>Gets an Environment.
90
91May return any of the following canonical error codes:
92
93- PERMISSION_DENIED - if the user is not authorized to read project
94- INVALID_ARGUMENT - if the request is malformed
95- NOT_FOUND - if the Environment does not exist
96
97Args:
98 projectId: string, Required. A Project id. (required)
99 historyId: string, Required. A History id. (required)
100 executionId: string, Required. An Execution id. (required)
101 environmentId: string, Required. An Environment id. (required)
102 x__xgafv: string, V1 error format.
103 Allowed values
104 1 - v1 error format
105 2 - v2 error format
106
107Returns:
108 An object of the form:
109
110 { # An Environment represents the set of test runs (Steps) from the parent
111 # Execution that are configured with the same set of dimensions (Model,
112 # Version, Locale, and Orientation). Multiple such runs occur particularly
113 # because of features like sharding (splitting up a test suite to run in
114 # parallel across devices) and reruns (running a test multiple times to check
115 # for different outcomes).
116 &quot;creationTime&quot;: { # A Timestamp represents a point in time independent of any time zone or local # Output only. The time when the Environment was created.
117 # calendar, encoded as a count of seconds and fractions of seconds at
118 # nanosecond resolution. The count is relative to an epoch at UTC midnight on
119 # January 1, 1970, in the proleptic Gregorian calendar which extends the
120 # Gregorian calendar backwards to year one.
121 #
122 # All minutes are 60 seconds long. Leap seconds are &quot;smeared&quot; so that no leap
123 # second table is needed for interpretation, using a [24-hour linear
124 # smear](https://developers.google.com/time/smear).
125 #
126 # The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By
127 # restricting to that range, we ensure that we can convert to and from [RFC
128 # 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings.
129 &quot;nanos&quot;: 42, # Non-negative fractions of a second at nanosecond resolution. Negative
130 # second values with fractions must still have non-negative nanos values
131 # that count forward in time. Must be from 0 to 999,999,999
132 # inclusive.
133 &quot;seconds&quot;: &quot;A String&quot;, # Represents seconds of UTC time since Unix epoch
134 # 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to
135 # 9999-12-31T23:59:59Z inclusive.
136 },
137 &quot;environmentResult&quot;: { # Merged test result for environment. # Merged result of the environment.
138 #
139 # If the environment has only one step (no reruns or shards), then the merged
140 # result is the same as the step result. If the environment has multiple shards
141 # and/or reruns, then the results of shards and reruns that belong to the same
142 # environment are merged into one environment result.
143 &quot;testSuiteOverviews&quot;: [ # The combined and rolled-up result of each test suite that was run as part
144 # of this environment.
145 #
146 # Combining:
147 # When the test cases from a suite are run in different steps (sharding),
148 # the results are added back together in one overview. (e.g., if shard1 has
149 # 2 failures and shard2 has 1 failure than the overview failure_count = 3).
150 #
151 # Rollup:
152 # When test cases from the same suite are run multiple times (flaky), the
153 # results are combined (e.g., if testcase1.run1 fails, testcase1.run2
154 # passes, and both testcase2.run1 and testcase2.run2 fail then the overview
155 # flaky_count = 1 and failure_count = 1).
156 { # A summary of a test suite result either parsed from XML or uploaded
157 # directly by a user.
158 #
159 # Note: the API related comments are for StepService only. This message is
160 # also being used in ExecutionService in a read only mode for the corresponding
161 # step.
162 &quot;name&quot;: &quot;A String&quot;, # The name of the test suite.
163 #
164 # - In create/response: always set
165 # - In update request: never
166 &quot;elapsedTime&quot;: { # # Elapsed time of test suite.
167 # A Duration represents a signed, fixed-length span of time represented
168 # as a count of seconds and fractions of seconds at nanosecond
169 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
170 # or &quot;month&quot;. It is related to Timestamp in that the difference between
171 # two Timestamp values is a Duration and it can be added or subtracted
172 # from a Timestamp. Range is approximately +-10,000 years.
173 &quot;nanos&quot;: 42, # Signed fractions of a second at nanosecond resolution of the span
174 # of time. Durations less than one second are represented with a 0
175 # `seconds` field and a positive or negative `nanos` field. For durations
176 # of one second or more, a non-zero value for the `nanos` field must be
177 # of the same sign as the `seconds` field. Must be from -999,999,999
178 # to +999,999,999 inclusive.
179 &quot;seconds&quot;: &quot;A String&quot;, # Signed seconds of the span of time. Must be from -315,576,000,000
180 # to +315,576,000,000 inclusive. Note: these bounds are computed from:
181 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
182 },
183 &quot;flakyCount&quot;: 42, # Number of flaky test cases, set by the service by rolling up flaky test
184 # attempts.
185 #
186 # Present only for rollup test suite overview at environment level. A step
187 # cannot have flaky test cases.
188 &quot;errorCount&quot;: 42, # Number of test cases in error, typically set by the service by parsing the
189 # xml_source.
190 #
191 # - In create/response: always set
192 # - In update request: never
193 &quot;totalCount&quot;: 42, # Number of test cases, typically set by the service by parsing the
194 # xml_source.
195 #
196 # - In create/response: always set
197 # - In update request: never
198 &quot;skippedCount&quot;: 42, # Number of test cases not run, typically set by the service by parsing the
199 # xml_source.
200 #
201 # - In create/response: always set
202 # - In update request: never
203 &quot;xmlSource&quot;: { # A reference to a file. # If this test suite was parsed from XML, this is the URI where the original
204 # XML file is stored.
205 #
206 # Note: Multiple test suites can share the same xml_source
207 #
208 # Returns INVALID_ARGUMENT if the uri format is not supported.
209 #
210 # - In create/response: optional
211 # - In update request: never
212 &quot;fileUri&quot;: &quot;A String&quot;, # The URI of a file stored in Google Cloud Storage.
213 #
214 # For example: http://storage.googleapis.com/mybucket/path/to/test.xml
215 # or in gsutil format: gs://mybucket/path/to/test.xml
216 # with version-specific info,
217 # gs://mybucket/path/to/test.xml#1360383693690000
218 #
219 # An INVALID_ARGUMENT error will be returned if the URI format is not
220 # supported.
221 #
222 # - In response: always set
223 # - In create/update request: always set
224 },
225 &quot;failureCount&quot;: 42, # Number of failed test cases, typically set by the service by parsing the
226 # xml_source. May also be set by the user.
227 #
228 # - In create/response: always set
229 # - In update request: never
230 },
231 ],
232 &quot;state&quot;: &quot;A String&quot;, # State of the resource
233 &quot;outcome&quot;: { # Interprets a result so that humans and machines can act on it. # Outcome of the resource
234 &quot;summary&quot;: &quot;A String&quot;, # The simplest way to interpret a result.
235 #
236 # Required
237 &quot;failureDetail&quot;: { # Details for an outcome with a FAILURE outcome summary. # More information about a FAILURE outcome.
238 #
239 # Returns INVALID_ARGUMENT if this field is set
240 # but the summary is not FAILURE.
241 #
242 # Optional
243 &quot;unableToCrawl&quot;: True or False, # If the robo was unable to crawl the app; perhaps because the app did not
244 # start.
245 &quot;notInstalled&quot;: True or False, # If an app is not installed and thus no test can be run with the app.
246 # This might be caused by trying to run a test on an unsupported platform.
247 &quot;timedOut&quot;: True or False, # If the test overran some time limit, and that is why it failed.
248 &quot;otherNativeCrash&quot;: True or False, # If a native process (including any other than the app) crashed.
249 &quot;crashed&quot;: True or False, # If the failure was severe because the system (app) under test crashed.
250 },
251 &quot;inconclusiveDetail&quot;: { # Details for an outcome with an INCONCLUSIVE outcome summary. # More information about an INCONCLUSIVE outcome.
252 #
253 # Returns INVALID_ARGUMENT if this field is set
254 # but the summary is not INCONCLUSIVE.
255 #
256 # Optional
257 &quot;hasErrorLogs&quot;: True or False, # If results are being provided to the user in certain cases of
258 # infrastructure failures
259 &quot;infrastructureFailure&quot;: True or False, # If the test runner could not determine success or failure because the test
260 # depends on a component other than the system under test which failed.
261 #
262 # For example, a mobile test requires provisioning a device where the test
263 # executes, and that provisioning can fail.
264 &quot;abortedByUser&quot;: True or False, # If the end user aborted the test execution before a pass or fail could be
265 # determined.
266 # For example, the user pressed ctrl-c which sent a kill signal to the test
267 # runner while the test was running.
268 },
269 &quot;successDetail&quot;: { # Details for an outcome with a SUCCESS outcome summary. # More information about a SUCCESS outcome.
270 #
271 # Returns INVALID_ARGUMENT if this field is set
272 # but the summary is not SUCCESS.
273 #
274 # Optional
275 # LINT.IfChange
276 &quot;otherNativeCrash&quot;: True or False, # If a native process other than the app crashed.
277 },
278 &quot;skippedDetail&quot;: { # Details for an outcome with a SKIPPED outcome summary. # More information about a SKIPPED outcome.
279 #
280 # Returns INVALID_ARGUMENT if this field is set
281 # but the summary is not SKIPPED.
282 #
283 # Optional
284 &quot;incompatibleAppVersion&quot;: True or False, # If the App doesn&#x27;t support the specific API level.
285 &quot;incompatibleDevice&quot;: True or False, # If the requested OS version doesn&#x27;t run on the specific device model.
286 &quot;incompatibleArchitecture&quot;: True or False, # If the App doesn&#x27;t run on the specific architecture, for example, x86.
287 },
288 },
289 },
290 &quot;dimensionValue&quot;: [ # Dimension values describing the environment. Dimension values always
291 # consist of &quot;Model&quot;, &quot;Version&quot;, &quot;Locale&quot;, and &quot;Orientation&quot;.
292 #
293 # - In response: always set
294 # - In create request: always set
295 # - In update request: never set
296 {
297 &quot;value&quot;: &quot;A String&quot;,
298 &quot;key&quot;: &quot;A String&quot;,
299 },
300 ],
301 &quot;projectId&quot;: &quot;A String&quot;, # Output only. A Project id.
302 &quot;completionTime&quot;: { # A Timestamp represents a point in time independent of any time zone or local # Output only. The time when the Environment status was set to complete.
303 #
304 # This value will be set automatically when state transitions to
305 # COMPLETE.
306 # calendar, encoded as a count of seconds and fractions of seconds at
307 # nanosecond resolution. The count is relative to an epoch at UTC midnight on
308 # January 1, 1970, in the proleptic Gregorian calendar which extends the
309 # Gregorian calendar backwards to year one.
310 #
311 # All minutes are 60 seconds long. Leap seconds are &quot;smeared&quot; so that no leap
312 # second table is needed for interpretation, using a [24-hour linear
313 # smear](https://developers.google.com/time/smear).
314 #
315 # The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By
316 # restricting to that range, we ensure that we can convert to and from [RFC
317 # 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings.
318 &quot;nanos&quot;: 42, # Non-negative fractions of a second at nanosecond resolution. Negative
319 # second values with fractions must still have non-negative nanos values
320 # that count forward in time. Must be from 0 to 999,999,999
321 # inclusive.
322 &quot;seconds&quot;: &quot;A String&quot;, # Represents seconds of UTC time since Unix epoch
323 # 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to
324 # 9999-12-31T23:59:59Z inclusive.
325 },
326 &quot;shardSummaries&quot;: [ # Output only. Summaries of shards.
327 #
328 # Only one shard will present unless sharding feature is enabled in
329 # TestExecutionService.
330 { # Result summary for a shard in an environment.
331 &quot;runs&quot;: [ # Summaries of the steps belonging to the shard.
332 #
333 # With flaky_test_attempts enabled from TestExecutionService, more than one
334 # run (Step) can present. And the runs will be sorted by multistep_number.
335 { # Lightweight summary of a step within this execution.
336 },
337 ],
338 &quot;shardResult&quot;: { # Merged test result for environment. # Merged result of the shard.
339 #
340 # If the environment has only one step (no reruns or shards), then the merged
341 # result is the same as the step result. If the environment has multiple shards
342 # and/or reruns, then the results of shards and reruns that belong to the same
343 # environment are merged into one environment result.
344 &quot;testSuiteOverviews&quot;: [ # The combined and rolled-up result of each test suite that was run as part
345 # of this environment.
346 #
347 # Combining:
348 # When the test cases from a suite are run in different steps (sharding),
349 # the results are added back together in one overview. (e.g., if shard1 has
350 # 2 failures and shard2 has 1 failure than the overview failure_count = 3).
351 #
352 # Rollup:
353 # When test cases from the same suite are run multiple times (flaky), the
354 # results are combined (e.g., if testcase1.run1 fails, testcase1.run2
355 # passes, and both testcase2.run1 and testcase2.run2 fail then the overview
356 # flaky_count = 1 and failure_count = 1).
357 { # A summary of a test suite result either parsed from XML or uploaded
358 # directly by a user.
359 #
360 # Note: the API related comments are for StepService only. This message is
361 # also being used in ExecutionService in a read only mode for the corresponding
362 # step.
363 &quot;name&quot;: &quot;A String&quot;, # The name of the test suite.
364 #
365 # - In create/response: always set
366 # - In update request: never
367 &quot;elapsedTime&quot;: { # # Elapsed time of test suite.
368 # A Duration represents a signed, fixed-length span of time represented
369 # as a count of seconds and fractions of seconds at nanosecond
370 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
371 # or &quot;month&quot;. It is related to Timestamp in that the difference between
372 # two Timestamp values is a Duration and it can be added or subtracted
373 # from a Timestamp. Range is approximately +-10,000 years.
374 &quot;nanos&quot;: 42, # Signed fractions of a second at nanosecond resolution of the span
375 # of time. Durations less than one second are represented with a 0
376 # `seconds` field and a positive or negative `nanos` field. For durations
377 # of one second or more, a non-zero value for the `nanos` field must be
378 # of the same sign as the `seconds` field. Must be from -999,999,999
379 # to +999,999,999 inclusive.
380 &quot;seconds&quot;: &quot;A String&quot;, # Signed seconds of the span of time. Must be from -315,576,000,000
381 # to +315,576,000,000 inclusive. Note: these bounds are computed from:
382 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
383 },
384 &quot;flakyCount&quot;: 42, # Number of flaky test cases, set by the service by rolling up flaky test
385 # attempts.
386 #
387 # Present only for rollup test suite overview at environment level. A step
388 # cannot have flaky test cases.
389 &quot;errorCount&quot;: 42, # Number of test cases in error, typically set by the service by parsing the
390 # xml_source.
391 #
392 # - In create/response: always set
393 # - In update request: never
394 &quot;totalCount&quot;: 42, # Number of test cases, typically set by the service by parsing the
395 # xml_source.
396 #
397 # - In create/response: always set
398 # - In update request: never
399 &quot;skippedCount&quot;: 42, # Number of test cases not run, typically set by the service by parsing the
400 # xml_source.
401 #
402 # - In create/response: always set
403 # - In update request: never
404 &quot;xmlSource&quot;: { # A reference to a file. # If this test suite was parsed from XML, this is the URI where the original
405 # XML file is stored.
406 #
407 # Note: Multiple test suites can share the same xml_source
408 #
409 # Returns INVALID_ARGUMENT if the uri format is not supported.
410 #
411 # - In create/response: optional
412 # - In update request: never
413 &quot;fileUri&quot;: &quot;A String&quot;, # The URI of a file stored in Google Cloud Storage.
414 #
415 # For example: http://storage.googleapis.com/mybucket/path/to/test.xml
416 # or in gsutil format: gs://mybucket/path/to/test.xml
417 # with version-specific info,
418 # gs://mybucket/path/to/test.xml#1360383693690000
419 #
420 # An INVALID_ARGUMENT error will be returned if the URI format is not
421 # supported.
422 #
423 # - In response: always set
424 # - In create/update request: always set
425 },
426 &quot;failureCount&quot;: 42, # Number of failed test cases, typically set by the service by parsing the
427 # xml_source. May also be set by the user.
428 #
429 # - In create/response: always set
430 # - In update request: never
431 },
432 ],
433 &quot;state&quot;: &quot;A String&quot;, # State of the resource
434 &quot;outcome&quot;: { # Interprets a result so that humans and machines can act on it. # Outcome of the resource
435 &quot;summary&quot;: &quot;A String&quot;, # The simplest way to interpret a result.
436 #
437 # Required
438 &quot;failureDetail&quot;: { # Details for an outcome with a FAILURE outcome summary. # More information about a FAILURE outcome.
439 #
440 # Returns INVALID_ARGUMENT if this field is set
441 # but the summary is not FAILURE.
442 #
443 # Optional
444 &quot;unableToCrawl&quot;: True or False, # If the robo was unable to crawl the app; perhaps because the app did not
445 # start.
446 &quot;notInstalled&quot;: True or False, # If an app is not installed and thus no test can be run with the app.
447 # This might be caused by trying to run a test on an unsupported platform.
448 &quot;timedOut&quot;: True or False, # If the test overran some time limit, and that is why it failed.
449 &quot;otherNativeCrash&quot;: True or False, # If a native process (including any other than the app) crashed.
450 &quot;crashed&quot;: True or False, # If the failure was severe because the system (app) under test crashed.
451 },
452 &quot;inconclusiveDetail&quot;: { # Details for an outcome with an INCONCLUSIVE outcome summary. # More information about an INCONCLUSIVE outcome.
453 #
454 # Returns INVALID_ARGUMENT if this field is set
455 # but the summary is not INCONCLUSIVE.
456 #
457 # Optional
458 &quot;hasErrorLogs&quot;: True or False, # If results are being provided to the user in certain cases of
459 # infrastructure failures
460 &quot;infrastructureFailure&quot;: True or False, # If the test runner could not determine success or failure because the test
461 # depends on a component other than the system under test which failed.
462 #
463 # For example, a mobile test requires provisioning a device where the test
464 # executes, and that provisioning can fail.
465 &quot;abortedByUser&quot;: True or False, # If the end user aborted the test execution before a pass or fail could be
466 # determined.
467 # For example, the user pressed ctrl-c which sent a kill signal to the test
468 # runner while the test was running.
469 },
470 &quot;successDetail&quot;: { # Details for an outcome with a SUCCESS outcome summary. # More information about a SUCCESS outcome.
471 #
472 # Returns INVALID_ARGUMENT if this field is set
473 # but the summary is not SUCCESS.
474 #
475 # Optional
476 # LINT.IfChange
477 &quot;otherNativeCrash&quot;: True or False, # If a native process other than the app crashed.
478 },
479 &quot;skippedDetail&quot;: { # Details for an outcome with a SKIPPED outcome summary. # More information about a SKIPPED outcome.
480 #
481 # Returns INVALID_ARGUMENT if this field is set
482 # but the summary is not SKIPPED.
483 #
484 # Optional
485 &quot;incompatibleAppVersion&quot;: True or False, # If the App doesn&#x27;t support the specific API level.
486 &quot;incompatibleDevice&quot;: True or False, # If the requested OS version doesn&#x27;t run on the specific device model.
487 &quot;incompatibleArchitecture&quot;: True or False, # If the App doesn&#x27;t run on the specific architecture, for example, x86.
488 },
489 },
490 },
491 },
492 ],
493 &quot;executionId&quot;: &quot;A String&quot;, # Output only. An Execution id.
494 &quot;resultsStorage&quot;: { # The storage for test results. # The location where output files are stored in the user bucket.
495 &quot;resultsStoragePath&quot;: { # A reference to a file. # The root directory for test results.
496 &quot;fileUri&quot;: &quot;A String&quot;, # The URI of a file stored in Google Cloud Storage.
497 #
498 # For example: http://storage.googleapis.com/mybucket/path/to/test.xml
499 # or in gsutil format: gs://mybucket/path/to/test.xml
500 # with version-specific info,
501 # gs://mybucket/path/to/test.xml#1360383693690000
502 #
503 # An INVALID_ARGUMENT error will be returned if the URI format is not
504 # supported.
505 #
506 # - In response: always set
507 # - In create/update request: always set
508 },
509 &quot;xunitXmlFile&quot;: { # A reference to a file. # The path to the Xunit XML file.
510 &quot;fileUri&quot;: &quot;A String&quot;, # The URI of a file stored in Google Cloud Storage.
511 #
512 # For example: http://storage.googleapis.com/mybucket/path/to/test.xml
513 # or in gsutil format: gs://mybucket/path/to/test.xml
514 # with version-specific info,
515 # gs://mybucket/path/to/test.xml#1360383693690000
516 #
517 # An INVALID_ARGUMENT error will be returned if the URI format is not
518 # supported.
519 #
520 # - In response: always set
521 # - In create/update request: always set
522 },
523 },
524 &quot;displayName&quot;: &quot;A String&quot;, # A short human-readable name to display in the UI.
525 # Maximum of 100 characters.
526 # For example: Nexus 5, API 27.
527 &quot;historyId&quot;: &quot;A String&quot;, # Output only. A History id.
528 &quot;environmentId&quot;: &quot;A String&quot;, # Output only. An Environment id.
529 }</pre>
530</div>
531
532<div class="method">
533 <code class="details" id="list">list(projectId, historyId, executionId, pageToken=None, pageSize=None, x__xgafv=None)</code>
534 <pre>Lists Environments for a given Execution.
535
536The Environments are sorted by display name.
537
538May return any of the following canonical error codes:
539
540- PERMISSION_DENIED - if the user is not authorized to read project
541- INVALID_ARGUMENT - if the request is malformed
542- NOT_FOUND - if the containing Execution does not exist
543
544Args:
545 projectId: string, Required. A Project id. (required)
546 historyId: string, Required. A History id. (required)
547 executionId: string, Required. An Execution id. (required)
548 pageToken: string, A continuation token to resume the query at the next item.
549 pageSize: integer, The maximum number of Environments to fetch.
550
551Default value: 25. The server will use this default if the field is not set
552or has a value of 0.
553 x__xgafv: string, V1 error format.
554 Allowed values
555 1 - v1 error format
556 2 - v2 error format
557
558Returns:
559 An object of the form:
560
561 { # Response message for EnvironmentService.ListEnvironments.
562 &quot;executionId&quot;: &quot;A String&quot;, # A Execution id
563 #
564 # Always set.
565 &quot;nextPageToken&quot;: &quot;A String&quot;, # A continuation token to resume the query at the next item.
566 #
567 # Will only be set if there are more Environments to fetch.
568 &quot;environments&quot;: [ # Environments.
569 #
570 # Always set.
571 { # An Environment represents the set of test runs (Steps) from the parent
572 # Execution that are configured with the same set of dimensions (Model,
573 # Version, Locale, and Orientation). Multiple such runs occur particularly
574 # because of features like sharding (splitting up a test suite to run in
575 # parallel across devices) and reruns (running a test multiple times to check
576 # for different outcomes).
577 &quot;creationTime&quot;: { # A Timestamp represents a point in time independent of any time zone or local # Output only. The time when the Environment was created.
578 # calendar, encoded as a count of seconds and fractions of seconds at
579 # nanosecond resolution. The count is relative to an epoch at UTC midnight on
580 # January 1, 1970, in the proleptic Gregorian calendar which extends the
581 # Gregorian calendar backwards to year one.
582 #
583 # All minutes are 60 seconds long. Leap seconds are &quot;smeared&quot; so that no leap
584 # second table is needed for interpretation, using a [24-hour linear
585 # smear](https://developers.google.com/time/smear).
586 #
587 # The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By
588 # restricting to that range, we ensure that we can convert to and from [RFC
589 # 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings.
590 &quot;nanos&quot;: 42, # Non-negative fractions of a second at nanosecond resolution. Negative
591 # second values with fractions must still have non-negative nanos values
592 # that count forward in time. Must be from 0 to 999,999,999
593 # inclusive.
594 &quot;seconds&quot;: &quot;A String&quot;, # Represents seconds of UTC time since Unix epoch
595 # 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to
596 # 9999-12-31T23:59:59Z inclusive.
597 },
598 &quot;environmentResult&quot;: { # Merged test result for environment. # Merged result of the environment.
599 #
600 # If the environment has only one step (no reruns or shards), then the merged
601 # result is the same as the step result. If the environment has multiple shards
602 # and/or reruns, then the results of shards and reruns that belong to the same
603 # environment are merged into one environment result.
604 &quot;testSuiteOverviews&quot;: [ # The combined and rolled-up result of each test suite that was run as part
605 # of this environment.
606 #
607 # Combining:
608 # When the test cases from a suite are run in different steps (sharding),
609 # the results are added back together in one overview. (e.g., if shard1 has
610 # 2 failures and shard2 has 1 failure than the overview failure_count = 3).
611 #
612 # Rollup:
613 # When test cases from the same suite are run multiple times (flaky), the
614 # results are combined (e.g., if testcase1.run1 fails, testcase1.run2
615 # passes, and both testcase2.run1 and testcase2.run2 fail then the overview
616 # flaky_count = 1 and failure_count = 1).
617 { # A summary of a test suite result either parsed from XML or uploaded
618 # directly by a user.
619 #
620 # Note: the API related comments are for StepService only. This message is
621 # also being used in ExecutionService in a read only mode for the corresponding
622 # step.
623 &quot;name&quot;: &quot;A String&quot;, # The name of the test suite.
624 #
625 # - In create/response: always set
626 # - In update request: never
627 &quot;elapsedTime&quot;: { # # Elapsed time of test suite.
628 # A Duration represents a signed, fixed-length span of time represented
629 # as a count of seconds and fractions of seconds at nanosecond
630 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
631 # or &quot;month&quot;. It is related to Timestamp in that the difference between
632 # two Timestamp values is a Duration and it can be added or subtracted
633 # from a Timestamp. Range is approximately +-10,000 years.
634 &quot;nanos&quot;: 42, # Signed fractions of a second at nanosecond resolution of the span
635 # of time. Durations less than one second are represented with a 0
636 # `seconds` field and a positive or negative `nanos` field. For durations
637 # of one second or more, a non-zero value for the `nanos` field must be
638 # of the same sign as the `seconds` field. Must be from -999,999,999
639 # to +999,999,999 inclusive.
640 &quot;seconds&quot;: &quot;A String&quot;, # Signed seconds of the span of time. Must be from -315,576,000,000
641 # to +315,576,000,000 inclusive. Note: these bounds are computed from:
642 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
643 },
644 &quot;flakyCount&quot;: 42, # Number of flaky test cases, set by the service by rolling up flaky test
645 # attempts.
646 #
647 # Present only for rollup test suite overview at environment level. A step
648 # cannot have flaky test cases.
649 &quot;errorCount&quot;: 42, # Number of test cases in error, typically set by the service by parsing the
650 # xml_source.
651 #
652 # - In create/response: always set
653 # - In update request: never
654 &quot;totalCount&quot;: 42, # Number of test cases, typically set by the service by parsing the
655 # xml_source.
656 #
657 # - In create/response: always set
658 # - In update request: never
659 &quot;skippedCount&quot;: 42, # Number of test cases not run, typically set by the service by parsing the
660 # xml_source.
661 #
662 # - In create/response: always set
663 # - In update request: never
664 &quot;xmlSource&quot;: { # A reference to a file. # If this test suite was parsed from XML, this is the URI where the original
665 # XML file is stored.
666 #
667 # Note: Multiple test suites can share the same xml_source
668 #
669 # Returns INVALID_ARGUMENT if the uri format is not supported.
670 #
671 # - In create/response: optional
672 # - In update request: never
673 &quot;fileUri&quot;: &quot;A String&quot;, # The URI of a file stored in Google Cloud Storage.
674 #
675 # For example: http://storage.googleapis.com/mybucket/path/to/test.xml
676 # or in gsutil format: gs://mybucket/path/to/test.xml
677 # with version-specific info,
678 # gs://mybucket/path/to/test.xml#1360383693690000
679 #
680 # An INVALID_ARGUMENT error will be returned if the URI format is not
681 # supported.
682 #
683 # - In response: always set
684 # - In create/update request: always set
685 },
686 &quot;failureCount&quot;: 42, # Number of failed test cases, typically set by the service by parsing the
687 # xml_source. May also be set by the user.
688 #
689 # - In create/response: always set
690 # - In update request: never
691 },
692 ],
693 &quot;state&quot;: &quot;A String&quot;, # State of the resource
694 &quot;outcome&quot;: { # Interprets a result so that humans and machines can act on it. # Outcome of the resource
695 &quot;summary&quot;: &quot;A String&quot;, # The simplest way to interpret a result.
696 #
697 # Required
698 &quot;failureDetail&quot;: { # Details for an outcome with a FAILURE outcome summary. # More information about a FAILURE outcome.
699 #
700 # Returns INVALID_ARGUMENT if this field is set
701 # but the summary is not FAILURE.
702 #
703 # Optional
704 &quot;unableToCrawl&quot;: True or False, # If the robo was unable to crawl the app; perhaps because the app did not
705 # start.
706 &quot;notInstalled&quot;: True or False, # If an app is not installed and thus no test can be run with the app.
707 # This might be caused by trying to run a test on an unsupported platform.
708 &quot;timedOut&quot;: True or False, # If the test overran some time limit, and that is why it failed.
709 &quot;otherNativeCrash&quot;: True or False, # If a native process (including any other than the app) crashed.
710 &quot;crashed&quot;: True or False, # If the failure was severe because the system (app) under test crashed.
711 },
712 &quot;inconclusiveDetail&quot;: { # Details for an outcome with an INCONCLUSIVE outcome summary. # More information about an INCONCLUSIVE outcome.
713 #
714 # Returns INVALID_ARGUMENT if this field is set
715 # but the summary is not INCONCLUSIVE.
716 #
717 # Optional
718 &quot;hasErrorLogs&quot;: True or False, # If results are being provided to the user in certain cases of
719 # infrastructure failures
720 &quot;infrastructureFailure&quot;: True or False, # If the test runner could not determine success or failure because the test
721 # depends on a component other than the system under test which failed.
722 #
723 # For example, a mobile test requires provisioning a device where the test
724 # executes, and that provisioning can fail.
725 &quot;abortedByUser&quot;: True or False, # If the end user aborted the test execution before a pass or fail could be
726 # determined.
727 # For example, the user pressed ctrl-c which sent a kill signal to the test
728 # runner while the test was running.
729 },
730 &quot;successDetail&quot;: { # Details for an outcome with a SUCCESS outcome summary. # More information about a SUCCESS outcome.
731 #
732 # Returns INVALID_ARGUMENT if this field is set
733 # but the summary is not SUCCESS.
734 #
735 # Optional
736 # LINT.IfChange
737 &quot;otherNativeCrash&quot;: True or False, # If a native process other than the app crashed.
738 },
739 &quot;skippedDetail&quot;: { # Details for an outcome with a SKIPPED outcome summary. # More information about a SKIPPED outcome.
740 #
741 # Returns INVALID_ARGUMENT if this field is set
742 # but the summary is not SKIPPED.
743 #
744 # Optional
745 &quot;incompatibleAppVersion&quot;: True or False, # If the App doesn&#x27;t support the specific API level.
746 &quot;incompatibleDevice&quot;: True or False, # If the requested OS version doesn&#x27;t run on the specific device model.
747 &quot;incompatibleArchitecture&quot;: True or False, # If the App doesn&#x27;t run on the specific architecture, for example, x86.
748 },
749 },
750 },
751 &quot;dimensionValue&quot;: [ # Dimension values describing the environment. Dimension values always
752 # consist of &quot;Model&quot;, &quot;Version&quot;, &quot;Locale&quot;, and &quot;Orientation&quot;.
753 #
754 # - In response: always set
755 # - In create request: always set
756 # - In update request: never set
757 {
758 &quot;value&quot;: &quot;A String&quot;,
759 &quot;key&quot;: &quot;A String&quot;,
760 },
761 ],
762 &quot;projectId&quot;: &quot;A String&quot;, # Output only. A Project id.
763 &quot;completionTime&quot;: { # A Timestamp represents a point in time independent of any time zone or local # Output only. The time when the Environment status was set to complete.
764 #
765 # This value will be set automatically when state transitions to
766 # COMPLETE.
767 # calendar, encoded as a count of seconds and fractions of seconds at
768 # nanosecond resolution. The count is relative to an epoch at UTC midnight on
769 # January 1, 1970, in the proleptic Gregorian calendar which extends the
770 # Gregorian calendar backwards to year one.
771 #
772 # All minutes are 60 seconds long. Leap seconds are &quot;smeared&quot; so that no leap
773 # second table is needed for interpretation, using a [24-hour linear
774 # smear](https://developers.google.com/time/smear).
775 #
776 # The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By
777 # restricting to that range, we ensure that we can convert to and from [RFC
778 # 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings.
779 &quot;nanos&quot;: 42, # Non-negative fractions of a second at nanosecond resolution. Negative
780 # second values with fractions must still have non-negative nanos values
781 # that count forward in time. Must be from 0 to 999,999,999
782 # inclusive.
783 &quot;seconds&quot;: &quot;A String&quot;, # Represents seconds of UTC time since Unix epoch
784 # 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to
785 # 9999-12-31T23:59:59Z inclusive.
786 },
787 &quot;shardSummaries&quot;: [ # Output only. Summaries of shards.
788 #
789 # Only one shard will present unless sharding feature is enabled in
790 # TestExecutionService.
791 { # Result summary for a shard in an environment.
792 &quot;runs&quot;: [ # Summaries of the steps belonging to the shard.
793 #
794 # With flaky_test_attempts enabled from TestExecutionService, more than one
795 # run (Step) can present. And the runs will be sorted by multistep_number.
796 { # Lightweight summary of a step within this execution.
797 },
798 ],
799 &quot;shardResult&quot;: { # Merged test result for environment. # Merged result of the shard.
800 #
801 # If the environment has only one step (no reruns or shards), then the merged
802 # result is the same as the step result. If the environment has multiple shards
803 # and/or reruns, then the results of shards and reruns that belong to the same
804 # environment are merged into one environment result.
805 &quot;testSuiteOverviews&quot;: [ # The combined and rolled-up result of each test suite that was run as part
806 # of this environment.
807 #
808 # Combining:
809 # When the test cases from a suite are run in different steps (sharding),
810 # the results are added back together in one overview. (e.g., if shard1 has
811 # 2 failures and shard2 has 1 failure than the overview failure_count = 3).
812 #
813 # Rollup:
814 # When test cases from the same suite are run multiple times (flaky), the
815 # results are combined (e.g., if testcase1.run1 fails, testcase1.run2
816 # passes, and both testcase2.run1 and testcase2.run2 fail then the overview
817 # flaky_count = 1 and failure_count = 1).
818 { # A summary of a test suite result either parsed from XML or uploaded
819 # directly by a user.
820 #
821 # Note: the API related comments are for StepService only. This message is
822 # also being used in ExecutionService in a read only mode for the corresponding
823 # step.
824 &quot;name&quot;: &quot;A String&quot;, # The name of the test suite.
825 #
826 # - In create/response: always set
827 # - In update request: never
828 &quot;elapsedTime&quot;: { # # Elapsed time of test suite.
829 # A Duration represents a signed, fixed-length span of time represented
830 # as a count of seconds and fractions of seconds at nanosecond
831 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
832 # or &quot;month&quot;. It is related to Timestamp in that the difference between
833 # two Timestamp values is a Duration and it can be added or subtracted
834 # from a Timestamp. Range is approximately +-10,000 years.
835 &quot;nanos&quot;: 42, # Signed fractions of a second at nanosecond resolution of the span
836 # of time. Durations less than one second are represented with a 0
837 # `seconds` field and a positive or negative `nanos` field. For durations
838 # of one second or more, a non-zero value for the `nanos` field must be
839 # of the same sign as the `seconds` field. Must be from -999,999,999
840 # to +999,999,999 inclusive.
841 &quot;seconds&quot;: &quot;A String&quot;, # Signed seconds of the span of time. Must be from -315,576,000,000
842 # to +315,576,000,000 inclusive. Note: these bounds are computed from:
843 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
844 },
845 &quot;flakyCount&quot;: 42, # Number of flaky test cases, set by the service by rolling up flaky test
846 # attempts.
847 #
848 # Present only for rollup test suite overview at environment level. A step
849 # cannot have flaky test cases.
850 &quot;errorCount&quot;: 42, # Number of test cases in error, typically set by the service by parsing the
851 # xml_source.
852 #
853 # - In create/response: always set
854 # - In update request: never
855 &quot;totalCount&quot;: 42, # Number of test cases, typically set by the service by parsing the
856 # xml_source.
857 #
858 # - In create/response: always set
859 # - In update request: never
860 &quot;skippedCount&quot;: 42, # Number of test cases not run, typically set by the service by parsing the
861 # xml_source.
862 #
863 # - In create/response: always set
864 # - In update request: never
865 &quot;xmlSource&quot;: { # A reference to a file. # If this test suite was parsed from XML, this is the URI where the original
866 # XML file is stored.
867 #
868 # Note: Multiple test suites can share the same xml_source
869 #
870 # Returns INVALID_ARGUMENT if the uri format is not supported.
871 #
872 # - In create/response: optional
873 # - In update request: never
874 &quot;fileUri&quot;: &quot;A String&quot;, # The URI of a file stored in Google Cloud Storage.
875 #
876 # For example: http://storage.googleapis.com/mybucket/path/to/test.xml
877 # or in gsutil format: gs://mybucket/path/to/test.xml
878 # with version-specific info,
879 # gs://mybucket/path/to/test.xml#1360383693690000
880 #
881 # An INVALID_ARGUMENT error will be returned if the URI format is not
882 # supported.
883 #
884 # - In response: always set
885 # - In create/update request: always set
886 },
887 &quot;failureCount&quot;: 42, # Number of failed test cases, typically set by the service by parsing the
888 # xml_source. May also be set by the user.
889 #
890 # - In create/response: always set
891 # - In update request: never
892 },
893 ],
894 &quot;state&quot;: &quot;A String&quot;, # State of the resource
895 &quot;outcome&quot;: { # Interprets a result so that humans and machines can act on it. # Outcome of the resource
896 &quot;summary&quot;: &quot;A String&quot;, # The simplest way to interpret a result.
897 #
898 # Required
899 &quot;failureDetail&quot;: { # Details for an outcome with a FAILURE outcome summary. # More information about a FAILURE outcome.
900 #
901 # Returns INVALID_ARGUMENT if this field is set
902 # but the summary is not FAILURE.
903 #
904 # Optional
905 &quot;unableToCrawl&quot;: True or False, # If the robo was unable to crawl the app; perhaps because the app did not
906 # start.
907 &quot;notInstalled&quot;: True or False, # If an app is not installed and thus no test can be run with the app.
908 # This might be caused by trying to run a test on an unsupported platform.
909 &quot;timedOut&quot;: True or False, # If the test overran some time limit, and that is why it failed.
910 &quot;otherNativeCrash&quot;: True or False, # If a native process (including any other than the app) crashed.
911 &quot;crashed&quot;: True or False, # If the failure was severe because the system (app) under test crashed.
912 },
913 &quot;inconclusiveDetail&quot;: { # Details for an outcome with an INCONCLUSIVE outcome summary. # More information about an INCONCLUSIVE outcome.
914 #
915 # Returns INVALID_ARGUMENT if this field is set
916 # but the summary is not INCONCLUSIVE.
917 #
918 # Optional
919 &quot;hasErrorLogs&quot;: True or False, # If results are being provided to the user in certain cases of
920 # infrastructure failures
921 &quot;infrastructureFailure&quot;: True or False, # If the test runner could not determine success or failure because the test
922 # depends on a component other than the system under test which failed.
923 #
924 # For example, a mobile test requires provisioning a device where the test
925 # executes, and that provisioning can fail.
926 &quot;abortedByUser&quot;: True or False, # If the end user aborted the test execution before a pass or fail could be
927 # determined.
928 # For example, the user pressed ctrl-c which sent a kill signal to the test
929 # runner while the test was running.
930 },
931 &quot;successDetail&quot;: { # Details for an outcome with a SUCCESS outcome summary. # More information about a SUCCESS outcome.
932 #
933 # Returns INVALID_ARGUMENT if this field is set
934 # but the summary is not SUCCESS.
935 #
936 # Optional
937 # LINT.IfChange
938 &quot;otherNativeCrash&quot;: True or False, # If a native process other than the app crashed.
939 },
940 &quot;skippedDetail&quot;: { # Details for an outcome with a SKIPPED outcome summary. # More information about a SKIPPED outcome.
941 #
942 # Returns INVALID_ARGUMENT if this field is set
943 # but the summary is not SKIPPED.
944 #
945 # Optional
946 &quot;incompatibleAppVersion&quot;: True or False, # If the App doesn&#x27;t support the specific API level.
947 &quot;incompatibleDevice&quot;: True or False, # If the requested OS version doesn&#x27;t run on the specific device model.
948 &quot;incompatibleArchitecture&quot;: True or False, # If the App doesn&#x27;t run on the specific architecture, for example, x86.
949 },
950 },
951 },
952 },
953 ],
954 &quot;executionId&quot;: &quot;A String&quot;, # Output only. An Execution id.
955 &quot;resultsStorage&quot;: { # The storage for test results. # The location where output files are stored in the user bucket.
956 &quot;resultsStoragePath&quot;: { # A reference to a file. # The root directory for test results.
957 &quot;fileUri&quot;: &quot;A String&quot;, # The URI of a file stored in Google Cloud Storage.
958 #
959 # For example: http://storage.googleapis.com/mybucket/path/to/test.xml
960 # or in gsutil format: gs://mybucket/path/to/test.xml
961 # with version-specific info,
962 # gs://mybucket/path/to/test.xml#1360383693690000
963 #
964 # An INVALID_ARGUMENT error will be returned if the URI format is not
965 # supported.
966 #
967 # - In response: always set
968 # - In create/update request: always set
969 },
970 &quot;xunitXmlFile&quot;: { # A reference to a file. # The path to the Xunit XML file.
971 &quot;fileUri&quot;: &quot;A String&quot;, # The URI of a file stored in Google Cloud Storage.
972 #
973 # For example: http://storage.googleapis.com/mybucket/path/to/test.xml
974 # or in gsutil format: gs://mybucket/path/to/test.xml
975 # with version-specific info,
976 # gs://mybucket/path/to/test.xml#1360383693690000
977 #
978 # An INVALID_ARGUMENT error will be returned if the URI format is not
979 # supported.
980 #
981 # - In response: always set
982 # - In create/update request: always set
983 },
984 },
985 &quot;displayName&quot;: &quot;A String&quot;, # A short human-readable name to display in the UI.
986 # Maximum of 100 characters.
987 # For example: Nexus 5, API 27.
988 &quot;historyId&quot;: &quot;A String&quot;, # Output only. A History id.
989 &quot;environmentId&quot;: &quot;A String&quot;, # Output only. An Environment id.
990 },
991 ],
992 &quot;projectId&quot;: &quot;A String&quot;, # A Project id.
993 #
994 # Always set.
995 &quot;historyId&quot;: &quot;A String&quot;, # A History id.
996 #
997 # Always set.
998 }</pre>
999</div>
1000
1001<div class="method">
1002 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
1003 <pre>Retrieves the next page of results.
1004
1005Args:
1006 previous_request: The request for the previous page. (required)
1007 previous_response: The response from the request for the previous page. (required)
1008
1009Returns:
1010 A request object that you can call &#x27;execute()&#x27; on to request the next
1011 page. Returns None if there are no more items in the collection.
1012 </pre>
1013</div>
1014
1015</body></html>