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 }, |
(...skipping 28 matching lines...) Expand all Loading... |
39 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", | 39 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", |
40 "location": "query", | 40 "location": "query", |
41 "type": "string" | 41 "type": "string" |
42 }, | 42 }, |
43 "prettyPrint": { | 43 "prettyPrint": { |
44 "default": "true", | 44 "default": "true", |
45 "description": "Returns response with indentations and line breaks."
, | 45 "description": "Returns response with indentations and line breaks."
, |
46 "location": "query", | 46 "location": "query", |
47 "type": "boolean" | 47 "type": "boolean" |
48 }, | 48 }, |
| 49 "fields": { |
| 50 "description": "Selector specifying which fields to include in a par
tial response.", |
| 51 "location": "query", |
| 52 "type": "string" |
| 53 }, |
49 "uploadType": { | 54 "uploadType": { |
50 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", | 55 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", |
51 "location": "query", | 56 "location": "query", |
52 "type": "string" | 57 "type": "string" |
53 }, | 58 }, |
54 "fields": { | |
55 "description": "Selector specifying which fields to include in a par
tial response.", | |
56 "location": "query", | |
57 "type": "string" | |
58 }, | |
59 "callback": { | 59 "callback": { |
60 "description": "JSONP", | 60 "description": "JSONP", |
61 "location": "query", | 61 "location": "query", |
62 "type": "string" | 62 "type": "string" |
63 }, | 63 }, |
64 "$.xgafv": { | 64 "$.xgafv": { |
65 "description": "V1 error format.", | 65 "description": "V1 error format.", |
66 "enum": [ | 66 "enum": [ |
67 "1", | 67 "1", |
68 "2" | 68 "2" |
(...skipping 14 matching lines...) Expand all Loading... |
83 "proto" | 83 "proto" |
84 ], | 84 ], |
85 "enumDescriptions": [ | 85 "enumDescriptions": [ |
86 "Responses with Content-Type of application/json", | 86 "Responses with Content-Type of application/json", |
87 "Media download with context-dependent Content-Type", | 87 "Media download with context-dependent Content-Type", |
88 "Responses with Content-Type of application/x-protobuf" | 88 "Responses with Content-Type of application/x-protobuf" |
89 ], | 89 ], |
90 "location": "query", | 90 "location": "query", |
91 "type": "string" | 91 "type": "string" |
92 }, | 92 }, |
| 93 "access_token": { |
| 94 "description": "OAuth access token.", |
| 95 "location": "query", |
| 96 "type": "string" |
| 97 }, |
93 "key": { | 98 "key": { |
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.", | 99 "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.", |
95 "location": "query", | 100 "location": "query", |
96 "type": "string" | 101 "type": "string" |
97 }, | 102 }, |
98 "access_token": { | |
99 "description": "OAuth access token.", | |
100 "location": "query", | |
101 "type": "string" | |
102 }, | |
103 "quotaUser": { | 103 "quotaUser": { |
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.", | 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.", |
105 "location": "query", | 105 "location": "query", |
106 "type": "string" | 106 "type": "string" |
107 }, | 107 }, |
108 "pp": { | 108 "pp": { |
109 "default": "true", | 109 "default": "true", |
110 "description": "Pretty-print response.", | 110 "description": "Pretty-print response.", |
111 "location": "query", | 111 "location": "query", |
112 "type": "boolean" | 112 "type": "boolean" |
(...skipping 87 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 "pageToken": { | |
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.", | |
212 "location": "query", | |
213 "type": "string" | |
214 }, | |
215 "timeRange.period": { | 210 "timeRange.period": { |
216 "description": "Restricts the query to the s
pecified time range.", | 211 "description": "Restricts the query to the s
pecified time range.", |
217 "enum": [ | 212 "enum": [ |
218 "PERIOD_UNSPECIFIED", | 213 "PERIOD_UNSPECIFIED", |
219 "PERIOD_1_HOUR", | 214 "PERIOD_1_HOUR", |
220 "PERIOD_6_HOURS", | 215 "PERIOD_6_HOURS", |
221 "PERIOD_1_DAY", | 216 "PERIOD_1_DAY", |
222 "PERIOD_1_WEEK", | 217 "PERIOD_1_WEEK", |
223 "PERIOD_30_DAYS" | 218 "PERIOD_30_DAYS" |
224 ], | 219 ], |
(...skipping 37 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
262 "AFFECTED_USERS_DESC" | 257 "AFFECTED_USERS_DESC" |
263 ], | 258 ], |
264 "location": "query", | 259 "location": "query", |
265 "type": "string" | 260 "type": "string" |
266 }, | 261 }, |
267 "serviceFilter.version": { | 262 "serviceFilter.version": { |
268 "description": "[Optional] The exact value t
o match against\n[`ServiceContext.version`](/error-reporting/reference/rest/v1be
ta1/ServiceContext#FIELDS.version).", | 263 "description": "[Optional] The exact value t
o match against\n[`ServiceContext.version`](/error-reporting/reference/rest/v1be
ta1/ServiceContext#FIELDS.version).", |
269 "location": "query", | 264 "location": "query", |
270 "type": "string" | 265 "type": "string" |
271 }, | 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": { | 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.", | 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", | 274 "format": "google-datetime", |
275 "location": "query", | 275 "location": "query", |
276 "type": "string" | 276 "type": "string" |
277 }, | 277 }, |
278 "serviceFilter.resourceType": { | |
279 "description": "[Optional] The exact value t
o match against\n[`ServiceContext.resource_type`](/error-reporting/reference/res
t/v1beta1/ServiceContext#FIELDS.resource_type).", | |
280 "location": "query", | |
281 "type": "string" | |
282 }, | |
283 "projectName": { | 278 "projectName": { |
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>.", | 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>.", |
285 "location": "path", | 280 "location": "path", |
286 "pattern": "^projects/[^/]+$", | 281 "pattern": "^projects/[^/]+$", |
287 "required": true, | 282 "required": true, |
288 "type": "string" | 283 "type": "string" |
289 }, | 284 }, |
290 "timedCountDuration": { | 285 "timedCountDuration": { |
291 "description": "[Optional] The preferred dur
ation for a single returned `TimedCount`.\nIf not set, no timed counts are retur
ned.", | 286 "description": "[Optional] The preferred dur
ation for a single returned `TimedCount`.\nIf not set, no timed counts are retur
ned.", |
292 "format": "google-duration", | 287 "format": "google-duration", |
293 "location": "query", | 288 "location": "query", |
294 "type": "string" | 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 "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 18 matching lines...) Expand all Loading... |
337 "location": "path", | 364 "location": "path", |
338 "pattern": "^projects/[^/]+$", | 365 "pattern": "^projects/[^/]+$", |
339 "required": true, | 366 "required": true, |
340 "type": "string" | 367 "type": "string" |
341 }, | 368 }, |
342 "groupId": { | 369 "groupId": { |
343 "description": "[Required] The group for whi
ch events shall be returned.", | 370 "description": "[Required] The group for whi
ch events shall be returned.", |
344 "location": "query", | 371 "location": "query", |
345 "type": "string" | 372 "type": "string" |
346 }, | 373 }, |
| 374 "serviceFilter.service": { |
| 375 "description": "[Optional] The exact value t
o match against\n[`ServiceContext.service`](/error-reporting/reference/rest/v1be
ta1/ServiceContext#FIELDS.service).", |
| 376 "location": "query", |
| 377 "type": "string" |
| 378 }, |
347 "pageToken": { | 379 "pageToken": { |
348 "description": "[Optional] A `next_page_toke
n` provided by a previous response.", | 380 "description": "[Optional] A `next_page_toke
n` provided by a previous response.", |
349 "location": "query", | 381 "location": "query", |
350 "type": "string" | 382 "type": "string" |
351 }, | 383 }, |
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": { | 384 "pageSize": { |
358 "description": "[Optional] The maximum numbe
r of results to return per response.", | 385 "description": "[Optional] The maximum numbe
r of results to return per response.", |
359 "format": "int32", | 386 "format": "int32", |
360 "location": "query", | 387 "location": "query", |
361 "type": "integer" | 388 "type": "integer" |
362 }, | 389 }, |
363 "serviceFilter.version": { | 390 "serviceFilter.version": { |
364 "description": "[Optional] The exact value t
o match against\n[`ServiceContext.version`](/error-reporting/reference/rest/v1be
ta1/ServiceContext#FIELDS.version).", | 391 "description": "[Optional] The exact value t
o match against\n[`ServiceContext.version`](/error-reporting/reference/rest/v1be
ta1/ServiceContext#FIELDS.version).", |
365 "location": "query", | 392 "location": "query", |
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": "20170113", | 409 "revision": "20170206", |
410 "rootUrl": "https://clouderrorreporting.googleapis.com/", | 410 "rootUrl": "https://clouderrorreporting.googleapis.com/", |
411 "schemas": { | 411 "schemas": { |
| 412 "ErrorEvent": { |
| 413 "description": "An error event which is returned by the Error Report
ing system.", |
| 414 "id": "ErrorEvent", |
| 415 "properties": { |
| 416 "eventTime": { |
| 417 "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.", |
| 418 "format": "google-datetime", |
| 419 "type": "string" |
| 420 }, |
| 421 "context": { |
| 422 "$ref": "ErrorContext", |
| 423 "description": "Data about the context in which the error oc
curred." |
| 424 }, |
| 425 "message": { |
| 426 "description": "The stack trace that was reported or logged
by the service.", |
| 427 "type": "string" |
| 428 }, |
| 429 "serviceContext": { |
| 430 "$ref": "ServiceContext", |
| 431 "description": "The `ServiceContext` for which this error wa
s reported." |
| 432 } |
| 433 }, |
| 434 "type": "object" |
| 435 }, |
412 "ReportedErrorEvent": { | 436 "ReportedErrorEvent": { |
413 "description": "An error event which is reported to the Error Report
ing system.", | 437 "description": "An error event which is reported to the Error Report
ing system.", |
414 "id": "ReportedErrorEvent", | 438 "id": "ReportedErrorEvent", |
415 "properties": { | 439 "properties": { |
416 "serviceContext": { | 440 "serviceContext": { |
417 "$ref": "ServiceContext", | 441 "$ref": "ServiceContext", |
418 "description": "[Required] The service context in which this
error has occurred." | 442 "description": "[Required] The service context in which this
error has occurred." |
419 }, | 443 }, |
420 "eventTime": { | 444 "eventTime": { |
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.", | 445 "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.", |
422 "format": "google-datetime", | 446 "format": "google-datetime", |
423 "type": "string" | 447 "type": "string" |
424 }, | 448 }, |
425 "context": { | 449 "context": { |
426 "$ref": "ErrorContext", | 450 "$ref": "ErrorContext", |
427 "description": "[Optional] A description of the context in w
hich the error occurred." | 451 "description": "[Optional] A description of the context in w
hich the error occurred." |
428 }, | 452 }, |
429 "message": { | 453 "message": { |
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).", | 454 "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" | 455 "type": "string" |
432 } | 456 } |
433 }, | 457 }, |
434 "type": "object" | 458 "type": "object" |
435 }, | 459 }, |
436 "ErrorContext": { | 460 "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.", | 461 "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", | 462 "id": "ErrorContext", |
439 "properties": { | 463 "properties": { |
| 464 "reportLocation": { |
| 465 "$ref": "SourceLocation", |
| 466 "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." |
| 467 }, |
440 "httpRequest": { | 468 "httpRequest": { |
441 "$ref": "HttpRequestContext", | 469 "$ref": "HttpRequestContext", |
442 "description": "The HTTP request which was processed when th
e error was\ntriggered." | 470 "description": "The HTTP request which was processed when th
e error was\ntriggered." |
443 }, | 471 }, |
444 "user": { | 472 "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`.", | 473 "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`.", |
446 "type": "string" | 474 "type": "string" |
447 }, | |
448 "reportLocation": { | |
449 "$ref": "SourceLocation", | |
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." | |
451 } | 475 } |
452 }, | 476 }, |
453 "type": "object" | 477 "type": "object" |
454 }, | 478 }, |
455 "TrackingIssue": { | 479 "TrackingIssue": { |
456 "description": "Information related to tracking the progress on reso
lving the error.", | 480 "description": "Information related to tracking the progress on reso
lving the error.", |
457 "id": "TrackingIssue", | 481 "id": "TrackingIssue", |
458 "properties": { | 482 "properties": { |
459 "url": { | 483 "url": { |
460 "description": "A URL pointing to a related entry in an issu
e tracking system.\nExample: https://github.com/user/project/issues/4", | 484 "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" | 485 "type": "string" |
462 } | 486 } |
463 }, | 487 }, |
464 "type": "object" | 488 "type": "object" |
465 }, | 489 }, |
466 "ErrorGroupStats": { | 490 "ErrorGroupStats": { |
467 "description": "Data extracted for a specific group based on certain
filter criteria,\nsuch as a given time period and/or service filter.", | 491 "description": "Data extracted for a specific group based on certain
filter criteria,\nsuch as a given time period and/or service filter.", |
468 "id": "ErrorGroupStats", | 492 "id": "ErrorGroupStats", |
469 "properties": { | 493 "properties": { |
| 494 "representative": { |
| 495 "$ref": "ErrorEvent", |
| 496 "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." |
| 497 }, |
470 "timedCounts": { | 498 "timedCounts": { |
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.", | 499 "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.", |
472 "items": { | 500 "items": { |
473 "$ref": "TimedCount" | 501 "$ref": "TimedCount" |
474 }, | 502 }, |
475 "type": "array" | 503 "type": "array" |
476 }, | 504 }, |
477 "group": { | 505 "group": { |
478 "$ref": "ErrorGroup", | 506 "$ref": "ErrorGroup", |
479 "description": "Group data that is independent of the filter
criteria." | 507 "description": "Group data that is independent of the filter
criteria." |
(...skipping 22 matching lines...) Expand all Loading... |
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.", | 530 "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.", |
503 "items": { | 531 "items": { |
504 "$ref": "ServiceContext" | 532 "$ref": "ServiceContext" |
505 }, | 533 }, |
506 "type": "array" | 534 "type": "array" |
507 }, | 535 }, |
508 "numAffectedServices": { | 536 "numAffectedServices": { |
509 "description": "The total number of services with a non-zero
error count for the given\nfilter criteria.", | 537 "description": "The total number of services with a non-zero
error count for the given\nfilter criteria.", |
510 "format": "int32", | 538 "format": "int32", |
511 "type": "integer" | 539 "type": "integer" |
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 } | 540 } |
517 }, | 541 }, |
518 "type": "object" | 542 "type": "object" |
519 }, | 543 }, |
520 "ListEventsResponse": { | 544 "ListEventsResponse": { |
521 "description": "Contains a set of requested error events.", | 545 "description": "Contains a set of requested error events.", |
522 "id": "ListEventsResponse", | 546 "id": "ListEventsResponse", |
523 "properties": { | 547 "properties": { |
524 "timeRangeBegin": { | |
525 "description": "The timestamp specifies the start time to wh
ich the request was restricted.", | |
526 "format": "google-datetime", | |
527 "type": "string" | |
528 }, | |
529 "errorEvents": { | 548 "errorEvents": { |
530 "description": "The error events which match the given reque
st.", | 549 "description": "The error events which match the given reque
st.", |
531 "items": { | 550 "items": { |
532 "$ref": "ErrorEvent" | 551 "$ref": "ErrorEvent" |
533 }, | 552 }, |
534 "type": "array" | 553 "type": "array" |
535 }, | 554 }, |
536 "nextPageToken": { | 555 "nextPageToken": { |
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.", | 556 "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.", |
538 "type": "string" | 557 "type": "string" |
| 558 }, |
| 559 "timeRangeBegin": { |
| 560 "description": "The timestamp specifies the start time to wh
ich the request was restricted.", |
| 561 "format": "google-datetime", |
| 562 "type": "string" |
539 } | 563 } |
540 }, | 564 }, |
541 "type": "object" | 565 "type": "object" |
542 }, | 566 }, |
543 "TimedCount": { | 567 "TimedCount": { |
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."
, | 568 "description": "The number of errors in a given time period.\nAll nu
mbers are approximate since the error events are sampled\nbefore counting them."
, |
545 "id": "TimedCount", | 569 "id": "TimedCount", |
546 "properties": { | 570 "properties": { |
547 "endTime": { | 571 "endTime": { |
548 "description": "End of the time period to which `count` refe
rs (excluded).", | 572 "description": "End of the time period to which `count` refe
rs (excluded).", |
(...skipping 32 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
581 "description": "The group resource name.\nExample: <code>pro
jects/my-project-123/groups/my-groupid</code>", | 605 "description": "The group resource name.\nExample: <code>pro
jects/my-project-123/groups/my-groupid</code>", |
582 "type": "string" | 606 "type": "string" |
583 } | 607 } |
584 }, | 608 }, |
585 "type": "object" | 609 "type": "object" |
586 }, | 610 }, |
587 "SourceLocation": { | 611 "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.", | 612 "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", | 613 "id": "SourceLocation", |
590 "properties": { | 614 "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": { | 615 "lineNumber": { |
596 "description": "1-based. 0 indicates that the line number is
unknown.", | 616 "description": "1-based. 0 indicates that the line number is
unknown.", |
597 "format": "int32", | 617 "format": "int32", |
598 "type": "integer" | 618 "type": "integer" |
599 }, | 619 }, |
600 "functionName": { | 620 "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.", | 621 "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" | 622 "type": "string" |
| 623 }, |
| 624 "filePath": { |
| 625 "description": "The source code filename, which can include
a truncated relative\npath, or a full path from a production machine.", |
| 626 "type": "string" |
603 } | 627 } |
604 }, | 628 }, |
605 "type": "object" | 629 "type": "object" |
606 }, | 630 }, |
607 "ServiceContext": { | 631 "ServiceContext": { |
608 "description": "Describes a running service that sends errors.\nIts
version changes over time and multiple versions can run in parallel.", | 632 "description": "Describes a running service that sends errors.\nIts
version changes over time and multiple versions can run in parallel.", |
609 "id": "ServiceContext", | 633 "id": "ServiceContext", |
610 "properties": { | 634 "properties": { |
611 "service": { | 635 "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.", | 636 "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.", |
(...skipping 13 matching lines...) Expand all Loading... |
626 "ReportErrorEventResponse": { | 650 "ReportErrorEventResponse": { |
627 "description": "Response for reporting an individual error event.\nD
ata may be added to this message in the future.", | 651 "description": "Response for reporting an individual error event.\nD
ata may be added to this message in the future.", |
628 "id": "ReportErrorEventResponse", | 652 "id": "ReportErrorEventResponse", |
629 "properties": {}, | 653 "properties": {}, |
630 "type": "object" | 654 "type": "object" |
631 }, | 655 }, |
632 "HttpRequestContext": { | 656 "HttpRequestContext": { |
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.", | 657 "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.", |
634 "id": "HttpRequestContext", | 658 "id": "HttpRequestContext", |
635 "properties": { | 659 "properties": { |
| 660 "referrer": { |
| 661 "description": "The referrer information that is provided wi
th the request.", |
| 662 "type": "string" |
| 663 }, |
636 "userAgent": { | 664 "userAgent": { |
637 "description": "The user agent information that is provided
with the request.", | 665 "description": "The user agent information that is provided
with the request.", |
638 "type": "string" | 666 "type": "string" |
639 }, | 667 }, |
640 "url": { | 668 "url": { |
641 "description": "The URL of the request.", | 669 "description": "The URL of the request.", |
642 "type": "string" | 670 "type": "string" |
643 }, | 671 }, |
644 "responseStatusCode": { | 672 "responseStatusCode": { |
645 "description": "The HTTP response status code for the reques
t.", | 673 "description": "The HTTP response status code for the reques
t.", |
646 "format": "int32", | 674 "format": "int32", |
647 "type": "integer" | 675 "type": "integer" |
648 }, | 676 }, |
649 "method": { | 677 "method": { |
650 "description": "The type of HTTP request, such as `GET`, `PO
ST`, etc.", | 678 "description": "The type of HTTP request, such as `GET`, `PO
ST`, etc.", |
651 "type": "string" | 679 "type": "string" |
652 }, | 680 }, |
653 "remoteIp": { | 681 "remoteIp": { |
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.", | 682 "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.", |
655 "type": "string" | 683 "type": "string" |
656 }, | |
657 "referrer": { | |
658 "description": "The referrer information that is provided wi
th the request.", | |
659 "type": "string" | |
660 } | 684 } |
661 }, | 685 }, |
662 "type": "object" | 686 "type": "object" |
663 }, | 687 }, |
664 "ListGroupStatsResponse": { | 688 "ListGroupStatsResponse": { |
665 "description": "Contains a set of requested error group stats.", | 689 "description": "Contains a set of requested error group stats.", |
666 "id": "ListGroupStatsResponse", | 690 "id": "ListGroupStatsResponse", |
667 "properties": { | 691 "properties": { |
668 "nextPageToken": { | 692 "nextPageToken": { |
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.", | 693 "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 12 matching lines...) Expand all Loading... |
682 "type": "array" | 706 "type": "array" |
683 } | 707 } |
684 }, | 708 }, |
685 "type": "object" | 709 "type": "object" |
686 }, | 710 }, |
687 "DeleteEventsResponse": { | 711 "DeleteEventsResponse": { |
688 "description": "Response message for deleting error events.", | 712 "description": "Response message for deleting error events.", |
689 "id": "DeleteEventsResponse", | 713 "id": "DeleteEventsResponse", |
690 "properties": {}, | 714 "properties": {}, |
691 "type": "object" | 715 "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 |