4a7494a · gogol · git.iko.soy

99 }

1010 }

1111 },

12− "description": "Stackdriver Error Reporting groups and counts similar errors from cloud services. The Stackdriver Error Reporting API provides read access to error groups and their associated errors.\n",

12+ "description": "Stackdriver Error Reporting groups and counts similar errors from cloud services. The Stackdriver Error Reporting API provides a way to report new errors and read access to error groups and their associated errors.\n",

1313 "protocol": "rest",

1414 "title": "Stackdriver Error Reporting API",

1515 "resources": {

4343 "type": "string"

4444 },

4545 "projectName": {

46− "description": "The resource name of the Google Cloud Platform project. Required.\nExample: projects/my-project",

46+ "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).\nExample: `projects/my-project-123`.",

4747 "required": true,

4848 "pattern": "^projects/[^/]*$",

4949 "location": "path",

5050 "type": "string"

5151 },

5252 "serviceFilter.service": {

53− "description": "The exact value to match against\n[`ServiceContext.service`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.service).",

53+ "description": "[Optional] The exact value to match against\n[`ServiceContext.service`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.service).",

5454 "location": "query",

5555 "type": "string"

5656 },

5757 "groupId": {

58− "description": "The group for which events shall be returned. Required.",

58+ "description": "[Required] The group for which events shall be returned.",

5959 "location": "query",

6060 "type": "string"

6161 },

6262 "serviceFilter.version": {

63− "description": "The exact value to match against\n[`ServiceContext.version`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.version).",

63+ "description": "[Optional] The exact value to match against\n[`ServiceContext.version`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.version).",

6464 "location": "query",

6565 "type": "string"

6666 },

6767 "pageSize": {

68− "description": "The maximum number of results to return per response.",

68+ "description": "[Optional] The maximum number of results to return per response.",

6969 "location": "query",

7070 "type": "integer",

7171 "format": "int32"

7272 },

7373 "pageToken": {

74− "description": "A `next_page_token` provided by a previous response.",

74+ "description": "[Optional] A `next_page_token` provided by a previous response.",

7575 "location": "query",

7676 "type": "string"

7777 }

8080 "scopes": [

8181 "https://www.googleapis.com/auth/cloud-platform"

8282 ]

83+ },

84+ "report": {

85+ "id": "clouderrorreporting.projects.events.report",

86+ "response": {

87+ "$ref": "ReportErrorEventResponse"

88+ },

89+ "parameterOrder": [

90+ "projectName"

91+ ],

92+ "description": "Report an individual error event.\n\nThis endpoint accepts \u003cstrong\u003eeither\u003c/strong\u003e an OAuth token,\n\u003cstrong\u003eor\u003c/strong\u003e an\n\u003ca href=\"https://support.google.com/cloud/answer/6158862\"\u003eAPI key\u003c/a\u003e\nfor authentication. To use an API key, append it to the URL as the value of\na `key` parameter. For example:\n\u003cpre\u003ePOST https://clouderrorreporting.googleapis.com/v1beta1/projects/example-project/events:report?key=123ABC456\u003c/pre\u003e",

93+ "request": {

94+ "$ref": "ReportedErrorEvent"

95+ },

96+ "flatPath": "v1beta1/projects/{projectsId}/events:report",

97+ "httpMethod": "POST",

98+ "parameters": {

99+ "projectName": {

100+ "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).\nExample: `projects/my-project-123`.",

101+ "required": true,

102+ "pattern": "^projects/[^/]*$",

103+ "location": "path",

104+ "type": "string"

105+ }

106+ },

107+ "path": "v1beta1/{+projectName}/events:report",

108+ "scopes": [

109+ "https://www.googleapis.com/auth/cloud-platform"

110+ ]

83111 }

84112 }

85113 },

101129 "httpMethod": "PUT",

102130 "parameters": {

103131 "name": {

104− "description": "Group resource name.\nExample: `projects/my-project-123/groups/my-groupid`",

132+ "description": "The group resource name.\nExample: \u003ccode\u003eprojects/my-project-123/groups/my-groupid\u003c/code\u003e",

105133 "required": true,

106134 "pattern": "^projects/[^/]*/groups/[^/]*$",

107135 "location": "path",

126154 "httpMethod": "GET",

127155 "parameters": {

128156 "groupName": {

129− "description": "Group resource name. Required.\nExample: `projects/my-project-123/groups/my-group`",

157+ "description": "[Required] The group resource name. Written as\n\u003ccode\u003eprojects/\u003cvar\u003eprojectID\u003c/var\u003e/groups/\u003cvar\u003egroup_name\u003c/var\u003e\u003c/code\u003e.\nCall\n\u003ca href=\"/error-reporting/reference/rest/v1beta1/projects.groupStats/list\"\u003e\n\u003ccode\u003egroupStats.list\u003c/code\u003e\u003c/a\u003e to return a list of groups belonging to\nthis project.\n\nExample: \u003ccode\u003eprojects/my-project-123/groups/my-group\u003c/code\u003e",

130158 "required": true,

131159 "pattern": "^projects/[^/]*/groups/[^/]*$",

132160 "location": "path",

155183 "httpMethod": "GET",

156184 "parameters": {

157185 "alignment": {

158− "description": "The alignment of the timed counts to be returned.\nDefault is `ALIGNMENT_EQUAL_AT_END`.",

186+ "description": "[Optional] The alignment of the timed counts to be returned.\nDefault is `ALIGNMENT_EQUAL_AT_END`.",

159187 "enum": [

160188 "ERROR_COUNT_ALIGNMENT_UNSPECIFIED",

161189 "ALIGNMENT_EQUAL_ROUNDED",

178206 "type": "string"

179207 },

180208 "projectName": {

181− "description": "The resource name of the Google Cloud Platform project. Written as\n`projects/` plus the\n[Google Cloud Platform project ID](https://support.google.com/cloud/answer/6158840).\nRequired. Example: `projects/my-project-123`.",

209+ "description": "[Required] The resource name of the Google Cloud Platform project. Written\nas \u003ccode\u003eprojects/\u003c/code\u003e plus the\n\u003ca href=\"https://support.google.com/cloud/answer/6158840\"\u003eGoogle Cloud\nPlatform project ID\u003c/a\u003e.\n\nExample: \u003ccode\u003eprojects/my-project-123\u003c/code\u003e.",

182210 "required": true,

183211 "pattern": "^projects/[^/]*$",

184212 "location": "path",

185213 "type": "string"

186214 },

187215 "order": {

188− "description": "The sort order in which the results are returned.\nDefault is `COUNT_DESC`.",

216+ "description": "[Optional] The sort order in which the results are returned.\nDefault is `COUNT_DESC`.",

189217 "enum": [

190218 "GROUP_ORDER_UNSPECIFIED",

191219 "COUNT_DESC",

197225 "type": "string"

198226 },

199227 "groupId": {

200− "description": "List all `ErrorGroupStats` with these IDs.\nIf not specified, all error group stats with a non-zero error count\nfor the given selection criteria are returned.",

228+ "description": "[Optional] List all \u003ccode\u003eErrorGroupStats\u003c/code\u003e with these IDs.",

201229 "repeated": true,

202230 "location": "query",

203231 "type": "string"

204232 },

205233 "serviceFilter.service": {

206− "description": "The exact value to match against\n[`ServiceContext.service`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.service).",

234+ "description": "[Optional] The exact value to match against\n[`ServiceContext.service`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.service).",

207235 "location": "query",

208236 "type": "string"

209237 },

210238 "alignmentTime": {

211− "description": "Time where the timed counts shall be aligned if rounded alignment\nis chosen. Default is 00:00 UTC.",

239+ "description": "[Optional] Time where the timed counts shall be aligned if rounded\nalignment is chosen. Default is 00:00 UTC.",

212240 "location": "query",

213241 "type": "string",

214242 "format": "google-datetime"

215243 },

216244 "serviceFilter.version": {

217− "description": "The exact value to match against\n[`ServiceContext.version`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.version).",

245+ "description": "[Optional] The exact value to match against\n[`ServiceContext.version`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.version).",

218246 "location": "query",

219247 "type": "string"

220248 },

221249 "pageSize": {

222− "description": "The maximum number of results to return per response.\nDefault is 20.",

250+ "description": "[Optional] The maximum number of results to return per response.\nDefault is 20.",

223251 "location": "query",

224252 "type": "integer",

225253 "format": "int32"

226254 },

227255 "timedCountDuration": {

228− "description": "The preferred duration for a single returned `TimedCount`.\nIf not set, no timed counts are returned.",

256+ "description": "[Optional] The preferred duration for a single returned `TimedCount`.\nIf not set, no timed counts are returned.",

229257 "location": "query",

230258 "type": "string",

231259 "format": "google-duration"

232260 },

233261 "pageToken": {

234− "description": "A `next_page_token` provided by a previous response. To view additional\nresults, pass this token along with the identical query parameters as the\nfirst request.",

262+ "description": "[Optional] A `next_page_token` provided by a previous response. To view\nadditional results, pass this token along with the identical query\nparameters as the first request.",

235263 "location": "query",

236264 "type": "string"

237265 }

258286 "httpMethod": "DELETE",

259287 "parameters": {

260288 "projectName": {

261− "description": "The resource name of the Google Cloud Platform project. Required.\nExample: `projects/my-project`.",

289+ "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).\nExample: `projects/my-project-123`.",

262290 "required": true,

263291 "pattern": "^projects/[^/]*$",

264292 "location": "path",

274302 }

275303 },

276304 "schemas": {

305+ "ReportedErrorEvent": {

306+ "description": "An error event which is reported to the Error Reporting system.",

307+ "type": "object",

308+ "properties": {

309+ "serviceContext": {

310+ "description": "[Required] The service context in which this error has occurred.",

311+ "$ref": "ServiceContext"

312+ },

313+ "context": {

314+ "description": "[Optional] A description of the context in which the error occurred.",

315+ "$ref": "ErrorContext"

316+ },

317+ "eventTime": {

318+ "description": "[Optional] Time when the event occurred.\nIf not provided, the time when the event was received by the\nError Reporting system will be used.",

319+ "type": "string",

320+ "format": "google-datetime"

321+ },

322+ "message": {

323+ "description": "[Required] A message describing the error. The message can contain an\nexception stack in one of the supported programming languages and formats.\nIn that case, the message is parsed and detailed exception information\nis returned when retrieving the error event again.",

324+ "type": "string"

325+ }

326+ },

327+ "id": "ReportedErrorEvent"

328+ },

277329 "SourceLocation": {

278330 "description": "Indicates a location in the source code of the service for which\nerrors are reported.\nThis data should be provided by the application when reporting an error,\nunless the error report has been generated automatically from Google App\nEngine logs. All fields are optional.",

279331 "type": "object",

280332 "properties": {

281333 "filePath": {

282− "description": "The source code filename, which can include a truncated relative path, or\na full path from a production machine.",

334+ "description": "The source code filename, which can include a truncated relative\npath, or a full path from a production machine.",

283335 "type": "string"

284336 },

285337 "functionName": {

295347 "id": "SourceLocation"

296348 },

297349 "ErrorGroupStats": {

298− "description": "Data extracted for a specific group based on certain selection criteria,\nsuch as a given time period and/or service filter.",

350+ "description": "Data extracted for a specific group based on certain filter criteria,\nsuch as a given time period and/or service filter.",

299351 "type": "object",

300352 "properties": {

301353 "representative": {

303355 "$ref": "ErrorEvent"

304356 },

305357 "numAffectedServices": {

306− "description": "The total number of services with a non-zero error count for the given\nselection criteria.",

358+ "description": "The total number of services with a non-zero error count for the given\nfilter criteria.",

307359 "type": "integer",

308360 "format": "int32"

309361 },

310362 "affectedUsersCount": {

311− "description": "Approximate number of affected users in the given group that\nmatch the selection 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 users 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 are\nimplicitly affected, such as due to a crash of the whole service,\nthis is not reflected here.",

363+ "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 users 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 are\nimplicitly affected, such as due to a crash of the whole service,\nthis is not reflected here.",

312364 "type": "string",

313365 "format": "int64"

314366 },

315367 "count": {

316− "description": "Approximate total number of events in the given group that match\nthe selection criteria.",

368+ "description": "Approximate total number of events in the given group that match\nthe filter criteria.",

317369 "type": "string",

318370 "format": "int64"

319371 },

320372 "firstSeenTime": {

321− "description": "Approximate first occurrence that was seen for this group and\nwhich matches the given selection criteria.",

373+ "description": "Approximate first occurrence that was ever seen for this group\nand which matches the given filter criteria, ignoring the\ntime_range that was specified in the request.",

322374 "type": "string",

323375 "format": "google-datetime"

324376 },

325377 "lastSeenTime": {

326− "description": "Approximate last occurrence that was seen for this group\nand which matches the given selection criteria.",

378+ "description": "Approximate last occurrence that was ever seen for this group and\nwhich matches the given filter criteria, ignoring the time_range\nthat was specified in the request.",

327379 "type": "string",

328380 "format": "google-datetime"

329381 },

330382 "group": {

331− "description": "Group data that is independent of the selection criteria.",

383+ "description": "Group data that is independent of the filter criteria.",

332384 "$ref": "ErrorGroup"

333385 },

334386 "affectedServices": {

335− "description": "Service contexts with a non-zero error count for the given selection\ncriteria. This list can be truncated if multiple services are affected.\nRefer to `num_affected_services` for the total count.",

387+ "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.",

336388 "type": "array",

337389 "items": {

338390 "$ref": "ServiceContext"

349401 "id": "ErrorGroupStats"

350402 },

351403 "ErrorContext": {

352− "description": "A description of the context in which an error occurred.\nThis data should be provided by the application when reporting an error,\nunless the\nerror report has been generated automatically from Google App Engine logs.\nAll fields are optional.",

404+ "description": "A description of the context in which an error occurred.\nThis data should be provided by the application when reporting an error,\nunless the\nerror report has been generated automatically from Google App Engine logs.",

353405 "type": "object",

354406 "properties": {

355407 "httpRequest": {

356− "description": "The HTTP request which was processed when the error was triggered.",

408+ "description": "The HTTP request which was processed when the error was\ntriggered.",

357409 "$ref": "HttpRequestContext"

358410 },

359411 "reportLocation": {

372424 "type": "object",

373425 "properties": {

374426 "service": {

375− "description": "An identifier of the service, such as the name of the executable, job, or\nGoogle App Engine module name. This field is expected to have a low number\nof values that are relatively stable over time, as opposed to\n`version`, which can be changed whenever new code is deployed.\n\nContains the module name for error reports extracted from Google\nApp Engine logs or `default` if the App Engine default module is used.",

427+ "description": "An identifier of the service, such as the name of the\nexecutable, job, or Google App Engine service name. This field is expected\nto have a low number of values that are relatively stable over time, as\nopposed to `version`, which can be changed whenever new code is deployed.\n\nContains the service name for error reports extracted from Google\nApp Engine logs or `default` if the App Engine default service is used.",

376428 "type": "string"

377429 },

378430 "version": {

391443 "type": "string"

392444 },

393445 "name": {

394− "description": "Group resource name.\nExample: `projects/my-project-123/groups/my-groupid`",

446+ "description": "The group resource name.\nExample: \u003ccode\u003eprojects/my-project-123/groups/my-groupid\u003c/code\u003e",

395447 "type": "string"

396448 },

397449 "trackingIssues": {

404456 },

405457 "id": "ErrorGroup"

406458 },

459+ "ReportErrorEventResponse": {

460+ "description": "Response for reporting an individual error event.\nData may be added to this message in the future.",

461+ "type": "object",

462+ "properties": {},

463+ "id": "ReportErrorEventResponse"

464+ },

407465 "TrackingIssue": {

408466 "description": "Information related to tracking the progress on resolving the error.",

409467 "type": "object",

426484 "type": "object",

427485 "properties": {

428486 "serviceContext": {

429− "description": "The service_context for which this error was reported.",

487+ "description": "The `ServiceContext` for which this error was reported.",

430488 "$ref": "ServiceContext"

431489 },

432490 "context": {

486544 "id": "TimedCount"

487545 },

488546 "HttpRequestContext": {

489− "description": "HTTP request data that is related to a reported error.\nThis data should be provided by the application when reporting an error,\nunless the\nerror report has been generated automatically from Google App Engine logs.\nAll fields are optional.",

547+ "description": "HTTP request data that is related to a reported error.\nThis data should be provided by the application when reporting an error,\nunless the\nerror report has been generated automatically from Google App Engine logs.",

490548 "type": "object",

491549 "properties": {

492550 "method": {

536594 "id": "ListGroupStatsResponse"

537595 }

538596 },

539− "revision": "20160502",

597+ "revision": "20160930",

540598 "basePath": "",

541599 "icons": {

542600 "x32": "http://www.google.com/images/icons/product/search-32.gif",