OLD | NEW |
1 { | 1 { |
2 "auth": { | 2 "auth": { |
3 "oauth2": { | 3 "oauth2": { |
4 "scopes": { | 4 "scopes": { |
| 5 "https://www.googleapis.com/auth/cloud_debugger": { |
| 6 "description": "Manage cloud debugger" |
| 7 }, |
5 "https://www.googleapis.com/auth/cloud-platform": { | 8 "https://www.googleapis.com/auth/cloud-platform": { |
6 "description": "View and manage your data across Google Clou
d Platform services" | 9 "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 } | 10 } |
11 } | 11 } |
12 } | 12 } |
13 }, | 13 }, |
14 "basePath": "", | 14 "basePath": "", |
15 "baseUrl": "https://clouddebugger.googleapis.com/", | 15 "baseUrl": "https://clouddebugger.googleapis.com/", |
16 "batchPath": "batch", | 16 "batchPath": "batch", |
17 "canonicalName": "Cloud Debugger", | 17 "canonicalName": "Cloud Debugger", |
18 "description": "Examines the call stack and variables of a running applicati
on without stopping or slowing it down.\n", | 18 "description": "Examines the call stack and variables of a running applicati
on without stopping or slowing it down.\n", |
19 "discoveryVersion": "v1", | 19 "discoveryVersion": "v1", |
20 "documentationLink": "http://cloud.google.com/debugger", | 20 "documentationLink": "http://cloud.google.com/debugger", |
21 "icons": { | 21 "icons": { |
22 "x16": "http://www.google.com/images/icons/product/search-16.gif", | 22 "x16": "http://www.google.com/images/icons/product/search-16.gif", |
23 "x32": "http://www.google.com/images/icons/product/search-32.gif" | 23 "x32": "http://www.google.com/images/icons/product/search-32.gif" |
24 }, | 24 }, |
25 "id": "clouddebugger:v2", | 25 "id": "clouddebugger:v2", |
26 "kind": "discovery#restDescription", | 26 "kind": "discovery#restDescription", |
27 "name": "clouddebugger", | 27 "name": "clouddebugger", |
28 "ownerDomain": "google.com", | 28 "ownerDomain": "google.com", |
29 "ownerName": "Google", | 29 "ownerName": "Google", |
30 "parameters": { | 30 "parameters": { |
31 "oauth_token": { | |
32 "description": "OAuth 2.0 token for the current user.", | |
33 "location": "query", | |
34 "type": "string" | |
35 }, | |
36 "bearer_token": { | |
37 "description": "OAuth bearer token.", | |
38 "location": "query", | |
39 "type": "string" | |
40 }, | |
41 "upload_protocol": { | 31 "upload_protocol": { |
42 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", | 32 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", |
43 "location": "query", | 33 "location": "query", |
44 "type": "string" | 34 "type": "string" |
45 }, | 35 }, |
46 "prettyPrint": { | 36 "prettyPrint": { |
47 "default": "true", | 37 "default": "true", |
48 "description": "Returns response with indentations and line breaks."
, | 38 "description": "Returns response with indentations and line breaks."
, |
49 "location": "query", | 39 "location": "query", |
50 "type": "boolean" | 40 "type": "boolean" |
51 }, | 41 }, |
| 42 "uploadType": { |
| 43 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", |
| 44 "location": "query", |
| 45 "type": "string" |
| 46 }, |
52 "fields": { | 47 "fields": { |
53 "description": "Selector specifying which fields to include in a par
tial response.", | 48 "description": "Selector specifying which fields to include in a par
tial response.", |
54 "location": "query", | 49 "location": "query", |
55 "type": "string" | 50 "type": "string" |
56 }, | 51 }, |
57 "uploadType": { | |
58 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", | |
59 "location": "query", | |
60 "type": "string" | |
61 }, | |
62 "callback": { | |
63 "description": "JSONP", | |
64 "location": "query", | |
65 "type": "string" | |
66 }, | |
67 "$.xgafv": { | 52 "$.xgafv": { |
68 "description": "V1 error format.", | 53 "description": "V1 error format.", |
69 "enum": [ | 54 "enum": [ |
70 "1", | 55 "1", |
71 "2" | 56 "2" |
72 ], | 57 ], |
73 "enumDescriptions": [ | 58 "enumDescriptions": [ |
74 "v1 error format", | 59 "v1 error format", |
75 "v2 error format" | 60 "v2 error format" |
76 ], | 61 ], |
77 "location": "query", | 62 "location": "query", |
78 "type": "string" | 63 "type": "string" |
79 }, | 64 }, |
| 65 "callback": { |
| 66 "description": "JSONP", |
| 67 "location": "query", |
| 68 "type": "string" |
| 69 }, |
80 "alt": { | 70 "alt": { |
81 "default": "json", | 71 "default": "json", |
82 "description": "Data format for response.", | 72 "description": "Data format for response.", |
83 "enum": [ | 73 "enum": [ |
84 "json", | 74 "json", |
85 "media", | 75 "media", |
86 "proto" | 76 "proto" |
87 ], | 77 ], |
88 "enumDescriptions": [ | 78 "enumDescriptions": [ |
89 "Responses with Content-Type of application/json", | 79 "Responses with Content-Type of application/json", |
90 "Media download with context-dependent Content-Type", | 80 "Media download with context-dependent Content-Type", |
91 "Responses with Content-Type of application/x-protobuf" | 81 "Responses with Content-Type of application/x-protobuf" |
92 ], | 82 ], |
93 "location": "query", | 83 "location": "query", |
94 "type": "string" | 84 "type": "string" |
95 }, | 85 }, |
| 86 "access_token": { |
| 87 "description": "OAuth access token.", |
| 88 "location": "query", |
| 89 "type": "string" |
| 90 }, |
96 "key": { | 91 "key": { |
97 "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.", | 92 "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.", |
98 "location": "query", | 93 "location": "query", |
99 "type": "string" | 94 "type": "string" |
100 }, | 95 }, |
101 "access_token": { | |
102 "description": "OAuth access token.", | |
103 "location": "query", | |
104 "type": "string" | |
105 }, | |
106 "quotaUser": { | 96 "quotaUser": { |
107 "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.", | 97 "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.", |
108 "location": "query", | 98 "location": "query", |
109 "type": "string" | 99 "type": "string" |
110 }, | 100 }, |
111 "pp": { | 101 "pp": { |
112 "default": "true", | 102 "default": "true", |
113 "description": "Pretty-print response.", | 103 "description": "Pretty-print response.", |
114 "location": "query", | 104 "location": "query", |
115 "type": "boolean" | 105 "type": "boolean" |
| 106 }, |
| 107 "bearer_token": { |
| 108 "description": "OAuth bearer token.", |
| 109 "location": "query", |
| 110 "type": "string" |
| 111 }, |
| 112 "oauth_token": { |
| 113 "description": "OAuth 2.0 token for the current user.", |
| 114 "location": "query", |
| 115 "type": "string" |
116 } | 116 } |
117 }, | 117 }, |
118 "protocol": "rest", | 118 "protocol": "rest", |
119 "resources": { | 119 "resources": { |
120 "debugger": { | 120 "debugger": { |
121 "resources": { | 121 "resources": { |
122 "debuggees": { | 122 "debuggees": { |
123 "methods": { | 123 "methods": { |
124 "list": { | 124 "list": { |
125 "description": "Lists all the debuggees that the use
r can set breakpoints to.", | 125 "description": "Lists all the debuggees that the use
r can set breakpoints to.", |
126 "httpMethod": "GET", | 126 "httpMethod": "GET", |
127 "id": "clouddebugger.debugger.debuggees.list", | 127 "id": "clouddebugger.debugger.debuggees.list", |
128 "parameterOrder": [], | 128 "parameterOrder": [], |
129 "parameters": { | 129 "parameters": { |
130 "clientVersion": { | |
131 "description": "The client version making th
e call.\nFollowing: `domain/type/version` (e.g., `google.com/intellij/v1`).", | |
132 "location": "query", | |
133 "type": "string" | |
134 }, | |
135 "includeInactive": { | 130 "includeInactive": { |
136 "description": "When set to `true`, the resu
lt includes all debuggees. Otherwise, the\nresult includes only debuggees that a
re active.", | 131 "description": "When set to `true`, the resu
lt includes all debuggees. Otherwise, the\nresult includes only debuggees that a
re active.", |
137 "location": "query", | 132 "location": "query", |
138 "type": "boolean" | 133 "type": "boolean" |
139 }, | 134 }, |
140 "project": { | 135 "project": { |
141 "description": "Project number of a Google C
loud project whose debuggees to list.", | 136 "description": "Project number of a Google C
loud project whose debuggees to list.", |
142 "location": "query", | 137 "location": "query", |
143 "type": "string" | 138 "type": "string" |
| 139 }, |
| 140 "clientVersion": { |
| 141 "description": "The client version making th
e call.\nFollowing: `domain/type/version` (e.g., `google.com/intellij/v1`).", |
| 142 "location": "query", |
| 143 "type": "string" |
144 } | 144 } |
145 }, | 145 }, |
146 "path": "v2/debugger/debuggees", | 146 "path": "v2/debugger/debuggees", |
147 "response": { | 147 "response": { |
148 "$ref": "ListDebuggeesResponse" | 148 "$ref": "ListDebuggeesResponse" |
149 }, | 149 }, |
150 "scopes": [ | 150 "scopes": [ |
151 "https://www.googleapis.com/auth/cloud-platform"
, | 151 "https://www.googleapis.com/auth/cloud-platform"
, |
152 "https://www.googleapis.com/auth/cloud_debugger" | 152 "https://www.googleapis.com/auth/cloud_debugger" |
153 ] | 153 ] |
(...skipping 71 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
225 ] | 225 ] |
226 }, | 226 }, |
227 "list": { | 227 "list": { |
228 "description": "Lists all breakpoints for th
e debuggee.", | 228 "description": "Lists all breakpoints for th
e debuggee.", |
229 "httpMethod": "GET", | 229 "httpMethod": "GET", |
230 "id": "clouddebugger.debugger.debuggees.brea
kpoints.list", | 230 "id": "clouddebugger.debugger.debuggees.brea
kpoints.list", |
231 "parameterOrder": [ | 231 "parameterOrder": [ |
232 "debuggeeId" | 232 "debuggeeId" |
233 ], | 233 ], |
234 "parameters": { | 234 "parameters": { |
235 "stripResults": { | |
236 "description": "This field is deprec
ated. The following fields are always stripped out of\nthe result: `stack_frames
`, `evaluated_expressions` and `variable_table`.", | |
237 "location": "query", | |
238 "type": "boolean" | |
239 }, | |
240 "debuggeeId": { | 235 "debuggeeId": { |
241 "description": "ID of the debuggee w
hose breakpoints to list.", | 236 "description": "ID of the debuggee w
hose breakpoints to list.", |
242 "location": "path", | 237 "location": "path", |
243 "required": true, | 238 "required": true, |
244 "type": "string" | 239 "type": "string" |
245 }, | 240 }, |
246 "waitToken": { | 241 "waitToken": { |
247 "description": "A wait token that, i
f specified, blocks the call until the breakpoints\nlist has changed, or a serve
r selected timeout has expired. The value\nshould be set from the last response
. The error code\n`google.rpc.Code.ABORTED` (RPC) is returned on wait timeout, w
hich\nshould be called again with the same `wait_token`.", | 242 "description": "A wait token that, i
f specified, blocks the call until the breakpoints\nlist has changed, or a serve
r selected timeout has expired. The value\nshould be set from the last response
. The error code\n`google.rpc.Code.ABORTED` (RPC) is returned on wait timeout, w
hich\nshould be called again with the same `wait_token`.", |
248 "location": "query", | 243 "location": "query", |
249 "type": "string" | 244 "type": "string" |
250 }, | 245 }, |
251 "clientVersion": { | 246 "clientVersion": { |
252 "description": "The client version m
aking the call.\nFollowing: `domain/type/version` (e.g., `google.com/intellij/v1
`).", | 247 "description": "The client version m
aking the call.\nFollowing: `domain/type/version` (e.g., `google.com/intellij/v1
`).", |
253 "location": "query", | 248 "location": "query", |
254 "type": "string" | 249 "type": "string" |
255 }, | 250 }, |
256 "action.value": { | 251 "action.value": { |
257 "description": "Only breakpoints wit
h the specified action will pass the filter.", | 252 "description": "Only breakpoints wit
h the specified action will pass the filter.", |
258 "enum": [ | 253 "enum": [ |
259 "CAPTURE", | 254 "CAPTURE", |
260 "LOG" | 255 "LOG" |
261 ], | 256 ], |
262 "location": "query", | 257 "location": "query", |
263 "type": "string" | 258 "type": "string" |
264 }, | 259 }, |
| 260 "includeInactive": { |
| 261 "description": "When set to `true`,
the response includes active and inactive\nbreakpoints. Otherwise, it includes o
nly active breakpoints.", |
| 262 "location": "query", |
| 263 "type": "boolean" |
| 264 }, |
265 "includeAllUsers": { | 265 "includeAllUsers": { |
266 "description": "When set to `true`,
the response includes the list of breakpoints set by\nany user. Otherwise, it in
cludes only breakpoints set by the caller.", | 266 "description": "When set to `true`,
the response includes the list of breakpoints set by\nany user. Otherwise, it in
cludes only breakpoints set by the caller.", |
267 "location": "query", | 267 "location": "query", |
268 "type": "boolean" | 268 "type": "boolean" |
269 }, | 269 }, |
270 "includeInactive": { | 270 "stripResults": { |
271 "description": "When set to `true`,
the response includes active and inactive\nbreakpoints. Otherwise, it includes o
nly active breakpoints.", | 271 "description": "This field is deprec
ated. The following fields are always stripped out of\nthe result: `stack_frames
`, `evaluated_expressions` and `variable_table`.", |
272 "location": "query", | 272 "location": "query", |
273 "type": "boolean" | 273 "type": "boolean" |
274 } | 274 } |
275 }, | 275 }, |
276 "path": "v2/debugger/debuggees/{debuggeeId}/
breakpoints", | 276 "path": "v2/debugger/debuggees/{debuggeeId}/
breakpoints", |
277 "response": { | 277 "response": { |
278 "$ref": "ListBreakpointsResponse" | 278 "$ref": "ListBreakpointsResponse" |
279 }, | 279 }, |
280 "scopes": [ | 280 "scopes": [ |
281 "https://www.googleapis.com/auth/cloud-p
latform", | 281 "https://www.googleapis.com/auth/cloud-p
latform", |
282 "https://www.googleapis.com/auth/cloud_d
ebugger" | 282 "https://www.googleapis.com/auth/cloud_d
ebugger" |
283 ] | 283 ] |
284 }, | 284 }, |
285 "get": { | 285 "get": { |
286 "description": "Gets breakpoint information.
", | 286 "description": "Gets breakpoint information.
", |
287 "httpMethod": "GET", | 287 "httpMethod": "GET", |
288 "id": "clouddebugger.debugger.debuggees.brea
kpoints.get", | 288 "id": "clouddebugger.debugger.debuggees.brea
kpoints.get", |
289 "parameterOrder": [ | 289 "parameterOrder": [ |
290 "debuggeeId", | 290 "debuggeeId", |
291 "breakpointId" | 291 "breakpointId" |
292 ], | 292 ], |
293 "parameters": { | 293 "parameters": { |
294 "clientVersion": { | |
295 "description": "The client version m
aking the call.\nFollowing: `domain/type/version` (e.g., `google.com/intellij/v1
`).", | |
296 "location": "query", | |
297 "type": "string" | |
298 }, | |
299 "breakpointId": { | 294 "breakpointId": { |
300 "description": "ID of the breakpoint
to get.", | 295 "description": "ID of the breakpoint
to get.", |
301 "location": "path", | 296 "location": "path", |
302 "required": true, | 297 "required": true, |
303 "type": "string" | 298 "type": "string" |
304 }, | 299 }, |
305 "debuggeeId": { | 300 "debuggeeId": { |
306 "description": "ID of the debuggee w
hose breakpoint to get.", | 301 "description": "ID of the debuggee w
hose breakpoint to get.", |
307 "location": "path", | 302 "location": "path", |
308 "required": true, | 303 "required": true, |
309 "type": "string" | 304 "type": "string" |
| 305 }, |
| 306 "clientVersion": { |
| 307 "description": "The client version m
aking the call.\nFollowing: `domain/type/version` (e.g., `google.com/intellij/v1
`).", |
| 308 "location": "query", |
| 309 "type": "string" |
310 } | 310 } |
311 }, | 311 }, |
312 "path": "v2/debugger/debuggees/{debuggeeId}/
breakpoints/{breakpointId}", | 312 "path": "v2/debugger/debuggees/{debuggeeId}/
breakpoints/{breakpointId}", |
313 "response": { | 313 "response": { |
314 "$ref": "GetBreakpointResponse" | 314 "$ref": "GetBreakpointResponse" |
315 }, | 315 }, |
316 "scopes": [ | 316 "scopes": [ |
317 "https://www.googleapis.com/auth/cloud-p
latform", | 317 "https://www.googleapis.com/auth/cloud-p
latform", |
318 "https://www.googleapis.com/auth/cloud_d
ebugger" | 318 "https://www.googleapis.com/auth/cloud_d
ebugger" |
319 ] | 319 ] |
(...skipping 23 matching lines...) Expand all Loading... |
343 }, | 343 }, |
344 "scopes": [ | 344 "scopes": [ |
345 "https://www.googleapis.com/auth/cloud-platform"
, | 345 "https://www.googleapis.com/auth/cloud-platform"
, |
346 "https://www.googleapis.com/auth/cloud_debugger" | 346 "https://www.googleapis.com/auth/cloud_debugger" |
347 ] | 347 ] |
348 } | 348 } |
349 }, | 349 }, |
350 "resources": { | 350 "resources": { |
351 "breakpoints": { | 351 "breakpoints": { |
352 "methods": { | 352 "methods": { |
353 "update": { | |
354 "description": "Updates the breakpoint state
or mutable fields.\nThe entire Breakpoint message must be sent back to the cont
roller\nservice.\n\nUpdates to active breakpoint fields are only allowed if the
new value\ndoes not change the breakpoint specification. Updates to the `locatio
n`,\n`condition` and `expression` fields should not alter the breakpoint\nsemant
ics. These may only make changes such as canonicalizing a value\nor snapping the
location to the correct line of code.", | |
355 "httpMethod": "PUT", | |
356 "id": "clouddebugger.controller.debuggees.br
eakpoints.update", | |
357 "parameterOrder": [ | |
358 "debuggeeId", | |
359 "id" | |
360 ], | |
361 "parameters": { | |
362 "debuggeeId": { | |
363 "description": "Identifies the debug
gee being debugged.", | |
364 "location": "path", | |
365 "required": true, | |
366 "type": "string" | |
367 }, | |
368 "id": { | |
369 "description": "Breakpoint identifie
r, unique in the scope of the debuggee.", | |
370 "location": "path", | |
371 "required": true, | |
372 "type": "string" | |
373 } | |
374 }, | |
375 "path": "v2/controller/debuggees/{debuggeeId
}/breakpoints/{id}", | |
376 "request": { | |
377 "$ref": "UpdateActiveBreakpointRequest" | |
378 }, | |
379 "response": { | |
380 "$ref": "UpdateActiveBreakpointResponse" | |
381 }, | |
382 "scopes": [ | |
383 "https://www.googleapis.com/auth/cloud-p
latform", | |
384 "https://www.googleapis.com/auth/cloud_d
ebugger" | |
385 ] | |
386 }, | |
387 "list": { | 353 "list": { |
388 "description": "Returns the list of all acti
ve breakpoints for the debuggee.\n\nThe breakpoint specification (location, cond
ition, and expression\nfields) is semantically immutable, although the field val
ues may\nchange. For example, an agent may update the location line number\nto r
eflect the actual line where the breakpoint was set, but this\ndoesn't change th
e breakpoint semantics.\n\nThis means that an agent does not need to check if a
breakpoint has changed\nwhen it encounters the same breakpoint on a successive c
all.\nMoreover, an agent should remember the breakpoints that are completed\nunt
il the controller removes them from the active list to avoid\nsetting those brea
kpoints again.", | 354 "description": "Returns the list of all acti
ve breakpoints for the debuggee.\n\nThe breakpoint specification (`location`, `c
ondition`, and `expressions`\nfields) is semantically immutable, although the fi
eld values may\nchange. For example, an agent may update the location line numbe
r\nto reflect the actual line where the breakpoint was set, but this\ndoesn't ch
ange the breakpoint semantics.\n\nThis means that an agent does not need to chec
k if a breakpoint has changed\nwhen it encounters the same breakpoint on a succe
ssive call.\nMoreover, an agent should remember the breakpoints that are complet
ed\nuntil the controller removes them from the active list to avoid\nsetting tho
se breakpoints again.", |
389 "httpMethod": "GET", | 355 "httpMethod": "GET", |
390 "id": "clouddebugger.controller.debuggees.br
eakpoints.list", | 356 "id": "clouddebugger.controller.debuggees.br
eakpoints.list", |
391 "parameterOrder": [ | 357 "parameterOrder": [ |
392 "debuggeeId" | 358 "debuggeeId" |
393 ], | 359 ], |
394 "parameters": { | 360 "parameters": { |
395 "successOnTimeout": { | 361 "successOnTimeout": { |
396 "description": "If set to `true`, re
turns `google.rpc.Code.OK` status and sets the\n`wait_expired` response field to
`true` when the server-selected timeout\nhas expired (recommended).\n\nIf set t
o `false`, returns `google.rpc.Code.ABORTED` status when the\nserver-selected ti
meout has expired (deprecated).", | 362 "description": "If set to `true`, re
turns `google.rpc.Code.OK` status and sets the\n`wait_expired` response field to
`true` when the server-selected timeout\nhas expired (recommended).\n\nIf set t
o `false`, returns `google.rpc.Code.ABORTED` status when the\nserver-selected ti
meout has expired (deprecated).", |
397 "location": "query", | 363 "location": "query", |
398 "type": "boolean" | 364 "type": "boolean" |
399 }, | 365 }, |
400 "debuggeeId": { | 366 "debuggeeId": { |
401 "description": "Identifies the debug
gee.", | 367 "description": "Identifies the debug
gee.", |
402 "location": "path", | 368 "location": "path", |
403 "required": true, | 369 "required": true, |
404 "type": "string" | 370 "type": "string" |
405 }, | 371 }, |
406 "waitToken": { | 372 "waitToken": { |
407 "description": "A wait token that, i
f specified, blocks the method call until the list\nof active breakpoints has ch
anged, or a server selected timeout has\nexpired. The value should be set from
the last returned response.", | 373 "description": "A wait token that, i
f specified, blocks the method call until the list\nof active breakpoints has ch
anged, or a server selected timeout has\nexpired. The value should be set from
the last returned response.", |
408 "location": "query", | 374 "location": "query", |
409 "type": "string" | 375 "type": "string" |
410 } | 376 } |
411 }, | 377 }, |
412 "path": "v2/controller/debuggees/{debuggeeId
}/breakpoints", | 378 "path": "v2/controller/debuggees/{debuggeeId
}/breakpoints", |
413 "response": { | 379 "response": { |
414 "$ref": "ListActiveBreakpointsResponse" | 380 "$ref": "ListActiveBreakpointsResponse" |
415 }, | 381 }, |
416 "scopes": [ | 382 "scopes": [ |
417 "https://www.googleapis.com/auth/cloud-p
latform", | 383 "https://www.googleapis.com/auth/cloud-p
latform", |
| 384 "https://www.googleapis.com/auth/cloud_d
ebugger" |
| 385 ] |
| 386 }, |
| 387 "update": { |
| 388 "description": "Updates the breakpoint state
or mutable fields.\nThe entire Breakpoint message must be sent back to the cont
roller\nservice.\n\nUpdates to active breakpoint fields are only allowed if the
new value\ndoes not change the breakpoint specification. Updates to the `locatio
n`,\n`condition` and `expressions` fields should not alter the breakpoint\nseman
tics. These may only make changes such as canonicalizing a value\nor snapping th
e location to the correct line of code.", |
| 389 "httpMethod": "PUT", |
| 390 "id": "clouddebugger.controller.debuggees.br
eakpoints.update", |
| 391 "parameterOrder": [ |
| 392 "debuggeeId", |
| 393 "id" |
| 394 ], |
| 395 "parameters": { |
| 396 "id": { |
| 397 "description": "Breakpoint identifie
r, unique in the scope of the debuggee.", |
| 398 "location": "path", |
| 399 "required": true, |
| 400 "type": "string" |
| 401 }, |
| 402 "debuggeeId": { |
| 403 "description": "Identifies the debug
gee being debugged.", |
| 404 "location": "path", |
| 405 "required": true, |
| 406 "type": "string" |
| 407 } |
| 408 }, |
| 409 "path": "v2/controller/debuggees/{debuggeeId
}/breakpoints/{id}", |
| 410 "request": { |
| 411 "$ref": "UpdateActiveBreakpointRequest" |
| 412 }, |
| 413 "response": { |
| 414 "$ref": "UpdateActiveBreakpointResponse" |
| 415 }, |
| 416 "scopes": [ |
| 417 "https://www.googleapis.com/auth/cloud-p
latform", |
418 "https://www.googleapis.com/auth/cloud_d
ebugger" | 418 "https://www.googleapis.com/auth/cloud_d
ebugger" |
419 ] | 419 ] |
420 } | 420 } |
421 } | 421 } |
422 } | 422 } |
423 } | 423 } |
424 } | 424 } |
425 } | 425 } |
426 } | 426 } |
427 }, | 427 }, |
428 "revision": "20170621", | 428 "revision": "20170710", |
429 "rootUrl": "https://clouddebugger.googleapis.com/", | 429 "rootUrl": "https://clouddebugger.googleapis.com/", |
430 "schemas": { | 430 "schemas": { |
431 "ListBreakpointsResponse": { | |
432 "description": "Response for listing breakpoints.", | |
433 "id": "ListBreakpointsResponse", | |
434 "properties": { | |
435 "nextWaitToken": { | |
436 "description": "A wait token that can be used in the next ca
ll to `list` (REST) or\n`ListBreakpoints` (RPC) to block until the list of break
points has changes.", | |
437 "type": "string" | |
438 }, | |
439 "breakpoints": { | |
440 "description": "List of breakpoints matching the request.\nT
he fields `id` and `location` are guaranteed to be set on each breakpoint.\nThe
fields: `stack_frames`, `evaluated_expressions` and `variable_table`\nare cleare
d on each breakpoint regardless of it's status.", | |
441 "items": { | |
442 "$ref": "Breakpoint" | |
443 }, | |
444 "type": "array" | |
445 } | |
446 }, | |
447 "type": "object" | |
448 }, | |
449 "Breakpoint": { | |
450 "description": "Represents the breakpoint specification, status and
results.", | |
451 "id": "Breakpoint", | |
452 "properties": { | |
453 "id": { | |
454 "description": "Breakpoint identifier, unique in the scope o
f the debuggee.", | |
455 "type": "string" | |
456 }, | |
457 "location": { | |
458 "$ref": "SourceLocation", | |
459 "description": "Breakpoint source location." | |
460 }, | |
461 "finalTime": { | |
462 "description": "Time this breakpoint was finalized as seen b
y the server in seconds\nresolution.", | |
463 "format": "google-datetime", | |
464 "type": "string" | |
465 }, | |
466 "variableTable": { | |
467 "description": "The `variable_table` exists to aid with comp
utation, memory and network\ntraffic optimization. It enables storing a variabl
e once and reference\nit from multiple variables, including variables stored in
the\n`variable_table` itself.\nFor example, the same `this` object, which may ap
pear at many levels of\nthe stack, can have all of its data stored once in this
table. The\nstack frame variables then would hold only a reference to it.\n\nTh
e variable `var_table_index` field is an index into this repeated field.\nThe st
ored objects are nameless and get their name from the referencing\nvariable. The
effective variable is a merge of the referencing variable\nand the referenced v
ariable.", | |
468 "items": { | |
469 "$ref": "Variable" | |
470 }, | |
471 "type": "array" | |
472 }, | |
473 "createTime": { | |
474 "description": "Time this breakpoint was created by the serv
er in seconds resolution.", | |
475 "format": "google-datetime", | |
476 "type": "string" | |
477 }, | |
478 "logMessageFormat": { | |
479 "description": "Only relevant when action is `LOG`. Defines
the message to log when\nthe breakpoint hits. The message may include parameter
placeholders `$0`,\n`$1`, etc. These placeholders are replaced with the evaluate
d value\nof the appropriate expression. Expressions not referenced in\n`log_mess
age_format` are not logged.\n\nExample: `Message received, id = $0, count = $1`
with\n`expressions` = `[ message.id, message.count ]`.", | |
480 "type": "string" | |
481 }, | |
482 "labels": { | |
483 "additionalProperties": { | |
484 "type": "string" | |
485 }, | |
486 "description": "A set of custom breakpoint properties, popul
ated by the agent, to be\ndisplayed to the user.", | |
487 "type": "object" | |
488 }, | |
489 "expressions": { | |
490 "description": "List of read-only expressions to evaluate at
the breakpoint location.\nThe expressions are composed using expressions in the
programming language\nat the source location. If the breakpoint action is `LOG`
, the evaluated\nexpressions are included in log statements.", | |
491 "items": { | |
492 "type": "string" | |
493 }, | |
494 "type": "array" | |
495 }, | |
496 "evaluatedExpressions": { | |
497 "description": "Values of evaluated expressions at breakpoin
t time.\nThe evaluated expressions appear in exactly the same order they\nare li
sted in the `expressions` field.\nThe `name` field holds the original expression
text, the `value` or\n`members` field holds the result of the evaluated express
ion.\nIf the expression cannot be evaluated, the `status` inside the `Variable`\
nwill indicate an error and contain the error text.", | |
498 "items": { | |
499 "$ref": "Variable" | |
500 }, | |
501 "type": "array" | |
502 }, | |
503 "isFinalState": { | |
504 "description": "When true, indicates that this is a final re
sult and the\nbreakpoint state will not change from here on.", | |
505 "type": "boolean" | |
506 }, | |
507 "stackFrames": { | |
508 "description": "The stack at breakpoint time.", | |
509 "items": { | |
510 "$ref": "StackFrame" | |
511 }, | |
512 "type": "array" | |
513 }, | |
514 "condition": { | |
515 "description": "Condition that triggers the breakpoint.\nThe
condition is a compound boolean expression composed using expressions\nin a pro
gramming language at the source location.", | |
516 "type": "string" | |
517 }, | |
518 "status": { | |
519 "$ref": "StatusMessage", | |
520 "description": "Breakpoint status.\n\nThe status includes an
error flag and a human readable message.\nThis field is usually unset. The mess
age can be either\ninformational or an error message. Regardless, clients should
always\ndisplay the text message back to the user.\n\nError status indicates co
mplete failure of the breakpoint.\n\nExample (non-final state): `Still loading s
ymbols...`\n\nExamples (final state):\n\n* `Invalid line number` referring to
location\n* `Field f not found in class C` referring to condition" | |
521 }, | |
522 "userEmail": { | |
523 "description": "E-mail address of the user that created this
breakpoint", | |
524 "type": "string" | |
525 }, | |
526 "action": { | |
527 "description": "Action that the agent should perform when th
e code at the\nbreakpoint location is hit.", | |
528 "enum": [ | |
529 "CAPTURE", | |
530 "LOG" | |
531 ], | |
532 "enumDescriptions": [ | |
533 "Capture stack frame and variables and update the breakp
oint.\nThe data is only captured once. After that the breakpoint is set\nin a fi
nal state.", | |
534 "Log each breakpoint hit. The breakpoint remains active
until\ndeleted or expired." | |
535 ], | |
536 "type": "string" | |
537 }, | |
538 "logLevel": { | |
539 "description": "Indicates the severity of the log. Only rele
vant when action is `LOG`.", | |
540 "enum": [ | |
541 "INFO", | |
542 "WARNING", | |
543 "ERROR" | |
544 ], | |
545 "enumDescriptions": [ | |
546 "Information log message.", | |
547 "Warning log message.", | |
548 "Error log message." | |
549 ], | |
550 "type": "string" | |
551 } | |
552 }, | |
553 "type": "object" | |
554 }, | |
555 "SetBreakpointResponse": { | |
556 "description": "Response for setting a breakpoint.", | |
557 "id": "SetBreakpointResponse", | |
558 "properties": { | |
559 "breakpoint": { | |
560 "$ref": "Breakpoint", | |
561 "description": "Breakpoint resource.\nThe field `id` is guar
anteed to be set (in addition to the echoed fileds)." | |
562 } | |
563 }, | |
564 "type": "object" | |
565 }, | |
566 "UpdateActiveBreakpointRequest": { | |
567 "description": "Request to update an active breakpoint.", | |
568 "id": "UpdateActiveBreakpointRequest", | |
569 "properties": { | |
570 "breakpoint": { | |
571 "$ref": "Breakpoint", | |
572 "description": "Updated breakpoint information.\nThe field '
id' must be set." | |
573 } | |
574 }, | |
575 "type": "object" | |
576 }, | |
577 "SourceContext": { | 431 "SourceContext": { |
578 "description": "A SourceContext is a reference to a tree of files. A
SourceContext together\nwith a path point to a unique revision of a single file
or directory.", | 432 "description": "A SourceContext is a reference to a tree of files. A
SourceContext together\nwith a path point to a unique revision of a single file
or directory.", |
579 "id": "SourceContext", | 433 "id": "SourceContext", |
580 "properties": { | 434 "properties": { |
581 "git": { | |
582 "$ref": "GitSourceContext", | |
583 "description": "A SourceContext referring to any third party
Git repo (e.g. GitHub)." | |
584 }, | |
585 "gerrit": { | 435 "gerrit": { |
586 "$ref": "GerritSourceContext", | 436 "$ref": "GerritSourceContext", |
587 "description": "A SourceContext referring to a Gerrit projec
t." | 437 "description": "A SourceContext referring to a Gerrit projec
t." |
588 }, | 438 }, |
589 "cloudWorkspace": { | 439 "cloudWorkspace": { |
590 "$ref": "CloudWorkspaceSourceContext", | 440 "$ref": "CloudWorkspaceSourceContext", |
591 "description": "A SourceContext referring to a snapshot in a
cloud workspace." | 441 "description": "A SourceContext referring to a snapshot in a
cloud workspace." |
592 }, | 442 }, |
593 "cloudRepo": { | 443 "cloudRepo": { |
594 "$ref": "CloudRepoSourceContext", | 444 "$ref": "CloudRepoSourceContext", |
595 "description": "A SourceContext referring to a revision in a
cloud repo." | 445 "description": "A SourceContext referring to a revision in a
cloud repo." |
| 446 }, |
| 447 "git": { |
| 448 "$ref": "GitSourceContext", |
| 449 "description": "A SourceContext referring to any third party
Git repo (e.g. GitHub)." |
596 } | 450 } |
597 }, | 451 }, |
598 "type": "object" | 452 "type": "object" |
599 }, | 453 }, |
600 "CloudRepoSourceContext": { | 454 "CloudRepoSourceContext": { |
601 "description": "A CloudRepoSourceContext denotes a particular revisi
on in a cloud\nrepo (a repo hosted by the Google Cloud Platform).", | 455 "description": "A CloudRepoSourceContext denotes a particular revisi
on in a cloud\nrepo (a repo hosted by the Google Cloud Platform).", |
602 "id": "CloudRepoSourceContext", | 456 "id": "CloudRepoSourceContext", |
603 "properties": { | 457 "properties": { |
604 "revisionId": { | 458 "revisionId": { |
605 "description": "A revision ID.", | 459 "description": "A revision ID.", |
(...skipping 96 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
702 "description": "Git repository URL.", | 556 "description": "Git repository URL.", |
703 "type": "string" | 557 "type": "string" |
704 } | 558 } |
705 }, | 559 }, |
706 "type": "object" | 560 "type": "object" |
707 }, | 561 }, |
708 "Variable": { | 562 "Variable": { |
709 "description": "Represents a variable or an argument possibly of a c
ompound object type.\nNote how the following variables are represented:\n\n1) A
simple variable:\n\n int x = 5\n\n { name: \"x\", value: \"5\", type: \"in
t\" } // Captured variable\n\n2) A compound object:\n\n struct T {\n
int m1;\n int m2;\n };\n T x = { 3, 7 };\n\n { // Captured vari
able\n name: \"x\",\n type: \"T\",\n members { name: \"m1\"
, value: \"3\", type: \"int\" },\n members { name: \"m2\", value: \"7\",
type: \"int\" }\n }\n\n3) A pointer where the pointee was captured:\n\n T
x = { 3, 7 };\n T* p = &x;\n\n { // Captured variable\n name: \"p
\",\n type: \"T*\",\n value: \"0x00500500\",\n members { na
me: \"m1\", value: \"3\", type: \"int\" },\n members { name: \"m2\", valu
e: \"7\", type: \"int\" }\n }\n\n4) A pointer where the pointee was not captu
red:\n\n T* p = new T;\n\n { // Captured variable\n name: \"p\",\
n type: \"T*\",\n value: \"0x00400400\"\n status { is_error
: true, description { format: \"unavailable\" } }\n }\n\nThe status should de
scribe the reason for the missing value,\nsuch as `<optimized out>`, `<inaccessi
ble>`, `<pointers limit reached>`.\n\nNote that a null pointer should not have m
embers.\n\n5) An unnamed value:\n\n int* p = new int(7);\n\n { // Captur
ed variable\n name: \"p\",\n value: \"0x00500500\",\n type:
\"int*\",\n members { value: \"7\", type: \"int\" } }\n\n6) An unnamed p
ointer where the pointee was not captured:\n\n int* p = new int(7);\n int*
* pp = &p;\n\n { // Captured variable\n name: \"pp\",\n value:
\"0x00500500\",\n type: \"int**\",\n members {\n value
: \"0x00400400\",\n type: \"int*\"\n status {\n
is_error: true,\n description: { format: \"unavailable\" } }
\n }\n }\n }\n\nTo optimize computation, memory and network
traffic, variables that\nrepeat in the output multiple times can be stored once
in a shared\nvariable table and be referenced using the `var_table_index` field
. The\nvariables stored in the shared table are nameless and are essentially\na
partition of the complete variable. To reconstruct the complete\nvariable, merg
e the referencing variable with the referenced variable.\n\nWhen using the share
d variable table, the following variables:\n\n T x = { 3, 7 };\n T* p = &x
;\n T& r = x;\n\n { name: \"x\", var_table_index: 3, type: \"T\" } // Cap
tured variables\n { name: \"p\", value \"0x00500500\", type=\"T*\", var_table
_index: 3 }\n { name: \"r\", type=\"T&\", var_table_index: 3 }\n\n { // S
hared variable table entry #3:\n members { name: \"m1\", value: \"3\", ty
pe: \"int\" },\n members { name: \"m2\", value: \"7\", type: \"int\" }\n
}\n\nNote that the pointer address is stored with the referencing variable\na
nd not with the referenced variable. This allows the referenced variable\nto be
shared between pointers and references.\n\nThe type field is optional. The debug
ger agent may or may not support it.", | 563 "description": "Represents a variable or an argument possibly of a c
ompound object type.\nNote how the following variables are represented:\n\n1) A
simple variable:\n\n int x = 5\n\n { name: \"x\", value: \"5\", type: \"in
t\" } // Captured variable\n\n2) A compound object:\n\n struct T {\n
int m1;\n int m2;\n };\n T x = { 3, 7 };\n\n { // Captured vari
able\n name: \"x\",\n type: \"T\",\n members { name: \"m1\"
, value: \"3\", type: \"int\" },\n members { name: \"m2\", value: \"7\",
type: \"int\" }\n }\n\n3) A pointer where the pointee was captured:\n\n T
x = { 3, 7 };\n T* p = &x;\n\n { // Captured variable\n name: \"p
\",\n type: \"T*\",\n value: \"0x00500500\",\n members { na
me: \"m1\", value: \"3\", type: \"int\" },\n members { name: \"m2\", valu
e: \"7\", type: \"int\" }\n }\n\n4) A pointer where the pointee was not captu
red:\n\n T* p = new T;\n\n { // Captured variable\n name: \"p\",\
n type: \"T*\",\n value: \"0x00400400\"\n status { is_error
: true, description { format: \"unavailable\" } }\n }\n\nThe status should de
scribe the reason for the missing value,\nsuch as `<optimized out>`, `<inaccessi
ble>`, `<pointers limit reached>`.\n\nNote that a null pointer should not have m
embers.\n\n5) An unnamed value:\n\n int* p = new int(7);\n\n { // Captur
ed variable\n name: \"p\",\n value: \"0x00500500\",\n type:
\"int*\",\n members { value: \"7\", type: \"int\" } }\n\n6) An unnamed p
ointer where the pointee was not captured:\n\n int* p = new int(7);\n int*
* pp = &p;\n\n { // Captured variable\n name: \"pp\",\n value:
\"0x00500500\",\n type: \"int**\",\n members {\n value
: \"0x00400400\",\n type: \"int*\"\n status {\n
is_error: true,\n description: { format: \"unavailable\" } }
\n }\n }\n }\n\nTo optimize computation, memory and network
traffic, variables that\nrepeat in the output multiple times can be stored once
in a shared\nvariable table and be referenced using the `var_table_index` field
. The\nvariables stored in the shared table are nameless and are essentially\na
partition of the complete variable. To reconstruct the complete\nvariable, merg
e the referencing variable with the referenced variable.\n\nWhen using the share
d variable table, the following variables:\n\n T x = { 3, 7 };\n T* p = &x
;\n T& r = x;\n\n { name: \"x\", var_table_index: 3, type: \"T\" } // Cap
tured variables\n { name: \"p\", value \"0x00500500\", type=\"T*\", var_table
_index: 3 }\n { name: \"r\", type=\"T&\", var_table_index: 3 }\n\n { // S
hared variable table entry #3:\n members { name: \"m1\", value: \"3\", ty
pe: \"int\" },\n members { name: \"m2\", value: \"7\", type: \"int\" }\n
}\n\nNote that the pointer address is stored with the referencing variable\na
nd not with the referenced variable. This allows the referenced variable\nto be
shared between pointers and references.\n\nThe type field is optional. The debug
ger agent may or may not support it.", |
710 "id": "Variable", | 564 "id": "Variable", |
711 "properties": { | 565 "properties": { |
712 "name": { | 566 "varTableIndex": { |
713 "description": "Name of the variable, if any.", | 567 "description": "Reference to a variable in the shared variab
le table. More than\none variable can reference the same variable in the table.
The\n`var_table_index` field is an index into `variable_table` in Breakpoint.", |
714 "type": "string" | 568 "format": "int32", |
715 }, | 569 "type": "integer" |
716 "type": { | |
717 "description": "Variable type (e.g. `MyClass`). If the varia
ble is split with\n`var_table_index`, `type` goes next to `value`. The interpret
ation of\na type is agent specific. It is recommended to include the dynamic typ
e\nrather than a static type of an object.", | |
718 "type": "string" | |
719 }, | 570 }, |
720 "value": { | 571 "value": { |
721 "description": "Simple value of the variable.", | 572 "description": "Simple value of the variable.", |
722 "type": "string" | 573 "type": "string" |
723 }, | 574 }, |
724 "varTableIndex": { | |
725 "description": "Reference to a variable in the shared variab
le table. More than\none variable can reference the same variable in the table.
The\n`var_table_index` field is an index into `variable_table` in Breakpoint.", | |
726 "format": "int32", | |
727 "type": "integer" | |
728 }, | |
729 "members": { | 575 "members": { |
730 "description": "Members contained or pointed to by the varia
ble.", | 576 "description": "Members contained or pointed to by the varia
ble.", |
731 "items": { | 577 "items": { |
732 "$ref": "Variable" | 578 "$ref": "Variable" |
733 }, | 579 }, |
734 "type": "array" | 580 "type": "array" |
735 }, | 581 }, |
736 "status": { | 582 "status": { |
737 "$ref": "StatusMessage", | 583 "$ref": "StatusMessage", |
738 "description": "Status associated with the variable. This fi
eld will usually stay\nunset. A status of a single variable only applies to that
variable or\nexpression. The rest of breakpoint data still remains valid. Varia
bles\nmight be reported in error state even when breakpoint is not in final\nsta
te.\n\nThe message may refer to variable name with `refers_to` set to\n`VARIABLE
_NAME`. Alternatively `refers_to` will be set to `VARIABLE_VALUE`.\nIn either ca
se variable value and members will be unset.\n\nExample of error message applied
to name: `Invalid expression syntax`.\n\nExample of information message applied
to value: `Not captured`.\n\nExamples of error message applied to value:\n\n*
`Malformed string`,\n* `Field f not found in class C`\n* `Null pointer dere
ference`" | 584 "description": "Status associated with the variable. This fi
eld will usually stay\nunset. A status of a single variable only applies to that
variable or\nexpression. The rest of breakpoint data still remains valid. Varia
bles\nmight be reported in error state even when breakpoint is not in final\nsta
te.\n\nThe message may refer to variable name with `refers_to` set to\n`VARIABLE
_NAME`. Alternatively `refers_to` will be set to `VARIABLE_VALUE`.\nIn either ca
se variable value and members will be unset.\n\nExample of error message applied
to name: `Invalid expression syntax`.\n\nExample of information message applied
to value: `Not captured`.\n\nExamples of error message applied to value:\n\n*
`Malformed string`,\n* `Field f not found in class C`\n* `Null pointer dere
ference`" |
| 585 }, |
| 586 "name": { |
| 587 "description": "Name of the variable, if any.", |
| 588 "type": "string" |
| 589 }, |
| 590 "type": { |
| 591 "description": "Variable type (e.g. `MyClass`). If the varia
ble is split with\n`var_table_index`, `type` goes next to `value`. The interpret
ation of\na type is agent specific. It is recommended to include the dynamic typ
e\nrather than a static type of an object.", |
| 592 "type": "string" |
739 } | 593 } |
740 }, | 594 }, |
741 "type": "object" | 595 "type": "object" |
742 }, | 596 }, |
743 "StackFrame": { | 597 "StackFrame": { |
744 "description": "Represents a stack frame context.", | 598 "description": "Represents a stack frame context.", |
745 "id": "StackFrame", | 599 "id": "StackFrame", |
746 "properties": { | 600 "properties": { |
747 "arguments": { | |
748 "description": "Set of arguments passed to this function.\nN
ote that this might not be populated for all stack frames.", | |
749 "items": { | |
750 "$ref": "Variable" | |
751 }, | |
752 "type": "array" | |
753 }, | |
754 "locals": { | 601 "locals": { |
755 "description": "Set of local variables at the stack frame lo
cation.\nNote that this might not be populated for all stack frames.", | 602 "description": "Set of local variables at the stack frame lo
cation.\nNote that this might not be populated for all stack frames.", |
756 "items": { | 603 "items": { |
757 "$ref": "Variable" | 604 "$ref": "Variable" |
758 }, | 605 }, |
759 "type": "array" | 606 "type": "array" |
760 }, | 607 }, |
761 "location": { | 608 "location": { |
762 "$ref": "SourceLocation", | 609 "$ref": "SourceLocation", |
763 "description": "Source location of the call site." | 610 "description": "Source location of the call site." |
764 }, | 611 }, |
765 "function": { | 612 "function": { |
766 "description": "Demangled function name at the call site.", | 613 "description": "Demangled function name at the call site.", |
767 "type": "string" | 614 "type": "string" |
| 615 }, |
| 616 "arguments": { |
| 617 "description": "Set of arguments passed to this function.\nN
ote that this might not be populated for all stack frames.", |
| 618 "items": { |
| 619 "$ref": "Variable" |
| 620 }, |
| 621 "type": "array" |
768 } | 622 } |
769 }, | 623 }, |
770 "type": "object" | 624 "type": "object" |
771 }, | 625 }, |
772 "RepoId": { | 626 "RepoId": { |
773 "description": "A unique identifier for a cloud repo.", | 627 "description": "A unique identifier for a cloud repo.", |
774 "id": "RepoId", | 628 "id": "RepoId", |
775 "properties": { | 629 "properties": { |
776 "uid": { | 630 "uid": { |
777 "description": "A server-assigned, globally unique identifie
r.", | 631 "description": "A server-assigned, globally unique identifie
r.", |
(...skipping 86 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
864 "Empty": { | 718 "Empty": { |
865 "description": "A generic empty message that you can re-use to avoid
defining duplicated\nempty messages in your APIs. A typical example is to use i
t as the request\nor the response type of an API method. For instance:\n\n se
rvice Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty
);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.", | 719 "description": "A generic empty message that you can re-use to avoid
defining duplicated\nempty messages in your APIs. A typical example is to use i
t as the request\nor the response type of an API method. For instance:\n\n se
rvice Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty
);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.", |
866 "id": "Empty", | 720 "id": "Empty", |
867 "properties": {}, | 721 "properties": {}, |
868 "type": "object" | 722 "type": "object" |
869 }, | 723 }, |
870 "SourceLocation": { | 724 "SourceLocation": { |
871 "description": "Represents a location in the source code.", | 725 "description": "Represents a location in the source code.", |
872 "id": "SourceLocation", | 726 "id": "SourceLocation", |
873 "properties": { | 727 "properties": { |
| 728 "path": { |
| 729 "description": "Path to the source file within the source co
ntext of the target binary.", |
| 730 "type": "string" |
| 731 }, |
874 "line": { | 732 "line": { |
875 "description": "Line inside the file. The first line in the
file has the value `1`.", | 733 "description": "Line inside the file. The first line in the
file has the value `1`.", |
876 "format": "int32", | 734 "format": "int32", |
877 "type": "integer" | 735 "type": "integer" |
878 }, | |
879 "path": { | |
880 "description": "Path to the source file within the source co
ntext of the target binary.", | |
881 "type": "string" | |
882 } | 736 } |
883 }, | 737 }, |
884 "type": "object" | 738 "type": "object" |
885 }, | 739 }, |
886 "Debuggee": { | 740 "Debuggee": { |
887 "description": "Represents the application to debug. The application
may include one or more\nreplicated processes executing the same code. Each of
these processes is\nattached with a debugger agent, carrying out the debugging c
ommands.\nThe agents attached to the same debuggee are identified by using exact
ly the\nsame field values when registering.", | 741 "description": "Represents the application to debug. The application
may include one or more\nreplicated processes executing the same code. Each of
these processes is\nattached with a debugger agent, carrying out the debugging c
ommands.\nThe agents attached to the same debuggee are identified by using exact
ly the\nsame field values when registering.", |
888 "id": "Debuggee", | 742 "id": "Debuggee", |
889 "properties": { | 743 "properties": { |
890 "uniquifier": { | |
891 "description": "Debuggee uniquifier within the project.\nAny
string that identifies the application within the project can be used.\nIncludi
ng environment and version or build IDs is recommended.", | |
892 "type": "string" | |
893 }, | |
894 "description": { | |
895 "description": "Human readable description of the debuggee.\
nIncluding a human-readable project name, environment name and version\ninformat
ion is recommended.", | |
896 "type": "string" | |
897 }, | |
898 "sourceContexts": { | |
899 "description": "References to the locations and revisions of
the source code used in the\ndeployed application.\n\nNOTE: This field is depre
cated. Consumers should use\n`ext_source_contexts` if it is not empty. Debug age
nts should populate\nboth this field and `ext_source_contexts`.", | |
900 "items": { | |
901 "$ref": "SourceContext" | |
902 }, | |
903 "type": "array" | |
904 }, | |
905 "extSourceContexts": { | 744 "extSourceContexts": { |
906 "description": "References to the locations and revisions of
the source code used in the\ndeployed application.\n\nContexts describing a rem
ote repo related to the source code\nhave a `category` label of `remote_repo`. S
ource snapshot source\ncontexts have a `category` of `snapshot`.", | 745 "description": "References to the locations and revisions of
the source code used in the\ndeployed application.\n\nContexts describing a rem
ote repo related to the source code\nhave a `category` label of `remote_repo`. S
ource snapshot source\ncontexts have a `category` of `snapshot`.", |
907 "items": { | 746 "items": { |
908 "$ref": "ExtendedSourceContext" | 747 "$ref": "ExtendedSourceContext" |
909 }, | 748 }, |
910 "type": "array" | 749 "type": "array" |
911 }, | 750 }, |
912 "labels": { | 751 "labels": { |
913 "additionalProperties": { | 752 "additionalProperties": { |
914 "type": "string" | 753 "type": "string" |
915 }, | 754 }, |
916 "description": "A set of custom debuggee properties, populat
ed by the agent, to be\ndisplayed to the user.", | 755 "description": "A set of custom debuggee properties, populat
ed by the agent, to be\ndisplayed to the user.", |
917 "type": "object" | 756 "type": "object" |
918 }, | 757 }, |
| 758 "status": { |
| 759 "$ref": "StatusMessage", |
| 760 "description": "Human readable message to be displayed to th
e user about this debuggee.\nAbsence of this field indicates no status. The mess
age can be either\ninformational or an error status." |
| 761 }, |
919 "isInactive": { | 762 "isInactive": { |
920 "description": "If set to `true`, indicates that the debugge
e is considered as inactive by\nthe Controller service.", | 763 "description": "If set to `true`, indicates that the debugge
e is considered as inactive by\nthe Controller service.", |
921 "type": "boolean" | 764 "type": "boolean" |
922 }, | 765 }, |
923 "status": { | |
924 "$ref": "StatusMessage", | |
925 "description": "Human readable message to be displayed to th
e user about this debuggee.\nAbsence of this field indicates no status. The mess
age can be either\ninformational or an error status." | |
926 }, | |
927 "project": { | 766 "project": { |
928 "description": "Project the debuggee is associated with.\nUs
e the project number when registering a Google Cloud Platform project.", | 767 "description": "Project the debuggee is associated with.\nUs
e the project number when registering a Google Cloud Platform project.", |
929 "type": "string" | 768 "type": "string" |
930 }, | 769 }, |
| 770 "isDisabled": { |
| 771 "description": "If set to `true`, indicates that the agent s
hould disable itself and\ndetach from the debuggee.", |
| 772 "type": "boolean" |
| 773 }, |
| 774 "agentVersion": { |
| 775 "description": "Version ID of the agent release. The version
ID is structured as\nfollowing: `domain/type/vmajor.minor` (for example\n`googl
e.com/gcp-java/v1.1`).", |
| 776 "type": "string" |
| 777 }, |
931 "id": { | 778 "id": { |
932 "description": "Unique identifier for the debuggee generated
by the controller service.", | 779 "description": "Unique identifier for the debuggee generated
by the controller service.", |
933 "type": "string" | 780 "type": "string" |
934 }, | 781 }, |
935 "agentVersion": { | 782 "description": { |
936 "description": "Version ID of the agent release. The version
ID is structured as\nfollowing: `domain/type/vmajor.minor` (for example\n`googl
e.com/gcp-java/v1.1`).", | 783 "description": "Human readable description of the debuggee.\
nIncluding a human-readable project name, environment name and version\ninformat
ion is recommended.", |
937 "type": "string" | 784 "type": "string" |
938 }, | 785 }, |
939 "isDisabled": { | 786 "uniquifier": { |
940 "description": "If set to `true`, indicates that the agent s
hould disable itself and\ndetach from the debuggee.", | 787 "description": "Debuggee uniquifier within the project.\nAny
string that identifies the application within the project can be used.\nIncludi
ng environment and version or build IDs is recommended.", |
941 "type": "boolean" | 788 "type": "string" |
| 789 }, |
| 790 "sourceContexts": { |
| 791 "description": "References to the locations and revisions of
the source code used in the\ndeployed application.\n\nNOTE: This field is depre
cated. Consumers should use\n`ext_source_contexts` if it is not empty. Debug age
nts should populate\nboth this field and `ext_source_contexts`.", |
| 792 "items": { |
| 793 "$ref": "SourceContext" |
| 794 }, |
| 795 "type": "array" |
942 } | 796 } |
943 }, | 797 }, |
944 "type": "object" | 798 "type": "object" |
945 }, | 799 }, |
946 "ListActiveBreakpointsResponse": { | 800 "ListActiveBreakpointsResponse": { |
947 "description": "Response for listing active breakpoints.", | 801 "description": "Response for listing active breakpoints.", |
948 "id": "ListActiveBreakpointsResponse", | 802 "id": "ListActiveBreakpointsResponse", |
949 "properties": { | 803 "properties": { |
950 "breakpoints": { | 804 "breakpoints": { |
951 "description": "List of all active breakpoints.\nThe fields
`id` and `location` are guaranteed to be set on each breakpoint.", | 805 "description": "List of all active breakpoints.\nThe fields
`id` and `location` are guaranteed to be set on each breakpoint.", |
(...skipping 36 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
988 "description": "The ID of the snapshot.\nAn empty snapshot_i
d refers to the most recent snapshot.", | 842 "description": "The ID of the snapshot.\nAn empty snapshot_i
d refers to the most recent snapshot.", |
989 "type": "string" | 843 "type": "string" |
990 }, | 844 }, |
991 "workspaceId": { | 845 "workspaceId": { |
992 "$ref": "CloudWorkspaceId", | 846 "$ref": "CloudWorkspaceId", |
993 "description": "The ID of the workspace." | 847 "description": "The ID of the workspace." |
994 } | 848 } |
995 }, | 849 }, |
996 "type": "object" | 850 "type": "object" |
997 }, | 851 }, |
| 852 "UpdateActiveBreakpointResponse": { |
| 853 "description": "Response for updating an active breakpoint.\nThe mes
sage is defined to allow future extensions.", |
| 854 "id": "UpdateActiveBreakpointResponse", |
| 855 "properties": {}, |
| 856 "type": "object" |
| 857 }, |
998 "GerritSourceContext": { | 858 "GerritSourceContext": { |
999 "description": "A SourceContext referring to a Gerrit project.", | 859 "description": "A SourceContext referring to a Gerrit project.", |
1000 "id": "GerritSourceContext", | 860 "id": "GerritSourceContext", |
1001 "properties": { | 861 "properties": { |
1002 "revisionId": { | |
1003 "description": "A revision (commit) ID.", | |
1004 "type": "string" | |
1005 }, | |
1006 "hostUri": { | |
1007 "description": "The URI of a running Gerrit instance.", | |
1008 "type": "string" | |
1009 }, | |
1010 "aliasName": { | 862 "aliasName": { |
1011 "description": "The name of an alias (branch, tag, etc.).", | 863 "description": "The name of an alias (branch, tag, etc.).", |
1012 "type": "string" | 864 "type": "string" |
1013 }, | 865 }, |
1014 "aliasContext": { | 866 "aliasContext": { |
1015 "$ref": "AliasContext", | 867 "$ref": "AliasContext", |
1016 "description": "An alias, which may be a branch or tag." | 868 "description": "An alias, which may be a branch or tag." |
1017 }, | 869 }, |
1018 "gerritProject": { | 870 "gerritProject": { |
1019 "description": "The full project name within the host. Proje
cts may be nested, so\n\"project/subproject\" is a valid project name.\nThe \"re
po name\" is hostURI/project.", | 871 "description": "The full project name within the host. Proje
cts may be nested, so\n\"project/subproject\" is a valid project name.\nThe \"re
po name\" is hostURI/project.", |
1020 "type": "string" | 872 "type": "string" |
| 873 }, |
| 874 "revisionId": { |
| 875 "description": "A revision (commit) ID.", |
| 876 "type": "string" |
| 877 }, |
| 878 "hostUri": { |
| 879 "description": "The URI of a running Gerrit instance.", |
| 880 "type": "string" |
1021 } | 881 } |
1022 }, | 882 }, |
1023 "type": "object" | 883 "type": "object" |
1024 }, | 884 }, |
1025 "UpdateActiveBreakpointResponse": { | |
1026 "description": "Response for updating an active breakpoint.\nThe mes
sage is defined to allow future extensions.", | |
1027 "id": "UpdateActiveBreakpointResponse", | |
1028 "properties": {}, | |
1029 "type": "object" | |
1030 }, | |
1031 "CloudWorkspaceId": { | 885 "CloudWorkspaceId": { |
1032 "description": "A CloudWorkspaceId is a unique identifier for a clou
d workspace.\nA cloud workspace is a place associated with a repo where modified
files\ncan be stored before they are committed.", | 886 "description": "A CloudWorkspaceId is a unique identifier for a clou
d workspace.\nA cloud workspace is a place associated with a repo where modified
files\ncan be stored before they are committed.", |
1033 "id": "CloudWorkspaceId", | 887 "id": "CloudWorkspaceId", |
1034 "properties": { | 888 "properties": { |
| 889 "name": { |
| 890 "description": "The unique name of the workspace within the
repo. This is the name\nchosen by the client in the Source API's CreateWorkspac
e method.", |
| 891 "type": "string" |
| 892 }, |
1035 "repoId": { | 893 "repoId": { |
1036 "$ref": "RepoId", | 894 "$ref": "RepoId", |
1037 "description": "The ID of the repo containing the workspace.
" | 895 "description": "The ID of the repo containing the workspace.
" |
| 896 } |
| 897 }, |
| 898 "type": "object" |
| 899 }, |
| 900 "ListBreakpointsResponse": { |
| 901 "description": "Response for listing breakpoints.", |
| 902 "id": "ListBreakpointsResponse", |
| 903 "properties": { |
| 904 "breakpoints": { |
| 905 "description": "List of breakpoints matching the request.\nT
he fields `id` and `location` are guaranteed to be set on each breakpoint.\nThe
fields: `stack_frames`, `evaluated_expressions` and `variable_table`\nare cleare
d on each breakpoint regardless of its status.", |
| 906 "items": { |
| 907 "$ref": "Breakpoint" |
| 908 }, |
| 909 "type": "array" |
1038 }, | 910 }, |
1039 "name": { | 911 "nextWaitToken": { |
1040 "description": "The unique name of the workspace within the
repo. This is the name\nchosen by the client in the Source API's CreateWorkspac
e method.", | 912 "description": "A wait token that can be used in the next ca
ll to `list` (REST) or\n`ListBreakpoints` (RPC) to block until the list of break
points has changes.", |
1041 "type": "string" | 913 "type": "string" |
1042 } | 914 } |
1043 }, | 915 }, |
1044 "type": "object" | 916 "type": "object" |
| 917 }, |
| 918 "Breakpoint": { |
| 919 "description": "Represents the breakpoint specification, status and
results.", |
| 920 "id": "Breakpoint", |
| 921 "properties": { |
| 922 "expressions": { |
| 923 "description": "List of read-only expressions to evaluate at
the breakpoint location.\nThe expressions are composed using expressions in the
programming language\nat the source location. If the breakpoint action is `LOG`
, the evaluated\nexpressions are included in log statements.", |
| 924 "items": { |
| 925 "type": "string" |
| 926 }, |
| 927 "type": "array" |
| 928 }, |
| 929 "evaluatedExpressions": { |
| 930 "description": "Values of evaluated expressions at breakpoin
t time.\nThe evaluated expressions appear in exactly the same order they\nare li
sted in the `expressions` field.\nThe `name` field holds the original expression
text, the `value` or\n`members` field holds the result of the evaluated express
ion.\nIf the expression cannot be evaluated, the `status` inside the `Variable`\
nwill indicate an error and contain the error text.", |
| 931 "items": { |
| 932 "$ref": "Variable" |
| 933 }, |
| 934 "type": "array" |
| 935 }, |
| 936 "isFinalState": { |
| 937 "description": "When true, indicates that this is a final re
sult and the\nbreakpoint state will not change from here on.", |
| 938 "type": "boolean" |
| 939 }, |
| 940 "stackFrames": { |
| 941 "description": "The stack at breakpoint time.", |
| 942 "items": { |
| 943 "$ref": "StackFrame" |
| 944 }, |
| 945 "type": "array" |
| 946 }, |
| 947 "condition": { |
| 948 "description": "Condition that triggers the breakpoint.\nThe
condition is a compound boolean expression composed using expressions\nin a pro
gramming language at the source location.", |
| 949 "type": "string" |
| 950 }, |
| 951 "status": { |
| 952 "$ref": "StatusMessage", |
| 953 "description": "Breakpoint status.\n\nThe status includes an
error flag and a human readable message.\nThis field is usually unset. The mess
age can be either\ninformational or an error message. Regardless, clients should
always\ndisplay the text message back to the user.\n\nError status indicates co
mplete failure of the breakpoint.\n\nExample (non-final state): `Still loading s
ymbols...`\n\nExamples (final state):\n\n* `Invalid line number` referring to
location\n* `Field f not found in class C` referring to condition" |
| 954 }, |
| 955 "userEmail": { |
| 956 "description": "E-mail address of the user that created this
breakpoint", |
| 957 "type": "string" |
| 958 }, |
| 959 "action": { |
| 960 "description": "Action that the agent should perform when th
e code at the\nbreakpoint location is hit.", |
| 961 "enum": [ |
| 962 "CAPTURE", |
| 963 "LOG" |
| 964 ], |
| 965 "enumDescriptions": [ |
| 966 "Capture stack frame and variables and update the breakp
oint.\nThe data is only captured once. After that the breakpoint is set\nin a fi
nal state.", |
| 967 "Log each breakpoint hit. The breakpoint remains active
until\ndeleted or expired." |
| 968 ], |
| 969 "type": "string" |
| 970 }, |
| 971 "logLevel": { |
| 972 "description": "Indicates the severity of the log. Only rele
vant when action is `LOG`.", |
| 973 "enum": [ |
| 974 "INFO", |
| 975 "WARNING", |
| 976 "ERROR" |
| 977 ], |
| 978 "enumDescriptions": [ |
| 979 "Information log message.", |
| 980 "Warning log message.", |
| 981 "Error log message." |
| 982 ], |
| 983 "type": "string" |
| 984 }, |
| 985 "id": { |
| 986 "description": "Breakpoint identifier, unique in the scope o
f the debuggee.", |
| 987 "type": "string" |
| 988 }, |
| 989 "location": { |
| 990 "$ref": "SourceLocation", |
| 991 "description": "Breakpoint source location." |
| 992 }, |
| 993 "finalTime": { |
| 994 "description": "Time this breakpoint was finalized as seen b
y the server in seconds\nresolution.", |
| 995 "format": "google-datetime", |
| 996 "type": "string" |
| 997 }, |
| 998 "variableTable": { |
| 999 "description": "The `variable_table` exists to aid with comp
utation, memory and network\ntraffic optimization. It enables storing a variabl
e once and reference\nit from multiple variables, including variables stored in
the\n`variable_table` itself.\nFor example, the same `this` object, which may ap
pear at many levels of\nthe stack, can have all of its data stored once in this
table. The\nstack frame variables then would hold only a reference to it.\n\nTh
e variable `var_table_index` field is an index into this repeated field.\nThe st
ored objects are nameless and get their name from the referencing\nvariable. The
effective variable is a merge of the referencing variable\nand the referenced v
ariable.", |
| 1000 "items": { |
| 1001 "$ref": "Variable" |
| 1002 }, |
| 1003 "type": "array" |
| 1004 }, |
| 1005 "createTime": { |
| 1006 "description": "Time this breakpoint was created by the serv
er in seconds resolution.", |
| 1007 "format": "google-datetime", |
| 1008 "type": "string" |
| 1009 }, |
| 1010 "logMessageFormat": { |
| 1011 "description": "Only relevant when action is `LOG`. Defines
the message to log when\nthe breakpoint hits. The message may include parameter
placeholders `$0`,\n`$1`, etc. These placeholders are replaced with the evaluate
d value\nof the appropriate expression. Expressions not referenced in\n`log_mess
age_format` are not logged.\n\nExample: `Message received, id = $0, count = $1`
with\n`expressions` = `[ message.id, message.count ]`.", |
| 1012 "type": "string" |
| 1013 }, |
| 1014 "labels": { |
| 1015 "additionalProperties": { |
| 1016 "type": "string" |
| 1017 }, |
| 1018 "description": "A set of custom breakpoint properties, popul
ated by the agent, to be\ndisplayed to the user.", |
| 1019 "type": "object" |
| 1020 } |
| 1021 }, |
| 1022 "type": "object" |
| 1023 }, |
| 1024 "SetBreakpointResponse": { |
| 1025 "description": "Response for setting a breakpoint.", |
| 1026 "id": "SetBreakpointResponse", |
| 1027 "properties": { |
| 1028 "breakpoint": { |
| 1029 "$ref": "Breakpoint", |
| 1030 "description": "Breakpoint resource.\nThe field `id` is guar
anteed to be set (in addition to the echoed fileds)." |
| 1031 } |
| 1032 }, |
| 1033 "type": "object" |
| 1034 }, |
| 1035 "UpdateActiveBreakpointRequest": { |
| 1036 "description": "Request to update an active breakpoint.", |
| 1037 "id": "UpdateActiveBreakpointRequest", |
| 1038 "properties": { |
| 1039 "breakpoint": { |
| 1040 "$ref": "Breakpoint", |
| 1041 "description": "Updated breakpoint information.\nThe field `
id` must be set." |
| 1042 } |
| 1043 }, |
| 1044 "type": "object" |
1045 } | 1045 } |
1046 }, | 1046 }, |
1047 "servicePath": "", | 1047 "servicePath": "", |
1048 "title": "Stackdriver Debugger API", | 1048 "title": "Stackdriver Debugger API", |
1049 "version": "v2" | 1049 "version": "v2" |
1050 } | 1050 } |
OLD | NEW |