OLD | NEW |
(Empty) | |
| 1 { |
| 2 "auth": { |
| 3 "oauth2": { |
| 4 "scopes": { |
| 5 "https://www.googleapis.com/auth/cloud-platform": { |
| 6 "description": "View and manage your data across Google Clou
d Platform services" |
| 7 }, |
| 8 "https://www.googleapis.com/auth/cloud_debugger": { |
| 9 "description": "Manage cloud debugger" |
| 10 }, |
| 11 "https://www.googleapis.com/auth/cloud_debugletcontroller": { |
| 12 "description": "Manage active breakpoints in cloud debugger" |
| 13 } |
| 14 } |
| 15 } |
| 16 }, |
| 17 "basePath": "", |
| 18 "baseUrl": "https://clouddebugger.googleapis.com/", |
| 19 "batchPath": "batch", |
| 20 "description": "", |
| 21 "discoveryVersion": "v1", |
| 22 "documentationLink": "https://cloud.google.com/tools/cloud-debugger", |
| 23 "etag": "\"ye6orv2F-1npMW3u9suM3a7C5Bo/Wr2nY13LMpGgsT7w2l5JsXnAVu4\"", |
| 24 "icons": { |
| 25 "x16": "http://www.google.com/images/icons/product/search-16.gif", |
| 26 "x32": "http://www.google.com/images/icons/product/search-32.gif" |
| 27 }, |
| 28 "id": "clouddebugger:v2", |
| 29 "kind": "discovery#restDescription", |
| 30 "name": "clouddebugger", |
| 31 "ownerDomain": "google.com", |
| 32 "ownerName": "Google", |
| 33 "parameters": { |
| 34 "access_token": { |
| 35 "description": "OAuth access token.", |
| 36 "location": "query", |
| 37 "type": "string" |
| 38 }, |
| 39 "alt": { |
| 40 "default": "json", |
| 41 "description": "Data format for response.", |
| 42 "enumDescriptions": [ |
| 43 "Responses with Content-Type of application/json", |
| 44 "Media download with context-dependent Content-Type", |
| 45 "Responses with Content-Type of application/x-protobuf" |
| 46 ], |
| 47 "location": "query", |
| 48 "type": "string" |
| 49 }, |
| 50 "bearer_token": { |
| 51 "description": "OAuth bearer token.", |
| 52 "location": "query", |
| 53 "type": "string" |
| 54 }, |
| 55 "callback": { |
| 56 "description": "JSONP", |
| 57 "location": "query", |
| 58 "type": "string" |
| 59 }, |
| 60 "fields": { |
| 61 "description": "Selector specifying which fields to include in a par
tial response.", |
| 62 "location": "query", |
| 63 "type": "string" |
| 64 }, |
| 65 "key": { |
| 66 "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.", |
| 67 "location": "query", |
| 68 "type": "string" |
| 69 }, |
| 70 "oauth_token": { |
| 71 "description": "OAuth 2.0 token for the current user.", |
| 72 "location": "query", |
| 73 "type": "string" |
| 74 }, |
| 75 "pp": { |
| 76 "default": "true", |
| 77 "description": "Pretty-print response.", |
| 78 "location": "query", |
| 79 "type": "boolean" |
| 80 }, |
| 81 "prettyPrint": { |
| 82 "default": "true", |
| 83 "description": "Returns response with indentations and line breaks."
, |
| 84 "location": "query", |
| 85 "type": "boolean" |
| 86 }, |
| 87 "quotaUser": { |
| 88 "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.", |
| 89 "location": "query", |
| 90 "type": "string" |
| 91 }, |
| 92 "upload_protocol": { |
| 93 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", |
| 94 "location": "query", |
| 95 "type": "string" |
| 96 }, |
| 97 "uploadType": { |
| 98 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", |
| 99 "location": "query", |
| 100 "type": "string" |
| 101 }, |
| 102 "$.xgafv": { |
| 103 "description": "V1 error format.", |
| 104 "enumDescriptions": [ |
| 105 "v1 error format", |
| 106 "v2 error format" |
| 107 ], |
| 108 "location": "query", |
| 109 "type": "string" |
| 110 } |
| 111 }, |
| 112 "protocol": "rest", |
| 113 "resources": { |
| 114 "controller": { |
| 115 "resources": { |
| 116 "debuggees": { |
| 117 "methods": { |
| 118 "register": { |
| 119 "description": "Registers the debuggee with the cont
roller. All agents should call this API with the same request content to get bac
k the same stable 'debuggee_id'. Agents should call this API again whenever List
ActiveBreakpoints or UpdateActiveBreakpoint return the error google.rpc.Code.NOT
_FOUND. It allows the server to disable the agent or recover from any registrati
on loss. If the debuggee is disabled server, the response will have is_disabled'
set to true.", |
| 120 "httpMethod": "POST", |
| 121 "id": "clouddebugger.controller.debuggees.register", |
| 122 "path": "v2/controller/debuggees/register", |
| 123 "request": { |
| 124 "$ref": "RegisterDebuggeeRequest" |
| 125 }, |
| 126 "response": { |
| 127 "$ref": "RegisterDebuggeeResponse" |
| 128 }, |
| 129 "scopes": [ |
| 130 "https://www.googleapis.com/auth/cloud-platform"
, |
| 131 "https://www.googleapis.com/auth/cloud_debugletc
ontroller" |
| 132 ] |
| 133 } |
| 134 }, |
| 135 "resources": { |
| 136 "breakpoints": { |
| 137 "methods": { |
| 138 "list": { |
| 139 "description": "Returns the list of all acti
ve breakpoints for the specified debuggee. The breakpoint specification (locatio
n, condition, and expression fields) is semantically immutable, although the fie
ld values may change. For example, an agent may update the location line number
to reflect the actual line the breakpoint was set to, but that doesn't change th
e breakpoint semantics. Thus, an agent does not need to check if a breakpoint ha
s changed when it encounters the same breakpoint on a successive call. Moreover,
an agent should remember breakpoints that are complete until the controller rem
oves them from the active list to avoid setting those breakpoints again.", |
| 140 "httpMethod": "GET", |
| 141 "id": "clouddebugger.controller.debuggees.br
eakpoints.list", |
| 142 "parameterOrder": [ |
| 143 "debuggeeId" |
| 144 ], |
| 145 "parameters": { |
| 146 "debuggeeId": { |
| 147 "description": "Identifies the debug
gee.", |
| 148 "location": "path", |
| 149 "required": true, |
| 150 "type": "string" |
| 151 }, |
| 152 "waitToken": { |
| 153 "description": "A wait token that, i
f specified, blocks the method call until the list of active breakpoints has cha
nged, or a server selected timeout has expired. The value should be set from the
last returned response. The error code google.rpc.Code.ABORTED is returned on w
ait timeout (which does not require the agent to re-register with the server)", |
| 154 "location": "query", |
| 155 "type": "string" |
| 156 } |
| 157 }, |
| 158 "path": "v2/controller/debuggees/{debuggeeId
}/breakpoints", |
| 159 "response": { |
| 160 "$ref": "ListActiveBreakpointsResponse" |
| 161 }, |
| 162 "scopes": [ |
| 163 "https://www.googleapis.com/auth/cloud-p
latform", |
| 164 "https://www.googleapis.com/auth/cloud_d
ebugletcontroller" |
| 165 ] |
| 166 }, |
| 167 "update": { |
| 168 "description": "Updates the breakpoint state
or mutable fields. The entire Breakpoint protobuf must be sent back to the cont
roller. Updates to active breakpoint fields are only allowed if the new value do
es not change the breakpoint specification. Updates to the 'location', 'conditio
n' and 'expression' fields should not alter the breakpoint semantics. They are r
estricted to changes such as canonicalizing a value or snapping the location to
the correct line of code.", |
| 169 "httpMethod": "PUT", |
| 170 "id": "clouddebugger.controller.debuggees.br
eakpoints.update", |
| 171 "parameterOrder": [ |
| 172 "debuggeeId", |
| 173 "id" |
| 174 ], |
| 175 "parameters": { |
| 176 "debuggeeId": { |
| 177 "description": "Identifies the debug
gee being debugged.", |
| 178 "location": "path", |
| 179 "required": true, |
| 180 "type": "string" |
| 181 }, |
| 182 "id": { |
| 183 "description": "Breakpoint identifie
r, unique in the scope of the debuggee.", |
| 184 "location": "path", |
| 185 "required": true, |
| 186 "type": "string" |
| 187 } |
| 188 }, |
| 189 "path": "v2/controller/debuggees/{debuggeeId
}/breakpoints/{id}", |
| 190 "request": { |
| 191 "$ref": "UpdateActiveBreakpointRequest" |
| 192 }, |
| 193 "response": { |
| 194 "$ref": "UpdateActiveBreakpointResponse" |
| 195 }, |
| 196 "scopes": [ |
| 197 "https://www.googleapis.com/auth/cloud-p
latform", |
| 198 "https://www.googleapis.com/auth/cloud_d
ebugletcontroller" |
| 199 ] |
| 200 } |
| 201 } |
| 202 } |
| 203 } |
| 204 } |
| 205 } |
| 206 }, |
| 207 "debugger": { |
| 208 "resources": { |
| 209 "debuggees": { |
| 210 "methods": { |
| 211 "list": { |
| 212 "description": "Lists all the debuggees that the use
r can set breakpoints to.", |
| 213 "httpMethod": "GET", |
| 214 "id": "clouddebugger.debugger.debuggees.list", |
| 215 "parameters": { |
| 216 "project": { |
| 217 "description": "Set to the project number of
the Google Cloud Platform to list the debuggees that are part of that project."
, |
| 218 "location": "query", |
| 219 "type": "string" |
| 220 }, |
| 221 "includeInactive": { |
| 222 "description": "When set to true the result
includes all debuggees, otherwise only debugees that are active.", |
| 223 "location": "query", |
| 224 "type": "boolean" |
| 225 } |
| 226 }, |
| 227 "path": "v2/debugger/debuggees", |
| 228 "response": { |
| 229 "$ref": "ListDebuggeesResponse" |
| 230 }, |
| 231 "scopes": [ |
| 232 "https://www.googleapis.com/auth/cloud-platform"
, |
| 233 "https://www.googleapis.com/auth/cloud_debugger" |
| 234 ] |
| 235 } |
| 236 }, |
| 237 "resources": { |
| 238 "breakpoints": { |
| 239 "methods": { |
| 240 "set": { |
| 241 "description": "Sets the breakpoint to the d
ebuggee.", |
| 242 "httpMethod": "POST", |
| 243 "id": "clouddebugger.debugger.debuggees.brea
kpoints.set", |
| 244 "parameterOrder": [ |
| 245 "debuggeeId" |
| 246 ], |
| 247 "parameters": { |
| 248 "debuggeeId": { |
| 249 "description": "The debuggee id to s
et the breakpoint to.", |
| 250 "location": "path", |
| 251 "required": true, |
| 252 "type": "string" |
| 253 } |
| 254 }, |
| 255 "path": "v2/debugger/debuggees/{debuggeeId}/
breakpoints/set", |
| 256 "request": { |
| 257 "$ref": "Breakpoint" |
| 258 }, |
| 259 "response": { |
| 260 "$ref": "SetBreakpointResponse" |
| 261 }, |
| 262 "scopes": [ |
| 263 "https://www.googleapis.com/auth/cloud-p
latform", |
| 264 "https://www.googleapis.com/auth/cloud_d
ebugger" |
| 265 ] |
| 266 }, |
| 267 "get": { |
| 268 "description": "Gets breakpoint information.
", |
| 269 "httpMethod": "GET", |
| 270 "id": "clouddebugger.debugger.debuggees.brea
kpoints.get", |
| 271 "parameterOrder": [ |
| 272 "debuggeeId", |
| 273 "breakpointId" |
| 274 ], |
| 275 "parameters": { |
| 276 "debuggeeId": { |
| 277 "description": "The debuggee id to g
et the breakpoint from.", |
| 278 "location": "path", |
| 279 "required": true, |
| 280 "type": "string" |
| 281 }, |
| 282 "breakpointId": { |
| 283 "description": "The breakpoint to ge
t.", |
| 284 "location": "path", |
| 285 "required": true, |
| 286 "type": "string" |
| 287 } |
| 288 }, |
| 289 "path": "v2/debugger/debuggees/{debuggeeId}/
breakpoints/{breakpointId}", |
| 290 "response": { |
| 291 "$ref": "GetBreakpointResponse" |
| 292 }, |
| 293 "scopes": [ |
| 294 "https://www.googleapis.com/auth/cloud-p
latform", |
| 295 "https://www.googleapis.com/auth/cloud_d
ebugger" |
| 296 ] |
| 297 }, |
| 298 "delete": { |
| 299 "description": "Deletes the breakpoint from
the debuggee.", |
| 300 "httpMethod": "DELETE", |
| 301 "id": "clouddebugger.debugger.debuggees.brea
kpoints.delete", |
| 302 "parameterOrder": [ |
| 303 "debuggeeId", |
| 304 "breakpointId" |
| 305 ], |
| 306 "parameters": { |
| 307 "debuggeeId": { |
| 308 "description": "The debuggee id to d
elete the breakpoint from.", |
| 309 "location": "path", |
| 310 "required": true, |
| 311 "type": "string" |
| 312 }, |
| 313 "breakpointId": { |
| 314 "description": "The breakpoint to de
lete.", |
| 315 "location": "path", |
| 316 "required": true, |
| 317 "type": "string" |
| 318 } |
| 319 }, |
| 320 "path": "v2/debugger/debuggees/{debuggeeId}/
breakpoints/{breakpointId}", |
| 321 "response": { |
| 322 "$ref": "Empty" |
| 323 }, |
| 324 "scopes": [ |
| 325 "https://www.googleapis.com/auth/cloud-p
latform", |
| 326 "https://www.googleapis.com/auth/cloud_d
ebugger" |
| 327 ] |
| 328 }, |
| 329 "list": { |
| 330 "description": "Lists all breakpoints of the
debuggee that the user has access to.", |
| 331 "httpMethod": "GET", |
| 332 "id": "clouddebugger.debugger.debuggees.brea
kpoints.list", |
| 333 "parameterOrder": [ |
| 334 "debuggeeId" |
| 335 ], |
| 336 "parameters": { |
| 337 "debuggeeId": { |
| 338 "description": "The debuggee id to l
ist breakpoint from.", |
| 339 "location": "path", |
| 340 "required": true, |
| 341 "type": "string" |
| 342 }, |
| 343 "includeAllUsers": { |
| 344 "description": "When set to true the
response includes the list of breakpoints set by any user, otherwise only break
points set by the caller.", |
| 345 "location": "query", |
| 346 "type": "boolean" |
| 347 }, |
| 348 "includeInactive": { |
| 349 "description": "When set to true the
response includes active and inactive breakpoints, otherwise only active breakp
oints are returned.", |
| 350 "location": "query", |
| 351 "type": "boolean" |
| 352 }, |
| 353 "action.value": { |
| 354 "description": "Only breakpoints wit
h the specified action will pass the filter.", |
| 355 "enum": [ |
| 356 "CAPTURE", |
| 357 "LOG" |
| 358 ], |
| 359 "location": "query", |
| 360 "type": "string" |
| 361 }, |
| 362 "stripResults": { |
| 363 "description": "When set to true the
response breakpoints will be stripped of the results fields: stack_frames, eval
uated_expressions and variable_table.", |
| 364 "location": "query", |
| 365 "type": "boolean" |
| 366 }, |
| 367 "waitToken": { |
| 368 "description": "A wait token that, i
f specified, blocks the call until the breakpoints list has changed, or a server
selected timeout has expired. The value should be set from the last response to
ListBreakpoints. The error code ABORTED is returned on wait timeout, which shou
ld be called again with the same wait_token.", |
| 369 "location": "query", |
| 370 "type": "string" |
| 371 } |
| 372 }, |
| 373 "path": "v2/debugger/debuggees/{debuggeeId}/
breakpoints", |
| 374 "response": { |
| 375 "$ref": "ListBreakpointsResponse" |
| 376 }, |
| 377 "scopes": [ |
| 378 "https://www.googleapis.com/auth/cloud-p
latform", |
| 379 "https://www.googleapis.com/auth/cloud_d
ebugger" |
| 380 ] |
| 381 } |
| 382 } |
| 383 } |
| 384 } |
| 385 } |
| 386 } |
| 387 } |
| 388 }, |
| 389 "revision": "20150710", |
| 390 "rootUrl": "https://clouddebugger.googleapis.com/", |
| 391 "schemas": { |
| 392 "RegisterDebuggeeRequest": { |
| 393 "description": "The request to register a debuggee.", |
| 394 "id": "RegisterDebuggeeRequest", |
| 395 "properties": { |
| 396 "debuggee": { |
| 397 "$ref": "Debuggee", |
| 398 "description": "The debuggee information to register. The fi
elds 'project', 'uniquifier', 'description' and 'agent_version' of the debuggee
must be set." |
| 399 } |
| 400 }, |
| 401 "type": "object" |
| 402 }, |
| 403 "Debuggee": { |
| 404 "description": "Represents the application to debug. The application
may include one or more replicated processes executing the same code. Each of t
hese processes is attached with a debugger agent, carrying out the debugging com
mands. The agents attached to the same debuggee are identified by using exactly
the same fields' values when registering.", |
| 405 "id": "Debuggee", |
| 406 "properties": { |
| 407 "id": { |
| 408 "description": "Debuggee unique identifer generated by the s
erver.", |
| 409 "type": "string" |
| 410 }, |
| 411 "project": { |
| 412 "description": "The project the debuggee is associated with.
Use the project number when registering a Google Cloud Platform project.", |
| 413 "type": "string" |
| 414 }, |
| 415 "uniquifier": { |
| 416 "description": "The debuggee uniqifier within the project. A
ny string that id the application within the project can be used. Recomended to
include environement and version or build id's.", |
| 417 "type": "string" |
| 418 }, |
| 419 "description": { |
| 420 "description": "A human readable description of the debuggee
. Recommended to include human readable project name, environment name, and vers
ion information .", |
| 421 "type": "string" |
| 422 }, |
| 423 "isInactive": { |
| 424 "description": "If set to true indicates that the debuggee h
as not been seen by the Controller service in the last active time period (defin
ed by the server).", |
| 425 "type": "boolean" |
| 426 }, |
| 427 "agentVersion": { |
| 428 "description": "Version ID of the agent release. The version
ID is structured as following: \"domain/type/vmajor.minor\" (for example \"goog
le.com/gcp-java/v1.1\").", |
| 429 "type": "string" |
| 430 }, |
| 431 "isDisabled": { |
| 432 "description": "If set to true, indicates that the agent sho
uld disable itself and detach from the debuggee.", |
| 433 "type": "boolean" |
| 434 }, |
| 435 "status": { |
| 436 "$ref": "StatusMessage", |
| 437 "description": "Human readable message to be displayed to th
e user about this debuggee. Absense of this field indicates no message. The mess
age can be either informational or error." |
| 438 }, |
| 439 "sourceContexts": { |
| 440 "description": "Repository snapshots containing the source c
ode of the project.", |
| 441 "items": { |
| 442 "$ref": "SourceContext" |
| 443 }, |
| 444 "type": "array" |
| 445 }, |
| 446 "labels": { |
| 447 "additionalProperties": { |
| 448 "type": "string" |
| 449 }, |
| 450 "description": "A set of custom debuggee properties, populat
ed by the agent, to be displayed to the user.", |
| 451 "type": "object" |
| 452 } |
| 453 }, |
| 454 "type": "object" |
| 455 }, |
| 456 "StatusMessage": { |
| 457 "description": "Represents a contextual status message. The message
can indicate an error or informational status, and refer to specific parts of th
e containing object. For example, the Breakpoint.status field can indicate an er
ror referring to the BREAKPOINT_SOURCE_LOCATION with the message \"Location not
found\".", |
| 458 "id": "StatusMessage", |
| 459 "properties": { |
| 460 "isError": { |
| 461 "description": "Distinguishes errors from informational mess
ages.", |
| 462 "type": "boolean" |
| 463 }, |
| 464 "refersTo": { |
| 465 "description": "Reference to which the message applies.", |
| 466 "enum": [ |
| 467 "UNSPECIFIED", |
| 468 "BREAKPOINT_SOURCE_LOCATION", |
| 469 "BREAKPOINT_CONDITION", |
| 470 "BREAKPOINT_EXPRESSION", |
| 471 "VARIABLE_NAME", |
| 472 "VARIABLE_VALUE" |
| 473 ], |
| 474 "type": "string" |
| 475 }, |
| 476 "description": { |
| 477 "$ref": "FormatMessage", |
| 478 "description": "Status message text." |
| 479 } |
| 480 }, |
| 481 "type": "object" |
| 482 }, |
| 483 "FormatMessage": { |
| 484 "description": "Represents a message with parameters.", |
| 485 "id": "FormatMessage", |
| 486 "properties": { |
| 487 "format": { |
| 488 "description": "Format template of the message. The \"format
\" uses placeholders \"$0\", \"$1\", etc. to reference parameters. \"$$\" can be
used to denote the '$' character. Examples: \"Failed to load '$0' which helps d
ebug $1 the first time it is loaded. Again, $0 is very important.\" \"Please pay
$$10 to use $0 instead of $1.\"", |
| 489 "type": "string" |
| 490 }, |
| 491 "parameters": { |
| 492 "description": "Optional parameters to be embedded into the
message.", |
| 493 "items": { |
| 494 "type": "string" |
| 495 }, |
| 496 "type": "array" |
| 497 } |
| 498 }, |
| 499 "type": "object" |
| 500 }, |
| 501 "SourceContext": { |
| 502 "description": "A SourceContext is a reference to a tree of files. A
SourceContext together with a path point to a unique revision of a single file
or directory.", |
| 503 "id": "SourceContext", |
| 504 "properties": { |
| 505 "cloudRepo": { |
| 506 "$ref": "CloudRepoSourceContext", |
| 507 "description": "A SourceContext referring to a revision in a
cloud repo." |
| 508 }, |
| 509 "cloudWorkspace": { |
| 510 "$ref": "CloudWorkspaceSourceContext", |
| 511 "description": "A SourceContext referring to a snapshot in a
cloud workspace." |
| 512 }, |
| 513 "gerrit": { |
| 514 "$ref": "GerritSourceContext", |
| 515 "description": "A SourceContext referring to a Gerrit projec
t." |
| 516 } |
| 517 }, |
| 518 "type": "object" |
| 519 }, |
| 520 "CloudRepoSourceContext": { |
| 521 "description": "A CloudRepoSourceContext denotes a particular revisi
on in a cloud repo (a repo hosted by the Google Cloud Platform).", |
| 522 "id": "CloudRepoSourceContext", |
| 523 "properties": { |
| 524 "repoId": { |
| 525 "$ref": "RepoId", |
| 526 "description": "The ID of the repo." |
| 527 }, |
| 528 "revisionId": { |
| 529 "description": "A revision ID.", |
| 530 "type": "string" |
| 531 }, |
| 532 "aliasName": { |
| 533 "description": "The name of an alias (branch, tag, etc.).", |
| 534 "type": "string" |
| 535 } |
| 536 }, |
| 537 "type": "object" |
| 538 }, |
| 539 "RepoId": { |
| 540 "description": "A unique identifier for a cloud repo.", |
| 541 "id": "RepoId", |
| 542 "properties": { |
| 543 "projectRepoId": { |
| 544 "$ref": "ProjectRepoId", |
| 545 "description": "A combination of a project ID and a repo nam
e." |
| 546 }, |
| 547 "uid": { |
| 548 "description": "A server-assigned, globally unique identifie
r.", |
| 549 "type": "string" |
| 550 } |
| 551 }, |
| 552 "type": "object" |
| 553 }, |
| 554 "ProjectRepoId": { |
| 555 "description": "Selects a repo using a Google Cloud Platform project
ID (e.g. winged-cargo-31) and a repo name within that project.", |
| 556 "id": "ProjectRepoId", |
| 557 "properties": { |
| 558 "projectId": { |
| 559 "description": "The ID of the project.", |
| 560 "type": "string" |
| 561 }, |
| 562 "repoName": { |
| 563 "description": "The name of the repo. Leave empty for the de
fault repo.", |
| 564 "type": "string" |
| 565 } |
| 566 }, |
| 567 "type": "object" |
| 568 }, |
| 569 "CloudWorkspaceSourceContext": { |
| 570 "description": "A CloudWorkspaceSourceContext denotes a workspace at
a particular snapshot.", |
| 571 "id": "CloudWorkspaceSourceContext", |
| 572 "properties": { |
| 573 "workspaceId": { |
| 574 "$ref": "CloudWorkspaceId", |
| 575 "description": "The ID of the workspace." |
| 576 }, |
| 577 "snapshotId": { |
| 578 "description": "The ID of the snapshot. An empty snapshot_id
refers to the most recent snapshot.", |
| 579 "type": "string" |
| 580 } |
| 581 }, |
| 582 "type": "object" |
| 583 }, |
| 584 "CloudWorkspaceId": { |
| 585 "description": "A CloudWorkspaceId is a unique identifier for a clou
d workspace. A cloud workspace is a place associated with a repo where modified
files can be stored before they are committed.", |
| 586 "id": "CloudWorkspaceId", |
| 587 "properties": { |
| 588 "repoId": { |
| 589 "$ref": "RepoId", |
| 590 "description": "The ID of the repo containing the workspace.
" |
| 591 }, |
| 592 "name": { |
| 593 "description": "The unique name of the workspace within the
repo. This is the name chosen by the client in the Source API's CreateWorkspace
method.", |
| 594 "type": "string" |
| 595 } |
| 596 }, |
| 597 "type": "object" |
| 598 }, |
| 599 "GerritSourceContext": { |
| 600 "description": "A SourceContext referring to a Gerrit project.", |
| 601 "id": "GerritSourceContext", |
| 602 "properties": { |
| 603 "hostUri": { |
| 604 "description": "The URI of a running Gerrit instance.", |
| 605 "type": "string" |
| 606 }, |
| 607 "gerritProject": { |
| 608 "description": "The full project name within the host. Proje
cts may be nested, so \"project/subproject\" is a valid project name. The \"repo
name\" is hostURI/project.", |
| 609 "type": "string" |
| 610 }, |
| 611 "revisionId": { |
| 612 "description": "A revision (commit) ID.", |
| 613 "type": "string" |
| 614 }, |
| 615 "aliasName": { |
| 616 "description": "The name of an alias (branch, tag, etc.).", |
| 617 "type": "string" |
| 618 } |
| 619 }, |
| 620 "type": "object" |
| 621 }, |
| 622 "RegisterDebuggeeResponse": { |
| 623 "description": "The response of registering a debuggee.", |
| 624 "id": "RegisterDebuggeeResponse", |
| 625 "properties": { |
| 626 "debuggee": { |
| 627 "$ref": "Debuggee", |
| 628 "description": "The debuggee resource. The field 'id' is gur
anteed to be set (in addition to the echoed fields)." |
| 629 } |
| 630 }, |
| 631 "type": "object" |
| 632 }, |
| 633 "ListActiveBreakpointsResponse": { |
| 634 "description": "The response of listing active breakpoints.", |
| 635 "id": "ListActiveBreakpointsResponse", |
| 636 "properties": { |
| 637 "breakpoints": { |
| 638 "description": "List of all active breakpoints. The fields '
id' and 'location' are guranteed to be set on each breakpoint.", |
| 639 "items": { |
| 640 "$ref": "Breakpoint" |
| 641 }, |
| 642 "type": "array" |
| 643 }, |
| 644 "nextWaitToken": { |
| 645 "description": "A wait token that can be used in the next me
thod call to block until the list of breakpoints changes.", |
| 646 "type": "string" |
| 647 } |
| 648 }, |
| 649 "type": "object" |
| 650 }, |
| 651 "Breakpoint": { |
| 652 "description": "Represents the breakpoint specification, status and
results.", |
| 653 "id": "Breakpoint", |
| 654 "properties": { |
| 655 "id": { |
| 656 "description": "Breakpoint identifier, unique in the scope o
f the debuggee.", |
| 657 "type": "string" |
| 658 }, |
| 659 "action": { |
| 660 "description": "Defines what to do when the breakpoint hits.
", |
| 661 "enum": [ |
| 662 "CAPTURE", |
| 663 "LOG" |
| 664 ], |
| 665 "type": "string" |
| 666 }, |
| 667 "location": { |
| 668 "$ref": "SourceLocation", |
| 669 "description": "The breakpoint source location." |
| 670 }, |
| 671 "condition": { |
| 672 "description": "A condition to trigger the breakpoint. The c
ondition is a compound boolean expression composed using expressions in a progra
mming language at the source location.", |
| 673 "type": "string" |
| 674 }, |
| 675 "expressions": { |
| 676 "description": "A list of read-only expressions to evaluate
at the breakpoint location. The expressions are composed using expressions in th
e programming language at the source location. If the breakpoint action is \"LOG
\", the evaluated expressions are included in log statements.", |
| 677 "items": { |
| 678 "type": "string" |
| 679 }, |
| 680 "type": "array" |
| 681 }, |
| 682 "logMessageFormat": { |
| 683 "description": "Only relevant when action is \"LOG\". Define
s the message to log when the breakpoint hits. The message may include parameter
placeholders \"$0\", \"$1\", etc. These placeholders will be replaced with the
evaluated value of the appropriate expression. Expressions not referenced in \"l
og_message_format\" will not be logged. Example: \"Poisonous message received, i
d = $0, count = $1\" with expressions = [ \"message.id\", \"message.count\" ].", |
| 684 "type": "string" |
| 685 }, |
| 686 "logLevel": { |
| 687 "description": "Indicates the severity of the log. Only rele
vant when action is \"LOG\".", |
| 688 "enum": [ |
| 689 "INFO", |
| 690 "WARNING", |
| 691 "ERROR" |
| 692 ], |
| 693 "type": "string" |
| 694 }, |
| 695 "isFinalState": { |
| 696 "description": "When true, indicates that this is a final re
sult and the breakpoint state will not change from here on.", |
| 697 "type": "boolean" |
| 698 }, |
| 699 "createTime": { |
| 700 "description": "The time this breakpoint was created by the
server. The value is in seconds resolution.", |
| 701 "type": "string" |
| 702 }, |
| 703 "finalTime": { |
| 704 "description": "The time this breakpoint was finalized as se
en by the server. The value is in seconds resolution.", |
| 705 "type": "string" |
| 706 }, |
| 707 "userEmail": { |
| 708 "description": "The e-mail of the user that created this bre
akpoint", |
| 709 "type": "string" |
| 710 }, |
| 711 "status": { |
| 712 "$ref": "StatusMessage", |
| 713 "description": "Breakpoint status. The status includes an er
ror flag and a human readable message. This field will usually stay unset. The m
essage can be either informational or error. Nevertheless, clients should always
display the text message back to the user. Error status of a breakpoint indicat
es complete failure. Example (non-final state): 'Still loading symbols...' Examp
les (final state): 'Failed to insert breakpoint' referring to breakpoint, 'Field
f not found in class C' referring to condition, ..." |
| 714 }, |
| 715 "stackFrames": { |
| 716 "description": "The stack at breakpoint time.", |
| 717 "items": { |
| 718 "$ref": "StackFrame" |
| 719 }, |
| 720 "type": "array" |
| 721 }, |
| 722 "evaluatedExpressions": { |
| 723 "description": "The evaluated expressions' values at breakpo
int time. The evaluated expressions appear in exactly the same order they are li
sted in the 'expressions' field. The 'name' field holds the original expression
text, the 'value'/'members' field holds the result of the evaluated expression.
If the expression can not be evaluated, an error text is placed in the value fie
ld.", |
| 724 "items": { |
| 725 "$ref": "Variable" |
| 726 }, |
| 727 "type": "array" |
| 728 }, |
| 729 "variableTable": { |
| 730 "description": "The variable_table exists to aid with comput
ation, memory and network traffic optimization. It enables storing a variable on
ce and reference it from multiple variables, including variables stored in the v
ariable_table itself. For example, the object 'this', which may appear at many l
evels of the stack, can have all of it's data stored once in this table. The sta
ck frame variables then would hold only a reference to it. The variable var_inde
x field is an index into this repeated field. The stored objects are nameless an
d get their name from the referencing variable. The effective variable is a merg
e of the referencing veariable and the referenced variable.", |
| 731 "items": { |
| 732 "$ref": "Variable" |
| 733 }, |
| 734 "type": "array" |
| 735 } |
| 736 }, |
| 737 "type": "object" |
| 738 }, |
| 739 "SourceLocation": { |
| 740 "description": "Represents a location in the source code.", |
| 741 "id": "SourceLocation", |
| 742 "properties": { |
| 743 "path": { |
| 744 "description": "A path to the source file within the source
context of the target binary.", |
| 745 "type": "string" |
| 746 }, |
| 747 "line": { |
| 748 "description": "The line inside the file (first line value i
s '1').", |
| 749 "format": "int32", |
| 750 "type": "integer" |
| 751 } |
| 752 }, |
| 753 "type": "object" |
| 754 }, |
| 755 "StackFrame": { |
| 756 "description": "Represents a stack frame context.", |
| 757 "id": "StackFrame", |
| 758 "properties": { |
| 759 "function": { |
| 760 "description": "The unmangled function name at the call site
.", |
| 761 "type": "string" |
| 762 }, |
| 763 "location": { |
| 764 "$ref": "SourceLocation", |
| 765 "description": "The source location of the call site." |
| 766 }, |
| 767 "arguments": { |
| 768 "description": "The set of arguments passed to this function
Note that this might not be populated for all stack frames.", |
| 769 "items": { |
| 770 "$ref": "Variable" |
| 771 }, |
| 772 "type": "array" |
| 773 }, |
| 774 "locals": { |
| 775 "description": "The set of local variables at the stack fram
e location. Note that this might not be populated for all stack frames.", |
| 776 "items": { |
| 777 "$ref": "Variable" |
| 778 }, |
| 779 "type": "array" |
| 780 } |
| 781 }, |
| 782 "type": "object" |
| 783 }, |
| 784 "Variable": { |
| 785 "description": "Represents a variable or an argument possibly of a c
ompound object type. 1. A simple variable such as, int x = 5 is represented as:
{ name: \"x\", value: \"5\" } 2. A compound object such as, struct T { int m1; i
nt m2; }; T x = { 3, 7 }; is represented as: { name: \"x\", members { name: \"m1
\", value: \"3\" }, members { name: \"m2\", value: \"7\" } } 3. A pointer where
the pointee was captured such as, T x = { 3, 7 }; T* p = &x; is represented as:
{ name: \"p\", value: \"0x00500500\", members { name: \"m1\", value: \"3\" }, me
mbers { name: \"m2\", value: \"7\" } } 4. A pointer where the pointee was not ca
ptured or is inaccessible such as, T* p = new T; is represented as: { name: \"p\
", value: \"0x00400400\", members { value: \"\" } } the value text should decrib
e the reason for the missing value. such as , ,\n. note that a null pointer shou
ld not have members. 5. An unnamed value such as, int* p = new int(7); is repres
ented as, { name: \"p\", value: \"0x00500500\", members { value: \"7\" } } 6. An
unnamed pointer where the pointee was not captured such as, int* p = new int(7)
; int** pp = &p; is represented as: { name: \"pp\", value: \"0x00500500\", membe
rs { value: \"0x00400400\", members { value: \"\" } } } To optimize computation,
memory and network traffic, variables that repeat in the output multiple times
can be stored once in a shared variable table and be referenced using the var_in
dex field. The variables stored in the shared table are nameless and are essenti
ally a partition of the complete variable. To reconstruct the complete variable
merge the referencing variable with the referenced variable. When using the shar
ed variable table, variables can be represented as: T x = { 3, 7 }; T* p = &x; T
& r = x; are represented as, { name: \"x\", var_index: 3 } { name: \"p\", value
\"0x00500500\", var_index: 3 } { name: \"r\", var_index: 3 } with shared variabl
e table entry #3: { members { name: \"m1\", value: \"3\" }, members { name: \"m2
\", value: \"7\" } } Note that the pointer address is stored with the referencin
g variable and not with the referenced variable, to allow the referenced variabl
e to be shared between pointer and references.", |
| 786 "id": "Variable", |
| 787 "properties": { |
| 788 "name": { |
| 789 "description": "The name of the variable, if any.", |
| 790 "type": "string" |
| 791 }, |
| 792 "value": { |
| 793 "description": "The simple value of the variable.", |
| 794 "type": "string" |
| 795 }, |
| 796 "members": { |
| 797 "description": "The members contained or pointed to by the v
ariable.", |
| 798 "items": { |
| 799 "$ref": "Variable" |
| 800 }, |
| 801 "type": "array" |
| 802 }, |
| 803 "varTableIndex": { |
| 804 "description": "This is a reference to a variable in the sha
red variable table. More than one variable can reference the same variable in th
e table. The var_index field is an index into variable_table in Breakpoint.", |
| 805 "format": "int32", |
| 806 "type": "integer" |
| 807 }, |
| 808 "status": { |
| 809 "$ref": "StatusMessage", |
| 810 "description": "Status associated with the variable. This fi
eld will usually stay unset. A status of a single variable only applies to that
variable or expression. The rest of breakpoint data still remains valid. Variabl
es might be reported in error state even when breakpoint is not in final state.
The message may refer to variable name with \"refers_to\" set to \"VARIABLE_NAME
\". Alternatively \"refers_to\" will be set to \"VARIABLE_VALUE\". In either cas
e variable value and members will be unset. Example of error message applied to
name: \"Invalid expression syntax\". Example of information message applied to v
alue: \"Not captured\". Examples of error message applied to value: \"Malformed
string\", \"Field f not found in class C\", \"Null pointer dereference\"." |
| 811 } |
| 812 }, |
| 813 "type": "object" |
| 814 }, |
| 815 "UpdateActiveBreakpointRequest": { |
| 816 "description": "The request to update an active breakpoint.", |
| 817 "id": "UpdateActiveBreakpointRequest", |
| 818 "properties": { |
| 819 "breakpoint": { |
| 820 "$ref": "Breakpoint", |
| 821 "description": "The updated breakpoint information. The fiel
d 'id' must be set." |
| 822 } |
| 823 }, |
| 824 "type": "object" |
| 825 }, |
| 826 "UpdateActiveBreakpointResponse": { |
| 827 "description": "The response of updating an active breakpoint. The m
essage is defined to allow future extensions.", |
| 828 "id": "UpdateActiveBreakpointResponse", |
| 829 "type": "object" |
| 830 }, |
| 831 "SetBreakpointResponse": { |
| 832 "description": "The response of setting a breakpoint.", |
| 833 "id": "SetBreakpointResponse", |
| 834 "properties": { |
| 835 "breakpoint": { |
| 836 "$ref": "Breakpoint", |
| 837 "description": "The breakpoint resource. The field 'id' is g
uranteed to be set (in addition to the echoed fileds)." |
| 838 } |
| 839 }, |
| 840 "type": "object" |
| 841 }, |
| 842 "GetBreakpointResponse": { |
| 843 "description": "The response of getting breakpoint information.", |
| 844 "id": "GetBreakpointResponse", |
| 845 "properties": { |
| 846 "breakpoint": { |
| 847 "$ref": "Breakpoint", |
| 848 "description": "The complete breakpoint state. The fields 'i
d' and 'location' are guranteed to be set." |
| 849 } |
| 850 }, |
| 851 "type": "object" |
| 852 }, |
| 853 "Empty": { |
| 854 "description": "A generic empty message that you can re-use to avoid
defining duplicated empty messages in your APIs. A typical example is to use it
as the request or the response type of an API method. For instance: service Foo
{ rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON re
presentation for `Empty` is empty JSON object `{}`.", |
| 855 "id": "Empty", |
| 856 "type": "object" |
| 857 }, |
| 858 "ListBreakpointsResponse": { |
| 859 "description": "The response of listing breakpoints.", |
| 860 "id": "ListBreakpointsResponse", |
| 861 "properties": { |
| 862 "breakpoints": { |
| 863 "description": "List of all breakpoints with complete state.
The fields 'id' and 'location' are guranteed to be set on each breakpoint.", |
| 864 "items": { |
| 865 "$ref": "Breakpoint" |
| 866 }, |
| 867 "type": "array" |
| 868 }, |
| 869 "nextWaitToken": { |
| 870 "description": "A wait token that can be used in the next ca
ll to ListBreakpoints to block until the list of breakpoints has changes.", |
| 871 "type": "string" |
| 872 } |
| 873 }, |
| 874 "type": "object" |
| 875 }, |
| 876 "ListDebuggeesResponse": { |
| 877 "description": "The response of listing debuggees.", |
| 878 "id": "ListDebuggeesResponse", |
| 879 "properties": { |
| 880 "debuggees": { |
| 881 "description": "The list of debuggees accessible to the call
ing user. Note that the description field is the only human readable field that
should be displayed to the user. The fields 'debuggee.id' and 'description' are
guranteed to be set on each debuggee.", |
| 882 "items": { |
| 883 "$ref": "Debuggee" |
| 884 }, |
| 885 "type": "array" |
| 886 } |
| 887 }, |
| 888 "type": "object" |
| 889 } |
| 890 }, |
| 891 "servicePath": "", |
| 892 "title": "Google Cloud Debugger API", |
| 893 "version": "v2" |
| 894 } |
OLD | NEW |