1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<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.perfSampleSeries.html">perfSampleSeries</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="toolresults_v1beta3.projects.histories.executions.steps.perfSampleSeries.samples.html">samples()</a></code>
</p>
<p class="firstline">Returns the samples Resource.</p>
<p class="toc_element">
<code><a href="#create">create(projectId, historyId, executionId, stepId, body)</a></code></p>
<p class="firstline">Creates a PerfSampleSeries.</p>
<p class="toc_element">
<code><a href="#get">get(projectId, historyId, executionId, stepId, sampleSeriesId)</a></code></p>
<p class="firstline">Gets a PerfSampleSeries.</p>
<p class="toc_element">
<code><a href="#list">list(projectId, historyId, executionId, stepId, filter=None)</a></code></p>
<p class="firstline">Lists PerfSampleSeries for a given Step.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="create">create(projectId, historyId, executionId, stepId, body)</code>
<pre>Creates a PerfSampleSeries.
May return any of the following error code(s): - ALREADY_EXISTS - PerfMetricSummary already exists for the given Step - NOT_FOUND - The containing Step does not exist
Args:
projectId: string, The cloud project (required)
historyId: string, A tool results history ID. (required)
executionId: string, A tool results execution ID. (required)
stepId: string, A tool results step ID. (required)
body: object, The request body. (required)
The object takes the form of:
{ # Resource representing a collection of performance samples (or data points)
"stepId": "A String", # A tool results step ID.
"projectId": "A String", # The cloud project
"sampleSeriesId": "A String", # A sample series id
"historyId": "A String", # A tool results history ID.
"executionId": "A String", # A tool results execution ID.
"basicPerfSampleSeries": { # Encapsulates the metadata for basic sample series represented by a line chart # Basic series represented by a line chart
"sampleSeriesLabel": "A String",
"perfUnit": "A String",
"perfMetricType": "A String",
},
}
Returns:
An object of the form:
{ # Resource representing a collection of performance samples (or data points)
"stepId": "A String", # A tool results step ID.
"projectId": "A String", # The cloud project
"sampleSeriesId": "A String", # A sample series id
"historyId": "A String", # A tool results history ID.
"executionId": "A String", # A tool results execution ID.
"basicPerfSampleSeries": { # Encapsulates the metadata for basic sample series represented by a line chart # Basic series represented by a line chart
"sampleSeriesLabel": "A String",
"perfUnit": "A String",
"perfMetricType": "A String",
},
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(projectId, historyId, executionId, stepId, sampleSeriesId)</code>
<pre>Gets a PerfSampleSeries.
May return any of the following error code(s): - NOT_FOUND - The specified PerfSampleSeries does not exist
Args:
projectId: string, The cloud project (required)
historyId: string, A tool results history ID. (required)
executionId: string, A tool results execution ID. (required)
stepId: string, A tool results step ID. (required)
sampleSeriesId: string, A sample series id (required)
Returns:
An object of the form:
{ # Resource representing a collection of performance samples (or data points)
"stepId": "A String", # A tool results step ID.
"projectId": "A String", # The cloud project
"sampleSeriesId": "A String", # A sample series id
"historyId": "A String", # A tool results history ID.
"executionId": "A String", # A tool results execution ID.
"basicPerfSampleSeries": { # Encapsulates the metadata for basic sample series represented by a line chart # Basic series represented by a line chart
"sampleSeriesLabel": "A String",
"perfUnit": "A String",
"perfMetricType": "A String",
},
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(projectId, historyId, executionId, stepId, filter=None)</code>
<pre>Lists PerfSampleSeries for a given Step.
The request provides an optional filter which specifies one or more PerfMetricsType to include in the result; if none returns all. The resulting PerfSampleSeries are sorted by ids.
May return any of the following canonical error codes: - NOT_FOUND - The containing Step does not exist
Args:
projectId: string, The cloud project (required)
historyId: string, A tool results history ID. (required)
executionId: string, A tool results execution ID. (required)
stepId: string, A tool results step ID. (required)
filter: string, Specify one or more PerfMetricType values such as CPU to filter the result (repeated)
Allowed values
cpu -
graphics -
memory -
network -
perfMetricTypeUnspecified -
Returns:
An object of the form:
{
"perfSampleSeries": [ # The resulting PerfSampleSeries sorted by id
{ # Resource representing a collection of performance samples (or data points)
"stepId": "A String", # A tool results step ID.
"projectId": "A String", # The cloud project
"sampleSeriesId": "A String", # A sample series id
"historyId": "A String", # A tool results history ID.
"executionId": "A String", # A tool results execution ID.
"basicPerfSampleSeries": { # Encapsulates the metadata for basic sample series represented by a line chart # Basic series represented by a line chart
"sampleSeriesLabel": "A String",
"perfUnit": "A String",
"perfMetricType": "A String",
},
},
],
}</pre>
</div>
</body></html>
|
