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.projects.html">projects</a> . <a href="toolresults_v1beta3.projects.histories.html">histories</a> . <a href="toolresults_v1beta3.projects.histories.executions.html">executions</a> . <a href="toolresults_v1beta3.projects.histories.executions.steps.html">steps</a> . <a href="toolresults_v1beta3.projects.histories.executions.steps.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, pageSize=None, pageToken=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, pageSize=None, pageToken=None)</code> 86 <pre>Lists thumbnails of images attached to a step. 87 88May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to read from the project, or from any of the images - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the step does not exist, or if any of the images do not exist 89 90Args: 91 projectId: string, A Project id. 92 93Required. (required) 94 historyId: string, A History id. 95 96Required. (required) 97 executionId: string, An Execution id. 98 99Required. (required) 100 stepId: string, A Step id. 101 102Required. (required) 103 pageSize: integer, The maximum number of thumbnails to fetch. 104 105Default value: 50. The server will use this default if the field is not set or has a value of 0. 106 107Optional. 108 pageToken: string, A continuation token to resume the query at the next item. 109 110Optional. 111 112Returns: 113 An object of the form: 114 115 { # A response containing the thumbnails in a step. 116 "nextPageToken": "A String", # A continuation token to resume the query at the next item. 117 # 118 # If set, indicates that there are more thumbnails to read, by calling list again with this value in the page_token field. 119 "thumbnails": [ # A list of image data. 120 # 121 # Images are returned in a deterministic order; they are ordered by these factors, in order of importance: * First, by their associated test case. Images without a test case are considered greater than images with one. * Second, by their creation time. Images without a creation time are greater than images with one. * Third, by the order in which they were added to the step (by calls to CreateStep or UpdateStep). 122 { # An image, with a link to the main image and a thumbnail. 123 "thumbnail": { # A single thumbnail, with its size and format. # The thumbnail. 124 "data": "A String", # The thumbnail file itself. 125 # 126 # That is, the bytes here are precisely the bytes that make up the thumbnail file; they can be served as an image as-is (with the appropriate content type.) 127 # 128 # Always set. 129 "widthPx": 42, # The width of the thumbnail, in pixels. 130 # 131 # Always set. 132 "contentType": "A String", # The thumbnail's content type, i.e. "image/png". 133 # 134 # Always set. 135 "heightPx": 42, # The height of the thumbnail, in pixels. 136 # 137 # Always set. 138 }, 139 "stepId": "A String", # The step to which the image is attached. 140 # 141 # Always set. 142 "sourceImage": { # A reference to a ToolExecution output file. # A reference to the full-size, original image. 143 # 144 # This is the same as the tool_outputs entry for the image under its Step. 145 # 146 # Always set. 147 "testCase": { # A reference to a test case. # The test case to which this output file belongs. 148 # 149 # - In response: present if set by create/update request - In create/update request: optional 150 # 151 # Test case references are canonically ordered lexicographically by these three factors: * First, by test_suite_name. * Second, by class_name. * Third, by name. 152 "className": "A String", # The name of the class. 153 "testSuiteName": "A String", # The name of the test suite to which this test case belongs. 154 "name": "A String", # The name of the test case. 155 # 156 # Required. 157 }, 158 "output": { # A reference to a file. # A FileReference to an output file. 159 # 160 # - In response: always set - In create/update request: always set 161 "fileUri": "A String", # The URI of a file stored in Google Cloud Storage. 162 # 163 # For example: http://storage.googleapis.com/mybucket/path/to/test.xml or in gsutil format: gs://mybucket/path/to/test.xml with version-specific info, gs://mybucket/path/to/test.xml#1360383693690000 164 # 165 # An INVALID_ARGUMENT error will be returned if the URI format is not supported. 166 # 167 # - In response: always set - In create/update request: always set 168 }, 169 "creationTime": { # A Timestamp represents a point in time independent of any time zone or local calendar, encoded as a count of seconds and fractions of seconds at nanosecond resolution. The count is relative to an epoch at UTC midnight on January 1, 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar backwards to year one. # The creation time of the file. 170 # 171 # - In response: present if set by create/update request - In create/update request: optional 172 # 173 # All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap second table is needed for interpretation, using a [24-hour linear smear](https://developers.google.com/time/smear). 174 # 175 # The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings. 176 # 177 # # Examples 178 # 179 # Example 1: Compute Timestamp from POSIX `time()`. 180 # 181 # Timestamp timestamp; timestamp.set_seconds(time(NULL)); timestamp.set_nanos(0); 182 # 183 # Example 2: Compute Timestamp from POSIX `gettimeofday()`. 184 # 185 # struct timeval tv; gettimeofday(&tv, NULL); 186 # 187 # Timestamp timestamp; timestamp.set_seconds(tv.tv_sec); timestamp.set_nanos(tv.tv_usec * 1000); 188 # 189 # Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`. 190 # 191 # FILETIME ft; GetSystemTimeAsFileTime(&ft); UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime; 192 # 193 # // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z. Timestamp timestamp; timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL)); timestamp.set_nanos((INT32) ((ticks % 10000000) * 100)); 194 # 195 # Example 4: Compute Timestamp from Java `System.currentTimeMillis()`. 196 # 197 # long millis = System.currentTimeMillis(); 198 # 199 # Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000) .setNanos((int) ((millis % 1000) * 1000000)).build(); 200 # 201 # 202 # 203 # Example 5: Compute Timestamp from current time in Python. 204 # 205 # timestamp = Timestamp() timestamp.GetCurrentTime() 206 # 207 # # JSON Mapping 208 # 209 # In JSON format, the Timestamp type is encoded as a string in the [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format. That is, the format is "{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z" where {year} is always expressed using four digits while {month}, {day}, {hour}, {min}, and {sec} are zero-padded to two digits each. The fractional seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution), are optional. The "Z" suffix indicates the timezone ("UTC"); the timezone is required. A proto3 JSON serializer should always use UTC (as indicated by "Z") when printing the Timestamp type and a proto3 JSON parser should be able to accept both UTC and other timezones (as indicated by an offset). 210 # 211 # For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past 01:30 UTC on January 15, 2017. 212 # 213 # In JavaScript, one can convert a Date object to this format using the standard [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString) method. In Python, a standard `datetime.datetime` object can be converted to this format using [`strftime`](https://docs.python.org/2/library/time.html#time.strftime) with the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use the Joda Time's [`ISODateTimeFormat.dateTime()`]( http://www.joda.org/joda-time/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime%2D%2D ) to obtain a formatter capable of generating timestamps in this format. 214 "nanos": 42, # Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive. 215 "seconds": "A String", # Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive. 216 }, 217 }, 218 "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. # An error explaining why the thumbnail could not be rendered. 219 # 220 # You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). 221 "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][] field, or localized by the client. 222 "code": 42, # The status code, which should be an enum value of [google.rpc.Code][]. 223 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 224 { # `Any` contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. 225 # 226 # Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type. 227 # 228 # Example 1: Pack and unpack a message in C++. 229 # 230 # Foo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo)) { ... } 231 # 232 # Example 2: Pack and unpack a message in Java. 233 # 234 # Foo foo = ...; Any any = Any.pack(foo); ... if (any.is(Foo.class)) { foo = any.unpack(Foo.class); } 235 # 236 # Example 3: Pack and unpack a message in Python. 237 # 238 # foo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ... 239 # 240 # Example 4: Pack and unpack a message in Go 241 # 242 # foo := &pb.Foo{...} any, err := ptypes.MarshalAny(foo) ... foo := &pb.Foo{} if err := ptypes.UnmarshalAny(any, foo); err != nil { ... } 243 # 244 # The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z". 245 # 246 # 247 # 248 # JSON ==== The JSON representation of an `Any` value uses the regular representation of the deserialized, embedded message, with an additional field `@type` which contains the type URL. Example: 249 # 250 # package google.profile; message Person { string first_name = 1; string last_name = 2; } 251 # 252 # { "@type": "type.googleapis.com/google.profile.Person", "firstName": , "lastName": } 253 # 254 # If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field `value` which holds the custom JSON in addition to the `@type` field. Example (for message [google.protobuf.Duration][]): 255 # 256 # { "@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" } 257 "typeUrl": "A String", # A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in `path/google.protobuf.Duration`). The name should be in a canonical form (e.g., leading "." is not accepted). 258 # 259 # In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme `http`, `https`, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows: 260 # 261 # * If no scheme is provided, `https` is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.) 262 # 263 # Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. 264 # 265 # Schemes other than `http`, `https` (or the empty scheme) might be used with implementation specific semantics. 266 "value": "A String", # Must be a valid serialized protocol buffer of the above specified type. 267 }, 268 ], 269 }, 270 }, 271 ], 272 }</pre> 273</div> 274 275<div class="method"> 276 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 277 <pre>Retrieves the next page of results. 278 279Args: 280 previous_request: The request for the previous page. (required) 281 previous_response: The response from the request for the previous page. (required) 282 283Returns: 284 A request object that you can call 'execute()' on to request the next 285 page. Returns None if there are no more items in the collection. 286 </pre> 287</div> 288 289</body></html>