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