OLD | NEW |
1 { | 1 { |
2 "auth": { | 2 "auth": { |
3 "oauth2": { | 3 "oauth2": { |
4 "scopes": { | 4 "scopes": { |
5 "https://www.googleapis.com/auth/cloud_debugger": { | 5 "https://www.googleapis.com/auth/cloud_debugger": { |
6 "description": "Manage cloud debugger" | 6 "description": "Manage cloud debugger" |
7 }, | 7 }, |
8 "https://www.googleapis.com/auth/cloud-platform": { | 8 "https://www.googleapis.com/auth/cloud-platform": { |
9 "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" |
10 } | 10 } |
(...skipping 21 matching lines...) Expand all Loading... |
32 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", | 32 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", |
33 "location": "query", | 33 "location": "query", |
34 "type": "string" | 34 "type": "string" |
35 }, | 35 }, |
36 "prettyPrint": { | 36 "prettyPrint": { |
37 "default": "true", | 37 "default": "true", |
38 "description": "Returns response with indentations and line breaks."
, | 38 "description": "Returns response with indentations and line breaks."
, |
39 "location": "query", | 39 "location": "query", |
40 "type": "boolean" | 40 "type": "boolean" |
41 }, | 41 }, |
| 42 "fields": { |
| 43 "description": "Selector specifying which fields to include in a par
tial response.", |
| 44 "location": "query", |
| 45 "type": "string" |
| 46 }, |
42 "uploadType": { | 47 "uploadType": { |
43 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", | 48 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", |
44 "location": "query", | 49 "location": "query", |
45 "type": "string" | 50 "type": "string" |
46 }, | 51 }, |
47 "fields": { | 52 "callback": { |
48 "description": "Selector specifying which fields to include in a par
tial response.", | 53 "description": "JSONP", |
49 "location": "query", | 54 "location": "query", |
50 "type": "string" | 55 "type": "string" |
51 }, | 56 }, |
52 "$.xgafv": { | 57 "$.xgafv": { |
53 "description": "V1 error format.", | 58 "description": "V1 error format.", |
54 "enum": [ | 59 "enum": [ |
55 "1", | 60 "1", |
56 "2" | 61 "2" |
57 ], | 62 ], |
58 "enumDescriptions": [ | 63 "enumDescriptions": [ |
59 "v1 error format", | 64 "v1 error format", |
60 "v2 error format" | 65 "v2 error format" |
61 ], | 66 ], |
62 "location": "query", | 67 "location": "query", |
63 "type": "string" | 68 "type": "string" |
64 }, | 69 }, |
65 "callback": { | |
66 "description": "JSONP", | |
67 "location": "query", | |
68 "type": "string" | |
69 }, | |
70 "alt": { | 70 "alt": { |
71 "default": "json", | 71 "default": "json", |
72 "description": "Data format for response.", | 72 "description": "Data format for response.", |
73 "enum": [ | 73 "enum": [ |
74 "json", | 74 "json", |
75 "media", | 75 "media", |
76 "proto" | 76 "proto" |
77 ], | 77 ], |
78 "enumDescriptions": [ | 78 "enumDescriptions": [ |
79 "Responses with Content-Type of application/json", | 79 "Responses with Content-Type of application/json", |
(...skipping 17 matching lines...) Expand all Loading... |
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.", | 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.", |
98 "location": "query", | 98 "location": "query", |
99 "type": "string" | 99 "type": "string" |
100 }, | 100 }, |
101 "pp": { | 101 "pp": { |
102 "default": "true", | 102 "default": "true", |
103 "description": "Pretty-print response.", | 103 "description": "Pretty-print response.", |
104 "location": "query", | 104 "location": "query", |
105 "type": "boolean" | 105 "type": "boolean" |
106 }, | 106 }, |
| 107 "oauth_token": { |
| 108 "description": "OAuth 2.0 token for the current user.", |
| 109 "location": "query", |
| 110 "type": "string" |
| 111 }, |
107 "bearer_token": { | 112 "bearer_token": { |
108 "description": "OAuth bearer token.", | 113 "description": "OAuth bearer token.", |
109 "location": "query", | 114 "location": "query", |
110 "type": "string" | 115 "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 has access 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.\nSchema: `domain/type/version` (e.g., `google.com/intellij/v1`).", |
| 132 "location": "query", |
| 133 "type": "string" |
| 134 }, |
130 "includeInactive": { | 135 "includeInactive": { |
131 "description": "When set to `true`, the resu
lt includes all debuggees. Otherwise, the\nresult includes only debuggees that a
re active.", | 136 "description": "When set to `true`, the resu
lt includes all debuggees. Otherwise, the\nresult includes only debuggees that a
re active.", |
132 "location": "query", | 137 "location": "query", |
133 "type": "boolean" | 138 "type": "boolean" |
134 }, | 139 }, |
135 "project": { | 140 "project": { |
136 "description": "Project number of a Google C
loud project whose debuggees to list.", | 141 "description": "Project number of a Google C
loud project whose debuggees to list.", |
137 "location": "query", | 142 "location": "query", |
138 "type": "string" | 143 "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 ] |
154 } | 154 } |
155 }, | 155 }, |
156 "resources": { | 156 "resources": { |
157 "breakpoints": { | 157 "breakpoints": { |
158 "methods": { | 158 "methods": { |
159 "delete": { | |
160 "description": "Deletes the breakpoint from
the debuggee.", | |
161 "httpMethod": "DELETE", | |
162 "id": "clouddebugger.debugger.debuggees.brea
kpoints.delete", | |
163 "parameterOrder": [ | |
164 "debuggeeId", | |
165 "breakpointId" | |
166 ], | |
167 "parameters": { | |
168 "breakpointId": { | |
169 "description": "ID of the breakpoint
to delete.", | |
170 "location": "path", | |
171 "required": true, | |
172 "type": "string" | |
173 }, | |
174 "debuggeeId": { | |
175 "description": "ID of the debuggee w
hose breakpoint to delete.", | |
176 "location": "path", | |
177 "required": true, | |
178 "type": "string" | |
179 }, | |
180 "clientVersion": { | |
181 "description": "The client version m
aking the call.\nFollowing: `domain/type/version` (e.g., `google.com/intellij/v1
`).", | |
182 "location": "query", | |
183 "type": "string" | |
184 } | |
185 }, | |
186 "path": "v2/debugger/debuggees/{debuggeeId}/
breakpoints/{breakpointId}", | |
187 "response": { | |
188 "$ref": "Empty" | |
189 }, | |
190 "scopes": [ | |
191 "https://www.googleapis.com/auth/cloud-p
latform", | |
192 "https://www.googleapis.com/auth/cloud_d
ebugger" | |
193 ] | |
194 }, | |
195 "set": { | |
196 "description": "Sets the breakpoint to the d
ebuggee.", | |
197 "httpMethod": "POST", | |
198 "id": "clouddebugger.debugger.debuggees.brea
kpoints.set", | |
199 "parameterOrder": [ | |
200 "debuggeeId" | |
201 ], | |
202 "parameters": { | |
203 "clientVersion": { | |
204 "description": "The client version m
aking the call.\nFollowing: `domain/type/version` (e.g., `google.com/intellij/v1
`).", | |
205 "location": "query", | |
206 "type": "string" | |
207 }, | |
208 "debuggeeId": { | |
209 "description": "ID of the debuggee w
here the breakpoint is to be set.", | |
210 "location": "path", | |
211 "required": true, | |
212 "type": "string" | |
213 } | |
214 }, | |
215 "path": "v2/debugger/debuggees/{debuggeeId}/
breakpoints/set", | |
216 "request": { | |
217 "$ref": "Breakpoint" | |
218 }, | |
219 "response": { | |
220 "$ref": "SetBreakpointResponse" | |
221 }, | |
222 "scopes": [ | |
223 "https://www.googleapis.com/auth/cloud-p
latform", | |
224 "https://www.googleapis.com/auth/cloud_d
ebugger" | |
225 ] | |
226 }, | |
227 "list": { | 159 "list": { |
228 "description": "Lists all breakpoints for th
e debuggee.", | 160 "description": "Lists all breakpoints for th
e debuggee.", |
229 "httpMethod": "GET", | 161 "httpMethod": "GET", |
230 "id": "clouddebugger.debugger.debuggees.brea
kpoints.list", | 162 "id": "clouddebugger.debugger.debuggees.brea
kpoints.list", |
231 "parameterOrder": [ | 163 "parameterOrder": [ |
232 "debuggeeId" | 164 "debuggeeId" |
233 ], | 165 ], |
234 "parameters": { | 166 "parameters": { |
| 167 "stripResults": { |
| 168 "description": "This field is deprec
ated. The following fields are always stripped out of\nthe result: `stack_frames
`, `evaluated_expressions` and `variable_table`.", |
| 169 "location": "query", |
| 170 "type": "boolean" |
| 171 }, |
235 "debuggeeId": { | 172 "debuggeeId": { |
236 "description": "ID of the debuggee w
hose breakpoints to list.", | 173 "description": "ID of the debuggee w
hose breakpoints to list.", |
237 "location": "path", | 174 "location": "path", |
238 "required": true, | 175 "required": true, |
239 "type": "string" | 176 "type": "string" |
240 }, | 177 }, |
241 "waitToken": { | 178 "waitToken": { |
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`.", | 179 "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`.", |
243 "location": "query", | 180 "location": "query", |
244 "type": "string" | 181 "type": "string" |
245 }, | 182 }, |
246 "clientVersion": { | 183 "clientVersion": { |
247 "description": "The client version m
aking the call.\nFollowing: `domain/type/version` (e.g., `google.com/intellij/v1
`).", | 184 "description": "The client version m
aking the call.\nSchema: `domain/type/version` (e.g., `google.com/intellij/v1`).
", |
248 "location": "query", | 185 "location": "query", |
249 "type": "string" | 186 "type": "string" |
250 }, | 187 }, |
251 "action.value": { | 188 "action.value": { |
252 "description": "Only breakpoints wit
h the specified action will pass the filter.", | 189 "description": "Only breakpoints wit
h the specified action will pass the filter.", |
253 "enum": [ | 190 "enum": [ |
254 "CAPTURE", | 191 "CAPTURE", |
255 "LOG" | 192 "LOG" |
256 ], | 193 ], |
257 "location": "query", | 194 "location": "query", |
258 "type": "string" | 195 "type": "string" |
259 }, | 196 }, |
260 "includeInactive": { | 197 "includeInactive": { |
261 "description": "When set to `true`,
the response includes active and inactive\nbreakpoints. Otherwise, it includes o
nly active breakpoints.", | 198 "description": "When set to `true`,
the response includes active and inactive\nbreakpoints. Otherwise, it includes o
nly active breakpoints.", |
262 "location": "query", | 199 "location": "query", |
263 "type": "boolean" | 200 "type": "boolean" |
264 }, | 201 }, |
265 "includeAllUsers": { | 202 "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.", | 203 "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", | 204 "location": "query", |
268 "type": "boolean" | 205 "type": "boolean" |
269 }, | |
270 "stripResults": { | |
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", | |
273 "type": "boolean" | |
274 } | 206 } |
275 }, | 207 }, |
276 "path": "v2/debugger/debuggees/{debuggeeId}/
breakpoints", | 208 "path": "v2/debugger/debuggees/{debuggeeId}/
breakpoints", |
277 "response": { | 209 "response": { |
278 "$ref": "ListBreakpointsResponse" | 210 "$ref": "ListBreakpointsResponse" |
279 }, | 211 }, |
280 "scopes": [ | 212 "scopes": [ |
281 "https://www.googleapis.com/auth/cloud-p
latform", | 213 "https://www.googleapis.com/auth/cloud-p
latform", |
282 "https://www.googleapis.com/auth/cloud_d
ebugger" | 214 "https://www.googleapis.com/auth/cloud_d
ebugger" |
283 ] | 215 ] |
284 }, | 216 }, |
285 "get": { | 217 "get": { |
286 "description": "Gets breakpoint information.
", | 218 "description": "Gets breakpoint information.
", |
287 "httpMethod": "GET", | 219 "httpMethod": "GET", |
288 "id": "clouddebugger.debugger.debuggees.brea
kpoints.get", | 220 "id": "clouddebugger.debugger.debuggees.brea
kpoints.get", |
289 "parameterOrder": [ | 221 "parameterOrder": [ |
290 "debuggeeId", | 222 "debuggeeId", |
291 "breakpointId" | 223 "breakpointId" |
292 ], | 224 ], |
293 "parameters": { | 225 "parameters": { |
294 "breakpointId": { | |
295 "description": "ID of the breakpoint
to get.", | |
296 "location": "path", | |
297 "required": true, | |
298 "type": "string" | |
299 }, | |
300 "debuggeeId": { | 226 "debuggeeId": { |
301 "description": "ID of the debuggee w
hose breakpoint to get.", | 227 "description": "ID of the debuggee w
hose breakpoint to get.", |
302 "location": "path", | 228 "location": "path", |
303 "required": true, | 229 "required": true, |
304 "type": "string" | 230 "type": "string" |
305 }, | 231 }, |
306 "clientVersion": { | 232 "clientVersion": { |
307 "description": "The client version m
aking the call.\nFollowing: `domain/type/version` (e.g., `google.com/intellij/v1
`).", | 233 "description": "The client version m
aking the call.\nSchema: `domain/type/version` (e.g., `google.com/intellij/v1`).
", |
308 "location": "query", | 234 "location": "query", |
309 "type": "string" | 235 "type": "string" |
| 236 }, |
| 237 "breakpointId": { |
| 238 "description": "ID of the breakpoint
to get.", |
| 239 "location": "path", |
| 240 "required": true, |
| 241 "type": "string" |
310 } | 242 } |
311 }, | 243 }, |
312 "path": "v2/debugger/debuggees/{debuggeeId}/
breakpoints/{breakpointId}", | 244 "path": "v2/debugger/debuggees/{debuggeeId}/
breakpoints/{breakpointId}", |
313 "response": { | 245 "response": { |
314 "$ref": "GetBreakpointResponse" | 246 "$ref": "GetBreakpointResponse" |
315 }, | 247 }, |
316 "scopes": [ | 248 "scopes": [ |
317 "https://www.googleapis.com/auth/cloud-p
latform", | 249 "https://www.googleapis.com/auth/cloud-p
latform", |
| 250 "https://www.googleapis.com/auth/cloud_d
ebugger" |
| 251 ] |
| 252 }, |
| 253 "delete": { |
| 254 "description": "Deletes the breakpoint from
the debuggee.", |
| 255 "httpMethod": "DELETE", |
| 256 "id": "clouddebugger.debugger.debuggees.brea
kpoints.delete", |
| 257 "parameterOrder": [ |
| 258 "debuggeeId", |
| 259 "breakpointId" |
| 260 ], |
| 261 "parameters": { |
| 262 "clientVersion": { |
| 263 "description": "The client version m
aking the call.\nSchema: `domain/type/version` (e.g., `google.com/intellij/v1`).
", |
| 264 "location": "query", |
| 265 "type": "string" |
| 266 }, |
| 267 "breakpointId": { |
| 268 "description": "ID of the breakpoint
to delete.", |
| 269 "location": "path", |
| 270 "required": true, |
| 271 "type": "string" |
| 272 }, |
| 273 "debuggeeId": { |
| 274 "description": "ID of the debuggee w
hose breakpoint to delete.", |
| 275 "location": "path", |
| 276 "required": true, |
| 277 "type": "string" |
| 278 } |
| 279 }, |
| 280 "path": "v2/debugger/debuggees/{debuggeeId}/
breakpoints/{breakpointId}", |
| 281 "response": { |
| 282 "$ref": "Empty" |
| 283 }, |
| 284 "scopes": [ |
| 285 "https://www.googleapis.com/auth/cloud-p
latform", |
| 286 "https://www.googleapis.com/auth/cloud_d
ebugger" |
| 287 ] |
| 288 }, |
| 289 "set": { |
| 290 "description": "Sets the breakpoint to the d
ebuggee.", |
| 291 "httpMethod": "POST", |
| 292 "id": "clouddebugger.debugger.debuggees.brea
kpoints.set", |
| 293 "parameterOrder": [ |
| 294 "debuggeeId" |
| 295 ], |
| 296 "parameters": { |
| 297 "clientVersion": { |
| 298 "description": "The client version m
aking the call.\nSchema: `domain/type/version` (e.g., `google.com/intellij/v1`).
", |
| 299 "location": "query", |
| 300 "type": "string" |
| 301 }, |
| 302 "debuggeeId": { |
| 303 "description": "ID of the debuggee w
here the breakpoint is to be set.", |
| 304 "location": "path", |
| 305 "required": true, |
| 306 "type": "string" |
| 307 } |
| 308 }, |
| 309 "path": "v2/debugger/debuggees/{debuggeeId}/
breakpoints/set", |
| 310 "request": { |
| 311 "$ref": "Breakpoint" |
| 312 }, |
| 313 "response": { |
| 314 "$ref": "SetBreakpointResponse" |
| 315 }, |
| 316 "scopes": [ |
| 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 ] |
320 } | 320 } |
321 } | 321 } |
322 } | 322 } |
323 } | 323 } |
324 } | 324 } |
325 } | 325 } |
326 }, | 326 }, |
327 "controller": { | 327 "controller": { |
328 "resources": { | 328 "resources": { |
329 "debuggees": { | 329 "debuggees": { |
330 "methods": { | 330 "methods": { |
331 "register": { | 331 "register": { |
332 "description": "Registers the debuggee with the cont
roller service.\n\nAll agents attached to the same application should call this
method with\nthe same request content to get back the same stable `debuggee_id`.
Agents\nshould call this method again whenever `google.rpc.Code.NOT_FOUND` is\n
returned from any controller method.\n\nThis allows the controller service to di
sable the agent or recover from any\ndata loss. If the debuggee is disabled by t
he server, the response will\nhave `is_disabled` set to `true`.", | 332 "description": "Registers the debuggee with the cont
roller service.\n\nAll agents attached to the same application must call this me
thod with\nexactly the same request content to get back the same stable `debugge
e_id`.\nAgents should call this method again whenever `google.rpc.Code.NOT_FOUND
`\nis returned from any controller method.\n\nThis protocol allows the controlle
r service to disable debuggees, recover\nfrom data loss, or change the `debuggee
_id` format. Agents must handle\n`debuggee_id` value changing upon re-registrati
on.", |
333 "httpMethod": "POST", | 333 "httpMethod": "POST", |
334 "id": "clouddebugger.controller.debuggees.register", | 334 "id": "clouddebugger.controller.debuggees.register", |
335 "parameterOrder": [], | 335 "parameterOrder": [], |
336 "parameters": {}, | 336 "parameters": {}, |
337 "path": "v2/controller/debuggees/register", | 337 "path": "v2/controller/debuggees/register", |
338 "request": { | 338 "request": { |
339 "$ref": "RegisterDebuggeeRequest" | 339 "$ref": "RegisterDebuggeeRequest" |
340 }, | 340 }, |
341 "response": { | 341 "response": { |
342 "$ref": "RegisterDebuggeeResponse" | 342 "$ref": "RegisterDebuggeeResponse" |
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 "list": { | 353 "list": { |
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.", | 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.", |
355 "httpMethod": "GET", | 355 "httpMethod": "GET", |
356 "id": "clouddebugger.controller.debuggees.br
eakpoints.list", | 356 "id": "clouddebugger.controller.debuggees.br
eakpoints.list", |
357 "parameterOrder": [ | 357 "parameterOrder": [ |
358 "debuggeeId" | 358 "debuggeeId" |
359 ], | 359 ], |
360 "parameters": { | 360 "parameters": { |
361 "successOnTimeout": { | 361 "successOnTimeout": { |
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).", | 362 "description": "If set to `true` (re
commended), returns `google.rpc.Code.OK` status and\nsets the `wait_expired` res
ponse field to `true` when the server-selected\ntimeout has expired.\n\nIf set t
o `false` (deprecated), returns `google.rpc.Code.ABORTED` status\nwhen the serve
r-selected timeout has expired.", |
363 "location": "query", | 363 "location": "query", |
364 "type": "boolean" | 364 "type": "boolean" |
365 }, | 365 }, |
366 "debuggeeId": { | 366 "debuggeeId": { |
367 "description": "Identifies the debug
gee.", | 367 "description": "Identifies the debug
gee.", |
368 "location": "path", | 368 "location": "path", |
369 "required": true, | 369 "required": true, |
370 "type": "string" | 370 "type": "string" |
371 }, | 371 }, |
372 "waitToken": { | 372 "waitToken": { |
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.", | 373 "description": "A token that, if spe
cified, blocks the method call until the list\nof active breakpoints has changed
, or a server-selected timeout has\nexpired. The value should be set from the `n
ext_wait_token` field in\nthe last response. The initial value should be set to
`\"init\"`.", |
374 "location": "query", | 374 "location": "query", |
375 "type": "string" | 375 "type": "string" |
376 } | 376 } |
377 }, | 377 }, |
378 "path": "v2/controller/debuggees/{debuggeeId
}/breakpoints", | 378 "path": "v2/controller/debuggees/{debuggeeId
}/breakpoints", |
379 "response": { | 379 "response": { |
380 "$ref": "ListActiveBreakpointsResponse" | 380 "$ref": "ListActiveBreakpointsResponse" |
381 }, | 381 }, |
382 "scopes": [ | 382 "scopes": [ |
383 "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" | 384 "https://www.googleapis.com/auth/cloud_d
ebugger" |
385 ] | 385 ] |
386 }, | 386 }, |
387 "update": { | 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.", | 388 "description": "Updates the breakpoint state
or mutable fields.\nThe entire Breakpoint message must be sent back to the cont
roller service.\n\nUpdates to active breakpoint fields are only allowed if the n
ew value\ndoes not change the breakpoint specification. Updates to the `location
`,\n`condition` and `expressions` 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.", |
389 "httpMethod": "PUT", | 389 "httpMethod": "PUT", |
390 "id": "clouddebugger.controller.debuggees.br
eakpoints.update", | 390 "id": "clouddebugger.controller.debuggees.br
eakpoints.update", |
391 "parameterOrder": [ | 391 "parameterOrder": [ |
392 "debuggeeId", | 392 "debuggeeId", |
393 "id" | 393 "id" |
394 ], | 394 ], |
395 "parameters": { | 395 "parameters": { |
| 396 "debuggeeId": { |
| 397 "description": "Identifies the debug
gee being debugged.", |
| 398 "location": "path", |
| 399 "required": true, |
| 400 "type": "string" |
| 401 }, |
396 "id": { | 402 "id": { |
397 "description": "Breakpoint identifie
r, unique in the scope of the debuggee.", | 403 "description": "Breakpoint identifie
r, unique in the scope of the debuggee.", |
398 "location": "path", | 404 "location": "path", |
399 "required": true, | 405 "required": true, |
400 "type": "string" | 406 "type": "string" |
401 }, | |
402 "debuggeeId": { | |
403 "description": "Identifies the debug
gee being debugged.", | |
404 "location": "path", | |
405 "required": true, | |
406 "type": "string" | |
407 } | 407 } |
408 }, | 408 }, |
409 "path": "v2/controller/debuggees/{debuggeeId
}/breakpoints/{id}", | 409 "path": "v2/controller/debuggees/{debuggeeId
}/breakpoints/{id}", |
410 "request": { | 410 "request": { |
411 "$ref": "UpdateActiveBreakpointRequest" | 411 "$ref": "UpdateActiveBreakpointRequest" |
412 }, | 412 }, |
413 "response": { | 413 "response": { |
414 "$ref": "UpdateActiveBreakpointResponse" | 414 "$ref": "UpdateActiveBreakpointResponse" |
415 }, | 415 }, |
416 "scopes": [ | 416 "scopes": [ |
417 "https://www.googleapis.com/auth/cloud-p
latform", | 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": "20170710", | 428 "revision": "20170817", |
429 "rootUrl": "https://clouddebugger.googleapis.com/", | 429 "rootUrl": "https://clouddebugger.googleapis.com/", |
430 "schemas": { | 430 "schemas": { |
| 431 "SourceLocation": { |
| 432 "description": "Represents a location in the source code.", |
| 433 "id": "SourceLocation", |
| 434 "properties": { |
| 435 "path": { |
| 436 "description": "Path to the source file within the source co
ntext of the target binary.", |
| 437 "type": "string" |
| 438 }, |
| 439 "line": { |
| 440 "description": "Line inside the file. The first line in the
file has the value `1`.", |
| 441 "format": "int32", |
| 442 "type": "integer" |
| 443 } |
| 444 }, |
| 445 "type": "object" |
| 446 }, |
| 447 "Debuggee": { |
| 448 "description": "Represents the debugged application. 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.\nAgents attached to the same debuggee identify themselves as such by us
ing\nexactly the same Debuggee message value when registering.", |
| 449 "id": "Debuggee", |
| 450 "properties": { |
| 451 "id": { |
| 452 "description": "Unique identifier for the debuggee generated
by the controller service.", |
| 453 "type": "string" |
| 454 }, |
| 455 "agentVersion": { |
| 456 "description": "Version ID of the agent.\nSchema: `domain/la
nguage-platform/vmajor.minor` (for example\n`google.com/java-gcp/v1.1`).", |
| 457 "type": "string" |
| 458 }, |
| 459 "isDisabled": { |
| 460 "description": "If set to `true`, indicates that the agent s
hould disable itself and\ndetach from the debuggee.", |
| 461 "type": "boolean" |
| 462 }, |
| 463 "uniquifier": { |
| 464 "description": "Uniquifier to further distiguish the applica
tion.\nIt is possible that different applications might have identical values in
\nthe debuggee message, thus, incorrectly identified as a single application\nby
the Controller service. This field adds salt to further distiguish the\napplica
tion. Agents should consider seeding this field with value that\nidentifies the
code, binary, configuration and environment.", |
| 465 "type": "string" |
| 466 }, |
| 467 "description": { |
| 468 "description": "Human readable description of the debuggee.\
nIncluding a human-readable project name, environment name and version\ninformat
ion is recommended.", |
| 469 "type": "string" |
| 470 }, |
| 471 "sourceContexts": { |
| 472 "description": "References to the locations and revisions of
the source code used in the\ndeployed application.", |
| 473 "items": { |
| 474 "$ref": "SourceContext" |
| 475 }, |
| 476 "type": "array" |
| 477 }, |
| 478 "extSourceContexts": { |
| 479 "description": "References to the locations and revisions of
the source code used in the\ndeployed application.\n\nNOTE: this field is exper
imental and can be ignored.", |
| 480 "items": { |
| 481 "$ref": "ExtendedSourceContext" |
| 482 }, |
| 483 "type": "array" |
| 484 }, |
| 485 "labels": { |
| 486 "additionalProperties": { |
| 487 "type": "string" |
| 488 }, |
| 489 "description": "A set of custom debuggee properties, populat
ed by the agent, to be\ndisplayed to the user.", |
| 490 "type": "object" |
| 491 }, |
| 492 "isInactive": { |
| 493 "description": "If set to `true`, indicates that Controller
service does not detect any\nactivity from the debuggee agents and the applicati
on is possibly stopped.", |
| 494 "type": "boolean" |
| 495 }, |
| 496 "status": { |
| 497 "$ref": "StatusMessage", |
| 498 "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." |
| 499 }, |
| 500 "project": { |
| 501 "description": "Project the debuggee is associated with.\nUs
e project number or id when registering a Google Cloud Platform project.", |
| 502 "type": "string" |
| 503 } |
| 504 }, |
| 505 "type": "object" |
| 506 }, |
| 507 "ListActiveBreakpointsResponse": { |
| 508 "description": "Response for listing active breakpoints.", |
| 509 "id": "ListActiveBreakpointsResponse", |
| 510 "properties": { |
| 511 "nextWaitToken": { |
| 512 "description": "A token that can be used in the next method
call to block until\nthe list of breakpoints changes.", |
| 513 "type": "string" |
| 514 }, |
| 515 "breakpoints": { |
| 516 "description": "List of all active breakpoints.\nThe fields
`id` and `location` are guaranteed to be set on each breakpoint.", |
| 517 "items": { |
| 518 "$ref": "Breakpoint" |
| 519 }, |
| 520 "type": "array" |
| 521 }, |
| 522 "waitExpired": { |
| 523 "description": "If set to `true`, indicates that there is no
change to the\nlist of active breakpoints and the server-selected timeout has e
xpired.\nThe `breakpoints` field would be empty and should be ignored.", |
| 524 "type": "boolean" |
| 525 } |
| 526 }, |
| 527 "type": "object" |
| 528 }, |
| 529 "ProjectRepoId": { |
| 530 "description": "Selects a repo using a Google Cloud Platform project
ID\n(e.g. winged-cargo-31) and a repo name within that project.", |
| 531 "id": "ProjectRepoId", |
| 532 "properties": { |
| 533 "repoName": { |
| 534 "description": "The name of the repo. Leave empty for the de
fault repo.", |
| 535 "type": "string" |
| 536 }, |
| 537 "projectId": { |
| 538 "description": "The ID of the project.", |
| 539 "type": "string" |
| 540 } |
| 541 }, |
| 542 "type": "object" |
| 543 }, |
| 544 "CloudWorkspaceSourceContext": { |
| 545 "description": "A CloudWorkspaceSourceContext denotes a workspace at
a particular snapshot.", |
| 546 "id": "CloudWorkspaceSourceContext", |
| 547 "properties": { |
| 548 "snapshotId": { |
| 549 "description": "The ID of the snapshot.\nAn empty snapshot_i
d refers to the most recent snapshot.", |
| 550 "type": "string" |
| 551 }, |
| 552 "workspaceId": { |
| 553 "$ref": "CloudWorkspaceId", |
| 554 "description": "The ID of the workspace." |
| 555 } |
| 556 }, |
| 557 "type": "object" |
| 558 }, |
| 559 "UpdateActiveBreakpointResponse": { |
| 560 "description": "Response for updating an active breakpoint.\nThe mes
sage is defined to allow future extensions.", |
| 561 "id": "UpdateActiveBreakpointResponse", |
| 562 "properties": {}, |
| 563 "type": "object" |
| 564 }, |
| 565 "GerritSourceContext": { |
| 566 "description": "A SourceContext referring to a Gerrit project.", |
| 567 "id": "GerritSourceContext", |
| 568 "properties": { |
| 569 "aliasContext": { |
| 570 "$ref": "AliasContext", |
| 571 "description": "An alias, which may be a branch or tag." |
| 572 }, |
| 573 "gerritProject": { |
| 574 "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.", |
| 575 "type": "string" |
| 576 }, |
| 577 "revisionId": { |
| 578 "description": "A revision (commit) ID.", |
| 579 "type": "string" |
| 580 }, |
| 581 "hostUri": { |
| 582 "description": "The URI of a running Gerrit instance.", |
| 583 "type": "string" |
| 584 }, |
| 585 "aliasName": { |
| 586 "description": "The name of an alias (branch, tag, etc.).", |
| 587 "type": "string" |
| 588 } |
| 589 }, |
| 590 "type": "object" |
| 591 }, |
| 592 "CloudWorkspaceId": { |
| 593 "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.", |
| 594 "id": "CloudWorkspaceId", |
| 595 "properties": { |
| 596 "repoId": { |
| 597 "$ref": "RepoId", |
| 598 "description": "The ID of the repo containing the workspace.
" |
| 599 }, |
| 600 "name": { |
| 601 "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.", |
| 602 "type": "string" |
| 603 } |
| 604 }, |
| 605 "type": "object" |
| 606 }, |
| 607 "ListBreakpointsResponse": { |
| 608 "description": "Response for listing breakpoints.", |
| 609 "id": "ListBreakpointsResponse", |
| 610 "properties": { |
| 611 "nextWaitToken": { |
| 612 "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.", |
| 613 "type": "string" |
| 614 }, |
| 615 "breakpoints": { |
| 616 "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.", |
| 617 "items": { |
| 618 "$ref": "Breakpoint" |
| 619 }, |
| 620 "type": "array" |
| 621 } |
| 622 }, |
| 623 "type": "object" |
| 624 }, |
| 625 "Breakpoint": { |
| 626 "description": "Represents the breakpoint specification, status and
results.", |
| 627 "id": "Breakpoint", |
| 628 "properties": { |
| 629 "logMessageFormat": { |
| 630 "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 ]`.", |
| 631 "type": "string" |
| 632 }, |
| 633 "createTime": { |
| 634 "description": "Time this breakpoint was created by the serv
er in seconds resolution.", |
| 635 "format": "google-datetime", |
| 636 "type": "string" |
| 637 }, |
| 638 "labels": { |
| 639 "additionalProperties": { |
| 640 "type": "string" |
| 641 }, |
| 642 "description": "A set of custom breakpoint properties, popul
ated by the agent, to be\ndisplayed to the user.", |
| 643 "type": "object" |
| 644 }, |
| 645 "expressions": { |
| 646 "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.", |
| 647 "items": { |
| 648 "type": "string" |
| 649 }, |
| 650 "type": "array" |
| 651 }, |
| 652 "evaluatedExpressions": { |
| 653 "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.", |
| 654 "items": { |
| 655 "$ref": "Variable" |
| 656 }, |
| 657 "type": "array" |
| 658 }, |
| 659 "isFinalState": { |
| 660 "description": "When true, indicates that this is a final re
sult and the\nbreakpoint state will not change from here on.", |
| 661 "type": "boolean" |
| 662 }, |
| 663 "stackFrames": { |
| 664 "description": "The stack at breakpoint time.", |
| 665 "items": { |
| 666 "$ref": "StackFrame" |
| 667 }, |
| 668 "type": "array" |
| 669 }, |
| 670 "condition": { |
| 671 "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.", |
| 672 "type": "string" |
| 673 }, |
| 674 "status": { |
| 675 "$ref": "StatusMessage", |
| 676 "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" |
| 677 }, |
| 678 "userEmail": { |
| 679 "description": "E-mail address of the user that created this
breakpoint", |
| 680 "type": "string" |
| 681 }, |
| 682 "action": { |
| 683 "description": "Action that the agent should perform when th
e code at the\nbreakpoint location is hit.", |
| 684 "enum": [ |
| 685 "CAPTURE", |
| 686 "LOG" |
| 687 ], |
| 688 "enumDescriptions": [ |
| 689 "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.", |
| 690 "Log each breakpoint hit. The breakpoint remains active
until\ndeleted or expired." |
| 691 ], |
| 692 "type": "string" |
| 693 }, |
| 694 "logLevel": { |
| 695 "description": "Indicates the severity of the log. Only rele
vant when action is `LOG`.", |
| 696 "enum": [ |
| 697 "INFO", |
| 698 "WARNING", |
| 699 "ERROR" |
| 700 ], |
| 701 "enumDescriptions": [ |
| 702 "Information log message.", |
| 703 "Warning log message.", |
| 704 "Error log message." |
| 705 ], |
| 706 "type": "string" |
| 707 }, |
| 708 "id": { |
| 709 "description": "Breakpoint identifier, unique in the scope o
f the debuggee.", |
| 710 "type": "string" |
| 711 }, |
| 712 "location": { |
| 713 "$ref": "SourceLocation", |
| 714 "description": "Breakpoint source location." |
| 715 }, |
| 716 "finalTime": { |
| 717 "description": "Time this breakpoint was finalized as seen b
y the server in seconds\nresolution.", |
| 718 "format": "google-datetime", |
| 719 "type": "string" |
| 720 }, |
| 721 "variableTable": { |
| 722 "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.", |
| 723 "items": { |
| 724 "$ref": "Variable" |
| 725 }, |
| 726 "type": "array" |
| 727 } |
| 728 }, |
| 729 "type": "object" |
| 730 }, |
| 731 "UpdateActiveBreakpointRequest": { |
| 732 "description": "Request to update an active breakpoint.", |
| 733 "id": "UpdateActiveBreakpointRequest", |
| 734 "properties": { |
| 735 "breakpoint": { |
| 736 "$ref": "Breakpoint", |
| 737 "description": "Updated breakpoint information.\nThe field `
id` must be set.\nThe agent must echo all Breakpoint specification fields in the
update." |
| 738 } |
| 739 }, |
| 740 "type": "object" |
| 741 }, |
| 742 "SetBreakpointResponse": { |
| 743 "description": "Response for setting a breakpoint.", |
| 744 "id": "SetBreakpointResponse", |
| 745 "properties": { |
| 746 "breakpoint": { |
| 747 "$ref": "Breakpoint", |
| 748 "description": "Breakpoint resource.\nThe field `id` is guar
anteed to be set (in addition to the echoed fileds)." |
| 749 } |
| 750 }, |
| 751 "type": "object" |
| 752 }, |
431 "SourceContext": { | 753 "SourceContext": { |
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.", | 754 "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.", |
433 "id": "SourceContext", | 755 "id": "SourceContext", |
434 "properties": { | 756 "properties": { |
| 757 "cloudWorkspace": { |
| 758 "$ref": "CloudWorkspaceSourceContext", |
| 759 "description": "A SourceContext referring to a snapshot in a
cloud workspace." |
| 760 }, |
| 761 "cloudRepo": { |
| 762 "$ref": "CloudRepoSourceContext", |
| 763 "description": "A SourceContext referring to a revision in a
cloud repo." |
| 764 }, |
| 765 "git": { |
| 766 "$ref": "GitSourceContext", |
| 767 "description": "A SourceContext referring to any third party
Git repo (e.g. GitHub)." |
| 768 }, |
435 "gerrit": { | 769 "gerrit": { |
436 "$ref": "GerritSourceContext", | 770 "$ref": "GerritSourceContext", |
437 "description": "A SourceContext referring to a Gerrit projec
t." | 771 "description": "A SourceContext referring to a Gerrit projec
t." |
438 }, | |
439 "cloudWorkspace": { | |
440 "$ref": "CloudWorkspaceSourceContext", | |
441 "description": "A SourceContext referring to a snapshot in a
cloud workspace." | |
442 }, | |
443 "cloudRepo": { | |
444 "$ref": "CloudRepoSourceContext", | |
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)." | |
450 } | 772 } |
451 }, | 773 }, |
452 "type": "object" | 774 "type": "object" |
453 }, | 775 }, |
454 "CloudRepoSourceContext": { | 776 "CloudRepoSourceContext": { |
455 "description": "A CloudRepoSourceContext denotes a particular revisi
on in a cloud\nrepo (a repo hosted by the Google Cloud Platform).", | 777 "description": "A CloudRepoSourceContext denotes a particular revisi
on in a cloud\nrepo (a repo hosted by the Google Cloud Platform).", |
456 "id": "CloudRepoSourceContext", | 778 "id": "CloudRepoSourceContext", |
457 "properties": { | 779 "properties": { |
458 "revisionId": { | |
459 "description": "A revision ID.", | |
460 "type": "string" | |
461 }, | |
462 "aliasName": { | 780 "aliasName": { |
463 "description": "The name of an alias (branch, tag, etc.).", | 781 "description": "The name of an alias (branch, tag, etc.).", |
464 "type": "string" | 782 "type": "string" |
465 }, | 783 }, |
466 "repoId": { | 784 "repoId": { |
467 "$ref": "RepoId", | 785 "$ref": "RepoId", |
468 "description": "The ID of the repo." | 786 "description": "The ID of the repo." |
469 }, | 787 }, |
470 "aliasContext": { | 788 "aliasContext": { |
471 "$ref": "AliasContext", | 789 "$ref": "AliasContext", |
472 "description": "An alias, which may be a branch or tag." | 790 "description": "An alias, which may be a branch or tag." |
| 791 }, |
| 792 "revisionId": { |
| 793 "description": "A revision ID.", |
| 794 "type": "string" |
| 795 } |
| 796 }, |
| 797 "type": "object" |
| 798 }, |
| 799 "RegisterDebuggeeResponse": { |
| 800 "description": "Response for registering a debuggee.", |
| 801 "id": "RegisterDebuggeeResponse", |
| 802 "properties": { |
| 803 "debuggee": { |
| 804 "$ref": "Debuggee", |
| 805 "description": "Debuggee resource.\nThe field `id` is gurant
eed to be set (in addition to the echoed fields).\nIf the field `is_disabled` is
set to `true`, the agent should disable\nitself by removing all breakpoints and
detaching from the application.\nIt should however continue to poll `RegisterDe
buggee` until reenabled." |
473 } | 806 } |
474 }, | 807 }, |
475 "type": "object" | 808 "type": "object" |
476 }, | 809 }, |
477 "RegisterDebuggeeRequest": { | 810 "RegisterDebuggeeRequest": { |
478 "description": "Request to register a debuggee.", | 811 "description": "Request to register a debuggee.", |
479 "id": "RegisterDebuggeeRequest", | 812 "id": "RegisterDebuggeeRequest", |
480 "properties": { | 813 "properties": { |
481 "debuggee": { | 814 "debuggee": { |
482 "$ref": "Debuggee", | 815 "$ref": "Debuggee", |
483 "description": "Debuggee information to register.\nThe field
s `project`, `uniquifier`, `description` and `agent_version`\nof the debuggee mu
st be set." | 816 "description": "Debuggee information to register.\nThe field
s `project`, `uniquifier`, `description` and `agent_version`\nof the debuggee mu
st be set." |
484 } | 817 } |
485 }, | 818 }, |
486 "type": "object" | 819 "type": "object" |
487 }, | 820 }, |
488 "RegisterDebuggeeResponse": { | |
489 "description": "Response for registering a debuggee.", | |
490 "id": "RegisterDebuggeeResponse", | |
491 "properties": { | |
492 "debuggee": { | |
493 "$ref": "Debuggee", | |
494 "description": "Debuggee resource.\nThe field `id` is gurant
eed to be set (in addition to the echoed fields)." | |
495 } | |
496 }, | |
497 "type": "object" | |
498 }, | |
499 "GetBreakpointResponse": { | 821 "GetBreakpointResponse": { |
500 "description": "Response for getting breakpoint information.", | 822 "description": "Response for getting breakpoint information.", |
501 "id": "GetBreakpointResponse", | 823 "id": "GetBreakpointResponse", |
502 "properties": { | 824 "properties": { |
503 "breakpoint": { | 825 "breakpoint": { |
504 "$ref": "Breakpoint", | 826 "$ref": "Breakpoint", |
505 "description": "Complete breakpoint state.\nThe fields `id`
and `location` are guaranteed to be set." | 827 "description": "Complete breakpoint state.\nThe fields `id`
and `location` are guaranteed to be set." |
506 } | 828 } |
507 }, | 829 }, |
508 "type": "object" | 830 "type": "object" |
(...skipping 47 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
556 "description": "Git repository URL.", | 878 "description": "Git repository URL.", |
557 "type": "string" | 879 "type": "string" |
558 } | 880 } |
559 }, | 881 }, |
560 "type": "object" | 882 "type": "object" |
561 }, | 883 }, |
562 "Variable": { | 884 "Variable": { |
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.", | 885 "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.", |
564 "id": "Variable", | 886 "id": "Variable", |
565 "properties": { | 887 "properties": { |
| 888 "value": { |
| 889 "description": "Simple value of the variable.", |
| 890 "type": "string" |
| 891 }, |
566 "varTableIndex": { | 892 "varTableIndex": { |
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.", | 893 "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.", |
568 "format": "int32", | 894 "format": "int32", |
569 "type": "integer" | 895 "type": "integer" |
570 }, | 896 }, |
571 "value": { | |
572 "description": "Simple value of the variable.", | |
573 "type": "string" | |
574 }, | |
575 "members": { | 897 "members": { |
576 "description": "Members contained or pointed to by the varia
ble.", | 898 "description": "Members contained or pointed to by the varia
ble.", |
577 "items": { | 899 "items": { |
578 "$ref": "Variable" | 900 "$ref": "Variable" |
579 }, | 901 }, |
580 "type": "array" | 902 "type": "array" |
581 }, | 903 }, |
582 "status": { | 904 "status": { |
583 "$ref": "StatusMessage", | 905 "$ref": "StatusMessage", |
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`" | 906 "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`" |
(...skipping 35 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
620 }, | 942 }, |
621 "type": "array" | 943 "type": "array" |
622 } | 944 } |
623 }, | 945 }, |
624 "type": "object" | 946 "type": "object" |
625 }, | 947 }, |
626 "RepoId": { | 948 "RepoId": { |
627 "description": "A unique identifier for a cloud repo.", | 949 "description": "A unique identifier for a cloud repo.", |
628 "id": "RepoId", | 950 "id": "RepoId", |
629 "properties": { | 951 "properties": { |
630 "uid": { | |
631 "description": "A server-assigned, globally unique identifie
r.", | |
632 "type": "string" | |
633 }, | |
634 "projectRepoId": { | 952 "projectRepoId": { |
635 "$ref": "ProjectRepoId", | 953 "$ref": "ProjectRepoId", |
636 "description": "A combination of a project ID and a repo nam
e." | 954 "description": "A combination of a project ID and a repo nam
e." |
| 955 }, |
| 956 "uid": { |
| 957 "description": "A server-assigned, globally unique identifie
r.", |
| 958 "type": "string" |
637 } | 959 } |
638 }, | 960 }, |
639 "type": "object" | 961 "type": "object" |
640 }, | 962 }, |
641 "FormatMessage": { | 963 "FormatMessage": { |
642 "description": "Represents a message with parameters.", | 964 "description": "Represents a message with parameters.", |
643 "id": "FormatMessage", | 965 "id": "FormatMessage", |
644 "properties": { | 966 "properties": { |
645 "parameters": { | 967 "parameters": { |
646 "description": "Optional parameters to be embedded into the
message.", | 968 "description": "Optional parameters to be embedded into the
message.", |
647 "items": { | 969 "items": { |
648 "type": "string" | 970 "type": "string" |
649 }, | 971 }, |
650 "type": "array" | 972 "type": "array" |
651 }, | 973 }, |
652 "format": { | 974 "format": { |
653 "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.`", | 975 "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.`", |
654 "type": "string" | 976 "type": "string" |
655 } | 977 } |
656 }, | 978 }, |
657 "type": "object" | 979 "type": "object" |
658 }, | 980 }, |
659 "ExtendedSourceContext": { | 981 "ExtendedSourceContext": { |
660 "description": "An ExtendedSourceContext is a SourceContext combined
with additional\ndetails describing the context.", | 982 "description": "An ExtendedSourceContext is a SourceContext combined
with additional\ndetails describing the context.", |
661 "id": "ExtendedSourceContext", | 983 "id": "ExtendedSourceContext", |
662 "properties": { | 984 "properties": { |
| 985 "labels": { |
| 986 "additionalProperties": { |
| 987 "type": "string" |
| 988 }, |
| 989 "description": "Labels with user defined metadata.", |
| 990 "type": "object" |
| 991 }, |
663 "context": { | 992 "context": { |
664 "$ref": "SourceContext", | 993 "$ref": "SourceContext", |
665 "description": "Any source context." | 994 "description": "Any source context." |
666 }, | 995 } |
667 "labels": { | 996 }, |
668 "additionalProperties": { | 997 "type": "object" |
669 "type": "string" | 998 }, |
670 }, | 999 "ListDebuggeesResponse": { |
671 "description": "Labels with user defined metadata.", | 1000 "description": "Response for listing debuggees.", |
672 "type": "object" | 1001 "id": "ListDebuggeesResponse", |
| 1002 "properties": { |
| 1003 "debuggees": { |
| 1004 "description": "List of debuggees accessible to the calling
user.\nThe fields `debuggee.id` and `description` are guaranteed to be set.\nThe
`description` field is a human readable field provided by agents and\ncan be di
splayed to users.", |
| 1005 "items": { |
| 1006 "$ref": "Debuggee" |
| 1007 }, |
| 1008 "type": "array" |
673 } | 1009 } |
674 }, | 1010 }, |
675 "type": "object" | 1011 "type": "object" |
676 }, | 1012 }, |
677 "AliasContext": { | 1013 "AliasContext": { |
678 "description": "An alias to a repo revision.", | 1014 "description": "An alias to a repo revision.", |
679 "id": "AliasContext", | 1015 "id": "AliasContext", |
680 "properties": { | 1016 "properties": { |
681 "name": { | 1017 "name": { |
682 "description": "The alias name.", | 1018 "description": "The alias name.", |
(...skipping 11 matching lines...) Expand all Loading... |
694 "Do not use.", | 1030 "Do not use.", |
695 "Git tag", | 1031 "Git tag", |
696 "Git branch", | 1032 "Git branch", |
697 "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." | 1033 "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." |
698 ], | 1034 ], |
699 "type": "string" | 1035 "type": "string" |
700 } | 1036 } |
701 }, | 1037 }, |
702 "type": "object" | 1038 "type": "object" |
703 }, | 1039 }, |
704 "ListDebuggeesResponse": { | |
705 "description": "Response for listing debuggees.", | |
706 "id": "ListDebuggeesResponse", | |
707 "properties": { | |
708 "debuggees": { | |
709 "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.", | |
710 "items": { | |
711 "$ref": "Debuggee" | |
712 }, | |
713 "type": "array" | |
714 } | |
715 }, | |
716 "type": "object" | |
717 }, | |
718 "Empty": { | 1040 "Empty": { |
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 `{}`.", | 1041 "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 `{}`.", |
720 "id": "Empty", | 1042 "id": "Empty", |
721 "properties": {}, | 1043 "properties": {}, |
722 "type": "object" | 1044 "type": "object" |
723 }, | |
724 "SourceLocation": { | |
725 "description": "Represents a location in the source code.", | |
726 "id": "SourceLocation", | |
727 "properties": { | |
728 "path": { | |
729 "description": "Path to the source file within the source co
ntext of the target binary.", | |
730 "type": "string" | |
731 }, | |
732 "line": { | |
733 "description": "Line inside the file. The first line in the
file has the value `1`.", | |
734 "format": "int32", | |
735 "type": "integer" | |
736 } | |
737 }, | |
738 "type": "object" | |
739 }, | |
740 "Debuggee": { | |
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.", | |
742 "id": "Debuggee", | |
743 "properties": { | |
744 "extSourceContexts": { | |
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`.", | |
746 "items": { | |
747 "$ref": "ExtendedSourceContext" | |
748 }, | |
749 "type": "array" | |
750 }, | |
751 "labels": { | |
752 "additionalProperties": { | |
753 "type": "string" | |
754 }, | |
755 "description": "A set of custom debuggee properties, populat
ed by the agent, to be\ndisplayed to the user.", | |
756 "type": "object" | |
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 }, | |
762 "isInactive": { | |
763 "description": "If set to `true`, indicates that the debugge
e is considered as inactive by\nthe Controller service.", | |
764 "type": "boolean" | |
765 }, | |
766 "project": { | |
767 "description": "Project the debuggee is associated with.\nUs
e the project number when registering a Google Cloud Platform project.", | |
768 "type": "string" | |
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 }, | |
778 "id": { | |
779 "description": "Unique identifier for the debuggee generated
by the controller service.", | |
780 "type": "string" | |
781 }, | |
782 "description": { | |
783 "description": "Human readable description of the debuggee.\
nIncluding a human-readable project name, environment name and version\ninformat
ion is recommended.", | |
784 "type": "string" | |
785 }, | |
786 "uniquifier": { | |
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.", | |
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" | |
796 } | |
797 }, | |
798 "type": "object" | |
799 }, | |
800 "ListActiveBreakpointsResponse": { | |
801 "description": "Response for listing active breakpoints.", | |
802 "id": "ListActiveBreakpointsResponse", | |
803 "properties": { | |
804 "breakpoints": { | |
805 "description": "List of all active breakpoints.\nThe fields
`id` and `location` are guaranteed to be set on each breakpoint.", | |
806 "items": { | |
807 "$ref": "Breakpoint" | |
808 }, | |
809 "type": "array" | |
810 }, | |
811 "waitExpired": { | |
812 "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.", | |
813 "type": "boolean" | |
814 }, | |
815 "nextWaitToken": { | |
816 "description": "A wait token that can be used in the next me
thod call to block until\nthe list of breakpoints changes.", | |
817 "type": "string" | |
818 } | |
819 }, | |
820 "type": "object" | |
821 }, | |
822 "ProjectRepoId": { | |
823 "description": "Selects a repo using a Google Cloud Platform project
ID\n(e.g. winged-cargo-31) and a repo name within that project.", | |
824 "id": "ProjectRepoId", | |
825 "properties": { | |
826 "repoName": { | |
827 "description": "The name of the repo. Leave empty for the de
fault repo.", | |
828 "type": "string" | |
829 }, | |
830 "projectId": { | |
831 "description": "The ID of the project.", | |
832 "type": "string" | |
833 } | |
834 }, | |
835 "type": "object" | |
836 }, | |
837 "CloudWorkspaceSourceContext": { | |
838 "description": "A CloudWorkspaceSourceContext denotes a workspace at
a particular snapshot.", | |
839 "id": "CloudWorkspaceSourceContext", | |
840 "properties": { | |
841 "snapshotId": { | |
842 "description": "The ID of the snapshot.\nAn empty snapshot_i
d refers to the most recent snapshot.", | |
843 "type": "string" | |
844 }, | |
845 "workspaceId": { | |
846 "$ref": "CloudWorkspaceId", | |
847 "description": "The ID of the workspace." | |
848 } | |
849 }, | |
850 "type": "object" | |
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 }, | |
858 "GerritSourceContext": { | |
859 "description": "A SourceContext referring to a Gerrit project.", | |
860 "id": "GerritSourceContext", | |
861 "properties": { | |
862 "aliasName": { | |
863 "description": "The name of an alias (branch, tag, etc.).", | |
864 "type": "string" | |
865 }, | |
866 "aliasContext": { | |
867 "$ref": "AliasContext", | |
868 "description": "An alias, which may be a branch or tag." | |
869 }, | |
870 "gerritProject": { | |
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.", | |
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" | |
881 } | |
882 }, | |
883 "type": "object" | |
884 }, | |
885 "CloudWorkspaceId": { | |
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.", | |
887 "id": "CloudWorkspaceId", | |
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 }, | |
893 "repoId": { | |
894 "$ref": "RepoId", | |
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" | |
910 }, | |
911 "nextWaitToken": { | |
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.", | |
913 "type": "string" | |
914 } | |
915 }, | |
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 |