OLD | NEW |
1 { | 1 { |
2 "auth": { | 2 "auth": { |
3 "oauth2": { | 3 "oauth2": { |
4 "scopes": { | 4 "scopes": { |
5 "https://www.googleapis.com/auth/cloud-platform": { | 5 "https://www.googleapis.com/auth/cloud-platform": { |
6 "description": "View and manage your data across Google Clou
d Platform services" | 6 "description": "View and manage your data across Google Clou
d Platform services" |
7 } | 7 } |
8 } | 8 } |
9 } | 9 } |
10 }, | 10 }, |
11 "basePath": "", | 11 "basePath": "", |
12 "baseUrl": "https://clouderrorreporting.googleapis.com/", | 12 "baseUrl": "https://clouderrorreporting.googleapis.com/", |
13 "batchPath": "batch", | 13 "batchPath": "batch", |
14 "canonicalName": "Clouderrorreporting", | 14 "canonicalName": "Clouderrorreporting", |
15 "description": "Stackdriver Error Reporting groups and counts similar errors
from cloud services. The Stackdriver Error Reporting API provides a way to repo
rt new errors and read access to error groups and their associated errors.\n", | 15 "description": "Stackdriver Error Reporting groups and counts similar errors
from cloud services. The Stackdriver Error Reporting API provides a way to repo
rt new errors and read access to error groups and their associated errors.\n", |
16 "discoveryVersion": "v1", | 16 "discoveryVersion": "v1", |
17 "documentationLink": "https://cloud.google.com/error-reporting/", | 17 "documentationLink": "https://cloud.google.com/error-reporting/", |
18 "icons": { | 18 "icons": { |
19 "x16": "http://www.google.com/images/icons/product/search-16.gif", | 19 "x16": "http://www.google.com/images/icons/product/search-16.gif", |
20 "x32": "http://www.google.com/images/icons/product/search-32.gif" | 20 "x32": "http://www.google.com/images/icons/product/search-32.gif" |
21 }, | 21 }, |
22 "id": "clouderrorreporting:v1beta1", | 22 "id": "clouderrorreporting:v1beta1", |
23 "kind": "discovery#restDescription", | 23 "kind": "discovery#restDescription", |
24 "name": "clouderrorreporting", | 24 "name": "clouderrorreporting", |
25 "ownerDomain": "google.com", | 25 "ownerDomain": "google.com", |
26 "ownerName": "Google", | 26 "ownerName": "Google", |
27 "parameters": { | 27 "parameters": { |
28 "access_token": { | 28 "bearer_token": { |
29 "description": "OAuth access token.", | 29 "description": "OAuth bearer token.", |
| 30 "location": "query", |
| 31 "type": "string" |
| 32 }, |
| 33 "oauth_token": { |
| 34 "description": "OAuth 2.0 token for the current user.", |
| 35 "location": "query", |
| 36 "type": "string" |
| 37 }, |
| 38 "upload_protocol": { |
| 39 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", |
30 "location": "query", | 40 "location": "query", |
31 "type": "string" | 41 "type": "string" |
32 }, | 42 }, |
33 "prettyPrint": { | 43 "prettyPrint": { |
34 "default": "true", | 44 "default": "true", |
35 "description": "Returns response with indentations and line breaks."
, | 45 "description": "Returns response with indentations and line breaks."
, |
36 "location": "query", | 46 "location": "query", |
37 "type": "boolean" | 47 "type": "boolean" |
38 }, | 48 }, |
39 "key": { | 49 "uploadType": { |
40 "description": "API key. Your API key identifies your project and pr
ovides you with API access, quota, and reports. Required unless you provide an O
Auth 2.0 token.", | 50 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", |
41 "location": "query", | 51 "location": "query", |
42 "type": "string" | 52 "type": "string" |
43 }, | 53 }, |
44 "quotaUser": { | |
45 "description": "Available to use for quota purposes for server-side
applications. Can be any arbitrary string assigned to a user, but should not exc
eed 40 characters.", | |
46 "location": "query", | |
47 "type": "string" | |
48 }, | |
49 "pp": { | |
50 "default": "true", | |
51 "description": "Pretty-print response.", | |
52 "location": "query", | |
53 "type": "boolean" | |
54 }, | |
55 "fields": { | 54 "fields": { |
56 "description": "Selector specifying which fields to include in a par
tial response.", | 55 "description": "Selector specifying which fields to include in a par
tial response.", |
57 "location": "query", | 56 "location": "query", |
58 "type": "string" | 57 "type": "string" |
59 }, | 58 }, |
60 "alt": { | 59 "callback": { |
61 "default": "json", | 60 "description": "JSONP", |
62 "description": "Data format for response.", | |
63 "enum": [ | |
64 "json", | |
65 "media", | |
66 "proto" | |
67 ], | |
68 "enumDescriptions": [ | |
69 "Responses with Content-Type of application/json", | |
70 "Media download with context-dependent Content-Type", | |
71 "Responses with Content-Type of application/x-protobuf" | |
72 ], | |
73 "location": "query", | 61 "location": "query", |
74 "type": "string" | 62 "type": "string" |
75 }, | 63 }, |
76 "$.xgafv": { | 64 "$.xgafv": { |
77 "description": "V1 error format.", | 65 "description": "V1 error format.", |
78 "enum": [ | 66 "enum": [ |
79 "1", | 67 "1", |
80 "2" | 68 "2" |
81 ], | 69 ], |
82 "enumDescriptions": [ | 70 "enumDescriptions": [ |
83 "v1 error format", | 71 "v1 error format", |
84 "v2 error format" | 72 "v2 error format" |
85 ], | 73 ], |
86 "location": "query", | 74 "location": "query", |
87 "type": "string" | 75 "type": "string" |
88 }, | 76 }, |
89 "callback": { | 77 "alt": { |
90 "description": "JSONP", | 78 "default": "json", |
| 79 "description": "Data format for response.", |
| 80 "enum": [ |
| 81 "json", |
| 82 "media", |
| 83 "proto" |
| 84 ], |
| 85 "enumDescriptions": [ |
| 86 "Responses with Content-Type of application/json", |
| 87 "Media download with context-dependent Content-Type", |
| 88 "Responses with Content-Type of application/x-protobuf" |
| 89 ], |
91 "location": "query", | 90 "location": "query", |
92 "type": "string" | 91 "type": "string" |
93 }, | 92 }, |
94 "oauth_token": { | 93 "key": { |
95 "description": "OAuth 2.0 token for the current user.", | 94 "description": "API key. Your API key identifies your project and pr
ovides you with API access, quota, and reports. Required unless you provide an O
Auth 2.0 token.", |
96 "location": "query", | 95 "location": "query", |
97 "type": "string" | 96 "type": "string" |
98 }, | 97 }, |
99 "uploadType": { | 98 "access_token": { |
100 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", | 99 "description": "OAuth access token.", |
101 "location": "query", | 100 "location": "query", |
102 "type": "string" | 101 "type": "string" |
103 }, | 102 }, |
104 "bearer_token": { | 103 "quotaUser": { |
105 "description": "OAuth bearer token.", | 104 "description": "Available to use for quota purposes for server-side
applications. Can be any arbitrary string assigned to a user, but should not exc
eed 40 characters.", |
106 "location": "query", | 105 "location": "query", |
107 "type": "string" | 106 "type": "string" |
108 }, | 107 }, |
109 "upload_protocol": { | 108 "pp": { |
110 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", | 109 "default": "true", |
| 110 "description": "Pretty-print response.", |
111 "location": "query", | 111 "location": "query", |
112 "type": "string" | 112 "type": "boolean" |
113 } | 113 } |
114 }, | 114 }, |
115 "protocol": "rest", | 115 "protocol": "rest", |
116 "resources": { | 116 "resources": { |
117 "projects": { | 117 "projects": { |
118 "methods": { | 118 "methods": { |
119 "deleteEvents": { | 119 "deleteEvents": { |
120 "description": "Deletes all error events of a given project.
", | 120 "description": "Deletes all error events of a given project.
", |
121 "httpMethod": "DELETE", | 121 "httpMethod": "DELETE", |
122 "id": "clouderrorreporting.projects.deleteEvents", | 122 "id": "clouderrorreporting.projects.deleteEvents", |
(...skipping 12 matching lines...) Expand all Loading... |
135 "path": "v1beta1/{+projectName}/events", | 135 "path": "v1beta1/{+projectName}/events", |
136 "response": { | 136 "response": { |
137 "$ref": "DeleteEventsResponse" | 137 "$ref": "DeleteEventsResponse" |
138 }, | 138 }, |
139 "scopes": [ | 139 "scopes": [ |
140 "https://www.googleapis.com/auth/cloud-platform" | 140 "https://www.googleapis.com/auth/cloud-platform" |
141 ] | 141 ] |
142 } | 142 } |
143 }, | 143 }, |
144 "resources": { | 144 "resources": { |
145 "events": { | 145 "groups": { |
146 "methods": { | 146 "methods": { |
147 "list": { | 147 "get": { |
148 "description": "Lists the specified events.", | 148 "description": "Get the specified group.", |
149 "httpMethod": "GET", | 149 "httpMethod": "GET", |
150 "id": "clouderrorreporting.projects.events.list", | 150 "id": "clouderrorreporting.projects.groups.get", |
151 "parameterOrder": [ | 151 "parameterOrder": [ |
152 "projectName" | 152 "groupName" |
153 ], | 153 ], |
154 "parameters": { | 154 "parameters": { |
155 "timeRange.period": { | 155 "groupName": { |
156 "description": "Restricts the query to the s
pecified time range.", | 156 "description": "[Required] The group resourc
e name. Written as\n<code>projects/<var>projectID</var>/groups/<var>group_name</
var></code>.\nCall\n<a href=\"/error-reporting/reference/rest/v1beta1/projects.g
roupStats/list\">\n<code>groupStats.list</code></a> to return a list of groups b
elonging to\nthis project.\n\nExample: <code>projects/my-project-123/groups/my-g
roup</code>", |
157 "enum": [ | |
158 "PERIOD_UNSPECIFIED", | |
159 "PERIOD_1_HOUR", | |
160 "PERIOD_6_HOURS", | |
161 "PERIOD_1_DAY", | |
162 "PERIOD_1_WEEK", | |
163 "PERIOD_30_DAYS" | |
164 ], | |
165 "location": "query", | |
166 "type": "string" | |
167 }, | |
168 "serviceFilter.resourceType": { | |
169 "description": "[Optional] The exact value t
o match against\n[`ServiceContext.resource_type`](/error-reporting/reference/res
t/v1beta1/ServiceContext#FIELDS.resource_type).", | |
170 "location": "query", | |
171 "type": "string" | |
172 }, | |
173 "projectName": { | |
174 "description": "[Required] The resource name
of the Google Cloud Platform project. Written\nas `projects/` plus the\n[Google
Cloud Platform project\nID](https://support.google.com/cloud/answer/6158840).\n
Example: `projects/my-project-123`.", | |
175 "location": "path", | 157 "location": "path", |
176 "pattern": "^projects/[^/]+$", | 158 "pattern": "^projects/[^/]+/groups/[^/]+$", |
177 "required": true, | 159 "required": true, |
178 "type": "string" | 160 "type": "string" |
179 }, | |
180 "serviceFilter.service": { | |
181 "description": "[Optional] The exact value t
o match against\n[`ServiceContext.service`](/error-reporting/reference/rest/v1be
ta1/ServiceContext#FIELDS.service).", | |
182 "location": "query", | |
183 "type": "string" | |
184 }, | |
185 "groupId": { | |
186 "description": "[Required] The group for whi
ch events shall be returned.", | |
187 "location": "query", | |
188 "type": "string" | |
189 }, | |
190 "serviceFilter.version": { | |
191 "description": "[Optional] The exact value t
o match against\n[`ServiceContext.version`](/error-reporting/reference/rest/v1be
ta1/ServiceContext#FIELDS.version).", | |
192 "location": "query", | |
193 "type": "string" | |
194 }, | |
195 "pageSize": { | |
196 "description": "[Optional] The maximum numbe
r of results to return per response.", | |
197 "format": "int32", | |
198 "location": "query", | |
199 "type": "integer" | |
200 }, | |
201 "pageToken": { | |
202 "description": "[Optional] A `next_page_toke
n` provided by a previous response.", | |
203 "location": "query", | |
204 "type": "string" | |
205 } | 161 } |
206 }, | 162 }, |
207 "path": "v1beta1/{+projectName}/events", | 163 "path": "v1beta1/{+groupName}", |
208 "response": { | 164 "response": { |
209 "$ref": "ListEventsResponse" | 165 "$ref": "ErrorGroup" |
210 }, | 166 }, |
211 "scopes": [ | 167 "scopes": [ |
212 "https://www.googleapis.com/auth/cloud-platform" | 168 "https://www.googleapis.com/auth/cloud-platform" |
213 ] | 169 ] |
214 }, | 170 }, |
215 "report": { | |
216 "description": "Report an individual error event.\n\
nThis endpoint accepts <strong>either</strong> an OAuth token,\n<strong>or</stro
ng> an\n<a href=\"https://support.google.com/cloud/answer/6158862\">API key</a>\
nfor authentication. To use an API key, append it to the URL as the value of\na
`key` parameter. For example:\n<pre>POST https://clouderrorreporting.googleapis.
com/v1beta1/projects/example-project/events:report?key=123ABC456</pre>", | |
217 "httpMethod": "POST", | |
218 "id": "clouderrorreporting.projects.events.report", | |
219 "parameterOrder": [ | |
220 "projectName" | |
221 ], | |
222 "parameters": { | |
223 "projectName": { | |
224 "description": "[Required] The resource name
of the Google Cloud Platform project. Written\nas `projects/` plus the\n[Google
Cloud Platform project ID](https://support.google.com/cloud/answer/6158840).\nE
xample: `projects/my-project-123`.", | |
225 "location": "path", | |
226 "pattern": "^projects/[^/]+$", | |
227 "required": true, | |
228 "type": "string" | |
229 } | |
230 }, | |
231 "path": "v1beta1/{+projectName}/events:report", | |
232 "request": { | |
233 "$ref": "ReportedErrorEvent" | |
234 }, | |
235 "response": { | |
236 "$ref": "ReportErrorEventResponse" | |
237 }, | |
238 "scopes": [ | |
239 "https://www.googleapis.com/auth/cloud-platform" | |
240 ] | |
241 } | |
242 } | |
243 }, | |
244 "groups": { | |
245 "methods": { | |
246 "update": { | 171 "update": { |
247 "description": "Replace the data for the specified g
roup.\nFails if the group does not exist.", | 172 "description": "Replace the data for the specified g
roup.\nFails if the group does not exist.", |
248 "httpMethod": "PUT", | 173 "httpMethod": "PUT", |
249 "id": "clouderrorreporting.projects.groups.update", | 174 "id": "clouderrorreporting.projects.groups.update", |
250 "parameterOrder": [ | 175 "parameterOrder": [ |
251 "name" | 176 "name" |
252 ], | 177 ], |
253 "parameters": { | 178 "parameters": { |
254 "name": { | 179 "name": { |
255 "description": "The group resource name.\nEx
ample: <code>projects/my-project-123/groups/my-groupid</code>", | 180 "description": "The group resource name.\nEx
ample: <code>projects/my-project-123/groups/my-groupid</code>", |
256 "location": "path", | 181 "location": "path", |
257 "pattern": "^projects/[^/]+/groups/[^/]+$", | 182 "pattern": "^projects/[^/]+/groups/[^/]+$", |
258 "required": true, | 183 "required": true, |
259 "type": "string" | 184 "type": "string" |
260 } | 185 } |
261 }, | 186 }, |
262 "path": "v1beta1/{+name}", | 187 "path": "v1beta1/{+name}", |
263 "request": { | 188 "request": { |
264 "$ref": "ErrorGroup" | 189 "$ref": "ErrorGroup" |
265 }, | 190 }, |
266 "response": { | 191 "response": { |
267 "$ref": "ErrorGroup" | 192 "$ref": "ErrorGroup" |
268 }, | 193 }, |
269 "scopes": [ | 194 "scopes": [ |
270 "https://www.googleapis.com/auth/cloud-platform" | 195 "https://www.googleapis.com/auth/cloud-platform" |
271 ] | 196 ] |
272 }, | |
273 "get": { | |
274 "description": "Get the specified group.", | |
275 "httpMethod": "GET", | |
276 "id": "clouderrorreporting.projects.groups.get", | |
277 "parameterOrder": [ | |
278 "groupName" | |
279 ], | |
280 "parameters": { | |
281 "groupName": { | |
282 "description": "[Required] The group resourc
e name. Written as\n<code>projects/<var>projectID</var>/groups/<var>group_name</
var></code>.\nCall\n<a href=\"/error-reporting/reference/rest/v1beta1/projects.g
roupStats/list\">\n<code>groupStats.list</code></a> to return a list of groups b
elonging to\nthis project.\n\nExample: <code>projects/my-project-123/groups/my-g
roup</code>", | |
283 "location": "path", | |
284 "pattern": "^projects/[^/]+/groups/[^/]+$", | |
285 "required": true, | |
286 "type": "string" | |
287 } | |
288 }, | |
289 "path": "v1beta1/{+groupName}", | |
290 "response": { | |
291 "$ref": "ErrorGroup" | |
292 }, | |
293 "scopes": [ | |
294 "https://www.googleapis.com/auth/cloud-platform" | |
295 ] | |
296 } | 197 } |
297 } | 198 } |
298 }, | 199 }, |
299 "groupStats": { | 200 "groupStats": { |
300 "methods": { | 201 "methods": { |
301 "list": { | 202 "list": { |
302 "description": "Lists the specified groups.", | 203 "description": "Lists the specified groups.", |
303 "httpMethod": "GET", | 204 "httpMethod": "GET", |
304 "id": "clouderrorreporting.projects.groupStats.list"
, | 205 "id": "clouderrorreporting.projects.groupStats.list"
, |
305 "parameterOrder": [ | 206 "parameterOrder": [ |
306 "projectName" | 207 "projectName" |
307 ], | 208 ], |
308 "parameters": { | 209 "parameters": { |
309 "alignment": { | 210 "pageToken": { |
310 "description": "[Optional] The alignment of
the timed counts to be returned.\nDefault is `ALIGNMENT_EQUAL_AT_END`.", | 211 "description": "[Optional] A `next_page_toke
n` provided by a previous response. To view\nadditional results, pass this token
along with the identical query\nparameters as the first request.", |
311 "enum": [ | |
312 "ERROR_COUNT_ALIGNMENT_UNSPECIFIED", | |
313 "ALIGNMENT_EQUAL_ROUNDED", | |
314 "ALIGNMENT_EQUAL_AT_END" | |
315 ], | |
316 "location": "query", | 212 "location": "query", |
317 "type": "string" | 213 "type": "string" |
318 }, | 214 }, |
319 "timeRange.period": { | 215 "timeRange.period": { |
320 "description": "Restricts the query to the s
pecified time range.", | 216 "description": "Restricts the query to the s
pecified time range.", |
321 "enum": [ | 217 "enum": [ |
322 "PERIOD_UNSPECIFIED", | 218 "PERIOD_UNSPECIFIED", |
323 "PERIOD_1_HOUR", | 219 "PERIOD_1_HOUR", |
324 "PERIOD_6_HOURS", | 220 "PERIOD_6_HOURS", |
325 "PERIOD_1_DAY", | 221 "PERIOD_1_DAY", |
326 "PERIOD_1_WEEK", | 222 "PERIOD_1_WEEK", |
327 "PERIOD_30_DAYS" | 223 "PERIOD_30_DAYS" |
328 ], | 224 ], |
329 "location": "query", | 225 "location": "query", |
330 "type": "string" | 226 "type": "string" |
331 }, | 227 }, |
332 "serviceFilter.resourceType": { | 228 "alignment": { |
333 "description": "[Optional] The exact value t
o match against\n[`ServiceContext.resource_type`](/error-reporting/reference/res
t/v1beta1/ServiceContext#FIELDS.resource_type).", | 229 "description": "[Optional] The alignment of
the timed counts to be returned.\nDefault is `ALIGNMENT_EQUAL_AT_END`.", |
| 230 "enum": [ |
| 231 "ERROR_COUNT_ALIGNMENT_UNSPECIFIED", |
| 232 "ALIGNMENT_EQUAL_ROUNDED", |
| 233 "ALIGNMENT_EQUAL_AT_END" |
| 234 ], |
334 "location": "query", | 235 "location": "query", |
335 "type": "string" | 236 "type": "string" |
336 }, | 237 }, |
337 "projectName": { | 238 "groupId": { |
338 "description": "[Required] The resource name
of the Google Cloud Platform project. Written\nas <code>projects/</code> plus t
he\n<a href=\"https://support.google.com/cloud/answer/6158840\">Google Cloud\nPl
atform project ID</a>.\n\nExample: <code>projects/my-project-123</code>.", | 239 "description": "[Optional] List all <code>Er
rorGroupStats</code> with these IDs.", |
339 "location": "path", | 240 "location": "query", |
340 "pattern": "^projects/[^/]+$", | 241 "repeated": true, |
341 "required": true, | |
342 "type": "string" | 242 "type": "string" |
343 }, | 243 }, |
| 244 "serviceFilter.service": { |
| 245 "description": "[Optional] The exact value t
o match against\n[`ServiceContext.service`](/error-reporting/reference/rest/v1be
ta1/ServiceContext#FIELDS.service).", |
| 246 "location": "query", |
| 247 "type": "string" |
| 248 }, |
| 249 "pageSize": { |
| 250 "description": "[Optional] The maximum numbe
r of results to return per response.\nDefault is 20.", |
| 251 "format": "int32", |
| 252 "location": "query", |
| 253 "type": "integer" |
| 254 }, |
344 "order": { | 255 "order": { |
345 "description": "[Optional] The sort order in
which the results are returned.\nDefault is `COUNT_DESC`.", | 256 "description": "[Optional] The sort order in
which the results are returned.\nDefault is `COUNT_DESC`.", |
346 "enum": [ | 257 "enum": [ |
347 "GROUP_ORDER_UNSPECIFIED", | 258 "GROUP_ORDER_UNSPECIFIED", |
348 "COUNT_DESC", | 259 "COUNT_DESC", |
349 "LAST_SEEN_DESC", | 260 "LAST_SEEN_DESC", |
350 "CREATED_DESC", | 261 "CREATED_DESC", |
351 "AFFECTED_USERS_DESC" | 262 "AFFECTED_USERS_DESC" |
352 ], | 263 ], |
353 "location": "query", | 264 "location": "query", |
354 "type": "string" | 265 "type": "string" |
355 }, | 266 }, |
356 "groupId": { | 267 "serviceFilter.version": { |
357 "description": "[Optional] List all <code>Er
rorGroupStats</code> with these IDs.", | 268 "description": "[Optional] The exact value t
o match against\n[`ServiceContext.version`](/error-reporting/reference/rest/v1be
ta1/ServiceContext#FIELDS.version).", |
358 "location": "query", | |
359 "repeated": true, | |
360 "type": "string" | |
361 }, | |
362 "serviceFilter.service": { | |
363 "description": "[Optional] The exact value t
o match against\n[`ServiceContext.service`](/error-reporting/reference/rest/v1be
ta1/ServiceContext#FIELDS.service).", | |
364 "location": "query", | 269 "location": "query", |
365 "type": "string" | 270 "type": "string" |
366 }, | 271 }, |
367 "alignmentTime": { | 272 "alignmentTime": { |
368 "description": "[Optional] Time where the ti
med counts shall be aligned if rounded\nalignment is chosen. Default is 00:00 UT
C.", | 273 "description": "[Optional] Time where the ti
med counts shall be aligned if rounded\nalignment is chosen. Default is 00:00 UT
C.", |
369 "format": "google-datetime", | 274 "format": "google-datetime", |
370 "location": "query", | 275 "location": "query", |
371 "type": "string" | 276 "type": "string" |
372 }, | 277 }, |
373 "serviceFilter.version": { | 278 "serviceFilter.resourceType": { |
374 "description": "[Optional] The exact value t
o match against\n[`ServiceContext.version`](/error-reporting/reference/rest/v1be
ta1/ServiceContext#FIELDS.version).", | 279 "description": "[Optional] The exact value t
o match against\n[`ServiceContext.resource_type`](/error-reporting/reference/res
t/v1beta1/ServiceContext#FIELDS.resource_type).", |
375 "location": "query", | 280 "location": "query", |
376 "type": "string" | 281 "type": "string" |
377 }, | 282 }, |
378 "pageSize": { | 283 "projectName": { |
379 "description": "[Optional] The maximum numbe
r of results to return per response.\nDefault is 20.", | 284 "description": "[Required] The resource name
of the Google Cloud Platform project. Written\nas <code>projects/</code> plus t
he\n<a href=\"https://support.google.com/cloud/answer/6158840\">Google Cloud\nPl
atform project ID</a>.\n\nExample: <code>projects/my-project-123</code>.", |
380 "format": "int32", | 285 "location": "path", |
381 "location": "query", | 286 "pattern": "^projects/[^/]+$", |
382 "type": "integer" | 287 "required": true, |
| 288 "type": "string" |
383 }, | 289 }, |
384 "timedCountDuration": { | 290 "timedCountDuration": { |
385 "description": "[Optional] The preferred dur
ation for a single returned `TimedCount`.\nIf not set, no timed counts are retur
ned.", | 291 "description": "[Optional] The preferred dur
ation for a single returned `TimedCount`.\nIf not set, no timed counts are retur
ned.", |
386 "format": "google-duration", | 292 "format": "google-duration", |
387 "location": "query", | 293 "location": "query", |
388 "type": "string" | 294 "type": "string" |
389 }, | |
390 "pageToken": { | |
391 "description": "[Optional] A `next_page_toke
n` provided by a previous response. To view\nadditional results, pass this token
along with the identical query\nparameters as the first request.", | |
392 "location": "query", | |
393 "type": "string" | |
394 } | 295 } |
395 }, | 296 }, |
396 "path": "v1beta1/{+projectName}/groupStats", | 297 "path": "v1beta1/{+projectName}/groupStats", |
397 "response": { | 298 "response": { |
398 "$ref": "ListGroupStatsResponse" | 299 "$ref": "ListGroupStatsResponse" |
399 }, | 300 }, |
400 "scopes": [ | 301 "scopes": [ |
401 "https://www.googleapis.com/auth/cloud-platform" | 302 "https://www.googleapis.com/auth/cloud-platform" |
402 ] | 303 ] |
403 } | 304 } |
404 } | 305 } |
| 306 }, |
| 307 "events": { |
| 308 "methods": { |
| 309 "list": { |
| 310 "description": "Lists the specified events.", |
| 311 "httpMethod": "GET", |
| 312 "id": "clouderrorreporting.projects.events.list", |
| 313 "parameterOrder": [ |
| 314 "projectName" |
| 315 ], |
| 316 "parameters": { |
| 317 "serviceFilter.resourceType": { |
| 318 "description": "[Optional] The exact value t
o match against\n[`ServiceContext.resource_type`](/error-reporting/reference/res
t/v1beta1/ServiceContext#FIELDS.resource_type).", |
| 319 "location": "query", |
| 320 "type": "string" |
| 321 }, |
| 322 "timeRange.period": { |
| 323 "description": "Restricts the query to the s
pecified time range.", |
| 324 "enum": [ |
| 325 "PERIOD_UNSPECIFIED", |
| 326 "PERIOD_1_HOUR", |
| 327 "PERIOD_6_HOURS", |
| 328 "PERIOD_1_DAY", |
| 329 "PERIOD_1_WEEK", |
| 330 "PERIOD_30_DAYS" |
| 331 ], |
| 332 "location": "query", |
| 333 "type": "string" |
| 334 }, |
| 335 "projectName": { |
| 336 "description": "[Required] The resource name
of the Google Cloud Platform project. Written\nas `projects/` plus the\n[Google
Cloud Platform project\nID](https://support.google.com/cloud/answer/6158840).\n
Example: `projects/my-project-123`.", |
| 337 "location": "path", |
| 338 "pattern": "^projects/[^/]+$", |
| 339 "required": true, |
| 340 "type": "string" |
| 341 }, |
| 342 "groupId": { |
| 343 "description": "[Required] The group for whi
ch events shall be returned.", |
| 344 "location": "query", |
| 345 "type": "string" |
| 346 }, |
| 347 "pageToken": { |
| 348 "description": "[Optional] A `next_page_toke
n` provided by a previous response.", |
| 349 "location": "query", |
| 350 "type": "string" |
| 351 }, |
| 352 "serviceFilter.service": { |
| 353 "description": "[Optional] The exact value t
o match against\n[`ServiceContext.service`](/error-reporting/reference/rest/v1be
ta1/ServiceContext#FIELDS.service).", |
| 354 "location": "query", |
| 355 "type": "string" |
| 356 }, |
| 357 "pageSize": { |
| 358 "description": "[Optional] The maximum numbe
r of results to return per response.", |
| 359 "format": "int32", |
| 360 "location": "query", |
| 361 "type": "integer" |
| 362 }, |
| 363 "serviceFilter.version": { |
| 364 "description": "[Optional] The exact value t
o match against\n[`ServiceContext.version`](/error-reporting/reference/rest/v1be
ta1/ServiceContext#FIELDS.version).", |
| 365 "location": "query", |
| 366 "type": "string" |
| 367 } |
| 368 }, |
| 369 "path": "v1beta1/{+projectName}/events", |
| 370 "response": { |
| 371 "$ref": "ListEventsResponse" |
| 372 }, |
| 373 "scopes": [ |
| 374 "https://www.googleapis.com/auth/cloud-platform" |
| 375 ] |
| 376 }, |
| 377 "report": { |
| 378 "description": "Report an individual error event.\n\
nThis endpoint accepts <strong>either</strong> an OAuth token,\n<strong>or</stro
ng> an\n<a href=\"https://support.google.com/cloud/answer/6158862\">API key</a>\
nfor authentication. To use an API key, append it to the URL as the value of\na
`key` parameter. For example:\n<pre>POST https://clouderrorreporting.googleapis.
com/v1beta1/projects/example-project/events:report?key=123ABC456</pre>", |
| 379 "httpMethod": "POST", |
| 380 "id": "clouderrorreporting.projects.events.report", |
| 381 "parameterOrder": [ |
| 382 "projectName" |
| 383 ], |
| 384 "parameters": { |
| 385 "projectName": { |
| 386 "description": "[Required] The resource name
of the Google Cloud Platform project. Written\nas `projects/` plus the\n[Google
Cloud Platform project ID](https://support.google.com/cloud/answer/6158840).\nE
xample: `projects/my-project-123`.", |
| 387 "location": "path", |
| 388 "pattern": "^projects/[^/]+$", |
| 389 "required": true, |
| 390 "type": "string" |
| 391 } |
| 392 }, |
| 393 "path": "v1beta1/{+projectName}/events:report", |
| 394 "request": { |
| 395 "$ref": "ReportedErrorEvent" |
| 396 }, |
| 397 "response": { |
| 398 "$ref": "ReportErrorEventResponse" |
| 399 }, |
| 400 "scopes": [ |
| 401 "https://www.googleapis.com/auth/cloud-platform" |
| 402 ] |
| 403 } |
| 404 } |
405 } | 405 } |
406 } | 406 } |
407 } | 407 } |
408 }, | 408 }, |
409 "revision": "20161122", | 409 "revision": "20170113", |
410 "rootUrl": "https://clouderrorreporting.googleapis.com/", | 410 "rootUrl": "https://clouderrorreporting.googleapis.com/", |
411 "schemas": { | 411 "schemas": { |
412 "ReportedErrorEvent": { | 412 "ReportedErrorEvent": { |
413 "description": "An error event which is reported to the Error Report
ing system.", | 413 "description": "An error event which is reported to the Error Report
ing system.", |
414 "id": "ReportedErrorEvent", | 414 "id": "ReportedErrorEvent", |
415 "properties": { | 415 "properties": { |
416 "serviceContext": { | 416 "serviceContext": { |
417 "$ref": "ServiceContext", | 417 "$ref": "ServiceContext", |
418 "description": "[Required] The service context in which this
error has occurred." | 418 "description": "[Required] The service context in which this
error has occurred." |
419 }, | 419 }, |
420 "context": { | |
421 "$ref": "ErrorContext", | |
422 "description": "[Optional] A description of the context in w
hich the error occurred." | |
423 }, | |
424 "eventTime": { | 420 "eventTime": { |
425 "description": "[Optional] Time when the event occurred.\nIf
not provided, the time when the event was received by the\nError Reporting syst
em will be used.", | 421 "description": "[Optional] Time when the event occurred.\nIf
not provided, the time when the event was received by the\nError Reporting syst
em will be used.", |
426 "format": "google-datetime", | 422 "format": "google-datetime", |
427 "type": "string" | 423 "type": "string" |
428 }, | 424 }, |
| 425 "context": { |
| 426 "$ref": "ErrorContext", |
| 427 "description": "[Optional] A description of the context in w
hich the error occurred." |
| 428 }, |
429 "message": { | 429 "message": { |
430 "description": "[Required] A message describing the error. T
he message can contain an\nexception stack in one of the supported programming l
anguages and formats.\nIn that case, the message is parsed and detailed exceptio
n information\nis returned when retrieving the error event again.", | 430 "description": "[Required] The error message.\nIf no `contex
t.reportLocation` is provided, the message must contain a\nheader (typically con
sisting of the exception type name and an error\nmessage) and an exception stack
trace in one of the supported programming\nlanguages and formats.\nSupported la
nguages are Java, Python, JavaScript, Ruby, C#, PHP, and Go.\nSupported stack tr
ace formats are:\n\n* **Java**: Must be the return value of [`Throwable.printSta
ckTrace()`](https://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html#p
rintStackTrace%28%29).\n* **Python**: Must be the return value of [`traceback.fo
rmat_exc()`](https://docs.python.org/2/library/traceback.html#traceback.format_e
xc).\n* **JavaScript**: Must be the value of [`error.stack`](https://github.com/
v8/v8/wiki/Stack-Trace-API)\nas returned by V8.\n* **Ruby**: Must contain frames
returned by [`Exception.backtrace`](https://ruby-doc.org/core-2.2.0/Exception.h
tml#method-i-backtrace).\n* **C#**: Must be the return value of [`Exception.ToSt
ring()`](https://msdn.microsoft.com/en-us/library/system.exception.tostring.aspx
).\n* **PHP**: Must start with `PHP (Notice|Parse error|Fatal error|Warning)`\na
nd contain the result of [`(string)$exception`](http://php.net/manual/en/excepti
on.tostring.php).\n* **Go**: Must be the return value of [`runtime.Stack()`](htt
ps://golang.org/pkg/runtime/debug/#Stack).", |
431 "type": "string" | 431 "type": "string" |
432 } | 432 } |
433 }, | 433 }, |
434 "type": "object" | 434 "type": "object" |
435 }, | 435 }, |
436 "SourceLocation": { | 436 "ErrorContext": { |
437 "description": "Indicates a location in the source code of the servi
ce for which\nerrors are reported.\nThis data should be provided by the applicat
ion when reporting an error,\nunless the error report has been generated automat
ically from Google App\nEngine logs. All fields are optional.", | 437 "description": "A description of the context in which an error occur
red.\nThis data should be provided by the application when reporting an error,\n
unless the\nerror report has been generated automatically from Google App Engine
logs.", |
438 "id": "SourceLocation", | 438 "id": "ErrorContext", |
439 "properties": { | 439 "properties": { |
440 "filePath": { | 440 "httpRequest": { |
441 "description": "The source code filename, which can include
a truncated relative\npath, or a full path from a production machine.", | 441 "$ref": "HttpRequestContext", |
| 442 "description": "The HTTP request which was processed when th
e error was\ntriggered." |
| 443 }, |
| 444 "user": { |
| 445 "description": "The user who caused or was affected by the c
rash.\nThis can be a user ID, an email address, or an arbitrary token that\nuniq
uely identifies the user.\nWhen sending an error report, leave this field empty
if the user was not\nlogged in. In this case the\nError Reporting system will us
e other data, such as remote IP address, to\ndistinguish affected users. See `af
fected_users_count` in\n`ErrorGroupStats`.", |
442 "type": "string" | 446 "type": "string" |
443 }, | 447 }, |
444 "functionName": { | 448 "reportLocation": { |
445 "description": "Human-readable name of a function or method.
\nThe value can include optional context like the class or package name.\nFor ex
ample, `my.package.MyClass.method` in case of Java.", | 449 "$ref": "SourceLocation", |
446 "type": "string" | 450 "description": "The location in the source code where the de
cision was made to\nreport the error, usually the place where it was logged.\nFo
r a logged exception this would be the source line where the\nexception is logge
d, usually close to the place where it was\ncaught. This value is in contrast to
`Exception.cause_location`,\nwhich describes the source line where the exceptio
n was thrown." |
447 }, | |
448 "lineNumber": { | |
449 "description": "1-based. 0 indicates that the line number is
unknown.", | |
450 "format": "int32", | |
451 "type": "integer" | |
452 } | 451 } |
453 }, | 452 }, |
454 "type": "object" | 453 "type": "object" |
| 454 }, |
| 455 "TrackingIssue": { |
| 456 "description": "Information related to tracking the progress on reso
lving the error.", |
| 457 "id": "TrackingIssue", |
| 458 "properties": { |
| 459 "url": { |
| 460 "description": "A URL pointing to a related entry in an issu
e tracking system.\nExample: https://github.com/user/project/issues/4", |
| 461 "type": "string" |
| 462 } |
| 463 }, |
| 464 "type": "object" |
455 }, | 465 }, |
456 "ErrorGroupStats": { | 466 "ErrorGroupStats": { |
457 "description": "Data extracted for a specific group based on certain
filter criteria,\nsuch as a given time period and/or service filter.", | 467 "description": "Data extracted for a specific group based on certain
filter criteria,\nsuch as a given time period and/or service filter.", |
458 "id": "ErrorGroupStats", | 468 "id": "ErrorGroupStats", |
459 "properties": { | 469 "properties": { |
460 "representative": { | 470 "timedCounts": { |
461 "$ref": "ErrorEvent", | 471 "description": "Approximate number of occurrences over time.
\nTimed counts returned by ListGroups are guaranteed to be:\n\n- Inside the requ
ested time interval\n- Non-overlapping, and\n- Ordered by ascending time.", |
462 "description": "An arbitrary event that is chosen as represe
ntative for the whole group.\nThe representative event is intended to be used as
a quick preview for\nthe whole group. Events in the group are usually sufficien
tly similar\nto each other such that showing an arbitrary representative provide
s\ninsight into the characteristics of the group as a whole." | 472 "items": { |
| 473 "$ref": "TimedCount" |
| 474 }, |
| 475 "type": "array" |
463 }, | 476 }, |
464 "numAffectedServices": { | 477 "group": { |
465 "description": "The total number of services with a non-zero
error count for the given\nfilter criteria.", | 478 "$ref": "ErrorGroup", |
466 "format": "int32", | 479 "description": "Group data that is independent of the filter
criteria." |
467 "type": "integer" | |
468 }, | 480 }, |
469 "affectedUsersCount": { | 481 "firstSeenTime": { |
470 "description": "Approximate number of affected users in the
given group that\nmatch the filter criteria.\nUsers are distinguished by data in
the `ErrorContext` of the\nindividual error events, such as their login name or
their remote\nIP address in case of HTTP requests.\nThe number of affected user
s can be zero even if the number of\nerrors is non-zero if no data was provided
from which the\naffected user could be deduced.\nUsers are counted based on data
in the request\ncontext that was provided in the error report. If more users ar
e\nimplicitly affected, such as due to a crash of the whole service,\nthis is no
t reflected here.", | 482 "description": "Approximate first occurrence that was ever s
een for this group\nand which matches the given filter criteria, ignoring the\nt
ime_range that was specified in the request.", |
471 "format": "int64", | 483 "format": "google-datetime", |
472 "type": "string" | 484 "type": "string" |
473 }, | 485 }, |
474 "count": { | 486 "count": { |
475 "description": "Approximate total number of events in the gi
ven group that match\nthe filter criteria.", | 487 "description": "Approximate total number of events in the gi
ven group that match\nthe filter criteria.", |
476 "format": "int64", | 488 "format": "int64", |
477 "type": "string" | 489 "type": "string" |
478 }, | 490 }, |
479 "firstSeenTime": { | |
480 "description": "Approximate first occurrence that was ever s
een for this group\nand which matches the given filter criteria, ignoring the\nt
ime_range that was specified in the request.", | |
481 "format": "google-datetime", | |
482 "type": "string" | |
483 }, | |
484 "lastSeenTime": { | 491 "lastSeenTime": { |
485 "description": "Approximate last occurrence that was ever se
en for this group and\nwhich matches the given filter criteria, ignoring the tim
e_range\nthat was specified in the request.", | 492 "description": "Approximate last occurrence that was ever se
en for this group and\nwhich matches the given filter criteria, ignoring the tim
e_range\nthat was specified in the request.", |
486 "format": "google-datetime", | 493 "format": "google-datetime", |
487 "type": "string" | 494 "type": "string" |
488 }, | 495 }, |
489 "group": { | 496 "affectedUsersCount": { |
490 "$ref": "ErrorGroup", | 497 "description": "Approximate number of affected users in the
given group that\nmatch the filter criteria.\nUsers are distinguished by data in
the `ErrorContext` of the\nindividual error events, such as their login name or
their remote\nIP address in case of HTTP requests.\nThe number of affected user
s can be zero even if the number of\nerrors is non-zero if no data was provided
from which the\naffected user could be deduced.\nUsers are counted based on data
in the request\ncontext that was provided in the error report. If more users ar
e\nimplicitly affected, such as due to a crash of the whole service,\nthis is no
t reflected here.", |
491 "description": "Group data that is independent of the filter
criteria." | 498 "format": "int64", |
| 499 "type": "string" |
492 }, | 500 }, |
493 "affectedServices": { | 501 "affectedServices": { |
494 "description": "Service contexts with a non-zero error count
for the given filter\ncriteria. This list can be truncated if multiple services
are affected.\nRefer to `num_affected_services` for the total count.", | 502 "description": "Service contexts with a non-zero error count
for the given filter\ncriteria. This list can be truncated if multiple services
are affected.\nRefer to `num_affected_services` for the total count.", |
495 "items": { | 503 "items": { |
496 "$ref": "ServiceContext" | 504 "$ref": "ServiceContext" |
497 }, | 505 }, |
498 "type": "array" | 506 "type": "array" |
499 }, | 507 }, |
500 "timedCounts": { | 508 "numAffectedServices": { |
501 "description": "Approximate number of occurrences over time.
\nTimed counts returned by ListGroups are guaranteed to be:\n\n- Inside the requ
ested time interval\n- Non-overlapping, and\n- Ordered by ascending time.", | 509 "description": "The total number of services with a non-zero
error count for the given\nfilter criteria.", |
502 "items": { | 510 "format": "int32", |
503 "$ref": "TimedCount" | 511 "type": "integer" |
504 }, | 512 }, |
505 "type": "array" | 513 "representative": { |
| 514 "$ref": "ErrorEvent", |
| 515 "description": "An arbitrary event that is chosen as represe
ntative for the whole group.\nThe representative event is intended to be used as
a quick preview for\nthe whole group. Events in the group are usually sufficien
tly similar\nto each other such that showing an arbitrary representative provide
s\ninsight into the characteristics of the group as a whole." |
506 } | 516 } |
507 }, | 517 }, |
508 "type": "object" | 518 "type": "object" |
509 }, | 519 }, |
510 "ErrorContext": { | 520 "ListEventsResponse": { |
511 "description": "A description of the context in which an error occur
red.\nThis data should be provided by the application when reporting an error,\n
unless the\nerror report has been generated automatically from Google App Engine
logs.", | 521 "description": "Contains a set of requested error events.", |
512 "id": "ErrorContext", | 522 "id": "ListEventsResponse", |
513 "properties": { | 523 "properties": { |
514 "httpRequest": { | 524 "timeRangeBegin": { |
515 "$ref": "HttpRequestContext", | 525 "description": "The timestamp specifies the start time to wh
ich the request was restricted.", |
516 "description": "The HTTP request which was processed when th
e error was\ntriggered." | 526 "format": "google-datetime", |
| 527 "type": "string" |
517 }, | 528 }, |
518 "reportLocation": { | 529 "errorEvents": { |
519 "$ref": "SourceLocation", | 530 "description": "The error events which match the given reque
st.", |
520 "description": "The location in the source code where the de
cision was made to\nreport the error, usually the place where it was logged.\nFo
r a logged exception this would be the source line where the\nexception is logge
d, usually close to the place where it was\ncaught. This value is in contrast to
`Exception.cause_location`,\nwhich describes the source line where the exceptio
n was thrown." | 531 "items": { |
| 532 "$ref": "ErrorEvent" |
| 533 }, |
| 534 "type": "array" |
521 }, | 535 }, |
522 "user": { | 536 "nextPageToken": { |
523 "description": "The user who caused or was affected by the c
rash.\nThis can be a user ID, an email address, or an arbitrary token that\nuniq
uely identifies the user.\nWhen sending an error report, leave this field empty
if the user was not\nlogged in. In this case the\nError Reporting system will us
e other data, such as remote IP address, to\ndistinguish affected users. See `af
fected_users_count` in\n`ErrorGroupStats`.", | 537 "description": "If non-empty, more results are available.\nP
ass this token, along with the same query parameters as the first\nrequest, to v
iew the next page of results.", |
524 "type": "string" | 538 "type": "string" |
525 } | 539 } |
526 }, | 540 }, |
527 "type": "object" | 541 "type": "object" |
528 }, | 542 }, |
529 "ServiceContext": { | 543 "TimedCount": { |
530 "description": "Describes a running service that sends errors.\nIts
version changes over time and multiple versions can run in parallel.", | 544 "description": "The number of errors in a given time period.\nAll nu
mbers are approximate since the error events are sampled\nbefore counting them."
, |
531 "id": "ServiceContext", | 545 "id": "TimedCount", |
532 "properties": { | 546 "properties": { |
533 "resourceType": { | 547 "endTime": { |
534 "description": "Type of the MonitoredResource. List of possi
ble values:\nhttps://cloud.google.com/monitoring/api/resources\n\nValue is set a
utomatically for incoming errors and must not be set when\nreporting errors.", | 548 "description": "End of the time period to which `count` refe
rs (excluded).", |
| 549 "format": "google-datetime", |
535 "type": "string" | 550 "type": "string" |
536 }, | 551 }, |
537 "service": { | 552 "count": { |
538 "description": "An identifier of the service, such as the na
me of the\nexecutable, job, or Google App Engine service name. This field is exp
ected\nto have a low number of values that are relatively stable over time, as\n
opposed to `version`, which can be changed whenever new code is deployed.\n\nCon
tains the service name for error reports extracted from Google\nApp Engine logs
or `default` if the App Engine default service is used.", | 553 "description": "Approximate number of occurrences in the giv
en time period.", |
| 554 "format": "int64", |
539 "type": "string" | 555 "type": "string" |
540 }, | 556 }, |
541 "version": { | 557 "startTime": { |
542 "description": "Represents the source code version that the
developer provided,\nwhich could represent a version label or a Git SHA-1 hash,
for example.", | 558 "description": "Start of the time period to which `count` re
fers (included).", |
| 559 "format": "google-datetime", |
543 "type": "string" | 560 "type": "string" |
544 } | 561 } |
545 }, | 562 }, |
546 "type": "object" | 563 "type": "object" |
547 }, | 564 }, |
548 "ErrorGroup": { | 565 "ErrorGroup": { |
549 "description": "Description of a group of similar error events.", | 566 "description": "Description of a group of similar error events.", |
550 "id": "ErrorGroup", | 567 "id": "ErrorGroup", |
551 "properties": { | 568 "properties": { |
552 "groupId": { | 569 "groupId": { |
553 "description": "Group IDs are unique for a given project. If
the same kind of error\noccurs in different service contexts, it will receive t
he same group ID.", | 570 "description": "Group IDs are unique for a given project. If
the same kind of error\noccurs in different service contexts, it will receive t
he same group ID.", |
554 "type": "string" | 571 "type": "string" |
555 }, | 572 }, |
556 "name": { | |
557 "description": "The group resource name.\nExample: <code>pro
jects/my-project-123/groups/my-groupid</code>", | |
558 "type": "string" | |
559 }, | |
560 "trackingIssues": { | 573 "trackingIssues": { |
561 "description": "Associated tracking issues.", | 574 "description": "Associated tracking issues.", |
562 "items": { | 575 "items": { |
563 "$ref": "TrackingIssue" | 576 "$ref": "TrackingIssue" |
564 }, | 577 }, |
565 "type": "array" | 578 "type": "array" |
| 579 }, |
| 580 "name": { |
| 581 "description": "The group resource name.\nExample: <code>pro
jects/my-project-123/groups/my-groupid</code>", |
| 582 "type": "string" |
| 583 } |
| 584 }, |
| 585 "type": "object" |
| 586 }, |
| 587 "SourceLocation": { |
| 588 "description": "Indicates a location in the source code of the servi
ce for which\nerrors are reported.\nThis data should be provided by the applicat
ion when reporting an error,\nunless the error report has been generated automat
ically from Google App\nEngine logs. All fields are optional.", |
| 589 "id": "SourceLocation", |
| 590 "properties": { |
| 591 "filePath": { |
| 592 "description": "The source code filename, which can include
a truncated relative\npath, or a full path from a production machine.", |
| 593 "type": "string" |
| 594 }, |
| 595 "lineNumber": { |
| 596 "description": "1-based. 0 indicates that the line number is
unknown.", |
| 597 "format": "int32", |
| 598 "type": "integer" |
| 599 }, |
| 600 "functionName": { |
| 601 "description": "Human-readable name of a function or method.
\nThe value can include optional context like the class or package name.\nFor ex
ample, `my.package.MyClass.method` in case of Java.", |
| 602 "type": "string" |
| 603 } |
| 604 }, |
| 605 "type": "object" |
| 606 }, |
| 607 "ServiceContext": { |
| 608 "description": "Describes a running service that sends errors.\nIts
version changes over time and multiple versions can run in parallel.", |
| 609 "id": "ServiceContext", |
| 610 "properties": { |
| 611 "service": { |
| 612 "description": "An identifier of the service, such as the na
me of the\nexecutable, job, or Google App Engine service name. This field is exp
ected\nto have a low number of values that are relatively stable over time, as\n
opposed to `version`, which can be changed whenever new code is deployed.\n\nCon
tains the service name for error reports extracted from Google\nApp Engine logs
or `default` if the App Engine default service is used.", |
| 613 "type": "string" |
| 614 }, |
| 615 "resourceType": { |
| 616 "description": "Type of the MonitoredResource. List of possi
ble values:\nhttps://cloud.google.com/monitoring/api/resources\n\nValue is set a
utomatically for incoming errors and must not be set when\nreporting errors.", |
| 617 "type": "string" |
| 618 }, |
| 619 "version": { |
| 620 "description": "Represents the source code version that the
developer provided,\nwhich could represent a version label or a Git SHA-1 hash,
for example.", |
| 621 "type": "string" |
566 } | 622 } |
567 }, | 623 }, |
568 "type": "object" | 624 "type": "object" |
569 }, | 625 }, |
570 "ReportErrorEventResponse": { | 626 "ReportErrorEventResponse": { |
571 "description": "Response for reporting an individual error event.\nD
ata may be added to this message in the future.", | 627 "description": "Response for reporting an individual error event.\nD
ata may be added to this message in the future.", |
572 "id": "ReportErrorEventResponse", | 628 "id": "ReportErrorEventResponse", |
573 "properties": {}, | 629 "properties": {}, |
574 "type": "object" | 630 "type": "object" |
575 }, | 631 }, |
576 "TrackingIssue": { | |
577 "description": "Information related to tracking the progress on reso
lving the error.", | |
578 "id": "TrackingIssue", | |
579 "properties": { | |
580 "url": { | |
581 "description": "A URL pointing to a related entry in an issu
e tracking system.\nExample: https://github.com/user/project/issues/4", | |
582 "type": "string" | |
583 } | |
584 }, | |
585 "type": "object" | |
586 }, | |
587 "DeleteEventsResponse": { | |
588 "description": "Response message for deleting error events.", | |
589 "id": "DeleteEventsResponse", | |
590 "properties": {}, | |
591 "type": "object" | |
592 }, | |
593 "ErrorEvent": { | |
594 "description": "An error event which is returned by the Error Report
ing system.", | |
595 "id": "ErrorEvent", | |
596 "properties": { | |
597 "serviceContext": { | |
598 "$ref": "ServiceContext", | |
599 "description": "The `ServiceContext` for which this error wa
s reported." | |
600 }, | |
601 "context": { | |
602 "$ref": "ErrorContext", | |
603 "description": "Data about the context in which the error oc
curred." | |
604 }, | |
605 "eventTime": { | |
606 "description": "Time when the event occurred as provided in
the error report.\nIf the report did not contain a timestamp, the time the error
was received\nby the Error Reporting system is used.", | |
607 "format": "google-datetime", | |
608 "type": "string" | |
609 }, | |
610 "message": { | |
611 "description": "The stack trace that was reported or logged
by the service.", | |
612 "type": "string" | |
613 } | |
614 }, | |
615 "type": "object" | |
616 }, | |
617 "ListEventsResponse": { | |
618 "description": "Contains a set of requested error events.", | |
619 "id": "ListEventsResponse", | |
620 "properties": { | |
621 "nextPageToken": { | |
622 "description": "If non-empty, more results are available.\nP
ass this token, along with the same query parameters as the first\nrequest, to v
iew the next page of results.", | |
623 "type": "string" | |
624 }, | |
625 "timeRangeBegin": { | |
626 "description": "The timestamp specifies the start time to wh
ich the request was restricted.", | |
627 "format": "google-datetime", | |
628 "type": "string" | |
629 }, | |
630 "errorEvents": { | |
631 "description": "The error events which match the given reque
st.", | |
632 "items": { | |
633 "$ref": "ErrorEvent" | |
634 }, | |
635 "type": "array" | |
636 } | |
637 }, | |
638 "type": "object" | |
639 }, | |
640 "TimedCount": { | |
641 "description": "The number of errors in a given time period.\nAll nu
mbers are approximate since the error events are sampled\nbefore counting them."
, | |
642 "id": "TimedCount", | |
643 "properties": { | |
644 "startTime": { | |
645 "description": "Start of the time period to which `count` re
fers (included).", | |
646 "format": "google-datetime", | |
647 "type": "string" | |
648 }, | |
649 "endTime": { | |
650 "description": "End of the time period to which `count` refe
rs (excluded).", | |
651 "format": "google-datetime", | |
652 "type": "string" | |
653 }, | |
654 "count": { | |
655 "description": "Approximate number of occurrences in the giv
en time period.", | |
656 "format": "int64", | |
657 "type": "string" | |
658 } | |
659 }, | |
660 "type": "object" | |
661 }, | |
662 "HttpRequestContext": { | 632 "HttpRequestContext": { |
663 "description": "HTTP request data that is related to a reported erro
r.\nThis data should be provided by the application when reporting an error,\nun
less the\nerror report has been generated automatically from Google App Engine l
ogs.", | 633 "description": "HTTP request data that is related to a reported erro
r.\nThis data should be provided by the application when reporting an error,\nun
less the\nerror report has been generated automatically from Google App Engine l
ogs.", |
664 "id": "HttpRequestContext", | 634 "id": "HttpRequestContext", |
665 "properties": { | 635 "properties": { |
666 "method": { | 636 "userAgent": { |
667 "description": "The type of HTTP request, such as `GET`, `PO
ST`, etc.", | 637 "description": "The user agent information that is provided
with the request.", |
| 638 "type": "string" |
| 639 }, |
| 640 "url": { |
| 641 "description": "The URL of the request.", |
668 "type": "string" | 642 "type": "string" |
669 }, | 643 }, |
670 "responseStatusCode": { | 644 "responseStatusCode": { |
671 "description": "The HTTP response status code for the reques
t.", | 645 "description": "The HTTP response status code for the reques
t.", |
672 "format": "int32", | 646 "format": "int32", |
673 "type": "integer" | 647 "type": "integer" |
674 }, | 648 }, |
| 649 "method": { |
| 650 "description": "The type of HTTP request, such as `GET`, `PO
ST`, etc.", |
| 651 "type": "string" |
| 652 }, |
675 "remoteIp": { | 653 "remoteIp": { |
676 "description": "The IP address from which the request origin
ated.\nThis can be IPv4, IPv6, or a token which is derived from the\nIP address,
depending on the data that has been provided\nin the error report.", | 654 "description": "The IP address from which the request origin
ated.\nThis can be IPv4, IPv6, or a token which is derived from the\nIP address,
depending on the data that has been provided\nin the error report.", |
677 "type": "string" | 655 "type": "string" |
678 }, | 656 }, |
679 "url": { | |
680 "description": "The URL of the request.", | |
681 "type": "string" | |
682 }, | |
683 "referrer": { | 657 "referrer": { |
684 "description": "The referrer information that is provided wi
th the request.", | 658 "description": "The referrer information that is provided wi
th the request.", |
685 "type": "string" | 659 "type": "string" |
686 }, | |
687 "userAgent": { | |
688 "description": "The user agent information that is provided
with the request.", | |
689 "type": "string" | |
690 } | 660 } |
691 }, | 661 }, |
692 "type": "object" | 662 "type": "object" |
693 }, | 663 }, |
694 "ListGroupStatsResponse": { | 664 "ListGroupStatsResponse": { |
695 "description": "Contains a set of requested error group stats.", | 665 "description": "Contains a set of requested error group stats.", |
696 "id": "ListGroupStatsResponse", | 666 "id": "ListGroupStatsResponse", |
697 "properties": { | 667 "properties": { |
698 "nextPageToken": { | 668 "nextPageToken": { |
699 "description": "If non-empty, more results are available.\nP
ass this token, along with the same query parameters as the first\nrequest, to v
iew the next page of results.", | 669 "description": "If non-empty, more results are available.\nP
ass this token, along with the same query parameters as the first\nrequest, to v
iew the next page of results.", |
700 "type": "string" | 670 "type": "string" |
701 }, | 671 }, |
702 "timeRangeBegin": { | 672 "timeRangeBegin": { |
703 "description": "The timestamp specifies the start time to wh
ich the request was restricted.\nThe start time is set based on the requested ti
me range. It may be adjusted\nto a later time if a project has exceeded the stor
age quota and older data\nhas been deleted.", | 673 "description": "The timestamp specifies the start time to wh
ich the request was restricted.\nThe start time is set based on the requested ti
me range. It may be adjusted\nto a later time if a project has exceeded the stor
age quota and older data\nhas been deleted.", |
704 "format": "google-datetime", | 674 "format": "google-datetime", |
705 "type": "string" | 675 "type": "string" |
706 }, | 676 }, |
707 "errorGroupStats": { | 677 "errorGroupStats": { |
708 "description": "The error group stats which match the given
request.", | 678 "description": "The error group stats which match the given
request.", |
709 "items": { | 679 "items": { |
710 "$ref": "ErrorGroupStats" | 680 "$ref": "ErrorGroupStats" |
711 }, | 681 }, |
712 "type": "array" | 682 "type": "array" |
713 } | 683 } |
714 }, | 684 }, |
715 "type": "object" | 685 "type": "object" |
| 686 }, |
| 687 "DeleteEventsResponse": { |
| 688 "description": "Response message for deleting error events.", |
| 689 "id": "DeleteEventsResponse", |
| 690 "properties": {}, |
| 691 "type": "object" |
| 692 }, |
| 693 "ErrorEvent": { |
| 694 "description": "An error event which is returned by the Error Report
ing system.", |
| 695 "id": "ErrorEvent", |
| 696 "properties": { |
| 697 "eventTime": { |
| 698 "description": "Time when the event occurred as provided in
the error report.\nIf the report did not contain a timestamp, the time the error
was received\nby the Error Reporting system is used.", |
| 699 "format": "google-datetime", |
| 700 "type": "string" |
| 701 }, |
| 702 "context": { |
| 703 "$ref": "ErrorContext", |
| 704 "description": "Data about the context in which the error oc
curred." |
| 705 }, |
| 706 "message": { |
| 707 "description": "The stack trace that was reported or logged
by the service.", |
| 708 "type": "string" |
| 709 }, |
| 710 "serviceContext": { |
| 711 "$ref": "ServiceContext", |
| 712 "description": "The `ServiceContext` for which this error wa
s reported." |
| 713 } |
| 714 }, |
| 715 "type": "object" |
716 } | 716 } |
717 }, | 717 }, |
718 "servicePath": "", | 718 "servicePath": "", |
719 "title": "Stackdriver Error Reporting API", | 719 "title": "Stackdriver Error Reporting API", |
720 "version": "v1beta1" | 720 "version": "v1beta1" |
721 } | 721 } |
OLD | NEW |