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 "alt": { | 28 "access_token": { |
29 "default": "json", | 29 "description": "OAuth access token.", |
30 "description": "Data format for response.", | |
31 "enum": [ | |
32 "json", | |
33 "media", | |
34 "proto" | |
35 ], | |
36 "enumDescriptions": [ | |
37 "Responses with Content-Type of application/json", | |
38 "Media download with context-dependent Content-Type", | |
39 "Responses with Content-Type of application/x-protobuf" | |
40 ], | |
41 "location": "query", | 30 "location": "query", |
42 "type": "string" | 31 "type": "string" |
43 }, | 32 }, |
44 "key": { | 33 "key": { |
45 "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.", | 34 "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.", |
46 "location": "query", | 35 "location": "query", |
47 "type": "string" | 36 "type": "string" |
48 }, | 37 }, |
49 "access_token": { | |
50 "description": "OAuth access token.", | |
51 "location": "query", | |
52 "type": "string" | |
53 }, | |
54 "quotaUser": { | 38 "quotaUser": { |
55 "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.", | 39 "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.", |
56 "location": "query", | 40 "location": "query", |
57 "type": "string" | 41 "type": "string" |
58 }, | 42 }, |
59 "pp": { | 43 "pp": { |
60 "default": "true", | 44 "default": "true", |
61 "description": "Pretty-print response.", | 45 "description": "Pretty-print response.", |
62 "location": "query", | 46 "location": "query", |
63 "type": "boolean" | 47 "type": "boolean" |
(...skipping 12 matching lines...) Expand all Loading... |
76 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", | 60 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", |
77 "location": "query", | 61 "location": "query", |
78 "type": "string" | 62 "type": "string" |
79 }, | 63 }, |
80 "prettyPrint": { | 64 "prettyPrint": { |
81 "default": "true", | 65 "default": "true", |
82 "description": "Returns response with indentations and line breaks."
, | 66 "description": "Returns response with indentations and line breaks."
, |
83 "location": "query", | 67 "location": "query", |
84 "type": "boolean" | 68 "type": "boolean" |
85 }, | 69 }, |
| 70 "fields": { |
| 71 "description": "Selector specifying which fields to include in a par
tial response.", |
| 72 "location": "query", |
| 73 "type": "string" |
| 74 }, |
86 "uploadType": { | 75 "uploadType": { |
87 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", | 76 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", |
88 "location": "query", | 77 "location": "query", |
89 "type": "string" | 78 "type": "string" |
90 }, | 79 }, |
91 "fields": { | |
92 "description": "Selector specifying which fields to include in a par
tial response.", | |
93 "location": "query", | |
94 "type": "string" | |
95 }, | |
96 "$.xgafv": { | 80 "$.xgafv": { |
97 "description": "V1 error format.", | 81 "description": "V1 error format.", |
98 "enum": [ | 82 "enum": [ |
99 "1", | 83 "1", |
100 "2" | 84 "2" |
101 ], | 85 ], |
102 "enumDescriptions": [ | 86 "enumDescriptions": [ |
103 "v1 error format", | 87 "v1 error format", |
104 "v2 error format" | 88 "v2 error format" |
105 ], | 89 ], |
106 "location": "query", | 90 "location": "query", |
107 "type": "string" | 91 "type": "string" |
108 }, | 92 }, |
109 "callback": { | 93 "callback": { |
110 "description": "JSONP", | 94 "description": "JSONP", |
111 "location": "query", | 95 "location": "query", |
112 "type": "string" | 96 "type": "string" |
| 97 }, |
| 98 "alt": { |
| 99 "default": "json", |
| 100 "description": "Data format for response.", |
| 101 "enum": [ |
| 102 "json", |
| 103 "media", |
| 104 "proto" |
| 105 ], |
| 106 "enumDescriptions": [ |
| 107 "Responses with Content-Type of application/json", |
| 108 "Media download with context-dependent Content-Type", |
| 109 "Responses with Content-Type of application/x-protobuf" |
| 110 ], |
| 111 "location": "query", |
| 112 "type": "string" |
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 77 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
200 "groupStats": { | 200 "groupStats": { |
201 "methods": { | 201 "methods": { |
202 "list": { | 202 "list": { |
203 "description": "Lists the specified groups.", | 203 "description": "Lists the specified groups.", |
204 "httpMethod": "GET", | 204 "httpMethod": "GET", |
205 "id": "clouderrorreporting.projects.groupStats.list"
, | 205 "id": "clouderrorreporting.projects.groupStats.list"
, |
206 "parameterOrder": [ | 206 "parameterOrder": [ |
207 "projectName" | 207 "projectName" |
208 ], | 208 ], |
209 "parameters": { | 209 "parameters": { |
| 210 "serviceFilter.resourceType": { |
| 211 "description": "[Optional] The exact value t
o match against\n[`ServiceContext.resource_type`](/error-reporting/reference/res
t/v1beta1/ServiceContext#FIELDS.resource_type).", |
| 212 "location": "query", |
| 213 "type": "string" |
| 214 }, |
| 215 "alignmentTime": { |
| 216 "description": "[Optional] Time where the ti
med counts shall be aligned if rounded\nalignment is chosen. Default is 00:00 UT
C.", |
| 217 "format": "google-datetime", |
| 218 "location": "query", |
| 219 "type": "string" |
| 220 }, |
| 221 "projectName": { |
| 222 "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>.", |
| 223 "location": "path", |
| 224 "pattern": "^projects/[^/]+$", |
| 225 "required": true, |
| 226 "type": "string" |
| 227 }, |
| 228 "timedCountDuration": { |
| 229 "description": "[Optional] The preferred dur
ation for a single returned `TimedCount`.\nIf not set, no timed counts are retur
ned.", |
| 230 "format": "google-duration", |
| 231 "location": "query", |
| 232 "type": "string" |
| 233 }, |
| 234 "pageToken": { |
| 235 "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.", |
| 236 "location": "query", |
| 237 "type": "string" |
| 238 }, |
210 "timeRange.period": { | 239 "timeRange.period": { |
211 "description": "Restricts the query to the s
pecified time range.", | 240 "description": "Restricts the query to the s
pecified time range.", |
212 "enum": [ | 241 "enum": [ |
213 "PERIOD_UNSPECIFIED", | 242 "PERIOD_UNSPECIFIED", |
214 "PERIOD_1_HOUR", | 243 "PERIOD_1_HOUR", |
215 "PERIOD_6_HOURS", | 244 "PERIOD_6_HOURS", |
216 "PERIOD_1_DAY", | 245 "PERIOD_1_DAY", |
217 "PERIOD_1_WEEK", | 246 "PERIOD_1_WEEK", |
218 "PERIOD_30_DAYS" | 247 "PERIOD_30_DAYS" |
219 ], | 248 ], |
(...skipping 36 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
256 "description": "[Optional] The sort order in
which the results are returned.\nDefault is `COUNT_DESC`.", | 285 "description": "[Optional] The sort order in
which the results are returned.\nDefault is `COUNT_DESC`.", |
257 "enum": [ | 286 "enum": [ |
258 "GROUP_ORDER_UNSPECIFIED", | 287 "GROUP_ORDER_UNSPECIFIED", |
259 "COUNT_DESC", | 288 "COUNT_DESC", |
260 "LAST_SEEN_DESC", | 289 "LAST_SEEN_DESC", |
261 "CREATED_DESC", | 290 "CREATED_DESC", |
262 "AFFECTED_USERS_DESC" | 291 "AFFECTED_USERS_DESC" |
263 ], | 292 ], |
264 "location": "query", | 293 "location": "query", |
265 "type": "string" | 294 "type": "string" |
266 }, | |
267 "serviceFilter.resourceType": { | |
268 "description": "[Optional] The exact value t
o match against\n[`ServiceContext.resource_type`](/error-reporting/reference/res
t/v1beta1/ServiceContext#FIELDS.resource_type).", | |
269 "location": "query", | |
270 "type": "string" | |
271 }, | |
272 "alignmentTime": { | |
273 "description": "[Optional] Time where the ti
med counts shall be aligned if rounded\nalignment is chosen. Default is 00:00 UT
C.", | |
274 "format": "google-datetime", | |
275 "location": "query", | |
276 "type": "string" | |
277 }, | |
278 "projectName": { | |
279 "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>.", | |
280 "location": "path", | |
281 "pattern": "^projects/[^/]+$", | |
282 "required": true, | |
283 "type": "string" | |
284 }, | |
285 "timedCountDuration": { | |
286 "description": "[Optional] The preferred dur
ation for a single returned `TimedCount`.\nIf not set, no timed counts are retur
ned.", | |
287 "format": "google-duration", | |
288 "location": "query", | |
289 "type": "string" | |
290 }, | |
291 "pageToken": { | |
292 "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.", | |
293 "location": "query", | |
294 "type": "string" | |
295 } | 295 } |
296 }, | 296 }, |
297 "path": "v1beta1/{+projectName}/groupStats", | 297 "path": "v1beta1/{+projectName}/groupStats", |
298 "response": { | 298 "response": { |
299 "$ref": "ListGroupStatsResponse" | 299 "$ref": "ListGroupStatsResponse" |
300 }, | 300 }, |
301 "scopes": [ | 301 "scopes": [ |
302 "https://www.googleapis.com/auth/cloud-platform" | 302 "https://www.googleapis.com/auth/cloud-platform" |
303 ] | 303 ] |
304 } | 304 } |
305 } | 305 } |
306 }, | 306 }, |
307 "events": { | 307 "events": { |
308 "methods": { | 308 "methods": { |
309 "list": { | 309 "list": { |
310 "description": "Lists the specified events.", | 310 "description": "Lists the specified events.", |
311 "httpMethod": "GET", | 311 "httpMethod": "GET", |
312 "id": "clouderrorreporting.projects.events.list", | 312 "id": "clouderrorreporting.projects.events.list", |
313 "parameterOrder": [ | 313 "parameterOrder": [ |
314 "projectName" | 314 "projectName" |
315 ], | 315 ], |
316 "parameters": { | 316 "parameters": { |
| 317 "pageToken": { |
| 318 "description": "[Optional] A `next_page_toke
n` provided by a previous response.", |
| 319 "location": "query", |
| 320 "type": "string" |
| 321 }, |
| 322 "serviceFilter.service": { |
| 323 "description": "[Optional] The exact value t
o match against\n[`ServiceContext.service`](/error-reporting/reference/rest/v1be
ta1/ServiceContext#FIELDS.service).", |
| 324 "location": "query", |
| 325 "type": "string" |
| 326 }, |
| 327 "pageSize": { |
| 328 "description": "[Optional] The maximum numbe
r of results to return per response.", |
| 329 "format": "int32", |
| 330 "location": "query", |
| 331 "type": "integer" |
| 332 }, |
317 "serviceFilter.version": { | 333 "serviceFilter.version": { |
318 "description": "[Optional] The exact value t
o match against\n[`ServiceContext.version`](/error-reporting/reference/rest/v1be
ta1/ServiceContext#FIELDS.version).", | 334 "description": "[Optional] The exact value t
o match against\n[`ServiceContext.version`](/error-reporting/reference/rest/v1be
ta1/ServiceContext#FIELDS.version).", |
319 "location": "query", | 335 "location": "query", |
320 "type": "string" | 336 "type": "string" |
321 }, | 337 }, |
322 "serviceFilter.resourceType": { | 338 "serviceFilter.resourceType": { |
323 "description": "[Optional] The exact value t
o match against\n[`ServiceContext.resource_type`](/error-reporting/reference/res
t/v1beta1/ServiceContext#FIELDS.resource_type).", | 339 "description": "[Optional] The exact value t
o match against\n[`ServiceContext.resource_type`](/error-reporting/reference/res
t/v1beta1/ServiceContext#FIELDS.resource_type).", |
324 "location": "query", | 340 "location": "query", |
325 "type": "string" | 341 "type": "string" |
326 }, | 342 }, |
(...skipping 14 matching lines...) Expand all Loading... |
341 "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`.", | 357 "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`.", |
342 "location": "path", | 358 "location": "path", |
343 "pattern": "^projects/[^/]+$", | 359 "pattern": "^projects/[^/]+$", |
344 "required": true, | 360 "required": true, |
345 "type": "string" | 361 "type": "string" |
346 }, | 362 }, |
347 "groupId": { | 363 "groupId": { |
348 "description": "[Required] The group for whi
ch events shall be returned.", | 364 "description": "[Required] The group for whi
ch events shall be returned.", |
349 "location": "query", | 365 "location": "query", |
350 "type": "string" | 366 "type": "string" |
351 }, | |
352 "pageToken": { | |
353 "description": "[Optional] A `next_page_toke
n` provided by a previous response.", | |
354 "location": "query", | |
355 "type": "string" | |
356 }, | |
357 "serviceFilter.service": { | |
358 "description": "[Optional] The exact value t
o match against\n[`ServiceContext.service`](/error-reporting/reference/rest/v1be
ta1/ServiceContext#FIELDS.service).", | |
359 "location": "query", | |
360 "type": "string" | |
361 }, | |
362 "pageSize": { | |
363 "description": "[Optional] The maximum numbe
r of results to return per response.", | |
364 "format": "int32", | |
365 "location": "query", | |
366 "type": "integer" | |
367 } | 367 } |
368 }, | 368 }, |
369 "path": "v1beta1/{+projectName}/events", | 369 "path": "v1beta1/{+projectName}/events", |
370 "response": { | 370 "response": { |
371 "$ref": "ListEventsResponse" | 371 "$ref": "ListEventsResponse" |
372 }, | 372 }, |
373 "scopes": [ | 373 "scopes": [ |
374 "https://www.googleapis.com/auth/cloud-platform" | 374 "https://www.googleapis.com/auth/cloud-platform" |
375 ] | 375 ] |
376 }, | 376 }, |
(...skipping 22 matching lines...) Expand all Loading... |
399 }, | 399 }, |
400 "scopes": [ | 400 "scopes": [ |
401 "https://www.googleapis.com/auth/cloud-platform" | 401 "https://www.googleapis.com/auth/cloud-platform" |
402 ] | 402 ] |
403 } | 403 } |
404 } | 404 } |
405 } | 405 } |
406 } | 406 } |
407 } | 407 } |
408 }, | 408 }, |
409 "revision": "20170220", | 409 "revision": "20170405", |
410 "rootUrl": "https://clouderrorreporting.googleapis.com/", | 410 "rootUrl": "https://clouderrorreporting.googleapis.com/", |
411 "schemas": { | 411 "schemas": { |
| 412 "ListGroupStatsResponse": { |
| 413 "description": "Contains a set of requested error group stats.", |
| 414 "id": "ListGroupStatsResponse", |
| 415 "properties": { |
| 416 "nextPageToken": { |
| 417 "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.", |
| 418 "type": "string" |
| 419 }, |
| 420 "timeRangeBegin": { |
| 421 "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.", |
| 422 "format": "google-datetime", |
| 423 "type": "string" |
| 424 }, |
| 425 "errorGroupStats": { |
| 426 "description": "The error group stats which match the given
request.", |
| 427 "items": { |
| 428 "$ref": "ErrorGroupStats" |
| 429 }, |
| 430 "type": "array" |
| 431 } |
| 432 }, |
| 433 "type": "object" |
| 434 }, |
412 "DeleteEventsResponse": { | 435 "DeleteEventsResponse": { |
413 "description": "Response message for deleting error events.", | 436 "description": "Response message for deleting error events.", |
414 "id": "DeleteEventsResponse", | 437 "id": "DeleteEventsResponse", |
415 "properties": {}, | 438 "properties": {}, |
416 "type": "object" | 439 "type": "object" |
417 }, | 440 }, |
418 "ErrorEvent": { | 441 "ErrorEvent": { |
419 "description": "An error event which is returned by the Error Report
ing system.", | 442 "description": "An error event which is returned by the Error Report
ing system.", |
420 "id": "ErrorEvent", | 443 "id": "ErrorEvent", |
421 "properties": { | 444 "properties": { |
422 "serviceContext": { | |
423 "$ref": "ServiceContext", | |
424 "description": "The `ServiceContext` for which this error wa
s reported." | |
425 }, | |
426 "eventTime": { | 445 "eventTime": { |
427 "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.", | 446 "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.", |
428 "format": "google-datetime", | 447 "format": "google-datetime", |
429 "type": "string" | 448 "type": "string" |
430 }, | 449 }, |
431 "context": { | 450 "context": { |
432 "$ref": "ErrorContext", | 451 "$ref": "ErrorContext", |
433 "description": "Data about the context in which the error oc
curred." | 452 "description": "Data about the context in which the error oc
curred." |
434 }, | 453 }, |
435 "message": { | 454 "message": { |
436 "description": "The stack trace that was reported or logged
by the service.", | 455 "description": "The stack trace that was reported or logged
by the service.", |
437 "type": "string" | 456 "type": "string" |
| 457 }, |
| 458 "serviceContext": { |
| 459 "$ref": "ServiceContext", |
| 460 "description": "The `ServiceContext` for which this error wa
s reported." |
438 } | 461 } |
439 }, | 462 }, |
440 "type": "object" | 463 "type": "object" |
441 }, | 464 }, |
442 "ReportedErrorEvent": { | 465 "ReportedErrorEvent": { |
443 "description": "An error event which is reported to the Error Report
ing system.", | 466 "description": "An error event which is reported to the Error Report
ing system.", |
444 "id": "ReportedErrorEvent", | 467 "id": "ReportedErrorEvent", |
445 "properties": { | 468 "properties": { |
446 "context": { | |
447 "$ref": "ErrorContext", | |
448 "description": "[Optional] A description of the context in w
hich the error occurred." | |
449 }, | |
450 "message": { | |
451 "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).", | |
452 "type": "string" | |
453 }, | |
454 "serviceContext": { | 469 "serviceContext": { |
455 "$ref": "ServiceContext", | 470 "$ref": "ServiceContext", |
456 "description": "[Required] The service context in which this
error has occurred." | 471 "description": "[Required] The service context in which this
error has occurred." |
457 }, | 472 }, |
458 "eventTime": { | 473 "eventTime": { |
459 "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.", | 474 "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.", |
460 "format": "google-datetime", | 475 "format": "google-datetime", |
461 "type": "string" | 476 "type": "string" |
| 477 }, |
| 478 "context": { |
| 479 "$ref": "ErrorContext", |
| 480 "description": "[Optional] A description of the context in w
hich the error occurred." |
| 481 }, |
| 482 "message": { |
| 483 "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).", |
| 484 "type": "string" |
462 } | 485 } |
463 }, | 486 }, |
464 "type": "object" | 487 "type": "object" |
465 }, | 488 }, |
466 "ErrorContext": { | 489 "ErrorContext": { |
467 "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.", | 490 "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.", |
468 "id": "ErrorContext", | 491 "id": "ErrorContext", |
469 "properties": { | 492 "properties": { |
470 "reportLocation": { | 493 "reportLocation": { |
471 "$ref": "SourceLocation", | 494 "$ref": "SourceLocation", |
(...skipping 18 matching lines...) Expand all Loading... |
490 "description": "A URL pointing to a related entry in an issu
e tracking system.\nExample: https://github.com/user/project/issues/4", | 513 "description": "A URL pointing to a related entry in an issu
e tracking system.\nExample: https://github.com/user/project/issues/4", |
491 "type": "string" | 514 "type": "string" |
492 } | 515 } |
493 }, | 516 }, |
494 "type": "object" | 517 "type": "object" |
495 }, | 518 }, |
496 "ErrorGroupStats": { | 519 "ErrorGroupStats": { |
497 "description": "Data extracted for a specific group based on certain
filter criteria,\nsuch as a given time period and/or service filter.", | 520 "description": "Data extracted for a specific group based on certain
filter criteria,\nsuch as a given time period and/or service filter.", |
498 "id": "ErrorGroupStats", | 521 "id": "ErrorGroupStats", |
499 "properties": { | 522 "properties": { |
| 523 "count": { |
| 524 "description": "Approximate total number of events in the gi
ven group that match\nthe filter criteria.", |
| 525 "format": "int64", |
| 526 "type": "string" |
| 527 }, |
| 528 "lastSeenTime": { |
| 529 "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.", |
| 530 "format": "google-datetime", |
| 531 "type": "string" |
| 532 }, |
| 533 "affectedUsersCount": { |
| 534 "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.", |
| 535 "format": "int64", |
| 536 "type": "string" |
| 537 }, |
500 "affectedServices": { | 538 "affectedServices": { |
501 "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.", | 539 "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 "items": { | 540 "items": { |
503 "$ref": "ServiceContext" | 541 "$ref": "ServiceContext" |
504 }, | 542 }, |
505 "type": "array" | 543 "type": "array" |
506 }, | 544 }, |
507 "numAffectedServices": { | 545 "numAffectedServices": { |
508 "description": "The total number of services with a non-zero
error count for the given\nfilter criteria.", | 546 "description": "The total number of services with a non-zero
error count for the given\nfilter criteria.", |
509 "format": "int32", | 547 "format": "int32", |
(...skipping 11 matching lines...) Expand all Loading... |
521 "type": "array" | 559 "type": "array" |
522 }, | 560 }, |
523 "group": { | 561 "group": { |
524 "$ref": "ErrorGroup", | 562 "$ref": "ErrorGroup", |
525 "description": "Group data that is independent of the filter
criteria." | 563 "description": "Group data that is independent of the filter
criteria." |
526 }, | 564 }, |
527 "firstSeenTime": { | 565 "firstSeenTime": { |
528 "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.", | 566 "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.", |
529 "format": "google-datetime", | 567 "format": "google-datetime", |
530 "type": "string" | 568 "type": "string" |
531 }, | |
532 "count": { | |
533 "description": "Approximate total number of events in the gi
ven group that match\nthe filter criteria.", | |
534 "format": "int64", | |
535 "type": "string" | |
536 }, | |
537 "lastSeenTime": { | |
538 "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.", | |
539 "format": "google-datetime", | |
540 "type": "string" | |
541 }, | |
542 "affectedUsersCount": { | |
543 "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.", | |
544 "format": "int64", | |
545 "type": "string" | |
546 } | 569 } |
547 }, | 570 }, |
548 "type": "object" | 571 "type": "object" |
549 }, | 572 }, |
550 "ListEventsResponse": { | 573 "ListEventsResponse": { |
551 "description": "Contains a set of requested error events.", | 574 "description": "Contains a set of requested error events.", |
552 "id": "ListEventsResponse", | 575 "id": "ListEventsResponse", |
553 "properties": { | 576 "properties": { |
554 "nextPageToken": { | 577 "nextPageToken": { |
555 "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.", | 578 "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.", |
(...skipping 33 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
589 "format": "google-datetime", | 612 "format": "google-datetime", |
590 "type": "string" | 613 "type": "string" |
591 } | 614 } |
592 }, | 615 }, |
593 "type": "object" | 616 "type": "object" |
594 }, | 617 }, |
595 "ErrorGroup": { | 618 "ErrorGroup": { |
596 "description": "Description of a group of similar error events.", | 619 "description": "Description of a group of similar error events.", |
597 "id": "ErrorGroup", | 620 "id": "ErrorGroup", |
598 "properties": { | 621 "properties": { |
599 "name": { | |
600 "description": "The group resource name.\nExample: <code>pro
jects/my-project-123/groups/my-groupid</code>", | |
601 "type": "string" | |
602 }, | |
603 "groupId": { | 622 "groupId": { |
604 "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.", | 623 "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.", |
605 "type": "string" | 624 "type": "string" |
606 }, | 625 }, |
607 "trackingIssues": { | 626 "trackingIssues": { |
608 "description": "Associated tracking issues.", | 627 "description": "Associated tracking issues.", |
609 "items": { | 628 "items": { |
610 "$ref": "TrackingIssue" | 629 "$ref": "TrackingIssue" |
611 }, | 630 }, |
612 "type": "array" | 631 "type": "array" |
| 632 }, |
| 633 "name": { |
| 634 "description": "The group resource name.\nExample: <code>pro
jects/my-project-123/groups/my-groupid</code>", |
| 635 "type": "string" |
| 636 } |
| 637 }, |
| 638 "type": "object" |
| 639 }, |
| 640 "ServiceContext": { |
| 641 "description": "Describes a running service that sends errors.\nIts
version changes over time and multiple versions can run in parallel.", |
| 642 "id": "ServiceContext", |
| 643 "properties": { |
| 644 "version": { |
| 645 "description": "Represents the source code version that the
developer provided,\nwhich could represent a version label or a Git SHA-1 hash,
for example.\nFor App Engine standard environment, the version is set to the ver
sion of\nthe app.", |
| 646 "type": "string" |
| 647 }, |
| 648 "service": { |
| 649 "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.", |
| 650 "type": "string" |
| 651 }, |
| 652 "resourceType": { |
| 653 "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.", |
| 654 "type": "string" |
613 } | 655 } |
614 }, | 656 }, |
615 "type": "object" | 657 "type": "object" |
616 }, | 658 }, |
617 "SourceLocation": { | 659 "SourceLocation": { |
618 "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.", | 660 "description": "Indicates a location in the source code of the servi
ce for which errors are\nreported. `functionName` must be provided by the applic
ation when reporting\nan error, unless the error report contains a `message` wit
h a supported\nexception stack trace. All fields are optional for the later case
.", |
619 "id": "SourceLocation", | 661 "id": "SourceLocation", |
620 "properties": { | 662 "properties": { |
621 "functionName": { | 663 "functionName": { |
622 "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.", | 664 "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.", |
623 "type": "string" | 665 "type": "string" |
624 }, | 666 }, |
625 "filePath": { | 667 "filePath": { |
626 "description": "The source code filename, which can include
a truncated relative\npath, or a full path from a production machine.", | 668 "description": "The source code filename, which can include
a truncated relative\npath, or a full path from a production machine.", |
627 "type": "string" | 669 "type": "string" |
628 }, | 670 }, |
629 "lineNumber": { | 671 "lineNumber": { |
630 "description": "1-based. 0 indicates that the line number is
unknown.", | 672 "description": "1-based. 0 indicates that the line number is
unknown.", |
631 "format": "int32", | 673 "format": "int32", |
632 "type": "integer" | 674 "type": "integer" |
633 } | 675 } |
634 }, | 676 }, |
635 "type": "object" | 677 "type": "object" |
636 }, | 678 }, |
637 "ServiceContext": { | |
638 "description": "Describes a running service that sends errors.\nIts
version changes over time and multiple versions can run in parallel.", | |
639 "id": "ServiceContext", | |
640 "properties": { | |
641 "resourceType": { | |
642 "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.", | |
643 "type": "string" | |
644 }, | |
645 "version": { | |
646 "description": "Represents the source code version that the
developer provided,\nwhich could represent a version label or a Git SHA-1 hash,
for example.", | |
647 "type": "string" | |
648 }, | |
649 "service": { | |
650 "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.", | |
651 "type": "string" | |
652 } | |
653 }, | |
654 "type": "object" | |
655 }, | |
656 "ReportErrorEventResponse": { | 679 "ReportErrorEventResponse": { |
657 "description": "Response for reporting an individual error event.\nD
ata may be added to this message in the future.", | 680 "description": "Response for reporting an individual error event.\nD
ata may be added to this message in the future.", |
658 "id": "ReportErrorEventResponse", | 681 "id": "ReportErrorEventResponse", |
659 "properties": {}, | 682 "properties": {}, |
660 "type": "object" | 683 "type": "object" |
661 }, | 684 }, |
662 "HttpRequestContext": { | 685 "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.", | 686 "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", | 687 "id": "HttpRequestContext", |
665 "properties": { | 688 "properties": { |
| 689 "url": { |
| 690 "description": "The URL of the request.", |
| 691 "type": "string" |
| 692 }, |
| 693 "responseStatusCode": { |
| 694 "description": "The HTTP response status code for the reques
t.", |
| 695 "format": "int32", |
| 696 "type": "integer" |
| 697 }, |
666 "method": { | 698 "method": { |
667 "description": "The type of HTTP request, such as `GET`, `PO
ST`, etc.", | 699 "description": "The type of HTTP request, such as `GET`, `PO
ST`, etc.", |
668 "type": "string" | 700 "type": "string" |
669 }, | 701 }, |
670 "remoteIp": { | 702 "remoteIp": { |
671 "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.", | 703 "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.", |
672 "type": "string" | 704 "type": "string" |
673 }, | 705 }, |
674 "referrer": { | 706 "referrer": { |
675 "description": "The referrer information that is provided wi
th the request.", | 707 "description": "The referrer information that is provided wi
th the request.", |
676 "type": "string" | 708 "type": "string" |
677 }, | 709 }, |
678 "userAgent": { | 710 "userAgent": { |
679 "description": "The user agent information that is provided
with the request.", | 711 "description": "The user agent information that is provided
with the request.", |
680 "type": "string" | 712 "type": "string" |
681 }, | |
682 "url": { | |
683 "description": "The URL of the request.", | |
684 "type": "string" | |
685 }, | |
686 "responseStatusCode": { | |
687 "description": "The HTTP response status code for the reques
t.", | |
688 "format": "int32", | |
689 "type": "integer" | |
690 } | 713 } |
691 }, | 714 }, |
692 "type": "object" | 715 "type": "object" |
693 }, | |
694 "ListGroupStatsResponse": { | |
695 "description": "Contains a set of requested error group stats.", | |
696 "id": "ListGroupStatsResponse", | |
697 "properties": { | |
698 "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.", | |
700 "type": "string" | |
701 }, | |
702 "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.", | |
704 "format": "google-datetime", | |
705 "type": "string" | |
706 }, | |
707 "errorGroupStats": { | |
708 "description": "The error group stats which match the given
request.", | |
709 "items": { | |
710 "$ref": "ErrorGroupStats" | |
711 }, | |
712 "type": "array" | |
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 |