| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 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_v1beta3.html">Cloud Tool Results API</a> . <a href="toolresults_v1beta3.perfSampleSeries.html">perfSampleSeries</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| 78 | <code><a href="#create">create(projectId, historyId, executionId, stepId, body=None, x__xgafv=None)</a></code></p> |
| 79 | <p class="firstline">Creates a PerfSampleSeries.</p> |
| 80 | <p class="toc_element"> |
| 81 | <code><a href="#get">get(projectId, historyId, executionId, stepId, sampleSeriesId, x__xgafv=None)</a></code></p> |
| 82 | <p class="firstline">Gets a PerfSampleSeries.</p> |
| 83 | <p class="toc_element"> |
| 84 | <code><a href="#list">list(projectId, historyId, executionId, stepId, filter=None, x__xgafv=None)</a></code></p> |
| 85 | <p class="firstline">Lists PerfSampleSeries for a given Step.</p> |
| 86 | <h3>Method Details</h3> |
| 87 | <div class="method"> |
| 88 | <code class="details" id="create">create(projectId, historyId, executionId, stepId, body=None, x__xgafv=None)</code> |
| 89 | <pre>Creates a PerfSampleSeries. |
| 90 | |
| 91 | May return any of the following error code(s): |
| 92 | - ALREADY_EXISTS - PerfMetricSummary already exists for the given Step |
| 93 | - NOT_FOUND - The containing Step does not exist |
| 94 | |
| 95 | Args: |
| 96 | projectId: string, The cloud project (required) |
| 97 | historyId: string, A tool results history ID. (required) |
| 98 | executionId: string, A tool results execution ID. (required) |
| 99 | stepId: string, A tool results step ID. (required) |
| 100 | body: object, The request body. |
| 101 | The object takes the form of: |
| 102 | |
| 103 | { # Resource representing a collection of performance samples (or data points) |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 104 | "sampleSeriesId": "A String", # A sample series id |
| 105 | # @OutputOnly |
| 106 | "projectId": "A String", # The cloud project |
| 107 | # @OutputOnly |
| 108 | "executionId": "A String", # A tool results execution ID. |
| 109 | # @OutputOnly |
| 110 | "basicPerfSampleSeries": { # Encapsulates the metadata for basic sample series represented by a line chart # Basic series represented by a line chart |
| 111 | "perfMetricType": "A String", |
| 112 | "sampleSeriesLabel": "A String", |
| 113 | "perfUnit": "A String", |
| 114 | }, |
| 115 | "stepId": "A String", # A tool results step ID. |
| 116 | # @OutputOnly |
| 117 | "historyId": "A String", # A tool results history ID. |
| 118 | # @OutputOnly |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 119 | } |
| 120 | |
| 121 | x__xgafv: string, V1 error format. |
| 122 | Allowed values |
| 123 | 1 - v1 error format |
| 124 | 2 - v2 error format |
| 125 | |
| 126 | Returns: |
| 127 | An object of the form: |
| 128 | |
| 129 | { # Resource representing a collection of performance samples (or data points) |
| 130 | "sampleSeriesId": "A String", # A sample series id |
| 131 | # @OutputOnly |
| 132 | "projectId": "A String", # The cloud project |
| 133 | # @OutputOnly |
| 134 | "executionId": "A String", # A tool results execution ID. |
| 135 | # @OutputOnly |
| 136 | "basicPerfSampleSeries": { # Encapsulates the metadata for basic sample series represented by a line chart # Basic series represented by a line chart |
| 137 | "perfMetricType": "A String", |
| 138 | "sampleSeriesLabel": "A String", |
| 139 | "perfUnit": "A String", |
| 140 | }, |
| 141 | "stepId": "A String", # A tool results step ID. |
| 142 | # @OutputOnly |
| 143 | "historyId": "A String", # A tool results history ID. |
| 144 | # @OutputOnly |
| 145 | }</pre> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 146 | </div> |
| 147 | |
| 148 | <div class="method"> |
| 149 | <code class="details" id="get">get(projectId, historyId, executionId, stepId, sampleSeriesId, x__xgafv=None)</code> |
| 150 | <pre>Gets a PerfSampleSeries. |
| 151 | |
| 152 | May return any of the following error code(s): |
| 153 | - NOT_FOUND - The specified PerfSampleSeries does not exist |
| 154 | |
| 155 | Args: |
| 156 | projectId: string, The cloud project (required) |
| 157 | historyId: string, A tool results history ID. (required) |
| 158 | executionId: string, A tool results execution ID. (required) |
| 159 | stepId: string, A tool results step ID. (required) |
| 160 | sampleSeriesId: string, A sample series id (required) |
| 161 | x__xgafv: string, V1 error format. |
| 162 | Allowed values |
| 163 | 1 - v1 error format |
| 164 | 2 - v2 error format |
| 165 | |
| 166 | Returns: |
| 167 | An object of the form: |
| 168 | |
| 169 | { # Resource representing a collection of performance samples (or data points) |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 170 | "sampleSeriesId": "A String", # A sample series id |
| 171 | # @OutputOnly |
| 172 | "projectId": "A String", # The cloud project |
| 173 | # @OutputOnly |
| 174 | "executionId": "A String", # A tool results execution ID. |
| 175 | # @OutputOnly |
| 176 | "basicPerfSampleSeries": { # Encapsulates the metadata for basic sample series represented by a line chart # Basic series represented by a line chart |
| 177 | "perfMetricType": "A String", |
| 178 | "sampleSeriesLabel": "A String", |
| 179 | "perfUnit": "A String", |
| 180 | }, |
| 181 | "stepId": "A String", # A tool results step ID. |
| 182 | # @OutputOnly |
| 183 | "historyId": "A String", # A tool results history ID. |
| 184 | # @OutputOnly |
| 185 | }</pre> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 186 | </div> |
| 187 | |
| 188 | <div class="method"> |
| 189 | <code class="details" id="list">list(projectId, historyId, executionId, stepId, filter=None, x__xgafv=None)</code> |
| 190 | <pre>Lists PerfSampleSeries for a given Step. |
| 191 | |
| 192 | The request provides an optional filter which specifies one or more |
| 193 | PerfMetricsType to include in the result; if none returns all. |
| 194 | The resulting PerfSampleSeries are sorted by ids. |
| 195 | |
| 196 | May return any of the following canonical error codes: |
| 197 | - NOT_FOUND - The containing Step does not exist |
| 198 | |
| 199 | Args: |
| 200 | projectId: string, The cloud project (required) |
| 201 | historyId: string, A tool results history ID. (required) |
| 202 | executionId: string, A tool results execution ID. (required) |
| 203 | stepId: string, A tool results step ID. (required) |
| 204 | filter: string, Specify one or more PerfMetricType values such as CPU to filter the result (repeated) |
| 205 | x__xgafv: string, V1 error format. |
| 206 | Allowed values |
| 207 | 1 - v1 error format |
| 208 | 2 - v2 error format |
| 209 | |
| 210 | Returns: |
| 211 | An object of the form: |
| 212 | |
| 213 | { |
| 214 | "perfSampleSeries": [ # The resulting PerfSampleSeries sorted by id |
| 215 | { # Resource representing a collection of performance samples (or data points) |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 216 | "sampleSeriesId": "A String", # A sample series id |
| 217 | # @OutputOnly |
| 218 | "projectId": "A String", # The cloud project |
| 219 | # @OutputOnly |
| 220 | "executionId": "A String", # A tool results execution ID. |
| 221 | # @OutputOnly |
| 222 | "basicPerfSampleSeries": { # Encapsulates the metadata for basic sample series represented by a line chart # Basic series represented by a line chart |
| 223 | "perfMetricType": "A String", |
| 224 | "sampleSeriesLabel": "A String", |
| 225 | "perfUnit": "A String", |
| 226 | }, |
| 227 | "stepId": "A String", # A tool results step ID. |
| 228 | # @OutputOnly |
| 229 | "historyId": "A String", # A tool results history ID. |
| 230 | # @OutputOnly |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 231 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 232 | ], |
| 233 | }</pre> |
| 234 | </div> |
| 235 | |
| 236 | </body></html> |