1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="clouddebugger_v2.html">Stackdriver Debugger API</a> . <a href="clouddebugger_v2.controller.html">controller</a> . <a href="clouddebugger_v2.controller.debuggees.html">debuggees</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="clouddebugger_v2.controller.debuggees.breakpoints.html">breakpoints()</a></code> 79</p> 80<p class="firstline">Returns the breakpoints Resource.</p> 81 82<p class="toc_element"> 83 <code><a href="#register">register(body, x__xgafv=None)</a></code></p> 84<p class="firstline">Registers the debuggee with the controller service.</p> 85<h3>Method Details</h3> 86<div class="method"> 87 <code class="details" id="register">register(body, x__xgafv=None)</code> 88 <pre>Registers the debuggee with the controller service. 89 90All agents attached to the same application must call this method with 91exactly the same request content to get back the same stable `debuggee_id`. 92Agents should call this method again whenever `google.rpc.Code.NOT_FOUND` 93is returned from any controller method. 94 95This protocol allows the controller service to disable debuggees, recover 96from data loss, or change the `debuggee_id` format. Agents must handle 97`debuggee_id` value changing upon re-registration. 98 99Args: 100 body: object, The request body. (required) 101 The object takes the form of: 102 103{ # Request to register a debuggee. 104 "debuggee": { # Represents the debugged application. The application may include one or more # Debuggee information to register. 105 # The fields `project`, `uniquifier`, `description` and `agent_version` 106 # of the debuggee must be set. 107 # replicated processes executing the same code. Each of these processes is 108 # attached with a debugger agent, carrying out the debugging commands. 109 # Agents attached to the same debuggee identify themselves as such by using 110 # exactly the same Debuggee message value when registering. 111 "status": { # Represents a contextual status message. # Human readable message to be displayed to the user about this debuggee. 112 # Absence of this field indicates no status. The message can be either 113 # informational or an error status. 114 # The message can indicate an error or informational status, and refer to 115 # specific parts of the containing object. 116 # For example, the `Breakpoint.status` field can indicate an error referring 117 # to the `BREAKPOINT_SOURCE_LOCATION` with the message `Location not found`. 118 "isError": True or False, # Distinguishes errors from informational messages. 119 "refersTo": "A String", # Reference to which the message applies. 120 "description": { # Represents a message with parameters. # Status message text. 121 "parameters": [ # Optional parameters to be embedded into the message. 122 "A String", 123 ], 124 "format": "A String", # Format template for the message. The `format` uses placeholders `$0`, 125 # `$1`, etc. to reference parameters. `$$` can be used to denote the `$` 126 # character. 127 # 128 # Examples: 129 # 130 # * `Failed to load '$0' which helps debug $1 the first time it 131 # is loaded. Again, $0 is very important.` 132 # * `Please pay $$10 to use $0 instead of $1.` 133 }, 134 }, 135 "description": "A String", # Human readable description of the debuggee. 136 # Including a human-readable project name, environment name and version 137 # information is recommended. 138 "isDisabled": True or False, # If set to `true`, indicates that the agent should disable itself and 139 # detach from the debuggee. 140 "labels": { # A set of custom debuggee properties, populated by the agent, to be 141 # displayed to the user. 142 "a_key": "A String", 143 }, 144 "uniquifier": "A String", # Uniquifier to further distinguish the application. 145 # It is possible that different applications might have identical values in 146 # the debuggee message, thus, incorrectly identified as a single application 147 # by the Controller service. This field adds salt to further distinguish the 148 # application. Agents should consider seeding this field with value that 149 # identifies the code, binary, configuration and environment. 150 "project": "A String", # Project the debuggee is associated with. 151 # Use project number or id when registering a Google Cloud Platform project. 152 "sourceContexts": [ # References to the locations and revisions of the source code used in the 153 # deployed application. 154 { # A SourceContext is a reference to a tree of files. A SourceContext together 155 # with a path point to a unique revision of a single file or directory. 156 "cloudWorkspace": { # A CloudWorkspaceSourceContext denotes a workspace at a particular snapshot. # A SourceContext referring to a snapshot in a cloud workspace. 157 "snapshotId": "A String", # The ID of the snapshot. 158 # An empty snapshot_id refers to the most recent snapshot. 159 "workspaceId": { # A CloudWorkspaceId is a unique identifier for a cloud workspace. # The ID of the workspace. 160 # A cloud workspace is a place associated with a repo where modified files 161 # can be stored before they are committed. 162 "name": "A String", # The unique name of the workspace within the repo. This is the name 163 # chosen by the client in the Source API's CreateWorkspace method. 164 "repoId": { # A unique identifier for a cloud repo. # The ID of the repo containing the workspace. 165 "uid": "A String", # A server-assigned, globally unique identifier. 166 "projectRepoId": { # Selects a repo using a Google Cloud Platform project ID # A combination of a project ID and a repo name. 167 # (e.g. winged-cargo-31) and a repo name within that project. 168 "projectId": "A String", # The ID of the project. 169 "repoName": "A String", # The name of the repo. Leave empty for the default repo. 170 }, 171 }, 172 }, 173 }, 174 "cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a cloud # A SourceContext referring to a revision in a cloud repo. 175 # repo (a repo hosted by the Google Cloud Platform). 176 "aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag. 177 "kind": "A String", # The alias kind. 178 "name": "A String", # The alias name. 179 }, 180 "revisionId": "A String", # A revision ID. 181 "aliasName": "A String", # The name of an alias (branch, tag, etc.). 182 "repoId": { # A unique identifier for a cloud repo. # The ID of the repo. 183 "uid": "A String", # A server-assigned, globally unique identifier. 184 "projectRepoId": { # Selects a repo using a Google Cloud Platform project ID # A combination of a project ID and a repo name. 185 # (e.g. winged-cargo-31) and a repo name within that project. 186 "projectId": "A String", # The ID of the project. 187 "repoName": "A String", # The name of the repo. Leave empty for the default repo. 188 }, 189 }, 190 }, 191 "git": { # A GitSourceContext denotes a particular revision in a third party Git # A SourceContext referring to any third party Git repo (e.g. GitHub). 192 # repository (e.g. GitHub). 193 "url": "A String", # Git repository URL. 194 "revisionId": "A String", # Git commit hash. 195 # required. 196 }, 197 "gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project. 198 "aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag. 199 "kind": "A String", # The alias kind. 200 "name": "A String", # The alias name. 201 }, 202 "revisionId": "A String", # A revision (commit) ID. 203 "gerritProject": "A String", # The full project name within the host. Projects may be nested, so 204 # "project/subproject" is a valid project name. 205 # The "repo name" is hostURI/project. 206 "hostUri": "A String", # The URI of a running Gerrit instance. 207 "aliasName": "A String", # The name of an alias (branch, tag, etc.). 208 }, 209 }, 210 ], 211 "extSourceContexts": [ # References to the locations and revisions of the source code used in the 212 # deployed application. 213 { # An ExtendedSourceContext is a SourceContext combined with additional 214 # details describing the context. 215 "labels": { # Labels with user defined metadata. 216 "a_key": "A String", 217 }, 218 "context": { # A SourceContext is a reference to a tree of files. A SourceContext together # Any source context. 219 # with a path point to a unique revision of a single file or directory. 220 "cloudWorkspace": { # A CloudWorkspaceSourceContext denotes a workspace at a particular snapshot. # A SourceContext referring to a snapshot in a cloud workspace. 221 "snapshotId": "A String", # The ID of the snapshot. 222 # An empty snapshot_id refers to the most recent snapshot. 223 "workspaceId": { # A CloudWorkspaceId is a unique identifier for a cloud workspace. # The ID of the workspace. 224 # A cloud workspace is a place associated with a repo where modified files 225 # can be stored before they are committed. 226 "name": "A String", # The unique name of the workspace within the repo. This is the name 227 # chosen by the client in the Source API's CreateWorkspace method. 228 "repoId": { # A unique identifier for a cloud repo. # The ID of the repo containing the workspace. 229 "uid": "A String", # A server-assigned, globally unique identifier. 230 "projectRepoId": { # Selects a repo using a Google Cloud Platform project ID # A combination of a project ID and a repo name. 231 # (e.g. winged-cargo-31) and a repo name within that project. 232 "projectId": "A String", # The ID of the project. 233 "repoName": "A String", # The name of the repo. Leave empty for the default repo. 234 }, 235 }, 236 }, 237 }, 238 "cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a cloud # A SourceContext referring to a revision in a cloud repo. 239 # repo (a repo hosted by the Google Cloud Platform). 240 "aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag. 241 "kind": "A String", # The alias kind. 242 "name": "A String", # The alias name. 243 }, 244 "revisionId": "A String", # A revision ID. 245 "aliasName": "A String", # The name of an alias (branch, tag, etc.). 246 "repoId": { # A unique identifier for a cloud repo. # The ID of the repo. 247 "uid": "A String", # A server-assigned, globally unique identifier. 248 "projectRepoId": { # Selects a repo using a Google Cloud Platform project ID # A combination of a project ID and a repo name. 249 # (e.g. winged-cargo-31) and a repo name within that project. 250 "projectId": "A String", # The ID of the project. 251 "repoName": "A String", # The name of the repo. Leave empty for the default repo. 252 }, 253 }, 254 }, 255 "git": { # A GitSourceContext denotes a particular revision in a third party Git # A SourceContext referring to any third party Git repo (e.g. GitHub). 256 # repository (e.g. GitHub). 257 "url": "A String", # Git repository URL. 258 "revisionId": "A String", # Git commit hash. 259 # required. 260 }, 261 "gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project. 262 "aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag. 263 "kind": "A String", # The alias kind. 264 "name": "A String", # The alias name. 265 }, 266 "revisionId": "A String", # A revision (commit) ID. 267 "gerritProject": "A String", # The full project name within the host. Projects may be nested, so 268 # "project/subproject" is a valid project name. 269 # The "repo name" is hostURI/project. 270 "hostUri": "A String", # The URI of a running Gerrit instance. 271 "aliasName": "A String", # The name of an alias (branch, tag, etc.). 272 }, 273 }, 274 }, 275 ], 276 "agentVersion": "A String", # Version ID of the agent. 277 # Schema: `domain/language-platform/vmajor.minor` (for example 278 # `google.com/java-gcp/v1.1`). 279 "isInactive": True or False, # If set to `true`, indicates that Controller service does not detect any 280 # activity from the debuggee agents and the application is possibly stopped. 281 "id": "A String", # Unique identifier for the debuggee generated by the controller service. 282 }, 283 } 284 285 x__xgafv: string, V1 error format. 286 Allowed values 287 1 - v1 error format 288 2 - v2 error format 289 290Returns: 291 An object of the form: 292 293 { # Response for registering a debuggee. 294 "debuggee": { # Represents the debugged application. The application may include one or more # Debuggee resource. 295 # The field `id` is guaranteed to be set (in addition to the echoed fields). 296 # If the field `is_disabled` is set to `true`, the agent should disable 297 # itself by removing all breakpoints and detaching from the application. 298 # It should however continue to poll `RegisterDebuggee` until reenabled. 299 # replicated processes executing the same code. Each of these processes is 300 # attached with a debugger agent, carrying out the debugging commands. 301 # Agents attached to the same debuggee identify themselves as such by using 302 # exactly the same Debuggee message value when registering. 303 "status": { # Represents a contextual status message. # Human readable message to be displayed to the user about this debuggee. 304 # Absence of this field indicates no status. The message can be either 305 # informational or an error status. 306 # The message can indicate an error or informational status, and refer to 307 # specific parts of the containing object. 308 # For example, the `Breakpoint.status` field can indicate an error referring 309 # to the `BREAKPOINT_SOURCE_LOCATION` with the message `Location not found`. 310 "isError": True or False, # Distinguishes errors from informational messages. 311 "refersTo": "A String", # Reference to which the message applies. 312 "description": { # Represents a message with parameters. # Status message text. 313 "parameters": [ # Optional parameters to be embedded into the message. 314 "A String", 315 ], 316 "format": "A String", # Format template for the message. The `format` uses placeholders `$0`, 317 # `$1`, etc. to reference parameters. `$$` can be used to denote the `$` 318 # character. 319 # 320 # Examples: 321 # 322 # * `Failed to load '$0' which helps debug $1 the first time it 323 # is loaded. Again, $0 is very important.` 324 # * `Please pay $$10 to use $0 instead of $1.` 325 }, 326 }, 327 "description": "A String", # Human readable description of the debuggee. 328 # Including a human-readable project name, environment name and version 329 # information is recommended. 330 "isDisabled": True or False, # If set to `true`, indicates that the agent should disable itself and 331 # detach from the debuggee. 332 "labels": { # A set of custom debuggee properties, populated by the agent, to be 333 # displayed to the user. 334 "a_key": "A String", 335 }, 336 "uniquifier": "A String", # Uniquifier to further distinguish the application. 337 # It is possible that different applications might have identical values in 338 # the debuggee message, thus, incorrectly identified as a single application 339 # by the Controller service. This field adds salt to further distinguish the 340 # application. Agents should consider seeding this field with value that 341 # identifies the code, binary, configuration and environment. 342 "project": "A String", # Project the debuggee is associated with. 343 # Use project number or id when registering a Google Cloud Platform project. 344 "sourceContexts": [ # References to the locations and revisions of the source code used in the 345 # deployed application. 346 { # A SourceContext is a reference to a tree of files. A SourceContext together 347 # with a path point to a unique revision of a single file or directory. 348 "cloudWorkspace": { # A CloudWorkspaceSourceContext denotes a workspace at a particular snapshot. # A SourceContext referring to a snapshot in a cloud workspace. 349 "snapshotId": "A String", # The ID of the snapshot. 350 # An empty snapshot_id refers to the most recent snapshot. 351 "workspaceId": { # A CloudWorkspaceId is a unique identifier for a cloud workspace. # The ID of the workspace. 352 # A cloud workspace is a place associated with a repo where modified files 353 # can be stored before they are committed. 354 "name": "A String", # The unique name of the workspace within the repo. This is the name 355 # chosen by the client in the Source API's CreateWorkspace method. 356 "repoId": { # A unique identifier for a cloud repo. # The ID of the repo containing the workspace. 357 "uid": "A String", # A server-assigned, globally unique identifier. 358 "projectRepoId": { # Selects a repo using a Google Cloud Platform project ID # A combination of a project ID and a repo name. 359 # (e.g. winged-cargo-31) and a repo name within that project. 360 "projectId": "A String", # The ID of the project. 361 "repoName": "A String", # The name of the repo. Leave empty for the default repo. 362 }, 363 }, 364 }, 365 }, 366 "cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a cloud # A SourceContext referring to a revision in a cloud repo. 367 # repo (a repo hosted by the Google Cloud Platform). 368 "aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag. 369 "kind": "A String", # The alias kind. 370 "name": "A String", # The alias name. 371 }, 372 "revisionId": "A String", # A revision ID. 373 "aliasName": "A String", # The name of an alias (branch, tag, etc.). 374 "repoId": { # A unique identifier for a cloud repo. # The ID of the repo. 375 "uid": "A String", # A server-assigned, globally unique identifier. 376 "projectRepoId": { # Selects a repo using a Google Cloud Platform project ID # A combination of a project ID and a repo name. 377 # (e.g. winged-cargo-31) and a repo name within that project. 378 "projectId": "A String", # The ID of the project. 379 "repoName": "A String", # The name of the repo. Leave empty for the default repo. 380 }, 381 }, 382 }, 383 "git": { # A GitSourceContext denotes a particular revision in a third party Git # A SourceContext referring to any third party Git repo (e.g. GitHub). 384 # repository (e.g. GitHub). 385 "url": "A String", # Git repository URL. 386 "revisionId": "A String", # Git commit hash. 387 # required. 388 }, 389 "gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project. 390 "aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag. 391 "kind": "A String", # The alias kind. 392 "name": "A String", # The alias name. 393 }, 394 "revisionId": "A String", # A revision (commit) ID. 395 "gerritProject": "A String", # The full project name within the host. Projects may be nested, so 396 # "project/subproject" is a valid project name. 397 # The "repo name" is hostURI/project. 398 "hostUri": "A String", # The URI of a running Gerrit instance. 399 "aliasName": "A String", # The name of an alias (branch, tag, etc.). 400 }, 401 }, 402 ], 403 "extSourceContexts": [ # References to the locations and revisions of the source code used in the 404 # deployed application. 405 { # An ExtendedSourceContext is a SourceContext combined with additional 406 # details describing the context. 407 "labels": { # Labels with user defined metadata. 408 "a_key": "A String", 409 }, 410 "context": { # A SourceContext is a reference to a tree of files. A SourceContext together # Any source context. 411 # with a path point to a unique revision of a single file or directory. 412 "cloudWorkspace": { # A CloudWorkspaceSourceContext denotes a workspace at a particular snapshot. # A SourceContext referring to a snapshot in a cloud workspace. 413 "snapshotId": "A String", # The ID of the snapshot. 414 # An empty snapshot_id refers to the most recent snapshot. 415 "workspaceId": { # A CloudWorkspaceId is a unique identifier for a cloud workspace. # The ID of the workspace. 416 # A cloud workspace is a place associated with a repo where modified files 417 # can be stored before they are committed. 418 "name": "A String", # The unique name of the workspace within the repo. This is the name 419 # chosen by the client in the Source API's CreateWorkspace method. 420 "repoId": { # A unique identifier for a cloud repo. # The ID of the repo containing the workspace. 421 "uid": "A String", # A server-assigned, globally unique identifier. 422 "projectRepoId": { # Selects a repo using a Google Cloud Platform project ID # A combination of a project ID and a repo name. 423 # (e.g. winged-cargo-31) and a repo name within that project. 424 "projectId": "A String", # The ID of the project. 425 "repoName": "A String", # The name of the repo. Leave empty for the default repo. 426 }, 427 }, 428 }, 429 }, 430 "cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a cloud # A SourceContext referring to a revision in a cloud repo. 431 # repo (a repo hosted by the Google Cloud Platform). 432 "aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag. 433 "kind": "A String", # The alias kind. 434 "name": "A String", # The alias name. 435 }, 436 "revisionId": "A String", # A revision ID. 437 "aliasName": "A String", # The name of an alias (branch, tag, etc.). 438 "repoId": { # A unique identifier for a cloud repo. # The ID of the repo. 439 "uid": "A String", # A server-assigned, globally unique identifier. 440 "projectRepoId": { # Selects a repo using a Google Cloud Platform project ID # A combination of a project ID and a repo name. 441 # (e.g. winged-cargo-31) and a repo name within that project. 442 "projectId": "A String", # The ID of the project. 443 "repoName": "A String", # The name of the repo. Leave empty for the default repo. 444 }, 445 }, 446 }, 447 "git": { # A GitSourceContext denotes a particular revision in a third party Git # A SourceContext referring to any third party Git repo (e.g. GitHub). 448 # repository (e.g. GitHub). 449 "url": "A String", # Git repository URL. 450 "revisionId": "A String", # Git commit hash. 451 # required. 452 }, 453 "gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project. 454 "aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag. 455 "kind": "A String", # The alias kind. 456 "name": "A String", # The alias name. 457 }, 458 "revisionId": "A String", # A revision (commit) ID. 459 "gerritProject": "A String", # The full project name within the host. Projects may be nested, so 460 # "project/subproject" is a valid project name. 461 # The "repo name" is hostURI/project. 462 "hostUri": "A String", # The URI of a running Gerrit instance. 463 "aliasName": "A String", # The name of an alias (branch, tag, etc.). 464 }, 465 }, 466 }, 467 ], 468 "agentVersion": "A String", # Version ID of the agent. 469 # Schema: `domain/language-platform/vmajor.minor` (for example 470 # `google.com/java-gcp/v1.1`). 471 "isInactive": True or False, # If set to `true`, indicates that Controller service does not detect any 472 # activity from the debuggee agents and the application is possibly stopped. 473 "id": "A String", # Unique identifier for the debuggee generated by the controller service. 474 }, 475 }</pre> 476</div> 477 478</body></html>