| OLD | NEW |
| 1 { | 1 { |
| 2 "auth": { | 2 "auth": { |
| 3 "oauth2": { | 3 "oauth2": { |
| 4 "scopes": { | 4 "scopes": { |
| 5 "https://www.googleapis.com/auth/cloud-platform": { | 5 "https://www.googleapis.com/auth/cloud-platform": { |
| 6 "description": "View and manage your data across Google Clou
d Platform services" | 6 "description": "View and manage your data across Google Clou
d Platform services" |
| 7 }, | 7 }, |
| 8 "https://www.googleapis.com/auth/cloud_debugger": { | 8 "https://www.googleapis.com/auth/cloud_debugger": { |
| 9 "description": "Manage 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.", | 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 "etag": "\"tbys6C40o18GZwyMen5GMkdK-3s/QjifI48X3fgI9mRgli3ziT84a8U\"", | |
| 22 "icons": { | 21 "icons": { |
| 23 "x16": "http://www.google.com/images/icons/product/search-16.gif", | 22 "x16": "http://www.google.com/images/icons/product/search-16.gif", |
| 24 "x32": "http://www.google.com/images/icons/product/search-32.gif" | 23 "x32": "http://www.google.com/images/icons/product/search-32.gif" |
| 25 }, | 24 }, |
| 26 "id": "clouddebugger:v2", | 25 "id": "clouddebugger:v2", |
| 27 "kind": "discovery#restDescription", | 26 "kind": "discovery#restDescription", |
| 28 "name": "clouddebugger", | 27 "name": "clouddebugger", |
| 29 "ownerDomain": "google.com", | 28 "ownerDomain": "google.com", |
| 30 "ownerName": "Google", | 29 "ownerName": "Google", |
| 31 "parameters": { | 30 "parameters": { |
| 32 "access_token": { | 31 "access_token": { |
| 33 "description": "OAuth access token.", | 32 "description": "OAuth access token.", |
| 34 "location": "query", | 33 "location": "query", |
| 35 "type": "string" | 34 "type": "string" |
| 36 }, | 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": { |
| 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.", |
| 49 "location": "query", |
| 50 "type": "string" |
| 51 }, |
| 52 "pp": { |
| 53 "default": "true", |
| 54 "description": "Pretty-print response.", |
| 55 "location": "query", |
| 56 "type": "boolean" |
| 57 }, |
| 58 "fields": { |
| 59 "description": "Selector specifying which fields to include in a par
tial response.", |
| 60 "location": "query", |
| 61 "type": "string" |
| 62 }, |
| 37 "alt": { | 63 "alt": { |
| 38 "default": "json", | 64 "default": "json", |
| 39 "description": "Data format for response.", | 65 "description": "Data format for response.", |
| 66 "enum": [ |
| 67 "json", |
| 68 "media", |
| 69 "proto" |
| 70 ], |
| 40 "enumDescriptions": [ | 71 "enumDescriptions": [ |
| 41 "Responses with Content-Type of application/json", | 72 "Responses with Content-Type of application/json", |
| 42 "Media download with context-dependent Content-Type", | 73 "Media download with context-dependent Content-Type", |
| 43 "Responses with Content-Type of application/x-protobuf" | 74 "Responses with Content-Type of application/x-protobuf" |
| 44 ], | 75 ], |
| 45 "location": "query", | 76 "location": "query", |
| 46 "type": "string" | 77 "type": "string" |
| 47 }, | 78 }, |
| 48 "bearer_token": { | 79 "$.xgafv": { |
| 49 "description": "OAuth bearer token.", | 80 "description": "V1 error format.", |
| 81 "enum": [ |
| 82 "1", |
| 83 "2" |
| 84 ], |
| 85 "enumDescriptions": [ |
| 86 "v1 error format", |
| 87 "v2 error format" |
| 88 ], |
| 50 "location": "query", | 89 "location": "query", |
| 51 "type": "string" | 90 "type": "string" |
| 52 }, | 91 }, |
| 53 "callback": { | 92 "callback": { |
| 54 "description": "JSONP", | 93 "description": "JSONP", |
| 55 "location": "query", | 94 "location": "query", |
| 56 "type": "string" | 95 "type": "string" |
| 57 }, | 96 }, |
| 58 "fields": { | |
| 59 "description": "Selector specifying which fields to include in a par
tial response.", | |
| 60 "location": "query", | |
| 61 "type": "string" | |
| 62 }, | |
| 63 "key": { | |
| 64 "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.", | |
| 65 "location": "query", | |
| 66 "type": "string" | |
| 67 }, | |
| 68 "oauth_token": { | 97 "oauth_token": { |
| 69 "description": "OAuth 2.0 token for the current user.", | 98 "description": "OAuth 2.0 token for the current user.", |
| 70 "location": "query", | 99 "location": "query", |
| 71 "type": "string" | 100 "type": "string" |
| 72 }, | 101 }, |
| 73 "pp": { | 102 "uploadType": { |
| 74 "default": "true", | 103 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", |
| 75 "description": "Pretty-print response.", | |
| 76 "location": "query", | |
| 77 "type": "boolean" | |
| 78 }, | |
| 79 "prettyPrint": { | |
| 80 "default": "true", | |
| 81 "description": "Returns response with indentations and line breaks."
, | |
| 82 "location": "query", | |
| 83 "type": "boolean" | |
| 84 }, | |
| 85 "quotaUser": { | |
| 86 "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.", | |
| 87 "location": "query", | 104 "location": "query", |
| 88 "type": "string" | 105 "type": "string" |
| 89 }, | 106 }, |
| 107 "bearer_token": { |
| 108 "description": "OAuth bearer token.", |
| 109 "location": "query", |
| 110 "type": "string" |
| 111 }, |
| 90 "upload_protocol": { | 112 "upload_protocol": { |
| 91 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", | 113 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", |
| 92 "location": "query", | 114 "location": "query", |
| 93 "type": "string" | 115 "type": "string" |
| 94 }, | |
| 95 "uploadType": { | |
| 96 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", | |
| 97 "location": "query", | |
| 98 "type": "string" | |
| 99 }, | |
| 100 "$.xgafv": { | |
| 101 "description": "V1 error format.", | |
| 102 "enumDescriptions": [ | |
| 103 "v1 error format", | |
| 104 "v2 error format" | |
| 105 ], | |
| 106 "location": "query", | |
| 107 "type": "string" | |
| 108 } | 116 } |
| 109 }, | 117 }, |
| 110 "protocol": "rest", | 118 "protocol": "rest", |
| 111 "resources": { | 119 "resources": { |
| 112 "controller": { | 120 "controller": { |
| 113 "resources": { | 121 "resources": { |
| 114 "debuggees": { | 122 "debuggees": { |
| 115 "methods": { | 123 "methods": { |
| 116 "register": { | 124 "register": { |
| 117 "description": "Registers the debuggee with the cont
roller service. All agents attached to the same application should call this met
hod with the same request content to get back the same stable `debuggee_id`. Age
nts should call this method again whenever `google.rpc.Code.NOT_FOUND` is return
ed from any controller method. This allows the controller service to disable the
agent or recover from any data loss. If the debuggee is disabled by the server,
the response will have `is_disabled` set to `true`.", | 125 "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`.", |
| 118 "httpMethod": "POST", | 126 "httpMethod": "POST", |
| 119 "id": "clouddebugger.controller.debuggees.register", | 127 "id": "clouddebugger.controller.debuggees.register", |
| 128 "parameterOrder": [], |
| 129 "parameters": {}, |
| 120 "path": "v2/controller/debuggees/register", | 130 "path": "v2/controller/debuggees/register", |
| 121 "request": { | 131 "request": { |
| 122 "$ref": "RegisterDebuggeeRequest" | 132 "$ref": "RegisterDebuggeeRequest" |
| 123 }, | 133 }, |
| 124 "response": { | 134 "response": { |
| 125 "$ref": "RegisterDebuggeeResponse" | 135 "$ref": "RegisterDebuggeeResponse" |
| 126 }, | 136 }, |
| 127 "scopes": [ | 137 "scopes": [ |
| 128 "https://www.googleapis.com/auth/cloud-platform"
, | 138 "https://www.googleapis.com/auth/cloud-platform"
, |
| 129 "https://www.googleapis.com/auth/cloud_debugger" | 139 "https://www.googleapis.com/auth/cloud_debugger" |
| 130 ] | 140 ] |
| 131 } | 141 } |
| 132 }, | 142 }, |
| 133 "resources": { | 143 "resources": { |
| 134 "breakpoints": { | 144 "breakpoints": { |
| 135 "methods": { | 145 "methods": { |
| 136 "list": { | |
| 137 "description": "Returns the list of all acti
ve breakpoints for the debuggee. The breakpoint specification (location, conditi
on, and expression fields) is semantically immutable, although the field values
may change. For example, an agent may update the location line number to reflect
the actual line where the breakpoint was set, but this doesn't change the break
point semantics. This means that an agent does not need to check if a breakpoint
has changed when it encounters the same breakpoint on a successive call. Moreov
er, an agent should remember the breakpoints that are completed until the contro
ller removes them from the active list to avoid setting those breakpoints again.
", | |
| 138 "httpMethod": "GET", | |
| 139 "id": "clouddebugger.controller.debuggees.br
eakpoints.list", | |
| 140 "parameterOrder": [ | |
| 141 "debuggeeId" | |
| 142 ], | |
| 143 "parameters": { | |
| 144 "debuggeeId": { | |
| 145 "description": "Identifies the debug
gee.", | |
| 146 "location": "path", | |
| 147 "required": true, | |
| 148 "type": "string" | |
| 149 }, | |
| 150 "waitToken": { | |
| 151 "description": "A wait token that, i
f specified, blocks the method call until the list of active breakpoints has cha
nged, or a server selected timeout has expired. The value should be set from the
last returned response.", | |
| 152 "location": "query", | |
| 153 "type": "string" | |
| 154 }, | |
| 155 "successOnTimeout": { | |
| 156 "description": "If set to `true`, re
turns `google.rpc.Code.OK` status and sets the `wait_expired` response field to
`true` when the server-selected timeout has expired (recommended). If set to `fa
lse`, returns `google.rpc.Code.ABORTED` status when the server-selected timeout
has expired (deprecated).", | |
| 157 "location": "query", | |
| 158 "type": "boolean" | |
| 159 } | |
| 160 }, | |
| 161 "path": "v2/controller/debuggees/{debuggeeId
}/breakpoints", | |
| 162 "response": { | |
| 163 "$ref": "ListActiveBreakpointsResponse" | |
| 164 }, | |
| 165 "scopes": [ | |
| 166 "https://www.googleapis.com/auth/cloud-p
latform", | |
| 167 "https://www.googleapis.com/auth/cloud_d
ebugger" | |
| 168 ] | |
| 169 }, | |
| 170 "update": { | 146 "update": { |
| 171 "description": "Updates the breakpoint state
or mutable fields. The entire Breakpoint message must be sent back to the contr
oller service. Updates to active breakpoint fields are only allowed if the new v
alue does not change the breakpoint specification. Updates to the `location`, `c
ondition` and `expression` fields should not alter the breakpoint semantics. The
se may only make changes such as canonicalizing a value or snapping the location
to the correct line of code.", | 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.", |
| 172 "httpMethod": "PUT", | 148 "httpMethod": "PUT", |
| 173 "id": "clouddebugger.controller.debuggees.br
eakpoints.update", | 149 "id": "clouddebugger.controller.debuggees.br
eakpoints.update", |
| 174 "parameterOrder": [ | 150 "parameterOrder": [ |
| 175 "debuggeeId", | 151 "debuggeeId", |
| 176 "id" | 152 "id" |
| 177 ], | 153 ], |
| 178 "parameters": { | 154 "parameters": { |
| 179 "debuggeeId": { | 155 "debuggeeId": { |
| 180 "description": "Identifies the debug
gee being debugged.", | 156 "description": "Identifies the debug
gee being debugged.", |
| 181 "location": "path", | 157 "location": "path", |
| 182 "required": true, | 158 "required": true, |
| 183 "type": "string" | 159 "type": "string" |
| 184 }, | 160 }, |
| 185 "id": { | 161 "id": { |
| 186 "description": "Breakpoint identifie
r, unique in the scope of the debuggee.", | 162 "description": "Breakpoint identifie
r, unique in the scope of the debuggee.", |
| 187 "location": "path", | 163 "location": "path", |
| 188 "required": true, | 164 "required": true, |
| 189 "type": "string" | 165 "type": "string" |
| 190 } | 166 } |
| 191 }, | 167 }, |
| 192 "path": "v2/controller/debuggees/{debuggeeId
}/breakpoints/{id}", | 168 "path": "v2/controller/debuggees/{debuggeeId
}/breakpoints/{id}", |
| 193 "request": { | 169 "request": { |
| 194 "$ref": "UpdateActiveBreakpointRequest" | 170 "$ref": "UpdateActiveBreakpointRequest" |
| 195 }, | 171 }, |
| 196 "response": { | 172 "response": { |
| 197 "$ref": "UpdateActiveBreakpointResponse" | 173 "$ref": "UpdateActiveBreakpointResponse" |
| 198 }, | 174 }, |
| 199 "scopes": [ | 175 "scopes": [ |
| 200 "https://www.googleapis.com/auth/cloud-p
latform", | 176 "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", |
| 201 "https://www.googleapis.com/auth/cloud_d
ebugger" | 211 "https://www.googleapis.com/auth/cloud_d
ebugger" |
| 202 ] | 212 ] |
| 203 } | 213 } |
| 204 } | 214 } |
| 205 } | 215 } |
| 206 } | 216 } |
| 207 } | 217 } |
| 208 } | 218 } |
| 209 }, | 219 }, |
| 210 "debugger": { | 220 "debugger": { |
| 211 "resources": { | 221 "resources": { |
| 212 "debuggees": { | 222 "debuggees": { |
| 213 "methods": { | 223 "methods": { |
| 214 "list": { | 224 "list": { |
| 215 "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.", |
| 216 "httpMethod": "GET", | 226 "httpMethod": "GET", |
| 217 "id": "clouddebugger.debugger.debuggees.list", | 227 "id": "clouddebugger.debugger.debuggees.list", |
| 228 "parameterOrder": [], |
| 218 "parameters": { | 229 "parameters": { |
| 230 "includeInactive": { |
| 231 "description": "When set to `true`, the resu
lt includes all debuggees. Otherwise, the\nresult includes only debuggees that a
re active.", |
| 232 "location": "query", |
| 233 "type": "boolean" |
| 234 }, |
| 219 "project": { | 235 "project": { |
| 220 "description": "Project number of a Google C
loud project whose debuggees to list.", | 236 "description": "Project number of a Google C
loud project whose debuggees to list.", |
| 221 "location": "query", | 237 "location": "query", |
| 222 "type": "string" | 238 "type": "string" |
| 223 }, | 239 }, |
| 224 "includeInactive": { | |
| 225 "description": "When set to `true`, the resu
lt includes all debuggees. Otherwise, the result includes only debuggees that ar
e active.", | |
| 226 "location": "query", | |
| 227 "type": "boolean" | |
| 228 }, | |
| 229 "clientVersion": { | 240 "clientVersion": { |
| 230 "description": "The client version making th
e call. Following: `domain/type/version` (e.g., `google.com/intellij/v1`).", | 241 "description": "The client version making th
e call.\nFollowing: `domain/type/version` (e.g., `google.com/intellij/v1`).", |
| 231 "location": "query", | 242 "location": "query", |
| 232 "type": "string" | 243 "type": "string" |
| 233 } | 244 } |
| 234 }, | 245 }, |
| 235 "path": "v2/debugger/debuggees", | 246 "path": "v2/debugger/debuggees", |
| 236 "response": { | 247 "response": { |
| 237 "$ref": "ListDebuggeesResponse" | 248 "$ref": "ListDebuggeesResponse" |
| 238 }, | 249 }, |
| 239 "scopes": [ | 250 "scopes": [ |
| 240 "https://www.googleapis.com/auth/cloud-platform"
, | 251 "https://www.googleapis.com/auth/cloud-platform"
, |
| 241 "https://www.googleapis.com/auth/cloud_debugger" | 252 "https://www.googleapis.com/auth/cloud_debugger" |
| 242 ] | 253 ] |
| 243 } | 254 } |
| 244 }, | 255 }, |
| 245 "resources": { | 256 "resources": { |
| 246 "breakpoints": { | 257 "breakpoints": { |
| 247 "methods": { | 258 "methods": { |
| 248 "set": { | |
| 249 "description": "Sets the breakpoint to the d
ebuggee.", | |
| 250 "httpMethod": "POST", | |
| 251 "id": "clouddebugger.debugger.debuggees.brea
kpoints.set", | |
| 252 "parameterOrder": [ | |
| 253 "debuggeeId" | |
| 254 ], | |
| 255 "parameters": { | |
| 256 "debuggeeId": { | |
| 257 "description": "ID of the debuggee w
here the breakpoint is to be set.", | |
| 258 "location": "path", | |
| 259 "required": true, | |
| 260 "type": "string" | |
| 261 }, | |
| 262 "clientVersion": { | |
| 263 "description": "The client version m
aking the call. Following: `domain/type/version` (e.g., `google.com/intellij/v1`
).", | |
| 264 "location": "query", | |
| 265 "type": "string" | |
| 266 } | |
| 267 }, | |
| 268 "path": "v2/debugger/debuggees/{debuggeeId}/
breakpoints/set", | |
| 269 "request": { | |
| 270 "$ref": "Breakpoint" | |
| 271 }, | |
| 272 "response": { | |
| 273 "$ref": "SetBreakpointResponse" | |
| 274 }, | |
| 275 "scopes": [ | |
| 276 "https://www.googleapis.com/auth/cloud-p
latform", | |
| 277 "https://www.googleapis.com/auth/cloud_d
ebugger" | |
| 278 ] | |
| 279 }, | |
| 280 "get": { | 259 "get": { |
| 281 "description": "Gets breakpoint information.
", | 260 "description": "Gets breakpoint information.
", |
| 282 "httpMethod": "GET", | 261 "httpMethod": "GET", |
| 283 "id": "clouddebugger.debugger.debuggees.brea
kpoints.get", | 262 "id": "clouddebugger.debugger.debuggees.brea
kpoints.get", |
| 284 "parameterOrder": [ | 263 "parameterOrder": [ |
| 285 "debuggeeId", | 264 "debuggeeId", |
| 286 "breakpointId" | 265 "breakpointId" |
| 287 ], | 266 ], |
| 288 "parameters": { | 267 "parameters": { |
| 289 "debuggeeId": { | 268 "debuggeeId": { |
| 290 "description": "ID of the debuggee w
hose breakpoint to get.", | 269 "description": "ID of the debuggee w
hose breakpoint to get.", |
| 291 "location": "path", | 270 "location": "path", |
| 292 "required": true, | 271 "required": true, |
| 293 "type": "string" | 272 "type": "string" |
| 294 }, | 273 }, |
| 295 "breakpointId": { | 274 "breakpointId": { |
| 296 "description": "ID of the breakpoint
to get.", | 275 "description": "ID of the breakpoint
to get.", |
| 297 "location": "path", | 276 "location": "path", |
| 298 "required": true, | 277 "required": true, |
| 299 "type": "string" | 278 "type": "string" |
| 300 }, | 279 }, |
| 301 "clientVersion": { | 280 "clientVersion": { |
| 302 "description": "The client version m
aking the call. Following: `domain/type/version` (e.g., `google.com/intellij/v1`
).", | 281 "description": "The client version m
aking the call.\nFollowing: `domain/type/version` (e.g., `google.com/intellij/v1
`).", |
| 303 "location": "query", | 282 "location": "query", |
| 304 "type": "string" | 283 "type": "string" |
| 305 } | 284 } |
| 306 }, | 285 }, |
| 307 "path": "v2/debugger/debuggees/{debuggeeId}/
breakpoints/{breakpointId}", | 286 "path": "v2/debugger/debuggees/{debuggeeId}/
breakpoints/{breakpointId}", |
| 308 "response": { | 287 "response": { |
| 309 "$ref": "GetBreakpointResponse" | 288 "$ref": "GetBreakpointResponse" |
| 310 }, | 289 }, |
| 311 "scopes": [ | 290 "scopes": [ |
| 312 "https://www.googleapis.com/auth/cloud-p
latform", | 291 "https://www.googleapis.com/auth/cloud-p
latform", |
| 313 "https://www.googleapis.com/auth/cloud_d
ebugger" | 292 "https://www.googleapis.com/auth/cloud_d
ebugger" |
| 314 ] | 293 ] |
| 315 }, | 294 }, |
| 316 "delete": { | |
| 317 "description": "Deletes the breakpoint from
the debuggee.", | |
| 318 "httpMethod": "DELETE", | |
| 319 "id": "clouddebugger.debugger.debuggees.brea
kpoints.delete", | |
| 320 "parameterOrder": [ | |
| 321 "debuggeeId", | |
| 322 "breakpointId" | |
| 323 ], | |
| 324 "parameters": { | |
| 325 "debuggeeId": { | |
| 326 "description": "ID of the debuggee w
hose breakpoint to delete.", | |
| 327 "location": "path", | |
| 328 "required": true, | |
| 329 "type": "string" | |
| 330 }, | |
| 331 "breakpointId": { | |
| 332 "description": "ID of the breakpoint
to delete.", | |
| 333 "location": "path", | |
| 334 "required": true, | |
| 335 "type": "string" | |
| 336 }, | |
| 337 "clientVersion": { | |
| 338 "description": "The client version m
aking the call. Following: `domain/type/version` (e.g., `google.com/intellij/v1`
).", | |
| 339 "location": "query", | |
| 340 "type": "string" | |
| 341 } | |
| 342 }, | |
| 343 "path": "v2/debugger/debuggees/{debuggeeId}/
breakpoints/{breakpointId}", | |
| 344 "response": { | |
| 345 "$ref": "Empty" | |
| 346 }, | |
| 347 "scopes": [ | |
| 348 "https://www.googleapis.com/auth/cloud-p
latform", | |
| 349 "https://www.googleapis.com/auth/cloud_d
ebugger" | |
| 350 ] | |
| 351 }, | |
| 352 "list": { | 295 "list": { |
| 353 "description": "Lists all breakpoints for th
e debuggee.", | 296 "description": "Lists all breakpoints for th
e debuggee.", |
| 354 "httpMethod": "GET", | 297 "httpMethod": "GET", |
| 355 "id": "clouddebugger.debugger.debuggees.brea
kpoints.list", | 298 "id": "clouddebugger.debugger.debuggees.brea
kpoints.list", |
| 356 "parameterOrder": [ | 299 "parameterOrder": [ |
| 357 "debuggeeId" | 300 "debuggeeId" |
| 358 ], | 301 ], |
| 359 "parameters": { | 302 "parameters": { |
| 360 "debuggeeId": { | 303 "debuggeeId": { |
| 361 "description": "ID of the debuggee w
hose breakpoints to list.", | 304 "description": "ID of the debuggee w
hose breakpoints to list.", |
| 362 "location": "path", | 305 "location": "path", |
| 363 "required": true, | 306 "required": true, |
| 364 "type": "string" | 307 "type": "string" |
| 365 }, | 308 }, |
| 309 "clientVersion": { |
| 310 "description": "The client version m
aking the call.\nFollowing: `domain/type/version` (e.g., `google.com/intellij/v1
`).", |
| 311 "location": "query", |
| 312 "type": "string" |
| 313 }, |
| 366 "includeAllUsers": { | 314 "includeAllUsers": { |
| 367 "description": "When set to `true`,
the response includes the list of breakpoints set by any user. Otherwise, it inc
ludes only breakpoints set by the caller.", | 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.", |
| 368 "location": "query", | 316 "location": "query", |
| 369 "type": "boolean" | 317 "type": "boolean" |
| 370 }, | 318 }, |
| 371 "includeInactive": { | 319 "stripResults": { |
| 372 "description": "When set to `true`,
the response includes active and inactive breakpoints. Otherwise, it includes on
ly active breakpoints.", | 320 "description": "This field is deprec
ated. The following fields are always stripped out of\nthe result: `stack_frames
`, `evaluated_expressions` and `variable_table`.", |
| 373 "location": "query", | 321 "location": "query", |
| 374 "type": "boolean" | 322 "type": "boolean" |
| 375 }, | 323 }, |
| 376 "action.value": { | 324 "action.value": { |
| 377 "description": "Only breakpoints wit
h the specified action will pass the filter.", | 325 "description": "Only breakpoints wit
h the specified action will pass the filter.", |
| 378 "enum": [ | 326 "enum": [ |
| 379 "CAPTURE", | 327 "CAPTURE", |
| 380 "LOG" | 328 "LOG" |
| 381 ], | 329 ], |
| 382 "location": "query", | 330 "location": "query", |
| 383 "type": "string" | 331 "type": "string" |
| 384 }, | 332 }, |
| 385 "stripResults": { | 333 "includeInactive": { |
| 386 "description": "When set to `true`,
the response breakpoints are stripped of the results fields: `stack_frames`, `ev
aluated_expressions` and `variable_table`.", | 334 "description": "When set to `true`,
the response includes active and inactive\nbreakpoints. Otherwise, it includes o
nly active breakpoints.", |
| 387 "location": "query", | 335 "location": "query", |
| 388 "type": "boolean" | 336 "type": "boolean" |
| 389 }, | 337 }, |
| 390 "waitToken": { | 338 "waitToken": { |
| 391 "description": "A wait token that, i
f specified, blocks the call until the breakpoints list has changed, or a server
selected timeout has expired. The value should be set from the last response. T
he error code `google.rpc.Code.ABORTED` (RPC) is returned on wait timeout, which
should be called again with the same `wait_token`.", | 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`.", |
| 392 "location": "query", | |
| 393 "type": "string" | |
| 394 }, | |
| 395 "clientVersion": { | |
| 396 "description": "The client version m
aking the call. Following: `domain/type/version` (e.g., `google.com/intellij/v1`
).", | |
| 397 "location": "query", | 340 "location": "query", |
| 398 "type": "string" | 341 "type": "string" |
| 399 } | 342 } |
| 400 }, | 343 }, |
| 401 "path": "v2/debugger/debuggees/{debuggeeId}/
breakpoints", | 344 "path": "v2/debugger/debuggees/{debuggeeId}/
breakpoints", |
| 402 "response": { | 345 "response": { |
| 403 "$ref": "ListBreakpointsResponse" | 346 "$ref": "ListBreakpointsResponse" |
| 404 }, | 347 }, |
| 405 "scopes": [ | 348 "scopes": [ |
| 406 "https://www.googleapis.com/auth/cloud-p
latform", | 349 "https://www.googleapis.com/auth/cloud-p
latform", |
| 407 "https://www.googleapis.com/auth/cloud_d
ebugger" | 350 "https://www.googleapis.com/auth/cloud_d
ebugger" |
| 408 ] | 351 ] |
| 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 ] |
| 409 } | 420 } |
| 410 } | 421 } |
| 411 } | 422 } |
| 412 } | 423 } |
| 413 } | 424 } |
| 414 } | 425 } |
| 415 } | 426 } |
| 416 }, | 427 }, |
| 417 "revision": "20160810", | 428 "revision": "20170117", |
| 418 "rootUrl": "https://clouddebugger.googleapis.com/", | 429 "rootUrl": "https://clouddebugger.googleapis.com/", |
| 419 "schemas": { | 430 "schemas": { |
| 420 "RegisterDebuggeeRequest": { | |
| 421 "description": "Request to register a debuggee.", | |
| 422 "id": "RegisterDebuggeeRequest", | |
| 423 "properties": { | |
| 424 "debuggee": { | |
| 425 "$ref": "Debuggee", | |
| 426 "description": "Debuggee information to register. The fields
`project`, `uniquifier`, `description` and `agent_version` of the debuggee must
be set." | |
| 427 } | |
| 428 }, | |
| 429 "type": "object" | |
| 430 }, | |
| 431 "Debuggee": { | 431 "Debuggee": { |
| 432 "description": "Represents the application to debug. The application
may include one or more replicated processes executing the same code. Each of t
hese processes is attached with a debugger agent, carrying out the debugging com
mands. The agents attached to the same debuggee are identified by using exactly
the same field values when registering.", | 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.", |
| 433 "id": "Debuggee", | 433 "id": "Debuggee", |
| 434 "properties": { | 434 "properties": { |
| 435 "id": { | 435 "id": { |
| 436 "description": "Unique identifier for the debuggee generated
by the controller service.", | 436 "description": "Unique identifier for the debuggee generated
by the controller service.", |
| 437 "type": "string" | 437 "type": "string" |
| 438 }, | 438 }, |
| 439 "project": { | 439 "project": { |
| 440 "description": "Project the debuggee is associated with. Use
the project number when registering a Google Cloud Platform project.", | 440 "description": "Project the debuggee is associated with.\nUs
e the project number when registering a Google Cloud Platform project.", |
| 441 "type": "string" | 441 "type": "string" |
| 442 }, | 442 }, |
| 443 "uniquifier": { | |
| 444 "description": "Debuggee uniquifier within the project. Any
string that identifies the application within the project can be used. Including
environment and version or build IDs is recommended.", | |
| 445 "type": "string" | |
| 446 }, | |
| 447 "description": { | |
| 448 "description": "Human readable description of the debuggee.
Including a human-readable project name, environment name and version informatio
n is recommended.", | |
| 449 "type": "string" | |
| 450 }, | |
| 451 "isInactive": { | |
| 452 "description": "If set to `true`, indicates that the debugge
e is considered as inactive by the Controller service.", | |
| 453 "type": "boolean" | |
| 454 }, | |
| 455 "agentVersion": { | |
| 456 "description": "Version ID of the agent release. The version
ID is structured as following: `domain/type/vmajor.minor` (for example `google.
com/gcp-java/v1.1`).", | |
| 457 "type": "string" | |
| 458 }, | |
| 459 "isDisabled": { | |
| 460 "description": "If set to `true`, indicates that the agent s
hould disable itself and detach from the debuggee.", | |
| 461 "type": "boolean" | |
| 462 }, | |
| 463 "status": { | |
| 464 "$ref": "StatusMessage", | |
| 465 "description": "Human readable message to be displayed to th
e user about this debuggee. Absence of this field indicates no status. The messa
ge can be either informational or an error status." | |
| 466 }, | |
| 467 "sourceContexts": { | |
| 468 "description": "References to the locations and revisions of
the source code used in the deployed application. NOTE: This field is deprecate
d. Consumers should use `ext_source_contexts` if it is not empty. Debug agents s
hould populate both this field and `ext_source_contexts`.", | |
| 469 "items": { | |
| 470 "$ref": "SourceContext" | |
| 471 }, | |
| 472 "type": "array" | |
| 473 }, | |
| 474 "extSourceContexts": { | 443 "extSourceContexts": { |
| 475 "description": "References to the locations and revisions of
the source code used in the deployed application. Contexts describing a remote
repo related to the source code have a `category` label of `remote_repo`. Source
snapshot source contexts have a `category` of `snapshot`.", | 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`.", |
| 476 "items": { | 445 "items": { |
| 477 "$ref": "ExtendedSourceContext" | 446 "$ref": "ExtendedSourceContext" |
| 478 }, | 447 }, |
| 479 "type": "array" | 448 "type": "array" |
| 480 }, | 449 }, |
| 450 "description": { |
| 451 "description": "Human readable description of the debuggee.\
nIncluding a human-readable project name, environment name and version\ninformat
ion is recommended.", |
| 452 "type": "string" |
| 453 }, |
| 454 "isDisabled": { |
| 455 "description": "If set to `true`, indicates that the agent s
hould disable itself and\ndetach from the debuggee.", |
| 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" |
| 469 }, |
| 481 "labels": { | 470 "labels": { |
| 482 "additionalProperties": { | 471 "additionalProperties": { |
| 483 "type": "string" | 472 "type": "string" |
| 484 }, | 473 }, |
| 485 "description": "A set of custom debuggee properties, populat
ed by the agent, to be displayed to the user.", | 474 "description": "A set of custom debuggee properties, populat
ed by the agent, to be\ndisplayed to the user.", |
| 486 "type": "object" | 475 "type": "object" |
| 487 } | |
| 488 }, | |
| 489 "type": "object" | |
| 490 }, | |
| 491 "StatusMessage": { | |
| 492 "description": "Represents a contextual status message. The message
can indicate an error or informational status, and refer to specific parts of th
e containing object. For example, the `Breakpoint.status` field can indicate an
error referring to the `BREAKPOINT_SOURCE_LOCATION` with the message `Location n
ot found`.", | |
| 493 "id": "StatusMessage", | |
| 494 "properties": { | |
| 495 "isError": { | |
| 496 "description": "Distinguishes errors from informational mess
ages.", | |
| 497 "type": "boolean" | |
| 498 }, | 476 }, |
| 499 "refersTo": { | 477 "uniquifier": { |
| 500 "description": "Reference to which the message applies.", | 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.", |
| 501 "enum": [ | |
| 502 "UNSPECIFIED", | |
| 503 "BREAKPOINT_SOURCE_LOCATION", | |
| 504 "BREAKPOINT_CONDITION", | |
| 505 "BREAKPOINT_EXPRESSION", | |
| 506 "VARIABLE_NAME", | |
| 507 "VARIABLE_VALUE" | |
| 508 ], | |
| 509 "type": "string" | 479 "type": "string" |
| 510 }, | 480 }, |
| 511 "description": { | 481 "sourceContexts": { |
| 512 "$ref": "FormatMessage", | 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`.", |
| 513 "description": "Status message text." | |
| 514 } | |
| 515 }, | |
| 516 "type": "object" | |
| 517 }, | |
| 518 "FormatMessage": { | |
| 519 "description": "Represents a message with parameters.", | |
| 520 "id": "FormatMessage", | |
| 521 "properties": { | |
| 522 "format": { | |
| 523 "description": "Format template for the message. The `format
` uses placeholders `$0`, `$1`, etc. to reference parameters. `$$` can be used t
o denote the `$` character. Examples: * `Failed to load '$0' which helps debug $
1 the first time it is loaded. Again, $0 is very important.` * `Please pay $$10
to use $0 instead of $1.`", | |
| 524 "type": "string" | |
| 525 }, | |
| 526 "parameters": { | |
| 527 "description": "Optional parameters to be embedded into the
message.", | |
| 528 "items": { | 483 "items": { |
| 529 "type": "string" | 484 "$ref": "SourceContext" |
| 530 }, | 485 }, |
| 531 "type": "array" | 486 "type": "array" |
| 532 } | 487 } |
| 533 }, | 488 }, |
| 534 "type": "object" | 489 "type": "object" |
| 535 }, | 490 }, |
| 536 "SourceContext": { | 491 "StackFrame": { |
| 537 "description": "A SourceContext is a reference to a tree of files. A
SourceContext together with a path point to a unique revision of a single file
or directory.", | 492 "description": "Represents a stack frame context.", |
| 538 "id": "SourceContext", | 493 "id": "StackFrame", |
| 539 "properties": { | 494 "properties": { |
| 540 "cloudRepo": { | 495 "locals": { |
| 541 "$ref": "CloudRepoSourceContext", | 496 "description": "Set of local variables at the stack frame lo
cation.\nNote that this might not be populated for all stack frames.", |
| 542 "description": "A SourceContext referring to a revision in a
cloud repo." | 497 "items": { |
| 498 "$ref": "Variable" |
| 499 }, |
| 500 "type": "array" |
| 543 }, | 501 }, |
| 544 "cloudWorkspace": { | 502 "function": { |
| 545 "$ref": "CloudWorkspaceSourceContext", | 503 "description": "Demangled function name at the call site.", |
| 546 "description": "A SourceContext referring to a snapshot in a
cloud workspace." | 504 "type": "string" |
| 547 }, | 505 }, |
| 548 "gerrit": { | 506 "location": { |
| 549 "$ref": "GerritSourceContext", | 507 "$ref": "SourceLocation", |
| 550 "description": "A SourceContext referring to a Gerrit projec
t." | 508 "description": "Source location of the call site." |
| 551 }, | 509 }, |
| 552 "git": { | 510 "arguments": { |
| 553 "$ref": "GitSourceContext", | 511 "description": "Set of arguments passed to this function.\nN
ote that this might not be populated for all stack frames.", |
| 554 "description": "A SourceContext referring to any third party
Git repo (e.g. GitHub)." | 512 "items": { |
| 513 "$ref": "Variable" |
| 514 }, |
| 515 "type": "array" |
| 555 } | 516 } |
| 556 }, | 517 }, |
| 557 "type": "object" | 518 "type": "object" |
| 558 }, | 519 }, |
| 559 "CloudRepoSourceContext": { | 520 "ListBreakpointsResponse": { |
| 560 "description": "A CloudRepoSourceContext denotes a particular revisi
on in a cloud repo (a repo hosted by the Google Cloud Platform).", | 521 "description": "Response for listing breakpoints.", |
| 561 "id": "CloudRepoSourceContext", | 522 "id": "ListBreakpointsResponse", |
| 562 "properties": { | 523 "properties": { |
| 563 "repoId": { | 524 "breakpoints": { |
| 564 "$ref": "RepoId", | 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.", |
| 565 "description": "The ID of the repo." | 526 "items": { |
| 527 "$ref": "Breakpoint" |
| 528 }, |
| 529 "type": "array" |
| 566 }, | 530 }, |
| 567 "revisionId": { | 531 "nextWaitToken": { |
| 568 "description": "A revision ID.", | 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.", |
| 533 "type": "string" |
| 534 } |
| 535 }, |
| 536 "type": "object" |
| 537 }, |
| 538 "Variable": { |
| 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.", |
| 540 "id": "Variable", |
| 541 "properties": { |
| 542 "varTableIndex": { |
| 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.", |
| 544 "format": "int32", |
| 545 "type": "integer" |
| 546 }, |
| 547 "status": { |
| 548 "$ref": "StatusMessage", |
| 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": { |
| 554 "$ref": "Variable" |
| 555 }, |
| 556 "type": "array" |
| 557 }, |
| 558 "name": { |
| 559 "description": "Name of the variable, if any.", |
| 560 "type": "string" |
| 561 }, |
| 562 "value": { |
| 563 "description": "Simple value of the variable.", |
| 564 "type": "string" |
| 565 }, |
| 566 "type": { |
| 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.", |
| 568 "type": "string" |
| 569 } |
| 570 }, |
| 571 "type": "object" |
| 572 }, |
| 573 "SourceLocation": { |
| 574 "description": "Represents a location in the source code.", |
| 575 "id": "SourceLocation", |
| 576 "properties": { |
| 577 "path": { |
| 578 "description": "Path to the source file within the source co
ntext of the target binary.", |
| 579 "type": "string" |
| 580 }, |
| 581 "line": { |
| 582 "description": "Line inside the file. The first line in the
file has the value `1`.", |
| 583 "format": "int32", |
| 584 "type": "integer" |
| 585 } |
| 586 }, |
| 587 "type": "object" |
| 588 }, |
| 589 "GerritSourceContext": { |
| 590 "description": "A SourceContext referring to a Gerrit project.", |
| 591 "id": "GerritSourceContext", |
| 592 "properties": { |
| 593 "hostUri": { |
| 594 "description": "The URI of a running Gerrit instance.", |
| 569 "type": "string" | 595 "type": "string" |
| 570 }, | 596 }, |
| 571 "aliasName": { | 597 "aliasName": { |
| 572 "description": "The name of an alias (branch, tag, etc.).", | 598 "description": "The name of an alias (branch, tag, etc.).", |
| 573 "type": "string" | 599 "type": "string" |
| 574 }, | 600 }, |
| 575 "aliasContext": { | 601 "aliasContext": { |
| 576 "$ref": "AliasContext", | 602 "$ref": "AliasContext", |
| 577 "description": "An alias, which may be a branch or tag." | 603 "description": "An alias, which may be a branch or tag." |
| 578 } | |
| 579 }, | |
| 580 "type": "object" | |
| 581 }, | |
| 582 "RepoId": { | |
| 583 "description": "A unique identifier for a cloud repo.", | |
| 584 "id": "RepoId", | |
| 585 "properties": { | |
| 586 "projectRepoId": { | |
| 587 "$ref": "ProjectRepoId", | |
| 588 "description": "A combination of a project ID and a repo nam
e." | |
| 589 }, | 604 }, |
| 590 "uid": { | 605 "gerritProject": { |
| 591 "description": "A server-assigned, globally unique identifie
r.", | 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.", |
| 607 "type": "string" |
| 608 }, |
| 609 "revisionId": { |
| 610 "description": "A revision (commit) ID.", |
| 592 "type": "string" | 611 "type": "string" |
| 593 } | 612 } |
| 594 }, | 613 }, |
| 595 "type": "object" | 614 "type": "object" |
| 596 }, | 615 }, |
| 597 "ProjectRepoId": { | 616 "FormatMessage": { |
| 598 "description": "Selects a repo using a Google Cloud Platform project
ID (e.g. winged-cargo-31) and a repo name within that project.", | 617 "description": "Represents a message with parameters.", |
| 599 "id": "ProjectRepoId", | 618 "id": "FormatMessage", |
| 600 "properties": { | 619 "properties": { |
| 601 "projectId": { | 620 "parameters": { |
| 602 "description": "The ID of the project.", | 621 "description": "Optional parameters to be embedded into the
message.", |
| 603 "type": "string" | 622 "items": { |
| 623 "type": "string" |
| 624 }, |
| 625 "type": "array" |
| 604 }, | 626 }, |
| 605 "repoName": { | 627 "format": { |
| 606 "description": "The name of the repo. Leave empty for the de
fault repo.", | 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.`", |
| 607 "type": "string" | 629 "type": "string" |
| 608 } | 630 } |
| 609 }, | 631 }, |
| 610 "type": "object" | 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" |
| 611 }, | 655 }, |
| 612 "AliasContext": { | 656 "AliasContext": { |
| 613 "description": "An alias to a repo revision.", | 657 "description": "An alias to a repo revision.", |
| 614 "id": "AliasContext", | 658 "id": "AliasContext", |
| 615 "properties": { | 659 "properties": { |
| 616 "kind": { | 660 "kind": { |
| 617 "description": "The alias kind.", | 661 "description": "The alias kind.", |
| 618 "enum": [ | 662 "enum": [ |
| 619 "ANY", | 663 "ANY", |
| 620 "FIXED", | 664 "FIXED", |
| 621 "MOVABLE", | 665 "MOVABLE", |
| 622 "OTHER" | 666 "OTHER" |
| 623 ], | 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 ], |
| 624 "type": "string" | 674 "type": "string" |
| 625 }, | 675 }, |
| 626 "name": { | 676 "name": { |
| 627 "description": "The alias name.", | 677 "description": "The alias name.", |
| 628 "type": "string" | 678 "type": "string" |
| 629 } | 679 } |
| 630 }, | 680 }, |
| 631 "type": "object" | 681 "type": "object" |
| 632 }, | 682 }, |
| 633 "CloudWorkspaceSourceContext": { | |
| 634 "description": "A CloudWorkspaceSourceContext denotes a workspace at
a particular snapshot.", | |
| 635 "id": "CloudWorkspaceSourceContext", | |
| 636 "properties": { | |
| 637 "workspaceId": { | |
| 638 "$ref": "CloudWorkspaceId", | |
| 639 "description": "The ID of the workspace." | |
| 640 }, | |
| 641 "snapshotId": { | |
| 642 "description": "The ID of the snapshot. An empty snapshot_id
refers to the most recent snapshot.", | |
| 643 "type": "string" | |
| 644 } | |
| 645 }, | |
| 646 "type": "object" | |
| 647 }, | |
| 648 "CloudWorkspaceId": { | 683 "CloudWorkspaceId": { |
| 649 "description": "A CloudWorkspaceId is a unique identifier for a clou
d workspace. A cloud workspace is a place associated with a repo where modified
files can be stored before they are committed.", | 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.", |
| 650 "id": "CloudWorkspaceId", | 685 "id": "CloudWorkspaceId", |
| 651 "properties": { | 686 "properties": { |
| 652 "repoId": { | 687 "repoId": { |
| 653 "$ref": "RepoId", | 688 "$ref": "RepoId", |
| 654 "description": "The ID of the repo containing the workspace.
" | 689 "description": "The ID of the repo containing the workspace.
" |
| 655 }, | 690 }, |
| 656 "name": { | 691 "name": { |
| 657 "description": "The unique name of the workspace within the
repo. This is the name chosen by the client in the Source API's CreateWorkspace
method.", | 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.", |
| 658 "type": "string" | 693 "type": "string" |
| 659 } | 694 } |
| 660 }, | 695 }, |
| 661 "type": "object" | 696 "type": "object" |
| 662 }, | 697 }, |
| 663 "GerritSourceContext": { | |
| 664 "description": "A SourceContext referring to a Gerrit project.", | |
| 665 "id": "GerritSourceContext", | |
| 666 "properties": { | |
| 667 "hostUri": { | |
| 668 "description": "The URI of a running Gerrit instance.", | |
| 669 "type": "string" | |
| 670 }, | |
| 671 "gerritProject": { | |
| 672 "description": "The full project name within the host. Proje
cts may be nested, so \"project/subproject\" is a valid project name. The \"repo
name\" is hostURI/project.", | |
| 673 "type": "string" | |
| 674 }, | |
| 675 "revisionId": { | |
| 676 "description": "A revision (commit) ID.", | |
| 677 "type": "string" | |
| 678 }, | |
| 679 "aliasName": { | |
| 680 "description": "The name of an alias (branch, tag, etc.).", | |
| 681 "type": "string" | |
| 682 }, | |
| 683 "aliasContext": { | |
| 684 "$ref": "AliasContext", | |
| 685 "description": "An alias, which may be a branch or tag." | |
| 686 } | |
| 687 }, | |
| 688 "type": "object" | |
| 689 }, | |
| 690 "GitSourceContext": { | |
| 691 "description": "A GitSourceContext denotes a particular revision in
a third party Git repository (e.g. GitHub).", | |
| 692 "id": "GitSourceContext", | |
| 693 "properties": { | |
| 694 "url": { | |
| 695 "description": "Git repository URL.", | |
| 696 "type": "string" | |
| 697 }, | |
| 698 "revisionId": { | |
| 699 "description": "Git commit hash. required.", | |
| 700 "type": "string" | |
| 701 } | |
| 702 }, | |
| 703 "type": "object" | |
| 704 }, | |
| 705 "ExtendedSourceContext": { | |
| 706 "description": "An ExtendedSourceContext is a SourceContext combined
with additional details describing the context.", | |
| 707 "id": "ExtendedSourceContext", | |
| 708 "properties": { | |
| 709 "context": { | |
| 710 "$ref": "SourceContext", | |
| 711 "description": "Any source context." | |
| 712 }, | |
| 713 "labels": { | |
| 714 "additionalProperties": { | |
| 715 "type": "string" | |
| 716 }, | |
| 717 "description": "Labels with user defined metadata.", | |
| 718 "type": "object" | |
| 719 } | |
| 720 }, | |
| 721 "type": "object" | |
| 722 }, | |
| 723 "RegisterDebuggeeResponse": { | |
| 724 "description": "Response for registering a debuggee.", | |
| 725 "id": "RegisterDebuggeeResponse", | |
| 726 "properties": { | |
| 727 "debuggee": { | |
| 728 "$ref": "Debuggee", | |
| 729 "description": "Debuggee resource. The field `id` is gurante
ed to be set (in addition to the echoed fields)." | |
| 730 } | |
| 731 }, | |
| 732 "type": "object" | |
| 733 }, | |
| 734 "ListActiveBreakpointsResponse": { | |
| 735 "description": "Response for listing active breakpoints.", | |
| 736 "id": "ListActiveBreakpointsResponse", | |
| 737 "properties": { | |
| 738 "breakpoints": { | |
| 739 "description": "List of all active breakpoints. The fields `
id` and `location` are guaranteed to be set on each breakpoint.", | |
| 740 "items": { | |
| 741 "$ref": "Breakpoint" | |
| 742 }, | |
| 743 "type": "array" | |
| 744 }, | |
| 745 "nextWaitToken": { | |
| 746 "description": "A wait token that can be used in the next me
thod call to block until the list of breakpoints changes.", | |
| 747 "type": "string" | |
| 748 }, | |
| 749 "waitExpired": { | |
| 750 "description": "The `wait_expired` field is set to true by t
he server when the request times out and the field `success_on_timeout` is set t
o true.", | |
| 751 "type": "boolean" | |
| 752 } | |
| 753 }, | |
| 754 "type": "object" | |
| 755 }, | |
| 756 "Breakpoint": { | 698 "Breakpoint": { |
| 757 "description": "Represents the breakpoint specification, status and
results.", | 699 "description": "Represents the breakpoint specification, status and
results.", |
| 758 "id": "Breakpoint", | 700 "id": "Breakpoint", |
| 759 "properties": { | 701 "properties": { |
| 760 "id": { | 702 "id": { |
| 761 "description": "Breakpoint identifier, unique in the scope o
f the debuggee.", | 703 "description": "Breakpoint identifier, unique in the scope o
f the debuggee.", |
| 762 "type": "string" | 704 "type": "string" |
| 763 }, | 705 }, |
| 764 "action": { | 706 "stackFrames": { |
| 765 "description": "Action that the agent should perform when th
e code at the breakpoint location is hit.", | 707 "description": "The stack at breakpoint time.", |
| 766 "enum": [ | 708 "items": { |
| 767 "CAPTURE", | 709 "$ref": "StackFrame" |
| 768 "LOG" | 710 }, |
| 769 ], | 711 "type": "array" |
| 770 "type": "string" | |
| 771 }, | 712 }, |
| 772 "location": { | 713 "location": { |
| 773 "$ref": "SourceLocation", | 714 "$ref": "SourceLocation", |
| 774 "description": "Breakpoint source location." | 715 "description": "Breakpoint source location." |
| 775 }, | 716 }, |
| 776 "condition": { | 717 "status": { |
| 777 "description": "Condition that triggers the breakpoint. The
condition is a compound boolean expression composed using expressions in a progr
amming language at the source location.", | 718 "$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" |
| 720 }, |
| 721 "userEmail": { |
| 722 "description": "E-mail address of the user that created this
breakpoint", |
| 778 "type": "string" | 723 "type": "string" |
| 779 }, | 724 }, |
| 780 "expressions": { | 725 "condition": { |
| 781 "description": "List of read-only expressions to evaluate at
the breakpoint location. The expressions are composed using expressions in the
programming language at the source location. If the breakpoint action is `LOG`,
the evaluated expressions are included in log statements.", | 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.", |
| 782 "items": { | 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": { |
| 735 "description": "Action that the agent should perform when th
e code at the\nbreakpoint location is hit.", |
| 736 "enum": [ |
| 737 "CAPTURE", |
| 738 "LOG" |
| 739 ], |
| 740 "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.", |
| 742 "Log each breakpoint hit. The breakpoint remains active
until\ndeleted or expired." |
| 743 ], |
| 744 "type": "string" |
| 745 }, |
| 746 "labels": { |
| 747 "additionalProperties": { |
| 783 "type": "string" | 748 "type": "string" |
| 784 }, | 749 }, |
| 785 "type": "array" | 750 "description": "A set of custom breakpoint properties, popul
ated by the agent, to be\ndisplayed to the user.", |
| 751 "type": "object" |
| 786 }, | 752 }, |
| 787 "logMessageFormat": { | 753 "logMessageFormat": { |
| 788 "description": "Only relevant when action is `LOG`. Defines
the message to log when the breakpoint hits. The message may include parameter p
laceholders `$0`, `$1`, etc. These placeholders are replaced with the evaluated
value of the appropriate expression. Expressions not referenced in `log_message_
format` are not logged. Example: `Message received, id = $0, count = $1` with `e
xpressions` = `[ message.id, message.count ]`.", | 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", |
| 789 "type": "string" | 760 "type": "string" |
| 790 }, | 761 }, |
| 791 "logLevel": { | 762 "logLevel": { |
| 792 "description": "Indicates the severity of the log. Only rele
vant when action is `LOG`.", | 763 "description": "Indicates the severity of the log. Only rele
vant when action is `LOG`.", |
| 793 "enum": [ | 764 "enum": [ |
| 794 "INFO", | 765 "INFO", |
| 795 "WARNING", | 766 "WARNING", |
| 796 "ERROR" | 767 "ERROR" |
| 797 ], | 768 ], |
| 798 "type": "string" | 769 "enumDescriptions": [ |
| 770 "Information log message.", |
| 771 "Warning log message.", |
| 772 "Error log message." |
| 773 ], |
| 774 "type": "string" |
| 775 }, |
| 776 "evaluatedExpressions": { |
| 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.", |
| 778 "items": { |
| 779 "$ref": "Variable" |
| 780 }, |
| 781 "type": "array" |
| 799 }, | 782 }, |
| 800 "isFinalState": { | 783 "isFinalState": { |
| 801 "description": "When true, indicates that this is a final re
sult and the breakpoint state will not change from here on.", | 784 "description": "When true, indicates that this is a final re
sult and the\nbreakpoint state will not change from here on.", |
| 802 "type": "boolean" | 785 "type": "boolean" |
| 803 }, | 786 }, |
| 804 "createTime": { | 787 "expressions": { |
| 805 "description": "Time this breakpoint was created by the serv
er in seconds resolution.", | 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.", |
| 806 "type": "string" | 789 "items": { |
| 807 }, | 790 "type": "string" |
| 808 "finalTime": { | 791 }, |
| 809 "description": "Time this breakpoint was finalized as seen b
y the server in seconds resolution.", | 792 "type": "array" |
| 810 "type": "string" | 793 }, |
| 811 }, | 794 "variableTable": { |
| 812 "userEmail": { | 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.", |
| 813 "description": "E-mail address of the user that created this
breakpoint", | |
| 814 "type": "string" | |
| 815 }, | |
| 816 "status": { | |
| 817 "$ref": "StatusMessage", | |
| 818 "description": "Breakpoint status. The status includes an er
ror flag and a human readable message. This field is usually unset. The message
can be either informational or an error message. Regardless, clients should alwa
ys display the text message back to the user. Error status indicates complete fa
ilure of the breakpoint. Example (non-final state): `Still loading symbols...` E
xamples (final state): * `Invalid line number` referring to location * `Field f
not found in class C` referring to condition" | |
| 819 }, | |
| 820 "stackFrames": { | |
| 821 "description": "The stack at breakpoint time.", | |
| 822 "items": { | |
| 823 "$ref": "StackFrame" | |
| 824 }, | |
| 825 "type": "array" | |
| 826 }, | |
| 827 "evaluatedExpressions": { | |
| 828 "description": "Values of evaluated expressions at breakpoin
t time. The evaluated expressions appear in exactly the same order they are list
ed in the `expressions` field. The `name` field holds the original expression te
xt, the `value` or `members` field holds the result of the evaluated expression.
If the expression cannot be evaluated, the `status` inside the `Variable` will
indicate an error and contain the error text.", | |
| 829 "items": { | 796 "items": { |
| 830 "$ref": "Variable" | 797 "$ref": "Variable" |
| 831 }, | 798 }, |
| 832 "type": "array" | 799 "type": "array" |
| 833 }, | 800 } |
| 834 "variableTable": { | 801 }, |
| 835 "description": "The `variable_table` exists to aid with comp
utation, memory and network traffic optimization. It enables storing a variable
once and reference it from multiple variables, including variables stored in the
`variable_table` itself. For example, the same `this` object, which may appear
at many levels of the stack, can have all of its data stored once in this table.
The stack frame variables then would hold only a reference to it. The variable
`var_table_index` field is an index into this repeated field. The stored objects
are nameless and get their name from the referencing variable. The effective va
riable is a merge of the referencing variable and the referenced variable.", | 802 "type": "object" |
| 836 "items": { | 803 }, |
| 837 "$ref": "Variable" | 804 "SetBreakpointResponse": { |
| 838 }, | 805 "description": "Response for setting a breakpoint.", |
| 839 "type": "array" | 806 "id": "SetBreakpointResponse", |
| 840 }, | 807 "properties": { |
| 808 "breakpoint": { |
| 809 "$ref": "Breakpoint", |
| 810 "description": "Breakpoint resource.\nThe field `id` is guar
anteed to be set (in addition to the echoed fileds)." |
| 811 } |
| 812 }, |
| 813 "type": "object" |
| 814 }, |
| 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": { | 841 "labels": { |
| 842 "additionalProperties": { | 842 "additionalProperties": { |
| 843 "type": "string" | 843 "type": "string" |
| 844 }, | 844 }, |
| 845 "description": "A set of custom breakpoint properties, popul
ated by the agent, to be displayed to the user.", | 845 "description": "Labels with user defined metadata.", |
| 846 "type": "object" | 846 "type": "object" |
| 847 } | 847 }, |
| 848 }, | 848 "context": { |
| 849 "type": "object" | 849 "$ref": "SourceContext", |
| 850 }, | 850 "description": "Any source context." |
| 851 "SourceLocation": { | 851 } |
| 852 "description": "Represents a location in the source code.", | 852 }, |
| 853 "id": "SourceLocation", | 853 "type": "object" |
| 854 "properties": { | 854 }, |
| 855 "path": { | 855 "RegisterDebuggeeRequest": { |
| 856 "description": "Path to the source file within the source co
ntext of the target binary.", | 856 "description": "Request to register a debuggee.", |
| 857 "type": "string" | 857 "id": "RegisterDebuggeeRequest", |
| 858 }, | 858 "properties": { |
| 859 "line": { | 859 "debuggee": { |
| 860 "description": "Line inside the file. The first line in the
file has the value `1`.", | 860 "$ref": "Debuggee", |
| 861 "format": "int32", | 861 "description": "Debuggee information to register.\nThe field
s `project`, `uniquifier`, `description` and `agent_version`\nof the debuggee mu
st be set." |
| 862 "type": "integer" | 862 } |
| 863 } | 863 }, |
| 864 }, | 864 "type": "object" |
| 865 "type": "object" | 865 }, |
| 866 }, | 866 "RepoId": { |
| 867 "StackFrame": { | 867 "description": "A unique identifier for a cloud repo.", |
| 868 "description": "Represents a stack frame context.", | 868 "id": "RepoId", |
| 869 "id": "StackFrame", | 869 "properties": { |
| 870 "properties": { | 870 "projectRepoId": { |
| 871 "function": { | 871 "$ref": "ProjectRepoId", |
| 872 "description": "Demangled function name at the call site.", | 872 "description": "A combination of a project ID and a repo nam
e." |
| 873 "type": "string" | 873 }, |
| 874 }, | 874 "uid": { |
| 875 "location": { | 875 "description": "A server-assigned, globally unique identifie
r.", |
| 876 "$ref": "SourceLocation", | 876 "type": "string" |
| 877 "description": "Source location of the call site." | 877 } |
| 878 }, | 878 }, |
| 879 "arguments": { | 879 "type": "object" |
| 880 "description": "Set of arguments passed to this function. No
te that this might not be populated for all stack frames.", | 880 }, |
| 881 "items": { | 881 "ProjectRepoId": { |
| 882 "$ref": "Variable" | 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 }, | 883 "id": "ProjectRepoId", |
| 884 "type": "array" | 884 "properties": { |
| 885 }, | 885 "repoName": { |
| 886 "locals": { | 886 "description": "The name of the repo. Leave empty for the de
fault repo.", |
| 887 "description": "Set of local variables at the stack frame lo
cation. Note that this might not be populated for all stack frames.", | 887 "type": "string" |
| 888 "items": { | 888 }, |
| 889 "$ref": "Variable" | 889 "projectId": { |
| 890 }, | 890 "description": "The ID of the project.", |
| 891 "type": "array" | 891 "type": "string" |
| 892 } | 892 } |
| 893 }, | 893 }, |
| 894 "type": "object" | 894 "type": "object" |
| 895 }, | 895 }, |
| 896 "Variable": { | 896 "CloudWorkspaceSourceContext": { |
| 897 "description": "Represents a variable or an argument possibly of a c
ompound object type. Note how the following variables are represented: 1) A simp
le variable: int x = 5 { name: \"x\", value: \"5\", type: \"int\" } // Captured
variable 2) A compound object: struct T { int m1; int m2; }; T x = { 3, 7 }; { /
/ Captured variable name: \"x\", type: \"T\", members { name: \"m1\", value: \"3
\", type: \"int\" }, members { name: \"m2\", value: \"7\", type: \"int\" } } 3)
A pointer where the pointee was captured: T x = { 3, 7 }; T* p = &x; { // Captur
ed variable name: \"p\", type: \"T*\", value: \"0x00500500\", members { name: \"
m1\", value: \"3\", type: \"int\" }, members { name: \"m2\", value: \"7\", type:
\"int\" } } 4) A pointer where the pointee was not captured: T* p = new T; { //
Captured variable name: \"p\", type: \"T*\", value: \"0x00400400\" status { is_
error: true, description { format: \"unavailable\" } } } The status should descr
ibe the reason for the missing value, such as ``, ``, `\n`. Note that a null poi
nter should not have members. 5) An unnamed value: int* p = new int(7); { // Cap
tured variable name: \"p\", value: \"0x00500500\", type: \"int*\", members { val
ue: \"7\", type: \"int\" } } 6) An unnamed pointer where the pointee was not cap
tured: int* p = new int(7); int** pp = &p; { // Captured variable name: \"pp\",
value: \"0x00500500\", type: \"int**\", members { value: \"0x00400400\", type: \
"int*\" status { is_error: true, description: { format: \"unavailable\" } } } }
} To optimize computation, memory and network traffic, variables that repeat in
the output multiple times can be stored once in a shared variable table and be r
eferenced using the `var_table_index` field. The variables stored in the shared
table are nameless and are essentially a partition of the complete variable. To
reconstruct the complete variable, merge the referencing variable with the refer
enced variable. When using the shared variable table, the following variables: T
x = { 3, 7 }; T* p = &x; T& r = x; { name: \"x\", var_table_index: 3, type: \"T
\" } // Captured variables { name: \"p\", value \"0x00500500\", type=\"T*\", var
_table_index: 3 } { name: \"r\", type=\"T&\", var_table_index: 3 } { // Shared v
ariable table entry #3: members { name: \"m1\", value: \"3\", type: \"int\" }, m
embers { name: \"m2\", value: \"7\", type: \"int\" } } Note that the pointer add
ress is stored with the referencing variable and not with the referenced variabl
e. This allows the referenced variable to be shared between pointers and referen
ces. The type field is optional. The debugger agent may or may not support it.", | 897 "description": "A CloudWorkspaceSourceContext denotes a workspace at
a particular snapshot.", |
| 898 "id": "Variable", | 898 "id": "CloudWorkspaceSourceContext", |
| 899 "properties": { | 899 "properties": { |
| 900 "name": { | 900 "snapshotId": { |
| 901 "description": "Name of the variable, if any.", | 901 "description": "The ID of the snapshot.\nAn empty snapshot_i
d refers to the most recent snapshot.", |
| 902 "type": "string" | 902 "type": "string" |
| 903 }, | 903 }, |
| 904 "value": { | 904 "workspaceId": { |
| 905 "description": "Simple value of the variable.", | 905 "$ref": "CloudWorkspaceId", |
| 906 "type": "string" | 906 "description": "The ID of the workspace." |
| 907 }, | 907 } |
| 908 "type": { | 908 }, |
| 909 "description": "Variable type (e.g. `MyClass`). If the varia
ble is split with `var_table_index`, `type` goes next to `value`. The interpreta
tion of a type is agent specific. It is recommended to include the dynamic type
rather than a static type of an object.", | 909 "type": "object" |
| 910 "type": "string" | 910 }, |
| 911 }, | 911 "ListDebuggeesResponse": { |
| 912 "members": { | 912 "description": "Response for listing debuggees.", |
| 913 "description": "Members contained or pointed to by the varia
ble.", | 913 "id": "ListDebuggeesResponse", |
| 914 "items": { | 914 "properties": { |
| 915 "$ref": "Variable" | 915 "debuggees": { |
| 916 }, | 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 "type": "array" | 917 "items": { |
| 918 }, | 918 "$ref": "Debuggee" |
| 919 "varTableIndex": { | 919 }, |
| 920 "description": "Reference to a variable in the shared variab
le table. More than one variable can reference the same variable in the table. T
he `var_table_index` field is an index into `variable_table` in Breakpoint.", | 920 "type": "array" |
| 921 "format": "int32", | 921 } |
| 922 "type": "integer" | 922 }, |
| 923 }, | 923 "type": "object" |
| 924 "status": { | 924 }, |
| 925 "$ref": "StatusMessage", | 925 "CloudRepoSourceContext": { |
| 926 "description": "Status associated with the variable. This fi
eld will usually stay unset. A status of a single variable only applies to that
variable or expression. The rest of breakpoint data still remains valid. Variabl
es might be reported in error state even when breakpoint is not in final state.
The message may refer to variable name with `refers_to` set to `VARIABLE_NAME`.
Alternatively `refers_to` will be set to `VARIABLE_VALUE`. In either case variab
le value and members will be unset. Example of error message applied to name: `I
nvalid expression syntax`. Example of information message applied to value: `Not
captured`. Examples of error message applied to value: * `Malformed string`, *
`Field f not found in class C` * `Null pointer dereference`" | 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" |
| 927 } | 944 } |
| 928 }, | 945 }, |
| 929 "type": "object" | 946 "type": "object" |
| 930 }, | 947 }, |
| 931 "UpdateActiveBreakpointRequest": { | 948 "UpdateActiveBreakpointRequest": { |
| 932 "description": "Request to update an active breakpoint.", | 949 "description": "Request to update an active breakpoint.", |
| 933 "id": "UpdateActiveBreakpointRequest", | 950 "id": "UpdateActiveBreakpointRequest", |
| 934 "properties": { | 951 "properties": { |
| 935 "breakpoint": { | 952 "breakpoint": { |
| 936 "$ref": "Breakpoint", | 953 "$ref": "Breakpoint", |
| 937 "description": "Updated breakpoint information. The field 'i
d' must be set." | 954 "description": "Updated breakpoint information.\nThe field '
id' must be set." |
| 955 } |
| 956 }, |
| 957 "type": "object" |
| 958 }, |
| 959 "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.", |
| 961 "id": "SourceContext", |
| 962 "properties": { |
| 963 "cloudRepo": { |
| 964 "$ref": "CloudRepoSourceContext", |
| 965 "description": "A SourceContext referring to a revision in a
cloud repo." |
| 966 }, |
| 967 "cloudWorkspace": { |
| 968 "$ref": "CloudWorkspaceSourceContext", |
| 969 "description": "A SourceContext referring to a snapshot in a
cloud workspace." |
| 970 }, |
| 971 "git": { |
| 972 "$ref": "GitSourceContext", |
| 973 "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 } |
| 979 }, |
| 980 "type": "object" |
| 981 }, |
| 982 "Empty": { |
| 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 `{}`.", |
| 984 "id": "Empty", |
| 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": { |
| 992 "url": { |
| 993 "description": "Git repository URL.", |
| 994 "type": "string" |
| 995 }, |
| 996 "revisionId": { |
| 997 "description": "Git commit hash.\nrequired.", |
| 998 "type": "string" |
| 999 } |
| 1000 }, |
| 1001 "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" |
| 938 } | 1036 } |
| 939 }, | 1037 }, |
| 940 "type": "object" | 1038 "type": "object" |
| 941 }, | 1039 }, |
| 942 "UpdateActiveBreakpointResponse": { | 1040 "UpdateActiveBreakpointResponse": { |
| 943 "description": "Response for updating an active breakpoint. The mess
age is defined to allow future extensions.", | 1041 "description": "Response for updating an active breakpoint.\nThe mes
sage is defined to allow future extensions.", |
| 944 "id": "UpdateActiveBreakpointResponse", | 1042 "id": "UpdateActiveBreakpointResponse", |
| 945 "type": "object" | 1043 "properties": {}, |
| 946 }, | |
| 947 "SetBreakpointResponse": { | |
| 948 "description": "Response for setting a breakpoint.", | |
| 949 "id": "SetBreakpointResponse", | |
| 950 "properties": { | |
| 951 "breakpoint": { | |
| 952 "$ref": "Breakpoint", | |
| 953 "description": "Breakpoint resource. The field `id` is guara
nteed to be set (in addition to the echoed fileds)." | |
| 954 } | |
| 955 }, | |
| 956 "type": "object" | |
| 957 }, | |
| 958 "GetBreakpointResponse": { | |
| 959 "description": "Response for getting breakpoint information.", | |
| 960 "id": "GetBreakpointResponse", | |
| 961 "properties": { | |
| 962 "breakpoint": { | |
| 963 "$ref": "Breakpoint", | |
| 964 "description": "Complete breakpoint state. The fields `id` a
nd `location` are guaranteed to be set." | |
| 965 } | |
| 966 }, | |
| 967 "type": "object" | |
| 968 }, | |
| 969 "Empty": { | |
| 970 "description": "A generic empty message that you can re-use to avoid
defining duplicated empty messages in your APIs. A typical example is to use it
as the request or the response type of an API method. For instance: service Foo
{ rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON re
presentation for `Empty` is empty JSON object `{}`.", | |
| 971 "id": "Empty", | |
| 972 "type": "object" | |
| 973 }, | |
| 974 "ListBreakpointsResponse": { | |
| 975 "description": "Response for listing breakpoints.", | |
| 976 "id": "ListBreakpointsResponse", | |
| 977 "properties": { | |
| 978 "breakpoints": { | |
| 979 "description": "List of all breakpoints with complete state.
The fields `id` and `location` are guaranteed to be set on each breakpoint.", | |
| 980 "items": { | |
| 981 "$ref": "Breakpoint" | |
| 982 }, | |
| 983 "type": "array" | |
| 984 }, | |
| 985 "nextWaitToken": { | |
| 986 "description": "A wait token that can be used in the next ca
ll to `list` (REST) or `ListBreakpoints` (RPC) to block until the list of breakp
oints has changes.", | |
| 987 "type": "string" | |
| 988 } | |
| 989 }, | |
| 990 "type": "object" | |
| 991 }, | |
| 992 "ListDebuggeesResponse": { | |
| 993 "description": "Response for listing debuggees.", | |
| 994 "id": "ListDebuggeesResponse", | |
| 995 "properties": { | |
| 996 "debuggees": { | |
| 997 "description": "List of debuggees accessible to the calling
user. Note that the `description` field is the only human readable field that sh
ould be displayed to the user. The fields `debuggee.id` and `description` fields
are guaranteed to be set on each debuggee.", | |
| 998 "items": { | |
| 999 "$ref": "Debuggee" | |
| 1000 }, | |
| 1001 "type": "array" | |
| 1002 } | |
| 1003 }, | |
| 1004 "type": "object" | 1044 "type": "object" |
| 1005 } | 1045 } |
| 1006 }, | 1046 }, |
| 1007 "servicePath": "", | 1047 "servicePath": "", |
| 1008 "title": "Stackdriver Debugger API", | 1048 "title": "Stackdriver Debugger API", |
| 1009 "version": "v2" | 1049 "version": "v2" |
| 1010 } | 1050 } |
| OLD | NEW |