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