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 "access_token": { | |
32 "description": "OAuth access token.", | |
33 "location": "query", | |
34 "type": "string" | |
35 }, | |
36 "prettyPrint": { | |
37 "default": "true", | |
38 "description": "Returns response with indentations and line breaks."
, | |
39 "location": "query", | |
40 "type": "boolean" | |
41 }, | |
42 "key": { | |
43 "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.", | |
44 "location": "query", | |
45 "type": "string" | |
46 }, | |
47 "quotaUser": { | 31 "quotaUser": { |
48 "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.", | 32 "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.", |
49 "location": "query", | 33 "location": "query", |
50 "type": "string" | 34 "type": "string" |
51 }, | 35 }, |
52 "pp": { | 36 "pp": { |
53 "default": "true", | 37 "default": "true", |
54 "description": "Pretty-print response.", | 38 "description": "Pretty-print response.", |
55 "location": "query", | 39 "location": "query", |
56 "type": "boolean" | 40 "type": "boolean" |
57 }, | 41 }, |
| 42 "bearer_token": { |
| 43 "description": "OAuth bearer token.", |
| 44 "location": "query", |
| 45 "type": "string" |
| 46 }, |
| 47 "oauth_token": { |
| 48 "description": "OAuth 2.0 token for the current user.", |
| 49 "location": "query", |
| 50 "type": "string" |
| 51 }, |
| 52 "upload_protocol": { |
| 53 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", |
| 54 "location": "query", |
| 55 "type": "string" |
| 56 }, |
| 57 "prettyPrint": { |
| 58 "default": "true", |
| 59 "description": "Returns response with indentations and line breaks."
, |
| 60 "location": "query", |
| 61 "type": "boolean" |
| 62 }, |
58 "fields": { | 63 "fields": { |
59 "description": "Selector specifying which fields to include in a par
tial response.", | 64 "description": "Selector specifying which fields to include in a par
tial response.", |
60 "location": "query", | 65 "location": "query", |
61 "type": "string" | 66 "type": "string" |
62 }, | 67 }, |
63 "alt": { | 68 "uploadType": { |
64 "default": "json", | 69 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", |
65 "description": "Data format for response.", | |
66 "enum": [ | |
67 "json", | |
68 "media", | |
69 "proto" | |
70 ], | |
71 "enumDescriptions": [ | |
72 "Responses with Content-Type of application/json", | |
73 "Media download with context-dependent Content-Type", | |
74 "Responses with Content-Type of application/x-protobuf" | |
75 ], | |
76 "location": "query", | 70 "location": "query", |
77 "type": "string" | 71 "type": "string" |
78 }, | 72 }, |
| 73 "callback": { |
| 74 "description": "JSONP", |
| 75 "location": "query", |
| 76 "type": "string" |
| 77 }, |
79 "$.xgafv": { | 78 "$.xgafv": { |
80 "description": "V1 error format.", | 79 "description": "V1 error format.", |
81 "enum": [ | 80 "enum": [ |
82 "1", | 81 "1", |
83 "2" | 82 "2" |
84 ], | 83 ], |
85 "enumDescriptions": [ | 84 "enumDescriptions": [ |
86 "v1 error format", | 85 "v1 error format", |
87 "v2 error format" | 86 "v2 error format" |
88 ], | 87 ], |
89 "location": "query", | 88 "location": "query", |
90 "type": "string" | 89 "type": "string" |
91 }, | 90 }, |
92 "callback": { | 91 "alt": { |
93 "description": "JSONP", | 92 "default": "json", |
| 93 "description": "Data format for response.", |
| 94 "enum": [ |
| 95 "json", |
| 96 "media", |
| 97 "proto" |
| 98 ], |
| 99 "enumDescriptions": [ |
| 100 "Responses with Content-Type of application/json", |
| 101 "Media download with context-dependent Content-Type", |
| 102 "Responses with Content-Type of application/x-protobuf" |
| 103 ], |
94 "location": "query", | 104 "location": "query", |
95 "type": "string" | 105 "type": "string" |
96 }, | 106 }, |
97 "oauth_token": { | 107 "access_token": { |
98 "description": "OAuth 2.0 token for the current user.", | 108 "description": "OAuth access token.", |
99 "location": "query", | 109 "location": "query", |
100 "type": "string" | 110 "type": "string" |
101 }, | 111 }, |
102 "uploadType": { | 112 "key": { |
103 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", | 113 "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.", |
104 "location": "query", | |
105 "type": "string" | |
106 }, | |
107 "bearer_token": { | |
108 "description": "OAuth bearer token.", | |
109 "location": "query", | |
110 "type": "string" | |
111 }, | |
112 "upload_protocol": { | |
113 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", | |
114 "location": "query", | 114 "location": "query", |
115 "type": "string" | 115 "type": "string" |
116 } | 116 } |
117 }, | 117 }, |
118 "protocol": "rest", | 118 "protocol": "rest", |
119 "resources": { | 119 "resources": { |
120 "controller": { | 120 "controller": { |
121 "resources": { | 121 "resources": { |
122 "debuggees": { | 122 "debuggees": { |
123 "methods": { | 123 "methods": { |
(...skipping 12 matching lines...) Expand all Loading... |
136 }, | 136 }, |
137 "scopes": [ | 137 "scopes": [ |
138 "https://www.googleapis.com/auth/cloud-platform"
, | 138 "https://www.googleapis.com/auth/cloud-platform"
, |
139 "https://www.googleapis.com/auth/cloud_debugger" | 139 "https://www.googleapis.com/auth/cloud_debugger" |
140 ] | 140 ] |
141 } | 141 } |
142 }, | 142 }, |
143 "resources": { | 143 "resources": { |
144 "breakpoints": { | 144 "breakpoints": { |
145 "methods": { | 145 "methods": { |
| 146 "list": { |
| 147 "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.", |
| 148 "httpMethod": "GET", |
| 149 "id": "clouddebugger.controller.debuggees.br
eakpoints.list", |
| 150 "parameterOrder": [ |
| 151 "debuggeeId" |
| 152 ], |
| 153 "parameters": { |
| 154 "debuggeeId": { |
| 155 "description": "Identifies the debug
gee.", |
| 156 "location": "path", |
| 157 "required": true, |
| 158 "type": "string" |
| 159 }, |
| 160 "successOnTimeout": { |
| 161 "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).", |
| 162 "location": "query", |
| 163 "type": "boolean" |
| 164 }, |
| 165 "waitToken": { |
| 166 "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.", |
| 167 "location": "query", |
| 168 "type": "string" |
| 169 } |
| 170 }, |
| 171 "path": "v2/controller/debuggees/{debuggeeId
}/breakpoints", |
| 172 "response": { |
| 173 "$ref": "ListActiveBreakpointsResponse" |
| 174 }, |
| 175 "scopes": [ |
| 176 "https://www.googleapis.com/auth/cloud-p
latform", |
| 177 "https://www.googleapis.com/auth/cloud_d
ebugger" |
| 178 ] |
| 179 }, |
146 "update": { | 180 "update": { |
147 "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.", | 181 "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.", |
148 "httpMethod": "PUT", | 182 "httpMethod": "PUT", |
149 "id": "clouddebugger.controller.debuggees.br
eakpoints.update", | 183 "id": "clouddebugger.controller.debuggees.br
eakpoints.update", |
150 "parameterOrder": [ | 184 "parameterOrder": [ |
151 "debuggeeId", | 185 "debuggeeId", |
152 "id" | 186 "id" |
153 ], | 187 ], |
154 "parameters": { | 188 "parameters": { |
155 "debuggeeId": { | 189 "debuggeeId": { |
(...skipping 11 matching lines...) Expand all Loading... |
167 }, | 201 }, |
168 "path": "v2/controller/debuggees/{debuggeeId
}/breakpoints/{id}", | 202 "path": "v2/controller/debuggees/{debuggeeId
}/breakpoints/{id}", |
169 "request": { | 203 "request": { |
170 "$ref": "UpdateActiveBreakpointRequest" | 204 "$ref": "UpdateActiveBreakpointRequest" |
171 }, | 205 }, |
172 "response": { | 206 "response": { |
173 "$ref": "UpdateActiveBreakpointResponse" | 207 "$ref": "UpdateActiveBreakpointResponse" |
174 }, | 208 }, |
175 "scopes": [ | 209 "scopes": [ |
176 "https://www.googleapis.com/auth/cloud-p
latform", | 210 "https://www.googleapis.com/auth/cloud-p
latform", |
177 "https://www.googleapis.com/auth/cloud_d
ebugger" | |
178 ] | |
179 }, | |
180 "list": { | |
181 "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.", | |
182 "httpMethod": "GET", | |
183 "id": "clouddebugger.controller.debuggees.br
eakpoints.list", | |
184 "parameterOrder": [ | |
185 "debuggeeId" | |
186 ], | |
187 "parameters": { | |
188 "debuggeeId": { | |
189 "description": "Identifies the debug
gee.", | |
190 "location": "path", | |
191 "required": true, | |
192 "type": "string" | |
193 }, | |
194 "successOnTimeout": { | |
195 "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).", | |
196 "location": "query", | |
197 "type": "boolean" | |
198 }, | |
199 "waitToken": { | |
200 "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.", | |
201 "location": "query", | |
202 "type": "string" | |
203 } | |
204 }, | |
205 "path": "v2/controller/debuggees/{debuggeeId
}/breakpoints", | |
206 "response": { | |
207 "$ref": "ListActiveBreakpointsResponse" | |
208 }, | |
209 "scopes": [ | |
210 "https://www.googleapis.com/auth/cloud-p
latform", | |
211 "https://www.googleapis.com/auth/cloud_d
ebugger" | 211 "https://www.googleapis.com/auth/cloud_d
ebugger" |
212 ] | 212 ] |
213 } | 213 } |
214 } | 214 } |
215 } | 215 } |
216 } | 216 } |
217 } | 217 } |
218 } | 218 } |
219 }, | 219 }, |
220 "debugger": { | 220 "debugger": { |
221 "resources": { | 221 "resources": { |
222 "debuggees": { | 222 "debuggees": { |
223 "methods": { | 223 "methods": { |
224 "list": { | 224 "list": { |
225 "description": "Lists all the debuggees that the use
r can set breakpoints to.", | 225 "description": "Lists all the debuggees that the use
r can set breakpoints to.", |
226 "httpMethod": "GET", | 226 "httpMethod": "GET", |
227 "id": "clouddebugger.debugger.debuggees.list", | 227 "id": "clouddebugger.debugger.debuggees.list", |
228 "parameterOrder": [], | 228 "parameterOrder": [], |
229 "parameters": { | 229 "parameters": { |
| 230 "clientVersion": { |
| 231 "description": "The client version making th
e call.\nFollowing: `domain/type/version` (e.g., `google.com/intellij/v1`).", |
| 232 "location": "query", |
| 233 "type": "string" |
| 234 }, |
230 "includeInactive": { | 235 "includeInactive": { |
231 "description": "When set to `true`, the resu
lt includes all debuggees. Otherwise, the\nresult includes only debuggees that a
re active.", | 236 "description": "When set to `true`, the resu
lt includes all debuggees. Otherwise, the\nresult includes only debuggees that a
re active.", |
232 "location": "query", | 237 "location": "query", |
233 "type": "boolean" | 238 "type": "boolean" |
234 }, | 239 }, |
235 "project": { | 240 "project": { |
236 "description": "Project number of a Google C
loud project whose debuggees to list.", | 241 "description": "Project number of a Google C
loud project whose debuggees to list.", |
237 "location": "query", | 242 "location": "query", |
238 "type": "string" | 243 "type": "string" |
239 }, | |
240 "clientVersion": { | |
241 "description": "The client version making th
e call.\nFollowing: `domain/type/version` (e.g., `google.com/intellij/v1`).", | |
242 "location": "query", | |
243 "type": "string" | |
244 } | 244 } |
245 }, | 245 }, |
246 "path": "v2/debugger/debuggees", | 246 "path": "v2/debugger/debuggees", |
247 "response": { | 247 "response": { |
248 "$ref": "ListDebuggeesResponse" | 248 "$ref": "ListDebuggeesResponse" |
249 }, | 249 }, |
250 "scopes": [ | 250 "scopes": [ |
251 "https://www.googleapis.com/auth/cloud-platform"
, | 251 "https://www.googleapis.com/auth/cloud-platform"
, |
252 "https://www.googleapis.com/auth/cloud_debugger" | 252 "https://www.googleapis.com/auth/cloud_debugger" |
253 ] | 253 ] |
254 } | 254 } |
255 }, | 255 }, |
256 "resources": { | 256 "resources": { |
257 "breakpoints": { | 257 "breakpoints": { |
258 "methods": { | 258 "methods": { |
| 259 "set": { |
| 260 "description": "Sets the breakpoint to the d
ebuggee.", |
| 261 "httpMethod": "POST", |
| 262 "id": "clouddebugger.debugger.debuggees.brea
kpoints.set", |
| 263 "parameterOrder": [ |
| 264 "debuggeeId" |
| 265 ], |
| 266 "parameters": { |
| 267 "clientVersion": { |
| 268 "description": "The client version m
aking the call.\nFollowing: `domain/type/version` (e.g., `google.com/intellij/v1
`).", |
| 269 "location": "query", |
| 270 "type": "string" |
| 271 }, |
| 272 "debuggeeId": { |
| 273 "description": "ID of the debuggee w
here the breakpoint is to be set.", |
| 274 "location": "path", |
| 275 "required": true, |
| 276 "type": "string" |
| 277 } |
| 278 }, |
| 279 "path": "v2/debugger/debuggees/{debuggeeId}/
breakpoints/set", |
| 280 "request": { |
| 281 "$ref": "Breakpoint" |
| 282 }, |
| 283 "response": { |
| 284 "$ref": "SetBreakpointResponse" |
| 285 }, |
| 286 "scopes": [ |
| 287 "https://www.googleapis.com/auth/cloud-p
latform", |
| 288 "https://www.googleapis.com/auth/cloud_d
ebugger" |
| 289 ] |
| 290 }, |
| 291 "delete": { |
| 292 "description": "Deletes the breakpoint from
the debuggee.", |
| 293 "httpMethod": "DELETE", |
| 294 "id": "clouddebugger.debugger.debuggees.brea
kpoints.delete", |
| 295 "parameterOrder": [ |
| 296 "debuggeeId", |
| 297 "breakpointId" |
| 298 ], |
| 299 "parameters": { |
| 300 "debuggeeId": { |
| 301 "description": "ID of the debuggee w
hose breakpoint to delete.", |
| 302 "location": "path", |
| 303 "required": true, |
| 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 }, |
| 311 "breakpointId": { |
| 312 "description": "ID of the breakpoint
to delete.", |
| 313 "location": "path", |
| 314 "required": true, |
| 315 "type": "string" |
| 316 } |
| 317 }, |
| 318 "path": "v2/debugger/debuggees/{debuggeeId}/
breakpoints/{breakpointId}", |
| 319 "response": { |
| 320 "$ref": "Empty" |
| 321 }, |
| 322 "scopes": [ |
| 323 "https://www.googleapis.com/auth/cloud-p
latform", |
| 324 "https://www.googleapis.com/auth/cloud_d
ebugger" |
| 325 ] |
| 326 }, |
259 "get": { | 327 "get": { |
260 "description": "Gets breakpoint information.
", | 328 "description": "Gets breakpoint information.
", |
261 "httpMethod": "GET", | 329 "httpMethod": "GET", |
262 "id": "clouddebugger.debugger.debuggees.brea
kpoints.get", | 330 "id": "clouddebugger.debugger.debuggees.brea
kpoints.get", |
263 "parameterOrder": [ | 331 "parameterOrder": [ |
264 "debuggeeId", | 332 "debuggeeId", |
265 "breakpointId" | 333 "breakpointId" |
266 ], | 334 ], |
267 "parameters": { | 335 "parameters": { |
268 "debuggeeId": { | 336 "debuggeeId": { |
269 "description": "ID of the debuggee w
hose breakpoint to get.", | 337 "description": "ID of the debuggee w
hose breakpoint to get.", |
270 "location": "path", | 338 "location": "path", |
271 "required": true, | 339 "required": true, |
272 "type": "string" | 340 "type": "string" |
273 }, | 341 }, |
| 342 "clientVersion": { |
| 343 "description": "The client version m
aking the call.\nFollowing: `domain/type/version` (e.g., `google.com/intellij/v1
`).", |
| 344 "location": "query", |
| 345 "type": "string" |
| 346 }, |
274 "breakpointId": { | 347 "breakpointId": { |
275 "description": "ID of the breakpoint
to get.", | 348 "description": "ID of the breakpoint
to get.", |
276 "location": "path", | 349 "location": "path", |
277 "required": true, | 350 "required": true, |
278 "type": "string" | 351 "type": "string" |
279 }, | |
280 "clientVersion": { | |
281 "description": "The client version m
aking the call.\nFollowing: `domain/type/version` (e.g., `google.com/intellij/v1
`).", | |
282 "location": "query", | |
283 "type": "string" | |
284 } | 352 } |
285 }, | 353 }, |
286 "path": "v2/debugger/debuggees/{debuggeeId}/
breakpoints/{breakpointId}", | 354 "path": "v2/debugger/debuggees/{debuggeeId}/
breakpoints/{breakpointId}", |
287 "response": { | 355 "response": { |
288 "$ref": "GetBreakpointResponse" | 356 "$ref": "GetBreakpointResponse" |
289 }, | 357 }, |
290 "scopes": [ | 358 "scopes": [ |
291 "https://www.googleapis.com/auth/cloud-p
latform", | 359 "https://www.googleapis.com/auth/cloud-p
latform", |
292 "https://www.googleapis.com/auth/cloud_d
ebugger" | 360 "https://www.googleapis.com/auth/cloud_d
ebugger" |
293 ] | 361 ] |
294 }, | 362 }, |
295 "list": { | 363 "list": { |
296 "description": "Lists all breakpoints for th
e debuggee.", | 364 "description": "Lists all breakpoints for th
e debuggee.", |
297 "httpMethod": "GET", | 365 "httpMethod": "GET", |
298 "id": "clouddebugger.debugger.debuggees.brea
kpoints.list", | 366 "id": "clouddebugger.debugger.debuggees.brea
kpoints.list", |
299 "parameterOrder": [ | 367 "parameterOrder": [ |
300 "debuggeeId" | 368 "debuggeeId" |
301 ], | 369 ], |
302 "parameters": { | 370 "parameters": { |
303 "debuggeeId": { | 371 "debuggeeId": { |
304 "description": "ID of the debuggee w
hose breakpoints to list.", | 372 "description": "ID of the debuggee w
hose breakpoints to list.", |
305 "location": "path", | 373 "location": "path", |
306 "required": true, | 374 "required": true, |
307 "type": "string" | 375 "type": "string" |
308 }, | 376 }, |
| 377 "waitToken": { |
| 378 "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`.", |
| 379 "location": "query", |
| 380 "type": "string" |
| 381 }, |
309 "clientVersion": { | 382 "clientVersion": { |
310 "description": "The client version m
aking the call.\nFollowing: `domain/type/version` (e.g., `google.com/intellij/v1
`).", | 383 "description": "The client version m
aking the call.\nFollowing: `domain/type/version` (e.g., `google.com/intellij/v1
`).", |
311 "location": "query", | 384 "location": "query", |
312 "type": "string" | 385 "type": "string" |
313 }, | 386 }, |
314 "includeAllUsers": { | |
315 "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.", | |
316 "location": "query", | |
317 "type": "boolean" | |
318 }, | |
319 "stripResults": { | |
320 "description": "This field is deprec
ated. The following fields are always stripped out of\nthe result: `stack_frames
`, `evaluated_expressions` and `variable_table`.", | |
321 "location": "query", | |
322 "type": "boolean" | |
323 }, | |
324 "action.value": { | 387 "action.value": { |
325 "description": "Only breakpoints wit
h the specified action will pass the filter.", | 388 "description": "Only breakpoints wit
h the specified action will pass the filter.", |
326 "enum": [ | 389 "enum": [ |
327 "CAPTURE", | 390 "CAPTURE", |
328 "LOG" | 391 "LOG" |
329 ], | 392 ], |
330 "location": "query", | 393 "location": "query", |
331 "type": "string" | 394 "type": "string" |
332 }, | 395 }, |
| 396 "includeAllUsers": { |
| 397 "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.", |
| 398 "location": "query", |
| 399 "type": "boolean" |
| 400 }, |
333 "includeInactive": { | 401 "includeInactive": { |
334 "description": "When set to `true`,
the response includes active and inactive\nbreakpoints. Otherwise, it includes o
nly active breakpoints.", | 402 "description": "When set to `true`,
the response includes active and inactive\nbreakpoints. Otherwise, it includes o
nly active breakpoints.", |
335 "location": "query", | 403 "location": "query", |
336 "type": "boolean" | 404 "type": "boolean" |
337 }, | 405 }, |
338 "waitToken": { | 406 "stripResults": { |
339 "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`.", | 407 "description": "This field is deprec
ated. The following fields are always stripped out of\nthe result: `stack_frames
`, `evaluated_expressions` and `variable_table`.", |
340 "location": "query", | 408 "location": "query", |
341 "type": "string" | 409 "type": "boolean" |
342 } | 410 } |
343 }, | 411 }, |
344 "path": "v2/debugger/debuggees/{debuggeeId}/
breakpoints", | 412 "path": "v2/debugger/debuggees/{debuggeeId}/
breakpoints", |
345 "response": { | 413 "response": { |
346 "$ref": "ListBreakpointsResponse" | 414 "$ref": "ListBreakpointsResponse" |
347 }, | 415 }, |
348 "scopes": [ | 416 "scopes": [ |
349 "https://www.googleapis.com/auth/cloud-p
latform", | 417 "https://www.googleapis.com/auth/cloud-p
latform", |
350 "https://www.googleapis.com/auth/cloud_d
ebugger" | 418 "https://www.googleapis.com/auth/cloud_d
ebugger" |
351 ] | 419 ] |
352 }, | |
353 "set": { | |
354 "description": "Sets the breakpoint to the d
ebuggee.", | |
355 "httpMethod": "POST", | |
356 "id": "clouddebugger.debugger.debuggees.brea
kpoints.set", | |
357 "parameterOrder": [ | |
358 "debuggeeId" | |
359 ], | |
360 "parameters": { | |
361 "debuggeeId": { | |
362 "description": "ID of the debuggee w
here the breakpoint is to be set.", | |
363 "location": "path", | |
364 "required": true, | |
365 "type": "string" | |
366 }, | |
367 "clientVersion": { | |
368 "description": "The client version m
aking the call.\nFollowing: `domain/type/version` (e.g., `google.com/intellij/v1
`).", | |
369 "location": "query", | |
370 "type": "string" | |
371 } | |
372 }, | |
373 "path": "v2/debugger/debuggees/{debuggeeId}/
breakpoints/set", | |
374 "request": { | |
375 "$ref": "Breakpoint" | |
376 }, | |
377 "response": { | |
378 "$ref": "SetBreakpointResponse" | |
379 }, | |
380 "scopes": [ | |
381 "https://www.googleapis.com/auth/cloud-p
latform", | |
382 "https://www.googleapis.com/auth/cloud_d
ebugger" | |
383 ] | |
384 }, | |
385 "delete": { | |
386 "description": "Deletes the breakpoint from
the debuggee.", | |
387 "httpMethod": "DELETE", | |
388 "id": "clouddebugger.debugger.debuggees.brea
kpoints.delete", | |
389 "parameterOrder": [ | |
390 "debuggeeId", | |
391 "breakpointId" | |
392 ], | |
393 "parameters": { | |
394 "debuggeeId": { | |
395 "description": "ID of the debuggee w
hose breakpoint to delete.", | |
396 "location": "path", | |
397 "required": true, | |
398 "type": "string" | |
399 }, | |
400 "breakpointId": { | |
401 "description": "ID of the breakpoint
to delete.", | |
402 "location": "path", | |
403 "required": true, | |
404 "type": "string" | |
405 }, | |
406 "clientVersion": { | |
407 "description": "The client version m
aking the call.\nFollowing: `domain/type/version` (e.g., `google.com/intellij/v1
`).", | |
408 "location": "query", | |
409 "type": "string" | |
410 } | |
411 }, | |
412 "path": "v2/debugger/debuggees/{debuggeeId}/
breakpoints/{breakpointId}", | |
413 "response": { | |
414 "$ref": "Empty" | |
415 }, | |
416 "scopes": [ | |
417 "https://www.googleapis.com/auth/cloud-p
latform", | |
418 "https://www.googleapis.com/auth/cloud_d
ebugger" | |
419 ] | |
420 } | 420 } |
421 } | 421 } |
422 } | 422 } |
423 } | 423 } |
424 } | 424 } |
425 } | 425 } |
426 } | 426 } |
427 }, | 427 }, |
428 "revision": "20170117", | 428 "revision": "20170208", |
429 "rootUrl": "https://clouddebugger.googleapis.com/", | 429 "rootUrl": "https://clouddebugger.googleapis.com/", |
430 "schemas": { | 430 "schemas": { |
431 "Debuggee": { | 431 "RegisterDebuggeeRequest": { |
432 "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.", | 432 "description": "Request to register a debuggee.", |
433 "id": "Debuggee", | 433 "id": "RegisterDebuggeeRequest", |
434 "properties": { | 434 "properties": { |
435 "id": { | 435 "debuggee": { |
436 "description": "Unique identifier for the debuggee generated
by the controller service.", | 436 "$ref": "Debuggee", |
| 437 "description": "Debuggee information to register.\nThe field
s `project`, `uniquifier`, `description` and `agent_version`\nof the debuggee mu
st be set." |
| 438 } |
| 439 }, |
| 440 "type": "object" |
| 441 }, |
| 442 "RegisterDebuggeeResponse": { |
| 443 "description": "Response for registering a debuggee.", |
| 444 "id": "RegisterDebuggeeResponse", |
| 445 "properties": { |
| 446 "debuggee": { |
| 447 "$ref": "Debuggee", |
| 448 "description": "Debuggee resource.\nThe field `id` is gurant
eed to be set (in addition to the echoed fields)." |
| 449 } |
| 450 }, |
| 451 "type": "object" |
| 452 }, |
| 453 "GetBreakpointResponse": { |
| 454 "description": "Response for getting breakpoint information.", |
| 455 "id": "GetBreakpointResponse", |
| 456 "properties": { |
| 457 "breakpoint": { |
| 458 "$ref": "Breakpoint", |
| 459 "description": "Complete breakpoint state.\nThe fields `id`
and `location` are guaranteed to be set." |
| 460 } |
| 461 }, |
| 462 "type": "object" |
| 463 }, |
| 464 "StatusMessage": { |
| 465 "description": "Represents a contextual status message.\nThe message
can indicate an error or informational status, and refer to\nspecific parts of
the containing object.\nFor example, the `Breakpoint.status` field can indicate
an error referring\nto the `BREAKPOINT_SOURCE_LOCATION` with the message `Locati
on not found`.", |
| 466 "id": "StatusMessage", |
| 467 "properties": { |
| 468 "isError": { |
| 469 "description": "Distinguishes errors from informational mess
ages.", |
| 470 "type": "boolean" |
| 471 }, |
| 472 "description": { |
| 473 "$ref": "FormatMessage", |
| 474 "description": "Status message text." |
| 475 }, |
| 476 "refersTo": { |
| 477 "description": "Reference to which the message applies.", |
| 478 "enum": [ |
| 479 "UNSPECIFIED", |
| 480 "BREAKPOINT_SOURCE_LOCATION", |
| 481 "BREAKPOINT_CONDITION", |
| 482 "BREAKPOINT_EXPRESSION", |
| 483 "BREAKPOINT_AGE", |
| 484 "VARIABLE_NAME", |
| 485 "VARIABLE_VALUE" |
| 486 ], |
| 487 "enumDescriptions": [ |
| 488 "Status doesn't refer to any particular input.", |
| 489 "Status applies to the breakpoint and is related to its
location.", |
| 490 "Status applies to the breakpoint and is related to its
condition.", |
| 491 "Status applies to the breakpoint and is related to its
expressions.", |
| 492 "Status applies to the breakpoint and is related to its
age.", |
| 493 "Status applies to the entire variable.", |
| 494 "Status applies to variable value (variable name is vali
d)." |
| 495 ], |
| 496 "type": "string" |
| 497 } |
| 498 }, |
| 499 "type": "object" |
| 500 }, |
| 501 "GitSourceContext": { |
| 502 "description": "A GitSourceContext denotes a particular revision in
a third party Git\nrepository (e.g. GitHub).", |
| 503 "id": "GitSourceContext", |
| 504 "properties": { |
| 505 "revisionId": { |
| 506 "description": "Git commit hash.\nrequired.", |
437 "type": "string" | 507 "type": "string" |
438 }, | 508 }, |
439 "project": { | 509 "url": { |
440 "description": "Project the debuggee is associated with.\nUs
e the project number when registering a Google Cloud Platform project.", | 510 "description": "Git repository URL.", |
441 "type": "string" | 511 "type": "string" |
442 }, | 512 } |
443 "extSourceContexts": { | 513 }, |
444 "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`.", | 514 "type": "object" |
| 515 }, |
| 516 "Variable": { |
| 517 "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.", |
| 518 "id": "Variable", |
| 519 "properties": { |
| 520 "members": { |
| 521 "description": "Members contained or pointed to by the varia
ble.", |
445 "items": { | 522 "items": { |
446 "$ref": "ExtendedSourceContext" | 523 "$ref": "Variable" |
447 }, | 524 }, |
448 "type": "array" | 525 "type": "array" |
449 }, | 526 }, |
450 "description": { | 527 "status": { |
451 "description": "Human readable description of the debuggee.\
nIncluding a human-readable project name, environment name and version\ninformat
ion is recommended.", | 528 "$ref": "StatusMessage", |
| 529 "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`" |
| 530 }, |
| 531 "name": { |
| 532 "description": "Name of the variable, if any.", |
452 "type": "string" | 533 "type": "string" |
453 }, | 534 }, |
454 "isDisabled": { | 535 "type": { |
455 "description": "If set to `true`, indicates that the agent s
hould disable itself and\ndetach from the debuggee.", | 536 "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.", |
456 "type": "boolean" | |
457 }, | |
458 "status": { | |
459 "$ref": "StatusMessage", | |
460 "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." | |
461 }, | |
462 "isInactive": { | |
463 "description": "If set to `true`, indicates that the debugge
e is considered as inactive by\nthe Controller service.", | |
464 "type": "boolean" | |
465 }, | |
466 "agentVersion": { | |
467 "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`).", | |
468 "type": "string" | 537 "type": "string" |
469 }, | 538 }, |
470 "labels": { | 539 "varTableIndex": { |
471 "additionalProperties": { | 540 "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.", |
472 "type": "string" | 541 "format": "int32", |
473 }, | 542 "type": "integer" |
474 "description": "A set of custom debuggee properties, populat
ed by the agent, to be\ndisplayed to the user.", | |
475 "type": "object" | |
476 }, | 543 }, |
477 "uniquifier": { | 544 "value": { |
478 "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.", | 545 "description": "Simple value of the variable.", |
479 "type": "string" | 546 "type": "string" |
480 }, | |
481 "sourceContexts": { | |
482 "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`.", | |
483 "items": { | |
484 "$ref": "SourceContext" | |
485 }, | |
486 "type": "array" | |
487 } | 547 } |
488 }, | 548 }, |
489 "type": "object" | 549 "type": "object" |
490 }, | 550 }, |
491 "StackFrame": { | 551 "StackFrame": { |
492 "description": "Represents a stack frame context.", | 552 "description": "Represents a stack frame context.", |
493 "id": "StackFrame", | 553 "id": "StackFrame", |
494 "properties": { | 554 "properties": { |
495 "locals": { | 555 "locals": { |
496 "description": "Set of local variables at the stack frame lo
cation.\nNote that this might not be populated for all stack frames.", | 556 "description": "Set of local variables at the stack frame lo
cation.\nNote that this might not be populated for all stack frames.", |
497 "items": { | 557 "items": { |
498 "$ref": "Variable" | 558 "$ref": "Variable" |
499 }, | 559 }, |
500 "type": "array" | 560 "type": "array" |
501 }, | 561 }, |
| 562 "location": { |
| 563 "$ref": "SourceLocation", |
| 564 "description": "Source location of the call site." |
| 565 }, |
502 "function": { | 566 "function": { |
503 "description": "Demangled function name at the call site.", | 567 "description": "Demangled function name at the call site.", |
504 "type": "string" | 568 "type": "string" |
505 }, | 569 }, |
506 "location": { | |
507 "$ref": "SourceLocation", | |
508 "description": "Source location of the call site." | |
509 }, | |
510 "arguments": { | 570 "arguments": { |
511 "description": "Set of arguments passed to this function.\nN
ote that this might not be populated for all stack frames.", | 571 "description": "Set of arguments passed to this function.\nN
ote that this might not be populated for all stack frames.", |
512 "items": { | 572 "items": { |
513 "$ref": "Variable" | 573 "$ref": "Variable" |
514 }, | 574 }, |
515 "type": "array" | 575 "type": "array" |
516 } | 576 } |
517 }, | 577 }, |
518 "type": "object" | 578 "type": "object" |
519 }, | 579 }, |
520 "ListBreakpointsResponse": { | 580 "RepoId": { |
521 "description": "Response for listing breakpoints.", | 581 "description": "A unique identifier for a cloud repo.", |
522 "id": "ListBreakpointsResponse", | 582 "id": "RepoId", |
523 "properties": { | 583 "properties": { |
524 "breakpoints": { | 584 "projectRepoId": { |
525 "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.", | 585 "$ref": "ProjectRepoId", |
526 "items": { | 586 "description": "A combination of a project ID and a repo nam
e." |
527 "$ref": "Breakpoint" | |
528 }, | |
529 "type": "array" | |
530 }, | 587 }, |
531 "nextWaitToken": { | 588 "uid": { |
532 "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.", | 589 "description": "A server-assigned, globally unique identifie
r.", |
533 "type": "string" | 590 "type": "string" |
534 } | 591 } |
535 }, | 592 }, |
536 "type": "object" | 593 "type": "object" |
537 }, | 594 }, |
538 "Variable": { | 595 "FormatMessage": { |
539 "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.", | 596 "description": "Represents a message with parameters.", |
540 "id": "Variable", | 597 "id": "FormatMessage", |
541 "properties": { | 598 "properties": { |
542 "varTableIndex": { | 599 "format": { |
543 "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.", | 600 "description": "Format template for the message. The `format
` uses placeholders `$0`,\n`$1`, etc. to reference parameters. `$$` can be used
to denote the `$`\ncharacter.\n\nExamples:\n\n* `Failed to load '$0' which hel
ps debug $1 the first time it\n is loaded. Again, $0 is very important.`\n*
`Please pay $$10 to use $0 instead of $1.`", |
544 "format": "int32", | 601 "type": "string" |
545 "type": "integer" | |
546 }, | 602 }, |
547 "status": { | 603 "parameters": { |
548 "$ref": "StatusMessage", | 604 "description": "Optional parameters to be embedded into the
message.", |
549 "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`" | |
550 }, | |
551 "members": { | |
552 "description": "Members contained or pointed to by the varia
ble.", | |
553 "items": { | 605 "items": { |
554 "$ref": "Variable" | 606 "type": "string" |
555 }, | 607 }, |
556 "type": "array" | 608 "type": "array" |
| 609 } |
| 610 }, |
| 611 "type": "object" |
| 612 }, |
| 613 "ExtendedSourceContext": { |
| 614 "description": "An ExtendedSourceContext is a SourceContext combined
with additional\ndetails describing the context.", |
| 615 "id": "ExtendedSourceContext", |
| 616 "properties": { |
| 617 "labels": { |
| 618 "additionalProperties": { |
| 619 "type": "string" |
| 620 }, |
| 621 "description": "Labels with user defined metadata.", |
| 622 "type": "object" |
557 }, | 623 }, |
| 624 "context": { |
| 625 "$ref": "SourceContext", |
| 626 "description": "Any source context." |
| 627 } |
| 628 }, |
| 629 "type": "object" |
| 630 }, |
| 631 "AliasContext": { |
| 632 "description": "An alias to a repo revision.", |
| 633 "id": "AliasContext", |
| 634 "properties": { |
558 "name": { | 635 "name": { |
559 "description": "Name of the variable, if any.", | 636 "description": "The alias name.", |
560 "type": "string" | 637 "type": "string" |
561 }, | 638 }, |
562 "value": { | 639 "kind": { |
563 "description": "Simple value of the variable.", | 640 "description": "The alias kind.", |
564 "type": "string" | 641 "enum": [ |
565 }, | 642 "ANY", |
566 "type": { | 643 "FIXED", |
567 "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.", | 644 "MOVABLE", |
| 645 "OTHER" |
| 646 ], |
| 647 "enumDescriptions": [ |
| 648 "Do not use.", |
| 649 "Git tag", |
| 650 "Git branch", |
| 651 "OTHER is used to specify non-standard aliases, those no
t of the kinds\nabove. For example, if a Git repo has a ref named \"refs/foo/bar
\", it\nis considered to be of kind OTHER." |
| 652 ], |
568 "type": "string" | 653 "type": "string" |
569 } | 654 } |
570 }, | 655 }, |
571 "type": "object" | 656 "type": "object" |
572 }, | 657 }, |
| 658 "ListDebuggeesResponse": { |
| 659 "description": "Response for listing debuggees.", |
| 660 "id": "ListDebuggeesResponse", |
| 661 "properties": { |
| 662 "debuggees": { |
| 663 "description": "List of debuggees accessible to the calling
user.\nNote that the `description` field is the only human readable field\nthat
should be displayed to the user.\nThe fields `debuggee.id` and `description` fi
elds are guaranteed to be\nset on each debuggee.", |
| 664 "items": { |
| 665 "$ref": "Debuggee" |
| 666 }, |
| 667 "type": "array" |
| 668 } |
| 669 }, |
| 670 "type": "object" |
| 671 }, |
| 672 "Empty": { |
| 673 "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 `{}`.", |
| 674 "id": "Empty", |
| 675 "properties": {}, |
| 676 "type": "object" |
| 677 }, |
573 "SourceLocation": { | 678 "SourceLocation": { |
574 "description": "Represents a location in the source code.", | 679 "description": "Represents a location in the source code.", |
575 "id": "SourceLocation", | 680 "id": "SourceLocation", |
576 "properties": { | 681 "properties": { |
577 "path": { | 682 "path": { |
578 "description": "Path to the source file within the source co
ntext of the target binary.", | 683 "description": "Path to the source file within the source co
ntext of the target binary.", |
579 "type": "string" | 684 "type": "string" |
580 }, | 685 }, |
581 "line": { | 686 "line": { |
582 "description": "Line inside the file. The first line in the
file has the value `1`.", | 687 "description": "Line inside the file. The first line in the
file has the value `1`.", |
583 "format": "int32", | 688 "format": "int32", |
584 "type": "integer" | 689 "type": "integer" |
585 } | 690 } |
586 }, | 691 }, |
587 "type": "object" | 692 "type": "object" |
588 }, | 693 }, |
| 694 "Debuggee": { |
| 695 "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.", |
| 696 "id": "Debuggee", |
| 697 "properties": { |
| 698 "description": { |
| 699 "description": "Human readable description of the debuggee.\
nIncluding a human-readable project name, environment name and version\ninformat
ion is recommended.", |
| 700 "type": "string" |
| 701 }, |
| 702 "uniquifier": { |
| 703 "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.", |
| 704 "type": "string" |
| 705 }, |
| 706 "sourceContexts": { |
| 707 "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`.", |
| 708 "items": { |
| 709 "$ref": "SourceContext" |
| 710 }, |
| 711 "type": "array" |
| 712 }, |
| 713 "extSourceContexts": { |
| 714 "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`.", |
| 715 "items": { |
| 716 "$ref": "ExtendedSourceContext" |
| 717 }, |
| 718 "type": "array" |
| 719 }, |
| 720 "labels": { |
| 721 "additionalProperties": { |
| 722 "type": "string" |
| 723 }, |
| 724 "description": "A set of custom debuggee properties, populat
ed by the agent, to be\ndisplayed to the user.", |
| 725 "type": "object" |
| 726 }, |
| 727 "isInactive": { |
| 728 "description": "If set to `true`, indicates that the debugge
e is considered as inactive by\nthe Controller service.", |
| 729 "type": "boolean" |
| 730 }, |
| 731 "status": { |
| 732 "$ref": "StatusMessage", |
| 733 "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." |
| 734 }, |
| 735 "project": { |
| 736 "description": "Project the debuggee is associated with.\nUs
e the project number when registering a Google Cloud Platform project.", |
| 737 "type": "string" |
| 738 }, |
| 739 "isDisabled": { |
| 740 "description": "If set to `true`, indicates that the agent s
hould disable itself and\ndetach from the debuggee.", |
| 741 "type": "boolean" |
| 742 }, |
| 743 "agentVersion": { |
| 744 "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`).", |
| 745 "type": "string" |
| 746 }, |
| 747 "id": { |
| 748 "description": "Unique identifier for the debuggee generated
by the controller service.", |
| 749 "type": "string" |
| 750 } |
| 751 }, |
| 752 "type": "object" |
| 753 }, |
| 754 "ListActiveBreakpointsResponse": { |
| 755 "description": "Response for listing active breakpoints.", |
| 756 "id": "ListActiveBreakpointsResponse", |
| 757 "properties": { |
| 758 "nextWaitToken": { |
| 759 "description": "A wait token that can be used in the next me
thod call to block until\nthe list of breakpoints changes.", |
| 760 "type": "string" |
| 761 }, |
| 762 "breakpoints": { |
| 763 "description": "List of all active breakpoints.\nThe fields
`id` and `location` are guaranteed to be set on each breakpoint.", |
| 764 "items": { |
| 765 "$ref": "Breakpoint" |
| 766 }, |
| 767 "type": "array" |
| 768 }, |
| 769 "waitExpired": { |
| 770 "description": "The `wait_expired` field is set to true by t
he server when the\nrequest times out and the field `success_on_timeout` is set
to true.", |
| 771 "type": "boolean" |
| 772 } |
| 773 }, |
| 774 "type": "object" |
| 775 }, |
| 776 "ProjectRepoId": { |
| 777 "description": "Selects a repo using a Google Cloud Platform project
ID\n(e.g. winged-cargo-31) and a repo name within that project.", |
| 778 "id": "ProjectRepoId", |
| 779 "properties": { |
| 780 "projectId": { |
| 781 "description": "The ID of the project.", |
| 782 "type": "string" |
| 783 }, |
| 784 "repoName": { |
| 785 "description": "The name of the repo. Leave empty for the de
fault repo.", |
| 786 "type": "string" |
| 787 } |
| 788 }, |
| 789 "type": "object" |
| 790 }, |
| 791 "CloudWorkspaceSourceContext": { |
| 792 "description": "A CloudWorkspaceSourceContext denotes a workspace at
a particular snapshot.", |
| 793 "id": "CloudWorkspaceSourceContext", |
| 794 "properties": { |
| 795 "snapshotId": { |
| 796 "description": "The ID of the snapshot.\nAn empty snapshot_i
d refers to the most recent snapshot.", |
| 797 "type": "string" |
| 798 }, |
| 799 "workspaceId": { |
| 800 "$ref": "CloudWorkspaceId", |
| 801 "description": "The ID of the workspace." |
| 802 } |
| 803 }, |
| 804 "type": "object" |
| 805 }, |
| 806 "UpdateActiveBreakpointResponse": { |
| 807 "description": "Response for updating an active breakpoint.\nThe mes
sage is defined to allow future extensions.", |
| 808 "id": "UpdateActiveBreakpointResponse", |
| 809 "properties": {}, |
| 810 "type": "object" |
| 811 }, |
589 "GerritSourceContext": { | 812 "GerritSourceContext": { |
590 "description": "A SourceContext referring to a Gerrit project.", | 813 "description": "A SourceContext referring to a Gerrit project.", |
591 "id": "GerritSourceContext", | 814 "id": "GerritSourceContext", |
592 "properties": { | 815 "properties": { |
593 "hostUri": { | 816 "gerritProject": { |
594 "description": "The URI of a running Gerrit instance.", | 817 "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.", |
595 "type": "string" | |
596 }, | |
597 "aliasName": { | |
598 "description": "The name of an alias (branch, tag, etc.).", | |
599 "type": "string" | 818 "type": "string" |
600 }, | 819 }, |
601 "aliasContext": { | 820 "aliasContext": { |
602 "$ref": "AliasContext", | 821 "$ref": "AliasContext", |
603 "description": "An alias, which may be a branch or tag." | 822 "description": "An alias, which may be a branch or tag." |
604 }, | 823 }, |
605 "gerritProject": { | 824 "hostUri": { |
606 "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.", | 825 "description": "The URI of a running Gerrit instance.", |
607 "type": "string" | 826 "type": "string" |
608 }, | 827 }, |
609 "revisionId": { | 828 "revisionId": { |
610 "description": "A revision (commit) ID.", | 829 "description": "A revision (commit) ID.", |
611 "type": "string" | 830 "type": "string" |
612 } | |
613 }, | |
614 "type": "object" | |
615 }, | |
616 "FormatMessage": { | |
617 "description": "Represents a message with parameters.", | |
618 "id": "FormatMessage", | |
619 "properties": { | |
620 "parameters": { | |
621 "description": "Optional parameters to be embedded into the
message.", | |
622 "items": { | |
623 "type": "string" | |
624 }, | |
625 "type": "array" | |
626 }, | 831 }, |
627 "format": { | 832 "aliasName": { |
628 "description": "Format template for the message. The `format
` uses placeholders `$0`,\n`$1`, etc. to reference parameters. `$$` can be used
to denote the `$`\ncharacter.\n\nExamples:\n\n* `Failed to load '$0' which hel
ps debug $1 the first time it\n is loaded. Again, $0 is very important.`\n*
`Please pay $$10 to use $0 instead of $1.`", | 833 "description": "The name of an alias (branch, tag, etc.).", |
629 "type": "string" | 834 "type": "string" |
630 } | 835 } |
631 }, | 836 }, |
632 "type": "object" | |
633 }, | |
634 "RegisterDebuggeeResponse": { | |
635 "description": "Response for registering a debuggee.", | |
636 "id": "RegisterDebuggeeResponse", | |
637 "properties": { | |
638 "debuggee": { | |
639 "$ref": "Debuggee", | |
640 "description": "Debuggee resource.\nThe field `id` is gurant
eed to be set (in addition to the echoed fields)." | |
641 } | |
642 }, | |
643 "type": "object" | |
644 }, | |
645 "GetBreakpointResponse": { | |
646 "description": "Response for getting breakpoint information.", | |
647 "id": "GetBreakpointResponse", | |
648 "properties": { | |
649 "breakpoint": { | |
650 "$ref": "Breakpoint", | |
651 "description": "Complete breakpoint state.\nThe fields `id`
and `location` are guaranteed to be set." | |
652 } | |
653 }, | |
654 "type": "object" | |
655 }, | |
656 "AliasContext": { | |
657 "description": "An alias to a repo revision.", | |
658 "id": "AliasContext", | |
659 "properties": { | |
660 "kind": { | |
661 "description": "The alias kind.", | |
662 "enum": [ | |
663 "ANY", | |
664 "FIXED", | |
665 "MOVABLE", | |
666 "OTHER" | |
667 ], | |
668 "enumDescriptions": [ | |
669 "Do not use.", | |
670 "Git tag", | |
671 "Git branch", | |
672 "OTHER is used to specify non-standard aliases, those no
t of the kinds\nabove. For example, if a Git repo has a ref named \"refs/foo/bar
\", it\nis considered to be of kind OTHER." | |
673 ], | |
674 "type": "string" | |
675 }, | |
676 "name": { | |
677 "description": "The alias name.", | |
678 "type": "string" | |
679 } | |
680 }, | |
681 "type": "object" | 837 "type": "object" |
682 }, | 838 }, |
683 "CloudWorkspaceId": { | 839 "CloudWorkspaceId": { |
684 "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.", | 840 "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.", |
685 "id": "CloudWorkspaceId", | 841 "id": "CloudWorkspaceId", |
686 "properties": { | 842 "properties": { |
687 "repoId": { | 843 "repoId": { |
688 "$ref": "RepoId", | 844 "$ref": "RepoId", |
689 "description": "The ID of the repo containing the workspace.
" | 845 "description": "The ID of the repo containing the workspace.
" |
690 }, | 846 }, |
691 "name": { | 847 "name": { |
692 "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.", | 848 "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.", |
693 "type": "string" | 849 "type": "string" |
694 } | 850 } |
695 }, | 851 }, |
696 "type": "object" | 852 "type": "object" |
697 }, | 853 }, |
| 854 "ListBreakpointsResponse": { |
| 855 "description": "Response for listing breakpoints.", |
| 856 "id": "ListBreakpointsResponse", |
| 857 "properties": { |
| 858 "nextWaitToken": { |
| 859 "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.", |
| 860 "type": "string" |
| 861 }, |
| 862 "breakpoints": { |
| 863 "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.", |
| 864 "items": { |
| 865 "$ref": "Breakpoint" |
| 866 }, |
| 867 "type": "array" |
| 868 } |
| 869 }, |
| 870 "type": "object" |
| 871 }, |
698 "Breakpoint": { | 872 "Breakpoint": { |
699 "description": "Represents the breakpoint specification, status and
results.", | 873 "description": "Represents the breakpoint specification, status and
results.", |
700 "id": "Breakpoint", | 874 "id": "Breakpoint", |
701 "properties": { | 875 "properties": { |
702 "id": { | 876 "location": { |
703 "description": "Breakpoint identifier, unique in the scope o
f the debuggee.", | 877 "$ref": "SourceLocation", |
| 878 "description": "Breakpoint source location." |
| 879 }, |
| 880 "finalTime": { |
| 881 "description": "Time this breakpoint was finalized as seen b
y the server in seconds\nresolution.", |
| 882 "format": "google-datetime", |
704 "type": "string" | 883 "type": "string" |
705 }, | 884 }, |
| 885 "variableTable": { |
| 886 "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.", |
| 887 "items": { |
| 888 "$ref": "Variable" |
| 889 }, |
| 890 "type": "array" |
| 891 }, |
| 892 "createTime": { |
| 893 "description": "Time this breakpoint was created by the serv
er in seconds resolution.", |
| 894 "format": "google-datetime", |
| 895 "type": "string" |
| 896 }, |
| 897 "labels": { |
| 898 "additionalProperties": { |
| 899 "type": "string" |
| 900 }, |
| 901 "description": "A set of custom breakpoint properties, popul
ated by the agent, to be\ndisplayed to the user.", |
| 902 "type": "object" |
| 903 }, |
| 904 "logMessageFormat": { |
| 905 "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 ]`.", |
| 906 "type": "string" |
| 907 }, |
| 908 "expressions": { |
| 909 "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.", |
| 910 "items": { |
| 911 "type": "string" |
| 912 }, |
| 913 "type": "array" |
| 914 }, |
| 915 "evaluatedExpressions": { |
| 916 "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.", |
| 917 "items": { |
| 918 "$ref": "Variable" |
| 919 }, |
| 920 "type": "array" |
| 921 }, |
| 922 "isFinalState": { |
| 923 "description": "When true, indicates that this is a final re
sult and the\nbreakpoint state will not change from here on.", |
| 924 "type": "boolean" |
| 925 }, |
706 "stackFrames": { | 926 "stackFrames": { |
707 "description": "The stack at breakpoint time.", | 927 "description": "The stack at breakpoint time.", |
708 "items": { | 928 "items": { |
709 "$ref": "StackFrame" | 929 "$ref": "StackFrame" |
710 }, | 930 }, |
711 "type": "array" | 931 "type": "array" |
712 }, | 932 }, |
713 "location": { | 933 "condition": { |
714 "$ref": "SourceLocation", | 934 "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.", |
715 "description": "Breakpoint source location." | 935 "type": "string" |
716 }, | 936 }, |
717 "status": { | 937 "status": { |
718 "$ref": "StatusMessage", | 938 "$ref": "StatusMessage", |
719 "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" | 939 "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" |
720 }, | 940 }, |
721 "userEmail": { | 941 "userEmail": { |
722 "description": "E-mail address of the user that created this
breakpoint", | 942 "description": "E-mail address of the user that created this
breakpoint", |
723 "type": "string" | 943 "type": "string" |
724 }, | 944 }, |
725 "condition": { | |
726 "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.", | |
727 "type": "string" | |
728 }, | |
729 "finalTime": { | |
730 "description": "Time this breakpoint was finalized as seen b
y the server in seconds\nresolution.", | |
731 "format": "google-datetime", | |
732 "type": "string" | |
733 }, | |
734 "action": { | 945 "action": { |
735 "description": "Action that the agent should perform when th
e code at the\nbreakpoint location is hit.", | 946 "description": "Action that the agent should perform when th
e code at the\nbreakpoint location is hit.", |
736 "enum": [ | 947 "enum": [ |
737 "CAPTURE", | 948 "CAPTURE", |
738 "LOG" | 949 "LOG" |
739 ], | 950 ], |
740 "enumDescriptions": [ | 951 "enumDescriptions": [ |
741 "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.", | 952 "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.", |
742 "Log each breakpoint hit. The breakpoint remains active
until\ndeleted or expired." | 953 "Log each breakpoint hit. The breakpoint remains active
until\ndeleted or expired." |
743 ], | 954 ], |
744 "type": "string" | 955 "type": "string" |
745 }, | 956 }, |
746 "labels": { | |
747 "additionalProperties": { | |
748 "type": "string" | |
749 }, | |
750 "description": "A set of custom breakpoint properties, popul
ated by the agent, to be\ndisplayed to the user.", | |
751 "type": "object" | |
752 }, | |
753 "logMessageFormat": { | |
754 "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 ]`.", | |
755 "type": "string" | |
756 }, | |
757 "createTime": { | |
758 "description": "Time this breakpoint was created by the serv
er in seconds resolution.", | |
759 "format": "google-datetime", | |
760 "type": "string" | |
761 }, | |
762 "logLevel": { | 957 "logLevel": { |
763 "description": "Indicates the severity of the log. Only rele
vant when action is `LOG`.", | 958 "description": "Indicates the severity of the log. Only rele
vant when action is `LOG`.", |
764 "enum": [ | 959 "enum": [ |
765 "INFO", | 960 "INFO", |
766 "WARNING", | 961 "WARNING", |
767 "ERROR" | 962 "ERROR" |
768 ], | 963 ], |
769 "enumDescriptions": [ | 964 "enumDescriptions": [ |
770 "Information log message.", | 965 "Information log message.", |
771 "Warning log message.", | 966 "Warning log message.", |
772 "Error log message." | 967 "Error log message." |
773 ], | 968 ], |
774 "type": "string" | 969 "type": "string" |
775 }, | 970 }, |
776 "evaluatedExpressions": { | 971 "id": { |
777 "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.", | 972 "description": "Breakpoint identifier, unique in the scope o
f the debuggee.", |
778 "items": { | 973 "type": "string" |
779 "$ref": "Variable" | |
780 }, | |
781 "type": "array" | |
782 }, | |
783 "isFinalState": { | |
784 "description": "When true, indicates that this is a final re
sult and the\nbreakpoint state will not change from here on.", | |
785 "type": "boolean" | |
786 }, | |
787 "expressions": { | |
788 "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.", | |
789 "items": { | |
790 "type": "string" | |
791 }, | |
792 "type": "array" | |
793 }, | |
794 "variableTable": { | |
795 "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.", | |
796 "items": { | |
797 "$ref": "Variable" | |
798 }, | |
799 "type": "array" | |
800 } | 974 } |
801 }, | 975 }, |
802 "type": "object" | 976 "type": "object" |
803 }, | 977 }, |
804 "SetBreakpointResponse": { | 978 "SetBreakpointResponse": { |
805 "description": "Response for setting a breakpoint.", | 979 "description": "Response for setting a breakpoint.", |
806 "id": "SetBreakpointResponse", | 980 "id": "SetBreakpointResponse", |
807 "properties": { | 981 "properties": { |
808 "breakpoint": { | 982 "breakpoint": { |
809 "$ref": "Breakpoint", | 983 "$ref": "Breakpoint", |
810 "description": "Breakpoint resource.\nThe field `id` is guar
anteed to be set (in addition to the echoed fileds)." | 984 "description": "Breakpoint resource.\nThe field `id` is guar
anteed to be set (in addition to the echoed fileds)." |
811 } | 985 } |
812 }, | 986 }, |
813 "type": "object" | 987 "type": "object" |
814 }, | 988 }, |
815 "ListActiveBreakpointsResponse": { | |
816 "description": "Response for listing active breakpoints.", | |
817 "id": "ListActiveBreakpointsResponse", | |
818 "properties": { | |
819 "waitExpired": { | |
820 "description": "The `wait_expired` field is set to true by t
he server when the\nrequest times out and the field `success_on_timeout` is set
to true.", | |
821 "type": "boolean" | |
822 }, | |
823 "breakpoints": { | |
824 "description": "List of all active breakpoints.\nThe fields
`id` and `location` are guaranteed to be set on each breakpoint.", | |
825 "items": { | |
826 "$ref": "Breakpoint" | |
827 }, | |
828 "type": "array" | |
829 }, | |
830 "nextWaitToken": { | |
831 "description": "A wait token that can be used in the next me
thod call to block until\nthe list of breakpoints changes.", | |
832 "type": "string" | |
833 } | |
834 }, | |
835 "type": "object" | |
836 }, | |
837 "ExtendedSourceContext": { | |
838 "description": "An ExtendedSourceContext is a SourceContext combined
with additional\ndetails describing the context.", | |
839 "id": "ExtendedSourceContext", | |
840 "properties": { | |
841 "labels": { | |
842 "additionalProperties": { | |
843 "type": "string" | |
844 }, | |
845 "description": "Labels with user defined metadata.", | |
846 "type": "object" | |
847 }, | |
848 "context": { | |
849 "$ref": "SourceContext", | |
850 "description": "Any source context." | |
851 } | |
852 }, | |
853 "type": "object" | |
854 }, | |
855 "RegisterDebuggeeRequest": { | |
856 "description": "Request to register a debuggee.", | |
857 "id": "RegisterDebuggeeRequest", | |
858 "properties": { | |
859 "debuggee": { | |
860 "$ref": "Debuggee", | |
861 "description": "Debuggee information to register.\nThe field
s `project`, `uniquifier`, `description` and `agent_version`\nof the debuggee mu
st be set." | |
862 } | |
863 }, | |
864 "type": "object" | |
865 }, | |
866 "RepoId": { | |
867 "description": "A unique identifier for a cloud repo.", | |
868 "id": "RepoId", | |
869 "properties": { | |
870 "projectRepoId": { | |
871 "$ref": "ProjectRepoId", | |
872 "description": "A combination of a project ID and a repo nam
e." | |
873 }, | |
874 "uid": { | |
875 "description": "A server-assigned, globally unique identifie
r.", | |
876 "type": "string" | |
877 } | |
878 }, | |
879 "type": "object" | |
880 }, | |
881 "ProjectRepoId": { | |
882 "description": "Selects a repo using a Google Cloud Platform project
ID\n(e.g. winged-cargo-31) and a repo name within that project.", | |
883 "id": "ProjectRepoId", | |
884 "properties": { | |
885 "repoName": { | |
886 "description": "The name of the repo. Leave empty for the de
fault repo.", | |
887 "type": "string" | |
888 }, | |
889 "projectId": { | |
890 "description": "The ID of the project.", | |
891 "type": "string" | |
892 } | |
893 }, | |
894 "type": "object" | |
895 }, | |
896 "CloudWorkspaceSourceContext": { | |
897 "description": "A CloudWorkspaceSourceContext denotes a workspace at
a particular snapshot.", | |
898 "id": "CloudWorkspaceSourceContext", | |
899 "properties": { | |
900 "snapshotId": { | |
901 "description": "The ID of the snapshot.\nAn empty snapshot_i
d refers to the most recent snapshot.", | |
902 "type": "string" | |
903 }, | |
904 "workspaceId": { | |
905 "$ref": "CloudWorkspaceId", | |
906 "description": "The ID of the workspace." | |
907 } | |
908 }, | |
909 "type": "object" | |
910 }, | |
911 "ListDebuggeesResponse": { | |
912 "description": "Response for listing debuggees.", | |
913 "id": "ListDebuggeesResponse", | |
914 "properties": { | |
915 "debuggees": { | |
916 "description": "List of debuggees accessible to the calling
user.\nNote that the `description` field is the only human readable field\nthat
should be displayed to the user.\nThe fields `debuggee.id` and `description` fi
elds are guaranteed to be\nset on each debuggee.", | |
917 "items": { | |
918 "$ref": "Debuggee" | |
919 }, | |
920 "type": "array" | |
921 } | |
922 }, | |
923 "type": "object" | |
924 }, | |
925 "CloudRepoSourceContext": { | |
926 "description": "A CloudRepoSourceContext denotes a particular revisi
on in a cloud\nrepo (a repo hosted by the Google Cloud Platform).", | |
927 "id": "CloudRepoSourceContext", | |
928 "properties": { | |
929 "aliasName": { | |
930 "description": "The name of an alias (branch, tag, etc.).", | |
931 "type": "string" | |
932 }, | |
933 "aliasContext": { | |
934 "$ref": "AliasContext", | |
935 "description": "An alias, which may be a branch or tag." | |
936 }, | |
937 "repoId": { | |
938 "$ref": "RepoId", | |
939 "description": "The ID of the repo." | |
940 }, | |
941 "revisionId": { | |
942 "description": "A revision ID.", | |
943 "type": "string" | |
944 } | |
945 }, | |
946 "type": "object" | |
947 }, | |
948 "UpdateActiveBreakpointRequest": { | 989 "UpdateActiveBreakpointRequest": { |
949 "description": "Request to update an active breakpoint.", | 990 "description": "Request to update an active breakpoint.", |
950 "id": "UpdateActiveBreakpointRequest", | 991 "id": "UpdateActiveBreakpointRequest", |
951 "properties": { | 992 "properties": { |
952 "breakpoint": { | 993 "breakpoint": { |
953 "$ref": "Breakpoint", | 994 "$ref": "Breakpoint", |
954 "description": "Updated breakpoint information.\nThe field '
id' must be set." | 995 "description": "Updated breakpoint information.\nThe field '
id' must be set." |
955 } | 996 } |
956 }, | 997 }, |
957 "type": "object" | 998 "type": "object" |
958 }, | 999 }, |
959 "SourceContext": { | 1000 "SourceContext": { |
960 "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.", | 1001 "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.", |
961 "id": "SourceContext", | 1002 "id": "SourceContext", |
962 "properties": { | 1003 "properties": { |
| 1004 "gerrit": { |
| 1005 "$ref": "GerritSourceContext", |
| 1006 "description": "A SourceContext referring to a Gerrit projec
t." |
| 1007 }, |
963 "cloudRepo": { | 1008 "cloudRepo": { |
964 "$ref": "CloudRepoSourceContext", | 1009 "$ref": "CloudRepoSourceContext", |
965 "description": "A SourceContext referring to a revision in a
cloud repo." | 1010 "description": "A SourceContext referring to a revision in a
cloud repo." |
966 }, | 1011 }, |
967 "cloudWorkspace": { | 1012 "cloudWorkspace": { |
968 "$ref": "CloudWorkspaceSourceContext", | 1013 "$ref": "CloudWorkspaceSourceContext", |
969 "description": "A SourceContext referring to a snapshot in a
cloud workspace." | 1014 "description": "A SourceContext referring to a snapshot in a
cloud workspace." |
970 }, | 1015 }, |
971 "git": { | 1016 "git": { |
972 "$ref": "GitSourceContext", | 1017 "$ref": "GitSourceContext", |
973 "description": "A SourceContext referring to any third party
Git repo (e.g. GitHub)." | 1018 "description": "A SourceContext referring to any third party
Git repo (e.g. GitHub)." |
974 }, | |
975 "gerrit": { | |
976 "$ref": "GerritSourceContext", | |
977 "description": "A SourceContext referring to a Gerrit projec
t." | |
978 } | 1019 } |
979 }, | 1020 }, |
980 "type": "object" | 1021 "type": "object" |
981 }, | 1022 }, |
982 "Empty": { | 1023 "CloudRepoSourceContext": { |
983 "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 `{}`.", | 1024 "description": "A CloudRepoSourceContext denotes a particular revisi
on in a cloud\nrepo (a repo hosted by the Google Cloud Platform).", |
984 "id": "Empty", | 1025 "id": "CloudRepoSourceContext", |
985 "properties": {}, | |
986 "type": "object" | |
987 }, | |
988 "GitSourceContext": { | |
989 "description": "A GitSourceContext denotes a particular revision in
a third party Git\nrepository (e.g. GitHub).", | |
990 "id": "GitSourceContext", | |
991 "properties": { | 1026 "properties": { |
992 "url": { | 1027 "repoId": { |
993 "description": "Git repository URL.", | 1028 "$ref": "RepoId", |
| 1029 "description": "The ID of the repo." |
| 1030 }, |
| 1031 "aliasContext": { |
| 1032 "$ref": "AliasContext", |
| 1033 "description": "An alias, which may be a branch or tag." |
| 1034 }, |
| 1035 "revisionId": { |
| 1036 "description": "A revision ID.", |
994 "type": "string" | 1037 "type": "string" |
995 }, | 1038 }, |
996 "revisionId": { | 1039 "aliasName": { |
997 "description": "Git commit hash.\nrequired.", | 1040 "description": "The name of an alias (branch, tag, etc.).", |
998 "type": "string" | 1041 "type": "string" |
999 } | 1042 } |
1000 }, | 1043 }, |
1001 "type": "object" | 1044 "type": "object" |
1002 }, | |
1003 "StatusMessage": { | |
1004 "description": "Represents a contextual status message.\nThe message
can indicate an error or informational status, and refer to\nspecific parts of
the containing object.\nFor example, the `Breakpoint.status` field can indicate
an error referring\nto the `BREAKPOINT_SOURCE_LOCATION` with the message `Locati
on not found`.", | |
1005 "id": "StatusMessage", | |
1006 "properties": { | |
1007 "isError": { | |
1008 "description": "Distinguishes errors from informational mess
ages.", | |
1009 "type": "boolean" | |
1010 }, | |
1011 "description": { | |
1012 "$ref": "FormatMessage", | |
1013 "description": "Status message text." | |
1014 }, | |
1015 "refersTo": { | |
1016 "description": "Reference to which the message applies.", | |
1017 "enum": [ | |
1018 "UNSPECIFIED", | |
1019 "BREAKPOINT_SOURCE_LOCATION", | |
1020 "BREAKPOINT_CONDITION", | |
1021 "BREAKPOINT_EXPRESSION", | |
1022 "BREAKPOINT_AGE", | |
1023 "VARIABLE_NAME", | |
1024 "VARIABLE_VALUE" | |
1025 ], | |
1026 "enumDescriptions": [ | |
1027 "Status doesn't refer to any particular input.", | |
1028 "Status applies to the breakpoint and is related to its
location.", | |
1029 "Status applies to the breakpoint and is related to its
condition.", | |
1030 "Status applies to the breakpoint and is related to its
expressions.", | |
1031 "Status applies to the breakpoint and is related to its
age.", | |
1032 "Status applies to the entire variable.", | |
1033 "Status applies to variable value (variable name is vali
d)." | |
1034 ], | |
1035 "type": "string" | |
1036 } | |
1037 }, | |
1038 "type": "object" | |
1039 }, | |
1040 "UpdateActiveBreakpointResponse": { | |
1041 "description": "Response for updating an active breakpoint.\nThe mes
sage is defined to allow future extensions.", | |
1042 "id": "UpdateActiveBreakpointResponse", | |
1043 "properties": {}, | |
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 |