Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / c482712935d1c1331e33bd7f9968bd3b2be223bb / . / docs / dyn / toolresults_v1beta3.samples.html
blob: 46a8d0a0f62ac316fb936d6401368f84b163cba5 [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.samples.html">samples</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#batchCreate">batchCreate(projectId, historyId, executionId, stepId, sampleSeriesId, body=None, x__xgafv=None)</a></code></p>
79<p class="firstline">Creates a batch of PerfSamples</p>
80<p class="toc_element">
81 <code><a href="#list">list(projectId, historyId, executionId, stepId, sampleSeriesId, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
82<p class="firstline">Lists the Performance Samples of a given Sample Series</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="batchCreate">batchCreate(projectId, historyId, executionId, stepId, sampleSeriesId, body=None, x__xgafv=None)</code>
89 <pre>Creates a batch of PerfSamples
90- a client can submit multiple batches of Perf Samples through repeated
91calls to this method in order to split up a large request payload
92- duplicates and existing timestamp entries will be ignored.
93- the batch operation may partially succeed
94- the set of elements successfully inserted is returned in the response
95(omits items which already existed in the database).
96
97May return any of the following canonical error codes:
98- NOT_FOUND - The containing PerfSampleSeries does not exist
99
100Args:
101 projectId: string, The cloud project (required)
102 historyId: string, A tool results history ID. (required)
103 executionId: string, A tool results execution ID. (required)
104 stepId: string, A tool results step ID. (required)
105 sampleSeriesId: string, A sample series id (required)
106 body: object, The request body.
107 The object takes the form of:
108
109{ # The request must provide up to a maximum of 5000 samples to be
110 # created; a larger sample size will cause an INVALID_ARGUMENT error
111 &quot;perfSamples&quot;: [ # The set of PerfSamples to create should not include existing timestamps
112 { # Resource representing a single performance measure or data point
113 &quot;sampleTime&quot;: { # A Timestamp represents a point in time independent of any time zone or local # Timestamp of collection.
114 # calendar, encoded as a count of seconds and fractions of seconds at
115 # nanosecond resolution. The count is relative to an epoch at UTC midnight on
116 # January 1, 1970, in the proleptic Gregorian calendar which extends the
117 # Gregorian calendar backwards to year one.
118 #
119 # All minutes are 60 seconds long. Leap seconds are &quot;smeared&quot; so that no leap
120 # second table is needed for interpretation, using a [24-hour linear
121 # smear](https://developers.google.com/time/smear).
122 #
123 # The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By
124 # restricting to that range, we ensure that we can convert to and from [RFC
125 # 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings.
126 &quot;nanos&quot;: 42, # Non-negative fractions of a second at nanosecond resolution. Negative
127 # second values with fractions must still have non-negative nanos values
128 # that count forward in time. Must be from 0 to 999,999,999
129 # inclusive.
130 &quot;seconds&quot;: &quot;A String&quot;, # Represents seconds of UTC time since Unix epoch
131 # 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to
132 # 9999-12-31T23:59:59Z inclusive.
133 },
134 &quot;value&quot;: 3.14, # Value observed
135 },
136 ],
137 }
138
139 x__xgafv: string, V1 error format.
140 Allowed values
141 1 - v1 error format
142 2 - v2 error format
143
144Returns:
145 An object of the form:
146
147 {
148 &quot;perfSamples&quot;: [
149 { # Resource representing a single performance measure or data point
150 &quot;sampleTime&quot;: { # A Timestamp represents a point in time independent of any time zone or local # Timestamp of collection.
151 # calendar, encoded as a count of seconds and fractions of seconds at
152 # nanosecond resolution. The count is relative to an epoch at UTC midnight on
153 # January 1, 1970, in the proleptic Gregorian calendar which extends the
154 # Gregorian calendar backwards to year one.
155 #
156 # All minutes are 60 seconds long. Leap seconds are &quot;smeared&quot; so that no leap
157 # second table is needed for interpretation, using a [24-hour linear
158 # smear](https://developers.google.com/time/smear).
159 #
160 # The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By
161 # restricting to that range, we ensure that we can convert to and from [RFC
162 # 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings.
163 &quot;nanos&quot;: 42, # Non-negative fractions of a second at nanosecond resolution. Negative
164 # second values with fractions must still have non-negative nanos values
165 # that count forward in time. Must be from 0 to 999,999,999
166 # inclusive.
167 &quot;seconds&quot;: &quot;A String&quot;, # Represents seconds of UTC time since Unix epoch
168 # 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to
169 # 9999-12-31T23:59:59Z inclusive.
170 },
171 &quot;value&quot;: 3.14, # Value observed
172 },
173 ],
174 }</pre>
175</div>
176
177<div class="method">
178 <code class="details" id="list">list(projectId, historyId, executionId, stepId, sampleSeriesId, pageToken=None, pageSize=None, x__xgafv=None)</code>
179 <pre>Lists the Performance Samples of a given Sample Series
180- The list results are sorted by timestamps ascending
181- The default page size is 500 samples; and maximum size allowed 5000
182- The response token indicates the last returned PerfSample timestamp
183- When the results size exceeds the page size, submit a subsequent request
184including the page token to return the rest of the samples up to the
185page limit
186
187May return any of the following canonical error codes:
188- OUT_OF_RANGE - The specified request page_token is out of valid range
189- NOT_FOUND - The containing PerfSampleSeries does not exist
190
191Args:
192 projectId: string, The cloud project (required)
193 historyId: string, A tool results history ID. (required)
194 executionId: string, A tool results execution ID. (required)
195 stepId: string, A tool results step ID. (required)
196 sampleSeriesId: string, A sample series id (required)
197 pageToken: string, Optional, the next_page_token returned in the previous response
198 pageSize: integer, The default page size is 500 samples, and the maximum size is 5000. If
199the page_size is greater than 5000, the effective page size will be 5000
200 x__xgafv: string, V1 error format.
201 Allowed values
202 1 - v1 error format
203 2 - v2 error format
204
205Returns:
206 An object of the form:
207
208 {
209 &quot;perfSamples&quot;: [
210 { # Resource representing a single performance measure or data point
211 &quot;sampleTime&quot;: { # A Timestamp represents a point in time independent of any time zone or local # Timestamp of collection.
212 # calendar, encoded as a count of seconds and fractions of seconds at
213 # nanosecond resolution. The count is relative to an epoch at UTC midnight on
214 # January 1, 1970, in the proleptic Gregorian calendar which extends the
215 # Gregorian calendar backwards to year one.
216 #
217 # All minutes are 60 seconds long. Leap seconds are &quot;smeared&quot; so that no leap
218 # second table is needed for interpretation, using a [24-hour linear
219 # smear](https://developers.google.com/time/smear).
220 #
221 # The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By
222 # restricting to that range, we ensure that we can convert to and from [RFC
223 # 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings.
224 &quot;nanos&quot;: 42, # Non-negative fractions of a second at nanosecond resolution. Negative
225 # second values with fractions must still have non-negative nanos values
226 # that count forward in time. Must be from 0 to 999,999,999
227 # inclusive.
228 &quot;seconds&quot;: &quot;A String&quot;, # Represents seconds of UTC time since Unix epoch
229 # 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to
230 # 9999-12-31T23:59:59Z inclusive.
231 },
232 &quot;value&quot;: 3.14, # Value observed
233 },
234 ],
235 &quot;nextPageToken&quot;: &quot;A String&quot;, # Optional, returned if result size exceeds the page size specified in the
236 # request (or the default page size, 500, if unspecified). It indicates the
237 # last sample timestamp to be used as page_token in subsequent request
238 }</pre>
239</div>
240
241<div class="method">
242 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
243 <pre>Retrieves the next page of results.
244
245Args:
246 previous_request: The request for the previous page. (required)
247 previous_response: The response from the request for the previous page. (required)
248
249Returns:
250 A request object that you can call &#x27;execute()&#x27; on to request the next
251 page. Returns None if there are no more items in the collection.
252 </pre>
253</div>
254
255</body></html>