blob: 0f370a44ce9b4a598489372e79bc2e9adc59b225 [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.testCases.html">testCases</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#get">get(projectId, historyId, executionId, stepId, testCaseId, x__xgafv=None)</a></code></p>
79<p class="firstline">Gets details of a Test Case for a Step.</p>
80<p class="toc_element">
81 <code><a href="#list">list(projectId, historyId, executionId, stepId, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
82<p class="firstline">Lists Test Cases attached to a Step.</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, stepId, testCaseId, x__xgafv=None)</code>
89 <pre>Gets details of a Test Case for a Step.
90Experimental test cases API. Still in active development.
91
92May return any of the following canonical error codes:
93
94- PERMISSION_DENIED - if the user is not authorized to write to project
95- INVALID_ARGUMENT - if the request is malformed
96- NOT_FOUND - if the containing Test Case does not exist
97
98Args:
99 projectId: string, A Project id.
100
101Required. (required)
102 historyId: string, A History id.
103
104Required. (required)
105 executionId: string, A Execution id
106
107Required. (required)
108 stepId: string, A Step id.
109Note: This step must include a TestExecutionStep.
110
111Required. (required)
112 testCaseId: string, A Test Case id.
113
114Required. (required)
115 x__xgafv: string, V1 error format.
116 Allowed values
117 1 - v1 error format
118 2 - v2 error format
119
120Returns:
121 An object of the form:
122
123 {
124 &quot;status&quot;: &quot;A String&quot;, # The status of the test case.
125 #
126 # Required.
127 &quot;elapsedTime&quot;: { # # The elapsed run time of the test case.
128 #
129 # Required.
130 # A Duration represents a signed, fixed-length span of time represented
131 # as a count of seconds and fractions of seconds at nanosecond
132 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
133 # or &quot;month&quot;. It is related to Timestamp in that the difference between
134 # two Timestamp values is a Duration and it can be added or subtracted
135 # from a Timestamp. Range is approximately +-10,000 years.
136 &quot;nanos&quot;: 42, # Signed fractions of a second at nanosecond resolution of the span
137 # of time. Durations less than one second are represented with a 0
138 # `seconds` field and a positive or negative `nanos` field. For durations
139 # of one second or more, a non-zero value for the `nanos` field must be
140 # of the same sign as the `seconds` field. Must be from -999,999,999
141 # to +999,999,999 inclusive.
142 &quot;seconds&quot;: &quot;A String&quot;, # Signed seconds of the span of time. Must be from -315,576,000,000
143 # to +315,576,000,000 inclusive. Note: these bounds are computed from:
144 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
145 },
146 &quot;testCaseId&quot;: &quot;A String&quot;, # A unique identifier within a Step for this Test Case.
147 &quot;stackTraces&quot;: [ # The stack trace details if the test case failed or encountered an error.
148 #
149 # The maximum size of the stack traces is 100KiB, beyond which the stack
150 # track will be truncated.
151 #
152 # Zero if the test case passed.
153 { # A stacktrace.
154 &quot;exception&quot;: &quot;A String&quot;, # The stack trace message.
155 #
156 # Required
157 },
158 ],
159 &quot;endTime&quot;: { # A Timestamp represents a point in time independent of any time zone or local # The end time of the test case.
160 # calendar, encoded as a count of seconds and fractions of seconds at
161 # nanosecond resolution. The count is relative to an epoch at UTC midnight on
162 # January 1, 1970, in the proleptic Gregorian calendar which extends the
163 # Gregorian calendar backwards to year one.
164 #
165 # All minutes are 60 seconds long. Leap seconds are &quot;smeared&quot; so that no leap
166 # second table is needed for interpretation, using a [24-hour linear
167 # smear](https://developers.google.com/time/smear).
168 #
169 # The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By
170 # restricting to that range, we ensure that we can convert to and from [RFC
171 # 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings.
172 &quot;nanos&quot;: 42, # Non-negative fractions of a second at nanosecond resolution. Negative
173 # second values with fractions must still have non-negative nanos values
174 # that count forward in time. Must be from 0 to 999,999,999
175 # inclusive.
176 &quot;seconds&quot;: &quot;A String&quot;, # Represents seconds of UTC time since Unix epoch
177 # 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to
178 # 9999-12-31T23:59:59Z inclusive.
179 },
180 &quot;skippedMessage&quot;: &quot;A String&quot;, # Why the test case was skipped.
181 #
182 # Present only for skipped test case
183 &quot;toolOutputs&quot;: [ # References to opaque files of any format output by the tool execution.
184 #
185 # @OutputOnly
186 { # A reference to a ToolExecution output file.
187 &quot;creationTime&quot;: { # A Timestamp represents a point in time independent of any time zone or local # The creation time of the file.
188 #
189 # - In response: present if set by create/update request
190 # - In create/update request: optional
191 # calendar, encoded as a count of seconds and fractions of seconds at
192 # nanosecond resolution. The count is relative to an epoch at UTC midnight on
193 # January 1, 1970, in the proleptic Gregorian calendar which extends the
194 # Gregorian calendar backwards to year one.
195 #
196 # All minutes are 60 seconds long. Leap seconds are &quot;smeared&quot; so that no leap
197 # second table is needed for interpretation, using a [24-hour linear
198 # smear](https://developers.google.com/time/smear).
199 #
200 # The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By
201 # restricting to that range, we ensure that we can convert to and from [RFC
202 # 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings.
203 &quot;nanos&quot;: 42, # Non-negative fractions of a second at nanosecond resolution. Negative
204 # second values with fractions must still have non-negative nanos values
205 # that count forward in time. Must be from 0 to 999,999,999
206 # inclusive.
207 &quot;seconds&quot;: &quot;A String&quot;, # Represents seconds of UTC time since Unix epoch
208 # 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to
209 # 9999-12-31T23:59:59Z inclusive.
210 },
211 &quot;output&quot;: { # A reference to a file. # A FileReference to an output file.
212 #
213 # - In response: always set
214 # - In create/update request: always set
215 &quot;fileUri&quot;: &quot;A String&quot;, # The URI of a file stored in Google Cloud Storage.
216 #
217 # For example: http://storage.googleapis.com/mybucket/path/to/test.xml
218 # or in gsutil format: gs://mybucket/path/to/test.xml
219 # with version-specific info,
220 # gs://mybucket/path/to/test.xml#1360383693690000
221 #
222 # An INVALID_ARGUMENT error will be returned if the URI format is not
223 # supported.
224 #
225 # - In response: always set
226 # - In create/update request: always set
227 },
228 &quot;testCase&quot;: { # A reference to a test case. # The test case to which this output file belongs.
229 #
230 # - In response: present if set by create/update request
231 # - In create/update request: optional
232 #
233 # Test case references are canonically ordered lexicographically by these three
234 # factors:
235 # * First, by test_suite_name.
236 # * Second, by class_name.
237 # * Third, by name.
238 &quot;name&quot;: &quot;A String&quot;, # The name of the test case.
239 #
240 # Required.
241 &quot;testSuiteName&quot;: &quot;A String&quot;, # The name of the test suite to which this test case belongs.
242 &quot;className&quot;: &quot;A String&quot;, # The name of the class.
243 },
244 },
245 ],
246 &quot;testCaseReference&quot;: { # A reference to a test case. # Test case reference, e.g. name, class name and test suite name.
247 #
248 # Required.
249 #
250 # Test case references are canonically ordered lexicographically by these three
251 # factors:
252 # * First, by test_suite_name.
253 # * Second, by class_name.
254 # * Third, by name.
255 &quot;name&quot;: &quot;A String&quot;, # The name of the test case.
256 #
257 # Required.
258 &quot;testSuiteName&quot;: &quot;A String&quot;, # The name of the test suite to which this test case belongs.
259 &quot;className&quot;: &quot;A String&quot;, # The name of the class.
260 },
261 &quot;startTime&quot;: { # A Timestamp represents a point in time independent of any time zone or local # The start time of the test case.
262 # calendar, encoded as a count of seconds and fractions of seconds at
263 # nanosecond resolution. The count is relative to an epoch at UTC midnight on
264 # January 1, 1970, in the proleptic Gregorian calendar which extends the
265 # Gregorian calendar backwards to year one.
266 #
267 # All minutes are 60 seconds long. Leap seconds are &quot;smeared&quot; so that no leap
268 # second table is needed for interpretation, using a [24-hour linear
269 # smear](https://developers.google.com/time/smear).
270 #
271 # The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By
272 # restricting to that range, we ensure that we can convert to and from [RFC
273 # 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings.
274 &quot;nanos&quot;: 42, # Non-negative fractions of a second at nanosecond resolution. Negative
275 # second values with fractions must still have non-negative nanos values
276 # that count forward in time. Must be from 0 to 999,999,999
277 # inclusive.
278 &quot;seconds&quot;: &quot;A String&quot;, # Represents seconds of UTC time since Unix epoch
279 # 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to
280 # 9999-12-31T23:59:59Z inclusive.
281 },
282 }</pre>
283</div>
284
285<div class="method">
286 <code class="details" id="list">list(projectId, historyId, executionId, stepId, pageToken=None, pageSize=None, x__xgafv=None)</code>
287 <pre>Lists Test Cases attached to a Step.
288Experimental test cases API. Still in active development.
289
290May return any of the following canonical error codes:
291
292- PERMISSION_DENIED - if the user is not authorized to write to project
293- INVALID_ARGUMENT - if the request is malformed
294- NOT_FOUND - if the containing Step does not exist
295
296Args:
297 projectId: string, A Project id.
298
299Required. (required)
300 historyId: string, A History id.
301
302Required. (required)
303 executionId: string, A Execution id
304
305Required. (required)
306 stepId: string, A Step id.
307Note: This step must include a TestExecutionStep.
308
309Required. (required)
310 pageToken: string, A continuation token to resume the query at the next item.
311
312Optional.
313 pageSize: integer, The maximum number of TestCases to fetch.
314
315Default value: 100. The server will use this default if the field is not
316set or has a value of 0.
317
318Optional.
319 x__xgafv: string, V1 error format.
320 Allowed values
321 1 - v1 error format
322 2 - v2 error format
323
324Returns:
325 An object of the form:
326
327 { # Response message for StepService.ListTestCases.
328 &quot;nextPageToken&quot;: &quot;A String&quot;,
329 &quot;testCases&quot;: [ # List of test cases.
330 {
331 &quot;status&quot;: &quot;A String&quot;, # The status of the test case.
332 #
333 # Required.
334 &quot;elapsedTime&quot;: { # # The elapsed run time of the test case.
335 #
336 # Required.
337 # A Duration represents a signed, fixed-length span of time represented
338 # as a count of seconds and fractions of seconds at nanosecond
339 # resolution. It is independent of any calendar and concepts like &quot;day&quot;
340 # or &quot;month&quot;. It is related to Timestamp in that the difference between
341 # two Timestamp values is a Duration and it can be added or subtracted
342 # from a Timestamp. Range is approximately +-10,000 years.
343 &quot;nanos&quot;: 42, # Signed fractions of a second at nanosecond resolution of the span
344 # of time. Durations less than one second are represented with a 0
345 # `seconds` field and a positive or negative `nanos` field. For durations
346 # of one second or more, a non-zero value for the `nanos` field must be
347 # of the same sign as the `seconds` field. Must be from -999,999,999
348 # to +999,999,999 inclusive.
349 &quot;seconds&quot;: &quot;A String&quot;, # Signed seconds of the span of time. Must be from -315,576,000,000
350 # to +315,576,000,000 inclusive. Note: these bounds are computed from:
351 # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
352 },
353 &quot;testCaseId&quot;: &quot;A String&quot;, # A unique identifier within a Step for this Test Case.
354 &quot;stackTraces&quot;: [ # The stack trace details if the test case failed or encountered an error.
355 #
356 # The maximum size of the stack traces is 100KiB, beyond which the stack
357 # track will be truncated.
358 #
359 # Zero if the test case passed.
360 { # A stacktrace.
361 &quot;exception&quot;: &quot;A String&quot;, # The stack trace message.
362 #
363 # Required
364 },
365 ],
366 &quot;endTime&quot;: { # A Timestamp represents a point in time independent of any time zone or local # The end time of the test case.
367 # calendar, encoded as a count of seconds and fractions of seconds at
368 # nanosecond resolution. The count is relative to an epoch at UTC midnight on
369 # January 1, 1970, in the proleptic Gregorian calendar which extends the
370 # Gregorian calendar backwards to year one.
371 #
372 # All minutes are 60 seconds long. Leap seconds are &quot;smeared&quot; so that no leap
373 # second table is needed for interpretation, using a [24-hour linear
374 # smear](https://developers.google.com/time/smear).
375 #
376 # The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By
377 # restricting to that range, we ensure that we can convert to and from [RFC
378 # 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings.
379 &quot;nanos&quot;: 42, # Non-negative fractions of a second at nanosecond resolution. Negative
380 # second values with fractions must still have non-negative nanos values
381 # that count forward in time. Must be from 0 to 999,999,999
382 # inclusive.
383 &quot;seconds&quot;: &quot;A String&quot;, # Represents seconds of UTC time since Unix epoch
384 # 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to
385 # 9999-12-31T23:59:59Z inclusive.
386 },
387 &quot;skippedMessage&quot;: &quot;A String&quot;, # Why the test case was skipped.
388 #
389 # Present only for skipped test case
390 &quot;toolOutputs&quot;: [ # References to opaque files of any format output by the tool execution.
391 #
392 # @OutputOnly
393 { # A reference to a ToolExecution output file.
394 &quot;creationTime&quot;: { # A Timestamp represents a point in time independent of any time zone or local # The creation time of the file.
395 #
396 # - In response: present if set by create/update request
397 # - In create/update request: optional
398 # calendar, encoded as a count of seconds and fractions of seconds at
399 # nanosecond resolution. The count is relative to an epoch at UTC midnight on
400 # January 1, 1970, in the proleptic Gregorian calendar which extends the
401 # Gregorian calendar backwards to year one.
402 #
403 # All minutes are 60 seconds long. Leap seconds are &quot;smeared&quot; so that no leap
404 # second table is needed for interpretation, using a [24-hour linear
405 # smear](https://developers.google.com/time/smear).
406 #
407 # The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By
408 # restricting to that range, we ensure that we can convert to and from [RFC
409 # 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings.
410 &quot;nanos&quot;: 42, # Non-negative fractions of a second at nanosecond resolution. Negative
411 # second values with fractions must still have non-negative nanos values
412 # that count forward in time. Must be from 0 to 999,999,999
413 # inclusive.
414 &quot;seconds&quot;: &quot;A String&quot;, # Represents seconds of UTC time since Unix epoch
415 # 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to
416 # 9999-12-31T23:59:59Z inclusive.
417 },
418 &quot;output&quot;: { # A reference to a file. # A FileReference to an output file.
419 #
420 # - In response: always set
421 # - In create/update request: always set
422 &quot;fileUri&quot;: &quot;A String&quot;, # The URI of a file stored in Google Cloud Storage.
423 #
424 # For example: http://storage.googleapis.com/mybucket/path/to/test.xml
425 # or in gsutil format: gs://mybucket/path/to/test.xml
426 # with version-specific info,
427 # gs://mybucket/path/to/test.xml#1360383693690000
428 #
429 # An INVALID_ARGUMENT error will be returned if the URI format is not
430 # supported.
431 #
432 # - In response: always set
433 # - In create/update request: always set
434 },
435 &quot;testCase&quot;: { # A reference to a test case. # The test case to which this output file belongs.
436 #
437 # - In response: present if set by create/update request
438 # - In create/update request: optional
439 #
440 # Test case references are canonically ordered lexicographically by these three
441 # factors:
442 # * First, by test_suite_name.
443 # * Second, by class_name.
444 # * Third, by name.
445 &quot;name&quot;: &quot;A String&quot;, # The name of the test case.
446 #
447 # Required.
448 &quot;testSuiteName&quot;: &quot;A String&quot;, # The name of the test suite to which this test case belongs.
449 &quot;className&quot;: &quot;A String&quot;, # The name of the class.
450 },
451 },
452 ],
453 &quot;testCaseReference&quot;: { # A reference to a test case. # Test case reference, e.g. name, class name and test suite name.
454 #
455 # Required.
456 #
457 # Test case references are canonically ordered lexicographically by these three
458 # factors:
459 # * First, by test_suite_name.
460 # * Second, by class_name.
461 # * Third, by name.
462 &quot;name&quot;: &quot;A String&quot;, # The name of the test case.
463 #
464 # Required.
465 &quot;testSuiteName&quot;: &quot;A String&quot;, # The name of the test suite to which this test case belongs.
466 &quot;className&quot;: &quot;A String&quot;, # The name of the class.
467 },
468 &quot;startTime&quot;: { # A Timestamp represents a point in time independent of any time zone or local # The start time of the test case.
469 # calendar, encoded as a count of seconds and fractions of seconds at
470 # nanosecond resolution. The count is relative to an epoch at UTC midnight on
471 # January 1, 1970, in the proleptic Gregorian calendar which extends the
472 # Gregorian calendar backwards to year one.
473 #
474 # All minutes are 60 seconds long. Leap seconds are &quot;smeared&quot; so that no leap
475 # second table is needed for interpretation, using a [24-hour linear
476 # smear](https://developers.google.com/time/smear).
477 #
478 # The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By
479 # restricting to that range, we ensure that we can convert to and from [RFC
480 # 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings.
481 &quot;nanos&quot;: 42, # Non-negative fractions of a second at nanosecond resolution. Negative
482 # second values with fractions must still have non-negative nanos values
483 # that count forward in time. Must be from 0 to 999,999,999
484 # inclusive.
485 &quot;seconds&quot;: &quot;A String&quot;, # Represents seconds of UTC time since Unix epoch
486 # 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to
487 # 9999-12-31T23:59:59Z inclusive.
488 },
489 },
490 ],
491 }</pre>
492</div>
493
494<div class="method">
495 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
496 <pre>Retrieves the next page of results.
497
498Args:
499 previous_request: The request for the previous page. (required)
500 previous_response: The response from the request for the previous page. (required)
501
502Returns:
503 A request object that you can call &#x27;execute()&#x27; on to request the next
504 page. Returns None if there are no more items in the collection.
505 </pre>
506</div>
507
508</body></html>