Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / c482712935d1c1331e33bd7f9968bd3b2be223bb / . / docs / dyn / toolresults_v1beta3.thumbnails.html
blob: 75c335f2c6ab3364edcb52175ca1fe52aa9285ca [file] [log] [blame]
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1<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.thumbnails.html">thumbnails</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#list">list(projectId, historyId, executionId, stepId, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
79<p class="firstline">Lists thumbnails of images attached to a step.</p>
80<p class="toc_element">
81 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
82<p class="firstline">Retrieves the next page of results.</p>
83<h3>Method Details</h3>
84<div class="method">
85 <code class="details" id="list">list(projectId, historyId, executionId, stepId, pageToken=None, pageSize=None, x__xgafv=None)</code>
86 <pre>Lists thumbnails of images attached to a step.
87
88May return any of the following canonical error codes:
89- PERMISSION_DENIED - if the user is not authorized to read from the
90 project, or from any of the images
91- INVALID_ARGUMENT - if the request is malformed
92- NOT_FOUND - if the step does not exist, or if any of the images
93 do not exist
94
95Args:
96 projectId: string, A Project id.
97
98Required. (required)
99 historyId: string, A History id.
100
101Required. (required)
102 executionId: string, An Execution id.
103
104Required. (required)
105 stepId: string, A Step id.
106
107Required. (required)
108 pageToken: string, A continuation token to resume the query at the next item.
109
110Optional.
111 pageSize: integer, The maximum number of thumbnails to fetch.
112
113Default value: 50. The server will use this default if the field is not set
114or has a value of 0.
115
116Optional.
117 x__xgafv: string, V1 error format.
118 Allowed values
119 1 - v1 error format
120 2 - v2 error format
121
122Returns:
123 An object of the form:
124
125 { # A response containing the thumbnails in a step.
126 &quot;thumbnails&quot;: [ # A list of image data.
127 #
128 # Images are returned in a deterministic order; they are ordered by these
129 # factors, in order of
130 # importance:
131 # * First, by their associated test case. Images without a test case are
132 # considered greater than images with one.
133 # * Second, by their creation time. Images without a creation time are
134 # greater than images with one.
135 # * Third, by the order in which they were added to the step (by calls to
136 # CreateStep or UpdateStep).
137 { # An image, with a link to the main image and a thumbnail.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]138 &quot;thumbnail&quot;: { # A single thumbnail, with its size and format. # The thumbnail.
139 &quot;data&quot;: &quot;A String&quot;, # The thumbnail file itself.
140 #
141 # That is, the bytes here are precisely the bytes that make up the thumbnail
142 # file; they can be served as an image as-is (with the appropriate content
143 # type.)
144 #
145 # Always set.
146 &quot;contentType&quot;: &quot;A String&quot;, # The thumbnail&#x27;s content type, i.e. &quot;image/png&quot;.
147 #
148 # Always set.
149 &quot;heightPx&quot;: 42, # The height of the thumbnail, in pixels.
150 #
151 # Always set.
152 &quot;widthPx&quot;: 42, # The width of the thumbnail, in pixels.
153 #
154 # Always set.
155 },
156 &quot;stepId&quot;: &quot;A String&quot;, # The step to which the image is attached.
157 #
158 # Always set.
159 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # An error explaining why the thumbnail could not be rendered.
160 # different programming environments, including REST APIs and RPC APIs. It is
161 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
162 # three pieces of data: error code, error message, and error details.
163 #
164 # You can find out more about this error model and how to work with it in the
165 # [API Design Guide](https://cloud.google.com/apis/design/errors).
166 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
167 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
168 # user-facing error message should be localized and sent in the
169 # google.rpc.Status.details field, or localized by the client.
170 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
171 # message types for APIs to use.
172 {
173 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
174 },
175 ],
176 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]177 &quot;sourceImage&quot;: { # A reference to a ToolExecution output file. # A reference to the full-size, original image.
178 #
179 # This is the same as the tool_outputs entry for the image under its Step.
180 #
181 # Always set.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]182 &quot;testCase&quot;: { # A reference to a test case. # The test case to which this output file belongs.
183 #
184 # - In response: present if set by create/update request
185 # - In create/update request: optional
186 #
187 # Test case references are canonically ordered lexicographically by these three
188 # factors:
189 # * First, by test_suite_name.
190 # * Second, by class_name.
191 # * Third, by name.
192 &quot;testSuiteName&quot;: &quot;A String&quot;, # The name of the test suite to which this test case belongs.
193 &quot;className&quot;: &quot;A String&quot;, # The name of the class.
194 &quot;name&quot;: &quot;A String&quot;, # The name of the test case.
195 #
196 # Required.
197 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]198 &quot;creationTime&quot;: { # A Timestamp represents a point in time independent of any time zone or local # The creation time of the file.
199 #
200 # - In response: present if set by create/update request
201 # - In create/update request: optional
202 # calendar, encoded as a count of seconds and fractions of seconds at
203 # nanosecond resolution. The count is relative to an epoch at UTC midnight on
204 # January 1, 1970, in the proleptic Gregorian calendar which extends the
205 # Gregorian calendar backwards to year one.
206 #
207 # All minutes are 60 seconds long. Leap seconds are &quot;smeared&quot; so that no leap
208 # second table is needed for interpretation, using a [24-hour linear
209 # smear](https://developers.google.com/time/smear).
210 #
211 # The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By
212 # restricting to that range, we ensure that we can convert to and from [RFC
213 # 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings.
214 &quot;nanos&quot;: 42, # Non-negative fractions of a second at nanosecond resolution. Negative
215 # second values with fractions must still have non-negative nanos values
216 # that count forward in time. Must be from 0 to 999,999,999
217 # inclusive.
218 &quot;seconds&quot;: &quot;A String&quot;, # Represents seconds of UTC time since Unix epoch
219 # 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to
220 # 9999-12-31T23:59:59Z inclusive.
221 },
222 &quot;output&quot;: { # A reference to a file. # A FileReference to an output file.
223 #
224 # - In response: always set
225 # - In create/update request: always set
226 &quot;fileUri&quot;: &quot;A String&quot;, # The URI of a file stored in Google Cloud Storage.
227 #
228 # For example: http://storage.googleapis.com/mybucket/path/to/test.xml
229 # or in gsutil format: gs://mybucket/path/to/test.xml
230 # with version-specific info,
231 # gs://mybucket/path/to/test.xml#1360383693690000
232 #
233 # An INVALID_ARGUMENT error will be returned if the URI format is not
234 # supported.
235 #
236 # - In response: always set
237 # - In create/update request: always set
238 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]239 },
240 },
241 ],
242 &quot;nextPageToken&quot;: &quot;A String&quot;, # A continuation token to resume the query at the next item.
243 #
244 # If set, indicates that there are more thumbnails to read, by calling list
245 # again with this value in the page_token field.
246 }</pre>
247</div>
248
249<div class="method">
250 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
251 <pre>Retrieves the next page of results.
252
253Args:
254 previous_request: The request for the previous page. (required)
255 previous_response: The response from the request for the previous page. (required)
256
257Returns:
258 A request object that you can call &#x27;execute()&#x27; on to request the next
259 page. Returns None if there are no more items in the collection.
260 </pre>
261</div>
262
263</body></html>