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