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": "Groups and counts similar errors from cloud services and app
lications, reports new errors, and provides access to error groups and their ass
ociated errors.\n", | 15 "description": "Groups and counts similar errors from cloud services and app
lications, reports new errors, and provides access to error groups and their ass
ociated 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 "$.xgafv": { |
| 29 "description": "V1 error format.", |
| 30 "enum": [ |
| 31 "1", |
| 32 "2" |
| 33 ], |
| 34 "enumDescriptions": [ |
| 35 "v1 error format", |
| 36 "v2 error format" |
| 37 ], |
| 38 "location": "query", |
| 39 "type": "string" |
| 40 }, |
| 41 "callback": { |
| 42 "description": "JSONP", |
| 43 "location": "query", |
| 44 "type": "string" |
| 45 }, |
28 "alt": { | 46 "alt": { |
29 "default": "json", | 47 "default": "json", |
30 "description": "Data format for response.", | 48 "description": "Data format for response.", |
31 "enum": [ | 49 "enum": [ |
32 "json", | 50 "json", |
33 "media", | 51 "media", |
34 "proto" | 52 "proto" |
35 ], | 53 ], |
36 "enumDescriptions": [ | 54 "enumDescriptions": [ |
37 "Responses with Content-Type of application/json", | 55 "Responses with Content-Type of application/json", |
(...skipping 38 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
76 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", | 94 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", |
77 "location": "query", | 95 "location": "query", |
78 "type": "string" | 96 "type": "string" |
79 }, | 97 }, |
80 "prettyPrint": { | 98 "prettyPrint": { |
81 "default": "true", | 99 "default": "true", |
82 "description": "Returns response with indentations and line breaks."
, | 100 "description": "Returns response with indentations and line breaks."
, |
83 "location": "query", | 101 "location": "query", |
84 "type": "boolean" | 102 "type": "boolean" |
85 }, | 103 }, |
86 "uploadType": { | |
87 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", | |
88 "location": "query", | |
89 "type": "string" | |
90 }, | |
91 "fields": { | 104 "fields": { |
92 "description": "Selector specifying which fields to include in a par
tial response.", | 105 "description": "Selector specifying which fields to include in a par
tial response.", |
93 "location": "query", | 106 "location": "query", |
94 "type": "string" | 107 "type": "string" |
95 }, | 108 }, |
96 "$.xgafv": { | 109 "uploadType": { |
97 "description": "V1 error format.", | 110 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", |
98 "enum": [ | |
99 "1", | |
100 "2" | |
101 ], | |
102 "enumDescriptions": [ | |
103 "v1 error format", | |
104 "v2 error format" | |
105 ], | |
106 "location": "query", | |
107 "type": "string" | |
108 }, | |
109 "callback": { | |
110 "description": "JSONP", | |
111 "location": "query", | 111 "location": "query", |
112 "type": "string" | 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.
", |
(...skipping 79 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 "alignmentTime": { | |
211 "description": "[Optional] Time where the ti
med counts shall be aligned if rounded\nalignment is chosen. Default is 00:00 UT
C.", | |
212 "format": "google-datetime", | |
213 "location": "query", | |
214 "type": "string" | |
215 }, | |
216 "serviceFilter.resourceType": { | |
217 "description": "[Optional] The exact value t
o match against\n[`ServiceContext.resource_type`](/error-reporting/reference/res
t/v1beta1/ServiceContext#FIELDS.resource_type).", | |
218 "location": "query", | |
219 "type": "string" | |
220 }, | |
221 "projectName": { | 210 "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>.", | 211 "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", | 212 "location": "path", |
224 "pattern": "^projects/[^/]+$", | 213 "pattern": "^projects/[^/]+$", |
225 "required": true, | 214 "required": true, |
226 "type": "string" | 215 "type": "string" |
227 }, | 216 }, |
228 "timedCountDuration": { | 217 "timedCountDuration": { |
229 "description": "[Optional] The preferred dur
ation for a single returned `TimedCount`.\nIf not set, no timed counts are retur
ned.", | 218 "description": "[Optional] The preferred dur
ation for a single returned `TimedCount`.\nIf not set, no timed counts are retur
ned.", |
230 "format": "google-duration", | 219 "format": "google-duration", |
(...skipping 54 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
285 "CREATED_DESC", | 274 "CREATED_DESC", |
286 "AFFECTED_USERS_DESC" | 275 "AFFECTED_USERS_DESC" |
287 ], | 276 ], |
288 "location": "query", | 277 "location": "query", |
289 "type": "string" | 278 "type": "string" |
290 }, | 279 }, |
291 "serviceFilter.version": { | 280 "serviceFilter.version": { |
292 "description": "[Optional] The exact value t
o match against\n[`ServiceContext.version`](/error-reporting/reference/rest/v1be
ta1/ServiceContext#FIELDS.version).", | 281 "description": "[Optional] The exact value t
o match against\n[`ServiceContext.version`](/error-reporting/reference/rest/v1be
ta1/ServiceContext#FIELDS.version).", |
293 "location": "query", | 282 "location": "query", |
294 "type": "string" | 283 "type": "string" |
| 284 }, |
| 285 "serviceFilter.resourceType": { |
| 286 "description": "[Optional] The exact value t
o match against\n[`ServiceContext.resource_type`](/error-reporting/reference/res
t/v1beta1/ServiceContext#FIELDS.resource_type).", |
| 287 "location": "query", |
| 288 "type": "string" |
| 289 }, |
| 290 "alignmentTime": { |
| 291 "description": "[Optional] Time where the ti
med counts shall be aligned if rounded\nalignment is chosen. Default is 00:00 UT
C.", |
| 292 "format": "google-datetime", |
| 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 "report": { |
| 310 "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>", |
| 311 "httpMethod": "POST", |
| 312 "id": "clouderrorreporting.projects.events.report", |
| 313 "parameterOrder": [ |
| 314 "projectName" |
| 315 ], |
| 316 "parameters": { |
| 317 "projectName": { |
| 318 "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`.", |
| 319 "location": "path", |
| 320 "pattern": "^projects/[^/]+$", |
| 321 "required": true, |
| 322 "type": "string" |
| 323 } |
| 324 }, |
| 325 "path": "v1beta1/{+projectName}/events:report", |
| 326 "request": { |
| 327 "$ref": "ReportedErrorEvent" |
| 328 }, |
| 329 "response": { |
| 330 "$ref": "ReportErrorEventResponse" |
| 331 }, |
| 332 "scopes": [ |
| 333 "https://www.googleapis.com/auth/cloud-platform" |
| 334 ] |
| 335 }, |
309 "list": { | 336 "list": { |
310 "description": "Lists the specified events.", | 337 "description": "Lists the specified events.", |
311 "httpMethod": "GET", | 338 "httpMethod": "GET", |
312 "id": "clouderrorreporting.projects.events.list", | 339 "id": "clouderrorreporting.projects.events.list", |
313 "parameterOrder": [ | 340 "parameterOrder": [ |
314 "projectName" | 341 "projectName" |
315 ], | 342 ], |
316 "parameters": { | 343 "parameters": { |
317 "serviceFilter.resourceType": { | 344 "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).", | 345 "description": "[Optional] The exact value t
o match against\n[`ServiceContext.resource_type`](/error-reporting/reference/res
t/v1beta1/ServiceContext#FIELDS.resource_type).", |
(...skipping 47 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
366 "type": "string" | 393 "type": "string" |
367 } | 394 } |
368 }, | 395 }, |
369 "path": "v1beta1/{+projectName}/events", | 396 "path": "v1beta1/{+projectName}/events", |
370 "response": { | 397 "response": { |
371 "$ref": "ListEventsResponse" | 398 "$ref": "ListEventsResponse" |
372 }, | 399 }, |
373 "scopes": [ | 400 "scopes": [ |
374 "https://www.googleapis.com/auth/cloud-platform" | 401 "https://www.googleapis.com/auth/cloud-platform" |
375 ] | 402 ] |
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 } | 403 } |
404 } | 404 } |
405 } | 405 } |
406 } | 406 } |
407 } | 407 } |
408 }, | 408 }, |
409 "revision": "20170517", | 409 "revision": "20170602", |
410 "rootUrl": "https://clouderrorreporting.googleapis.com/", | 410 "rootUrl": "https://clouderrorreporting.googleapis.com/", |
411 "schemas": { | 411 "schemas": { |
412 "ReportedErrorEvent": { | |
413 "description": "An error event which is reported to the Error Report
ing system.", | |
414 "id": "ReportedErrorEvent", | |
415 "properties": { | |
416 "context": { | |
417 "$ref": "ErrorContext", | |
418 "description": "[Optional] A description of the context in w
hich the error occurred." | |
419 }, | |
420 "message": { | |
421 "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).", | |
422 "type": "string" | |
423 }, | |
424 "serviceContext": { | |
425 "$ref": "ServiceContext", | |
426 "description": "[Required] The service context in which this
error has occurred." | |
427 }, | |
428 "eventTime": { | |
429 "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.", | |
430 "format": "google-datetime", | |
431 "type": "string" | |
432 } | |
433 }, | |
434 "type": "object" | |
435 }, | |
436 "ErrorContext": { | |
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": "ErrorContext", | |
439 "properties": { | |
440 "user": { | |
441 "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" | |
443 }, | |
444 "reportLocation": { | |
445 "$ref": "SourceLocation", | |
446 "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 "sourceReferences": { | |
449 "description": "Source code that was used to build the execu
table which has\ncaused the given error message.", | |
450 "items": { | |
451 "$ref": "SourceReference" | |
452 }, | |
453 "type": "array" | |
454 }, | |
455 "httpRequest": { | |
456 "$ref": "HttpRequestContext", | |
457 "description": "The HTTP request which was processed when th
e error was\ntriggered." | |
458 } | |
459 }, | |
460 "type": "object" | |
461 }, | |
462 "TrackingIssue": { | |
463 "description": "Information related to tracking the progress on reso
lving the error.", | |
464 "id": "TrackingIssue", | |
465 "properties": { | |
466 "url": { | |
467 "description": "A URL pointing to a related entry in an issu
e tracking system.\nExample: https://github.com/user/project/issues/4", | |
468 "type": "string" | |
469 } | |
470 }, | |
471 "type": "object" | |
472 }, | |
473 "ErrorGroupStats": { | |
474 "description": "Data extracted for a specific group based on certain
filter criteria,\nsuch as a given time period and/or service filter.", | |
475 "id": "ErrorGroupStats", | |
476 "properties": { | |
477 "group": { | |
478 "$ref": "ErrorGroup", | |
479 "description": "Group data that is independent of the filter
criteria." | |
480 }, | |
481 "firstSeenTime": { | |
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.", | |
483 "format": "google-datetime", | |
484 "type": "string" | |
485 }, | |
486 "count": { | |
487 "description": "Approximate total number of events in the gi
ven group that match\nthe filter criteria.", | |
488 "format": "int64", | |
489 "type": "string" | |
490 }, | |
491 "lastSeenTime": { | |
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.", | |
493 "format": "google-datetime", | |
494 "type": "string" | |
495 }, | |
496 "affectedUsersCount": { | |
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.", | |
498 "format": "int64", | |
499 "type": "string" | |
500 }, | |
501 "numAffectedServices": { | |
502 "description": "The total number of services with a non-zero
error count for the given\nfilter criteria.", | |
503 "format": "int32", | |
504 "type": "integer" | |
505 }, | |
506 "affectedServices": { | |
507 "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.", | |
508 "items": { | |
509 "$ref": "ServiceContext" | |
510 }, | |
511 "type": "array" | |
512 }, | |
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." | |
516 }, | |
517 "timedCounts": { | |
518 "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.", | |
519 "items": { | |
520 "$ref": "TimedCount" | |
521 }, | |
522 "type": "array" | |
523 } | |
524 }, | |
525 "type": "object" | |
526 }, | |
527 "ListEventsResponse": { | |
528 "description": "Contains a set of requested error events.", | |
529 "id": "ListEventsResponse", | |
530 "properties": { | |
531 "nextPageToken": { | |
532 "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.", | |
533 "type": "string" | |
534 }, | |
535 "timeRangeBegin": { | |
536 "description": "The timestamp specifies the start time to wh
ich the request was restricted.", | |
537 "format": "google-datetime", | |
538 "type": "string" | |
539 }, | |
540 "errorEvents": { | |
541 "description": "The error events which match the given reque
st.", | |
542 "items": { | |
543 "$ref": "ErrorEvent" | |
544 }, | |
545 "type": "array" | |
546 } | |
547 }, | |
548 "type": "object" | |
549 }, | |
550 "TimedCount": { | 412 "TimedCount": { |
551 "description": "The number of errors in a given time period.\nAll nu
mbers are approximate since the error events are sampled\nbefore counting them."
, | 413 "description": "The number of errors in a given time period.\nAll nu
mbers are approximate since the error events are sampled\nbefore counting them."
, |
552 "id": "TimedCount", | 414 "id": "TimedCount", |
553 "properties": { | 415 "properties": { |
554 "endTime": { | 416 "endTime": { |
555 "description": "End of the time period to which `count` refe
rs (excluded).", | 417 "description": "End of the time period to which `count` refe
rs (excluded).", |
556 "format": "google-datetime", | 418 "format": "google-datetime", |
557 "type": "string" | 419 "type": "string" |
558 }, | 420 }, |
559 "count": { | 421 "count": { |
560 "description": "Approximate number of occurrences in the giv
en time period.", | 422 "description": "Approximate number of occurrences in the giv
en time period.", |
561 "format": "int64", | 423 "format": "int64", |
562 "type": "string" | 424 "type": "string" |
563 }, | 425 }, |
564 "startTime": { | 426 "startTime": { |
565 "description": "Start of the time period to which `count` re
fers (included).", | 427 "description": "Start of the time period to which `count` re
fers (included).", |
566 "format": "google-datetime", | 428 "format": "google-datetime", |
567 "type": "string" | 429 "type": "string" |
568 } | 430 } |
569 }, | 431 }, |
570 "type": "object" | 432 "type": "object" |
571 }, | 433 }, |
572 "ErrorGroup": { | 434 "ErrorGroup": { |
573 "description": "Description of a group of similar error events.", | 435 "description": "Description of a group of similar error events.", |
574 "id": "ErrorGroup", | 436 "id": "ErrorGroup", |
575 "properties": { | 437 "properties": { |
576 "name": { | |
577 "description": "The group resource name.\nExample: <code>pro
jects/my-project-123/groups/my-groupid</code>", | |
578 "type": "string" | |
579 }, | |
580 "groupId": { | 438 "groupId": { |
581 "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.", | 439 "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.", |
582 "type": "string" | 440 "type": "string" |
583 }, | 441 }, |
584 "trackingIssues": { | 442 "trackingIssues": { |
585 "description": "Associated tracking issues.", | 443 "description": "Associated tracking issues.", |
586 "items": { | 444 "items": { |
587 "$ref": "TrackingIssue" | 445 "$ref": "TrackingIssue" |
588 }, | 446 }, |
589 "type": "array" | 447 "type": "array" |
590 } | |
591 }, | |
592 "type": "object" | |
593 }, | |
594 "ServiceContext": { | |
595 "description": "Describes a running service that sends errors.\nIts
version changes over time and multiple versions can run in parallel.", | |
596 "id": "ServiceContext", | |
597 "properties": { | |
598 "service": { | |
599 "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.", | |
600 "type": "string" | |
601 }, | 448 }, |
602 "resourceType": { | 449 "name": { |
603 "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.", | 450 "description": "The group resource name.\nExample: <code>pro
jects/my-project-123/groups/my-groupid</code>", |
604 "type": "string" | |
605 }, | |
606 "version": { | |
607 "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.", | |
608 "type": "string" | 451 "type": "string" |
609 } | 452 } |
610 }, | 453 }, |
611 "type": "object" | 454 "type": "object" |
612 }, | 455 }, |
613 "SourceLocation": { | 456 "SourceLocation": { |
614 "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
.", | 457 "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
.", |
615 "id": "SourceLocation", | 458 "id": "SourceLocation", |
616 "properties": { | 459 "properties": { |
| 460 "functionName": { |
| 461 "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.", |
| 462 "type": "string" |
| 463 }, |
617 "filePath": { | 464 "filePath": { |
618 "description": "The source code filename, which can include
a truncated relative\npath, or a full path from a production machine.", | 465 "description": "The source code filename, which can include
a truncated relative\npath, or a full path from a production machine.", |
619 "type": "string" | 466 "type": "string" |
620 }, | 467 }, |
621 "lineNumber": { | 468 "lineNumber": { |
622 "description": "1-based. 0 indicates that the line number is
unknown.", | 469 "description": "1-based. 0 indicates that the line number is
unknown.", |
623 "format": "int32", | 470 "format": "int32", |
624 "type": "integer" | 471 "type": "integer" |
| 472 } |
| 473 }, |
| 474 "type": "object" |
| 475 }, |
| 476 "ServiceContext": { |
| 477 "description": "Describes a running service that sends errors.\nIts
version changes over time and multiple versions can run in parallel.", |
| 478 "id": "ServiceContext", |
| 479 "properties": { |
| 480 "resourceType": { |
| 481 "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.", |
| 482 "type": "string" |
625 }, | 483 }, |
626 "functionName": { | 484 "version": { |
627 "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.", | 485 "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.", |
| 486 "type": "string" |
| 487 }, |
| 488 "service": { |
| 489 "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.", |
628 "type": "string" | 490 "type": "string" |
629 } | 491 } |
630 }, | 492 }, |
631 "type": "object" | 493 "type": "object" |
632 }, | 494 }, |
633 "ReportErrorEventResponse": { | 495 "ReportErrorEventResponse": { |
634 "description": "Response for reporting an individual error event.\nD
ata may be added to this message in the future.", | 496 "description": "Response for reporting an individual error event.\nD
ata may be added to this message in the future.", |
635 "id": "ReportErrorEventResponse", | 497 "id": "ReportErrorEventResponse", |
636 "properties": {}, | 498 "properties": {}, |
637 "type": "object" | 499 "type": "object" |
638 }, | 500 }, |
639 "HttpRequestContext": { | 501 "HttpRequestContext": { |
640 "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.", | 502 "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.", |
641 "id": "HttpRequestContext", | 503 "id": "HttpRequestContext", |
642 "properties": { | 504 "properties": { |
| 505 "referrer": { |
| 506 "description": "The referrer information that is provided wi
th the request.", |
| 507 "type": "string" |
| 508 }, |
| 509 "userAgent": { |
| 510 "description": "The user agent information that is provided
with the request.", |
| 511 "type": "string" |
| 512 }, |
| 513 "url": { |
| 514 "description": "The URL of the request.", |
| 515 "type": "string" |
| 516 }, |
643 "responseStatusCode": { | 517 "responseStatusCode": { |
644 "description": "The HTTP response status code for the reques
t.", | 518 "description": "The HTTP response status code for the reques
t.", |
645 "format": "int32", | 519 "format": "int32", |
646 "type": "integer" | 520 "type": "integer" |
647 }, | 521 }, |
648 "method": { | 522 "method": { |
649 "description": "The type of HTTP request, such as `GET`, `PO
ST`, etc.", | 523 "description": "The type of HTTP request, such as `GET`, `PO
ST`, etc.", |
650 "type": "string" | 524 "type": "string" |
651 }, | 525 }, |
652 "remoteIp": { | 526 "remoteIp": { |
653 "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.", | 527 "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 "type": "string" | 528 "type": "string" |
655 }, | |
656 "referrer": { | |
657 "description": "The referrer information that is provided wi
th the request.", | |
658 "type": "string" | |
659 }, | |
660 "userAgent": { | |
661 "description": "The user agent information that is provided
with the request.", | |
662 "type": "string" | |
663 }, | |
664 "url": { | |
665 "description": "The URL of the request.", | |
666 "type": "string" | |
667 } | 529 } |
668 }, | 530 }, |
669 "type": "object" | 531 "type": "object" |
670 }, | 532 }, |
671 "ListGroupStatsResponse": { | 533 "ListGroupStatsResponse": { |
672 "description": "Contains a set of requested error group stats.", | 534 "description": "Contains a set of requested error group stats.", |
673 "id": "ListGroupStatsResponse", | 535 "id": "ListGroupStatsResponse", |
674 "properties": { | 536 "properties": { |
675 "timeRangeBegin": { | 537 "timeRangeBegin": { |
676 "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.", | 538 "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.", |
(...skipping 11 matching lines...) Expand all Loading... |
688 "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.", | 550 "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.", |
689 "type": "string" | 551 "type": "string" |
690 } | 552 } |
691 }, | 553 }, |
692 "type": "object" | 554 "type": "object" |
693 }, | 555 }, |
694 "SourceReference": { | 556 "SourceReference": { |
695 "description": "A reference to a particular snapshot of the source t
ree used to build and\ndeploy an application.", | 557 "description": "A reference to a particular snapshot of the source t
ree used to build and\ndeploy an application.", |
696 "id": "SourceReference", | 558 "id": "SourceReference", |
697 "properties": { | 559 "properties": { |
| 560 "repository": { |
| 561 "description": "Optional. A URI string identifying the repos
itory.\nExample: \"https://github.com/GoogleCloudPlatform/kubernetes.git\"", |
| 562 "type": "string" |
| 563 }, |
698 "revisionId": { | 564 "revisionId": { |
699 "description": "The canonical and persistent identifier of t
he deployed revision.\nExample (git): \"0035781c50ec7aa23385dc841529ce8a4b70db1b
\"", | 565 "description": "The canonical and persistent identifier of t
he deployed revision.\nExample (git): \"0035781c50ec7aa23385dc841529ce8a4b70db1b
\"", |
700 "type": "string" | 566 "type": "string" |
701 }, | |
702 "repository": { | |
703 "description": "Optional. A URI string identifying the repos
itory.\nExample: \"https://github.com/GoogleCloudPlatform/kubernetes.git\"", | |
704 "type": "string" | |
705 } | 567 } |
706 }, | 568 }, |
707 "type": "object" | 569 "type": "object" |
708 }, | 570 }, |
709 "DeleteEventsResponse": { | 571 "DeleteEventsResponse": { |
710 "description": "Response message for deleting error events.", | 572 "description": "Response message for deleting error events.", |
711 "id": "DeleteEventsResponse", | 573 "id": "DeleteEventsResponse", |
712 "properties": {}, | 574 "properties": {}, |
713 "type": "object" | 575 "type": "object" |
714 }, | 576 }, |
(...skipping 13 matching lines...) Expand all Loading... |
728 "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.", | 590 "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.", |
729 "format": "google-datetime", | 591 "format": "google-datetime", |
730 "type": "string" | 592 "type": "string" |
731 }, | 593 }, |
732 "context": { | 594 "context": { |
733 "$ref": "ErrorContext", | 595 "$ref": "ErrorContext", |
734 "description": "Data about the context in which the error oc
curred." | 596 "description": "Data about the context in which the error oc
curred." |
735 } | 597 } |
736 }, | 598 }, |
737 "type": "object" | 599 "type": "object" |
| 600 }, |
| 601 "ReportedErrorEvent": { |
| 602 "description": "An error event which is reported to the Error Report
ing system.", |
| 603 "id": "ReportedErrorEvent", |
| 604 "properties": { |
| 605 "eventTime": { |
| 606 "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.", |
| 607 "format": "google-datetime", |
| 608 "type": "string" |
| 609 }, |
| 610 "context": { |
| 611 "$ref": "ErrorContext", |
| 612 "description": "[Optional] A description of the context in w
hich the error occurred." |
| 613 }, |
| 614 "message": { |
| 615 "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).", |
| 616 "type": "string" |
| 617 }, |
| 618 "serviceContext": { |
| 619 "$ref": "ServiceContext", |
| 620 "description": "[Required] The service context in which this
error has occurred." |
| 621 } |
| 622 }, |
| 623 "type": "object" |
| 624 }, |
| 625 "ErrorContext": { |
| 626 "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.", |
| 627 "id": "ErrorContext", |
| 628 "properties": { |
| 629 "user": { |
| 630 "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`.", |
| 631 "type": "string" |
| 632 }, |
| 633 "reportLocation": { |
| 634 "$ref": "SourceLocation", |
| 635 "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." |
| 636 }, |
| 637 "sourceReferences": { |
| 638 "description": "Source code that was used to build the execu
table which has\ncaused the given error message.", |
| 639 "items": { |
| 640 "$ref": "SourceReference" |
| 641 }, |
| 642 "type": "array" |
| 643 }, |
| 644 "httpRequest": { |
| 645 "$ref": "HttpRequestContext", |
| 646 "description": "The HTTP request which was processed when th
e error was\ntriggered." |
| 647 } |
| 648 }, |
| 649 "type": "object" |
| 650 }, |
| 651 "TrackingIssue": { |
| 652 "description": "Information related to tracking the progress on reso
lving the error.", |
| 653 "id": "TrackingIssue", |
| 654 "properties": { |
| 655 "url": { |
| 656 "description": "A URL pointing to a related entry in an issu
e tracking system.\nExample: https://github.com/user/project/issues/4", |
| 657 "type": "string" |
| 658 } |
| 659 }, |
| 660 "type": "object" |
| 661 }, |
| 662 "ErrorGroupStats": { |
| 663 "description": "Data extracted for a specific group based on certain
filter criteria,\nsuch as a given time period and/or service filter.", |
| 664 "id": "ErrorGroupStats", |
| 665 "properties": { |
| 666 "group": { |
| 667 "$ref": "ErrorGroup", |
| 668 "description": "Group data that is independent of the filter
criteria." |
| 669 }, |
| 670 "firstSeenTime": { |
| 671 "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.", |
| 672 "format": "google-datetime", |
| 673 "type": "string" |
| 674 }, |
| 675 "count": { |
| 676 "description": "Approximate total number of events in the gi
ven group that match\nthe filter criteria.", |
| 677 "format": "int64", |
| 678 "type": "string" |
| 679 }, |
| 680 "affectedUsersCount": { |
| 681 "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.", |
| 682 "format": "int64", |
| 683 "type": "string" |
| 684 }, |
| 685 "lastSeenTime": { |
| 686 "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.", |
| 687 "format": "google-datetime", |
| 688 "type": "string" |
| 689 }, |
| 690 "affectedServices": { |
| 691 "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.", |
| 692 "items": { |
| 693 "$ref": "ServiceContext" |
| 694 }, |
| 695 "type": "array" |
| 696 }, |
| 697 "numAffectedServices": { |
| 698 "description": "The total number of services with a non-zero
error count for the given\nfilter criteria.", |
| 699 "format": "int32", |
| 700 "type": "integer" |
| 701 }, |
| 702 "representative": { |
| 703 "$ref": "ErrorEvent", |
| 704 "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." |
| 705 }, |
| 706 "timedCounts": { |
| 707 "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.", |
| 708 "items": { |
| 709 "$ref": "TimedCount" |
| 710 }, |
| 711 "type": "array" |
| 712 } |
| 713 }, |
| 714 "type": "object" |
| 715 }, |
| 716 "ListEventsResponse": { |
| 717 "description": "Contains a set of requested error events.", |
| 718 "id": "ListEventsResponse", |
| 719 "properties": { |
| 720 "errorEvents": { |
| 721 "description": "The error events which match the given reque
st.", |
| 722 "items": { |
| 723 "$ref": "ErrorEvent" |
| 724 }, |
| 725 "type": "array" |
| 726 }, |
| 727 "nextPageToken": { |
| 728 "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.", |
| 729 "type": "string" |
| 730 }, |
| 731 "timeRangeBegin": { |
| 732 "description": "The timestamp specifies the start time to wh
ich the request was restricted.", |
| 733 "format": "google-datetime", |
| 734 "type": "string" |
| 735 } |
| 736 }, |
| 737 "type": "object" |
738 } | 738 } |
739 }, | 739 }, |
740 "servicePath": "", | 740 "servicePath": "", |
741 "title": "Stackdriver Error Reporting API", | 741 "title": "Stackdriver Error Reporting API", |
742 "version": "v1beta1" | 742 "version": "v1beta1" |
743 } | 743 } |
OLD | NEW |