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"> |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 83 | <code><a href="#close">close()</a></code></p> |
| 84 | <p class="firstline">Close httplib2 connections.</p> |
| 85 | <p class="toc_element"> |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 86 | <code><a href="#register">register(body=None, x__xgafv=None)</a></code></p> |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 87 | <p class="firstline">Registers the debuggee with the controller service. All agents attached to the same application must call this method with exactly the same request content to get back the same stable `debuggee_id`. Agents should call this method again whenever `google.rpc.Code.NOT_FOUND` is returned from any controller method. This protocol allows the controller service to disable debuggees, recover from data loss, or change the `debuggee_id` format. Agents must handle `debuggee_id` value changing upon re-registration.</p> |
Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 88 | <h3>Method Details</h3> |
| 89 | <div class="method"> |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 90 | <code class="details" id="close">close()</code> |
| 91 | <pre>Close httplib2 connections.</pre> |
| 92 | </div> |
| 93 | |
| 94 | <div class="method"> |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 95 | <code class="details" id="register">register(body=None, x__xgafv=None)</code> |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 96 | <pre>Registers the debuggee with the controller service. All agents attached to the same application must call this method with exactly the same request content to get back the same stable `debuggee_id`. Agents should call this method again whenever `google.rpc.Code.NOT_FOUND` is returned from any controller method. This protocol allows the controller service to disable debuggees, recover from data loss, or change the `debuggee_id` format. Agents must handle `debuggee_id` value changing upon re-registration. |
Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 97 | |
| 98 | Args: |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 99 | body: object, The request body. |
Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 100 | The object takes the form of: |
| 101 | |
Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 102 | { # Request to register a debuggee. |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 103 | "debuggee": { # Represents the debugged application. The application may include one or more replicated processes executing the same code. Each of these processes is attached with a debugger agent, carrying out the debugging commands. Agents attached to the same debuggee identify themselves as such by using exactly the same Debuggee message value when registering. # Required. Debuggee information to register. The fields `project`, `uniquifier`, `description` and `agent_version` of the debuggee must be set. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame^] | 104 | "canaryMode": "A String", # Used when setting breakpoint canary for this debuggee. |
| 105 | "uniquifier": "A String", # Uniquifier to further distinguish the application. It is possible that different applications might have identical values in the debuggee message, thus, incorrectly identified as a single application by the Controller service. This field adds salt to further distinguish the application. Agents should consider seeding this field with value that identifies the code, binary, configuration and environment. |
| 106 | "extSourceContexts": [ # References to the locations and revisions of the source code used in the deployed application. |
| 107 | { # An ExtendedSourceContext is a SourceContext combined with additional details describing the context. |
| 108 | "context": { # 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. # Any source context. |
| 109 | "gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project. |
| 110 | "revisionId": "A String", # A revision (commit) ID. |
| 111 | "hostUri": "A String", # The URI of a running Gerrit instance. |
| 112 | "gerritProject": "A String", # The full project name within the host. Projects may be nested, so "project/subproject" is a valid project name. The "repo name" is hostURI/project. |
| 113 | "aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag. |
| 114 | "name": "A String", # The alias name. |
| 115 | "kind": "A String", # The alias kind. |
| 116 | }, |
| 117 | "aliasName": "A String", # The name of an alias (branch, tag, etc.). |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 118 | }, |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame^] | 119 | "git": { # A GitSourceContext denotes a particular revision in a third party Git repository (e.g. GitHub). # A SourceContext referring to any third party Git repo (e.g. GitHub). |
| 120 | "url": "A String", # Git repository URL. |
| 121 | "revisionId": "A String", # Git commit hash. required. |
| 122 | }, |
| 123 | "cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a cloud repo (a repo hosted by the Google Cloud Platform). # A SourceContext referring to a revision in a cloud repo. |
| 124 | "repoId": { # A unique identifier for a cloud repo. # The ID of the repo. |
| 125 | "projectRepoId": { # Selects a repo using a Google Cloud Platform project ID (e.g. winged-cargo-31) and a repo name within that project. # A combination of a project ID and a repo name. |
| 126 | "repoName": "A String", # The name of the repo. Leave empty for the default repo. |
| 127 | "projectId": "A String", # The ID of the project. |
| 128 | }, |
| 129 | "uid": "A String", # A server-assigned, globally unique identifier. |
| 130 | }, |
| 131 | "revisionId": "A String", # A revision ID. |
| 132 | "aliasName": "A String", # The name of an alias (branch, tag, etc.). |
| 133 | "aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag. |
| 134 | "name": "A String", # The alias name. |
| 135 | "kind": "A String", # The alias kind. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 136 | }, |
| 137 | }, |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame^] | 138 | "cloudWorkspace": { # A CloudWorkspaceSourceContext denotes a workspace at a particular snapshot. # A SourceContext referring to a snapshot in a cloud workspace. |
| 139 | "snapshotId": "A String", # The ID of the snapshot. An empty snapshot_id refers to the most recent snapshot. |
| 140 | "workspaceId": { # A CloudWorkspaceId is a unique identifier for a cloud workspace. A cloud workspace is a place associated with a repo where modified files can be stored before they are committed. # The ID of the workspace. |
| 141 | "repoId": { # A unique identifier for a cloud repo. # The ID of the repo containing the workspace. |
| 142 | "projectRepoId": { # Selects a repo using a Google Cloud Platform project ID (e.g. winged-cargo-31) and a repo name within that project. # A combination of a project ID and a repo name. |
| 143 | "repoName": "A String", # The name of the repo. Leave empty for the default repo. |
| 144 | "projectId": "A String", # The ID of the project. |
| 145 | }, |
| 146 | "uid": "A String", # A server-assigned, globally unique identifier. |
| 147 | }, |
| 148 | "name": "A String", # The unique name of the workspace within the repo. This is the name chosen by the client in the Source API's CreateWorkspace method. |
| 149 | }, |
| 150 | }, |
| 151 | }, |
| 152 | "labels": { # Labels with user defined metadata. |
| 153 | "a_key": "A String", |
| 154 | }, |
| 155 | }, |
| 156 | ], |
| 157 | "id": "A String", # Unique identifier for the debuggee generated by the controller service. |
| 158 | "isInactive": True or False, # If set to `true`, indicates that Controller service does not detect any activity from the debuggee agents and the application is possibly stopped. |
| 159 | "labels": { # A set of custom debuggee properties, populated by the agent, to be displayed to the user. |
| 160 | "a_key": "A String", |
| 161 | }, |
| 162 | "sourceContexts": [ # References to the locations and revisions of the source code used in the deployed application. |
| 163 | { # 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. |
| 164 | "gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project. |
| 165 | "revisionId": "A String", # A revision (commit) ID. |
| 166 | "hostUri": "A String", # The URI of a running Gerrit instance. |
| 167 | "gerritProject": "A String", # The full project name within the host. Projects may be nested, so "project/subproject" is a valid project name. The "repo name" is hostURI/project. |
| 168 | "aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag. |
| 169 | "name": "A String", # The alias name. |
| 170 | "kind": "A String", # The alias kind. |
| 171 | }, |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 172 | "aliasName": "A String", # The name of an alias (branch, tag, etc.). |
| 173 | }, |
| 174 | "git": { # A GitSourceContext denotes a particular revision in a third party Git repository (e.g. GitHub). # A SourceContext referring to any third party Git repo (e.g. GitHub). |
| 175 | "url": "A String", # Git repository URL. |
| 176 | "revisionId": "A String", # Git commit hash. required. |
| 177 | }, |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame^] | 178 | "cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a cloud repo (a repo hosted by the Google Cloud Platform). # A SourceContext referring to a revision in a cloud repo. |
| 179 | "repoId": { # A unique identifier for a cloud repo. # The ID of the repo. |
| 180 | "projectRepoId": { # Selects a repo using a Google Cloud Platform project ID (e.g. winged-cargo-31) and a repo name within that project. # A combination of a project ID and a repo name. |
| 181 | "repoName": "A String", # The name of the repo. Leave empty for the default repo. |
| 182 | "projectId": "A String", # The ID of the project. |
| 183 | }, |
| 184 | "uid": "A String", # A server-assigned, globally unique identifier. |
| 185 | }, |
| 186 | "revisionId": "A String", # A revision ID. |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 187 | "aliasName": "A String", # The name of an alias (branch, tag, etc.). |
| 188 | "aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag. |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 189 | "name": "A String", # The alias name. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame^] | 190 | "kind": "A String", # The alias kind. |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 191 | }, |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 192 | }, |
| 193 | "cloudWorkspace": { # A CloudWorkspaceSourceContext denotes a workspace at a particular snapshot. # A SourceContext referring to a snapshot in a cloud workspace. |
| 194 | "snapshotId": "A String", # The ID of the snapshot. An empty snapshot_id refers to the most recent snapshot. |
| 195 | "workspaceId": { # A CloudWorkspaceId is a unique identifier for a cloud workspace. A cloud workspace is a place associated with a repo where modified files can be stored before they are committed. # The ID of the workspace. |
| 196 | "repoId": { # A unique identifier for a cloud repo. # The ID of the repo containing the workspace. |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 197 | "projectRepoId": { # Selects a repo using a Google Cloud Platform project ID (e.g. winged-cargo-31) and a repo name within that project. # A combination of a project ID and a repo name. |
| 198 | "repoName": "A String", # The name of the repo. Leave empty for the default repo. |
| 199 | "projectId": "A String", # The ID of the project. |
| 200 | }, |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame^] | 201 | "uid": "A String", # A server-assigned, globally unique identifier. |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 202 | }, |
| 203 | "name": "A String", # The unique name of the workspace within the repo. This is the name chosen by the client in the Source API's CreateWorkspace method. |
| 204 | }, |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 205 | }, |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 206 | }, |
| 207 | ], |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 208 | "status": { # Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the `Breakpoint.status` field can indicate an error referring to the `BREAKPOINT_SOURCE_LOCATION` with the message `Location not found`. # Human readable message to be displayed to the user about this debuggee. Absence of this field indicates no status. The message can be either informational or an error status. |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 209 | "description": { # Represents a message with parameters. # Status message text. |
| 210 | "format": "A String", # Format template for the message. The `format` uses placeholders `$0`, `$1`, etc. to reference parameters. `$$` can be used to 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.` |
| 211 | "parameters": [ # Optional parameters to be embedded into the message. |
| 212 | "A String", |
| 213 | ], |
| 214 | }, |
| 215 | "refersTo": "A String", # Reference to which the message applies. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame^] | 216 | "isError": True or False, # Distinguishes errors from informational messages. |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 217 | }, |
| 218 | "project": "A String", # Project the debuggee is associated with. Use project number or id when registering a Google Cloud Platform project. |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 219 | "description": "A String", # Human readable description of the debuggee. Including a human-readable project name, environment name and version information is recommended. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame^] | 220 | "isDisabled": True or False, # If set to `true`, indicates that the agent should disable itself and detach from the debuggee. |
| 221 | "agentVersion": "A String", # Version ID of the agent. Schema: `domain/language-platform/vmajor.minor` (for example `google.com/java-gcp/v1.1`). |
Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 222 | }, |
| 223 | } |
| 224 | |
| 225 | x__xgafv: string, V1 error format. |
Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 226 | Allowed values |
| 227 | 1 - v1 error format |
| 228 | 2 - v2 error format |
Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 229 | |
| 230 | Returns: |
| 231 | An object of the form: |
| 232 | |
Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 233 | { # Response for registering a debuggee. |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 234 | "debuggee": { # Represents the debugged application. The application may include one or more replicated processes executing the same code. Each of these processes is attached with a debugger agent, carrying out the debugging commands. Agents attached to the same debuggee identify themselves as such by using exactly the same Debuggee message value when registering. # Debuggee resource. The field `id` is guaranteed to be set (in addition to the echoed fields). If the field `is_disabled` is set to `true`, the agent should disable itself by removing all breakpoints and detaching from the application. It should however continue to poll `RegisterDebuggee` until reenabled. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame^] | 235 | "canaryMode": "A String", # Used when setting breakpoint canary for this debuggee. |
| 236 | "uniquifier": "A String", # Uniquifier to further distinguish the application. It is possible that different applications might have identical values in the debuggee message, thus, incorrectly identified as a single application by the Controller service. This field adds salt to further distinguish the application. Agents should consider seeding this field with value that identifies the code, binary, configuration and environment. |
| 237 | "extSourceContexts": [ # References to the locations and revisions of the source code used in the deployed application. |
| 238 | { # An ExtendedSourceContext is a SourceContext combined with additional details describing the context. |
| 239 | "context": { # 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. # Any source context. |
| 240 | "gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project. |
| 241 | "revisionId": "A String", # A revision (commit) ID. |
| 242 | "hostUri": "A String", # The URI of a running Gerrit instance. |
| 243 | "gerritProject": "A String", # The full project name within the host. Projects may be nested, so "project/subproject" is a valid project name. The "repo name" is hostURI/project. |
| 244 | "aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag. |
| 245 | "name": "A String", # The alias name. |
| 246 | "kind": "A String", # The alias kind. |
| 247 | }, |
| 248 | "aliasName": "A String", # The name of an alias (branch, tag, etc.). |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 249 | }, |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame^] | 250 | "git": { # A GitSourceContext denotes a particular revision in a third party Git repository (e.g. GitHub). # A SourceContext referring to any third party Git repo (e.g. GitHub). |
| 251 | "url": "A String", # Git repository URL. |
| 252 | "revisionId": "A String", # Git commit hash. required. |
| 253 | }, |
| 254 | "cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a cloud repo (a repo hosted by the Google Cloud Platform). # A SourceContext referring to a revision in a cloud repo. |
| 255 | "repoId": { # A unique identifier for a cloud repo. # The ID of the repo. |
| 256 | "projectRepoId": { # Selects a repo using a Google Cloud Platform project ID (e.g. winged-cargo-31) and a repo name within that project. # A combination of a project ID and a repo name. |
| 257 | "repoName": "A String", # The name of the repo. Leave empty for the default repo. |
| 258 | "projectId": "A String", # The ID of the project. |
| 259 | }, |
| 260 | "uid": "A String", # A server-assigned, globally unique identifier. |
| 261 | }, |
| 262 | "revisionId": "A String", # A revision ID. |
| 263 | "aliasName": "A String", # The name of an alias (branch, tag, etc.). |
| 264 | "aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag. |
| 265 | "name": "A String", # The alias name. |
| 266 | "kind": "A String", # The alias kind. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 267 | }, |
| 268 | }, |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame^] | 269 | "cloudWorkspace": { # A CloudWorkspaceSourceContext denotes a workspace at a particular snapshot. # A SourceContext referring to a snapshot in a cloud workspace. |
| 270 | "snapshotId": "A String", # The ID of the snapshot. An empty snapshot_id refers to the most recent snapshot. |
| 271 | "workspaceId": { # A CloudWorkspaceId is a unique identifier for a cloud workspace. A cloud workspace is a place associated with a repo where modified files can be stored before they are committed. # The ID of the workspace. |
| 272 | "repoId": { # A unique identifier for a cloud repo. # The ID of the repo containing the workspace. |
| 273 | "projectRepoId": { # Selects a repo using a Google Cloud Platform project ID (e.g. winged-cargo-31) and a repo name within that project. # A combination of a project ID and a repo name. |
| 274 | "repoName": "A String", # The name of the repo. Leave empty for the default repo. |
| 275 | "projectId": "A String", # The ID of the project. |
| 276 | }, |
| 277 | "uid": "A String", # A server-assigned, globally unique identifier. |
| 278 | }, |
| 279 | "name": "A String", # The unique name of the workspace within the repo. This is the name chosen by the client in the Source API's CreateWorkspace method. |
| 280 | }, |
| 281 | }, |
| 282 | }, |
| 283 | "labels": { # Labels with user defined metadata. |
| 284 | "a_key": "A String", |
| 285 | }, |
| 286 | }, |
| 287 | ], |
| 288 | "id": "A String", # Unique identifier for the debuggee generated by the controller service. |
| 289 | "isInactive": True or False, # If set to `true`, indicates that Controller service does not detect any activity from the debuggee agents and the application is possibly stopped. |
| 290 | "labels": { # A set of custom debuggee properties, populated by the agent, to be displayed to the user. |
| 291 | "a_key": "A String", |
| 292 | }, |
| 293 | "sourceContexts": [ # References to the locations and revisions of the source code used in the deployed application. |
| 294 | { # 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. |
| 295 | "gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project. |
| 296 | "revisionId": "A String", # A revision (commit) ID. |
| 297 | "hostUri": "A String", # The URI of a running Gerrit instance. |
| 298 | "gerritProject": "A String", # The full project name within the host. Projects may be nested, so "project/subproject" is a valid project name. The "repo name" is hostURI/project. |
| 299 | "aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag. |
| 300 | "name": "A String", # The alias name. |
| 301 | "kind": "A String", # The alias kind. |
| 302 | }, |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 303 | "aliasName": "A String", # The name of an alias (branch, tag, etc.). |
| 304 | }, |
| 305 | "git": { # A GitSourceContext denotes a particular revision in a third party Git repository (e.g. GitHub). # A SourceContext referring to any third party Git repo (e.g. GitHub). |
| 306 | "url": "A String", # Git repository URL. |
| 307 | "revisionId": "A String", # Git commit hash. required. |
| 308 | }, |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame^] | 309 | "cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a cloud repo (a repo hosted by the Google Cloud Platform). # A SourceContext referring to a revision in a cloud repo. |
| 310 | "repoId": { # A unique identifier for a cloud repo. # The ID of the repo. |
| 311 | "projectRepoId": { # Selects a repo using a Google Cloud Platform project ID (e.g. winged-cargo-31) and a repo name within that project. # A combination of a project ID and a repo name. |
| 312 | "repoName": "A String", # The name of the repo. Leave empty for the default repo. |
| 313 | "projectId": "A String", # The ID of the project. |
| 314 | }, |
| 315 | "uid": "A String", # A server-assigned, globally unique identifier. |
| 316 | }, |
| 317 | "revisionId": "A String", # A revision ID. |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 318 | "aliasName": "A String", # The name of an alias (branch, tag, etc.). |
| 319 | "aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag. |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 320 | "name": "A String", # The alias name. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame^] | 321 | "kind": "A String", # The alias kind. |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 322 | }, |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 323 | }, |
| 324 | "cloudWorkspace": { # A CloudWorkspaceSourceContext denotes a workspace at a particular snapshot. # A SourceContext referring to a snapshot in a cloud workspace. |
| 325 | "snapshotId": "A String", # The ID of the snapshot. An empty snapshot_id refers to the most recent snapshot. |
| 326 | "workspaceId": { # A CloudWorkspaceId is a unique identifier for a cloud workspace. A cloud workspace is a place associated with a repo where modified files can be stored before they are committed. # The ID of the workspace. |
| 327 | "repoId": { # A unique identifier for a cloud repo. # The ID of the repo containing the workspace. |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 328 | "projectRepoId": { # Selects a repo using a Google Cloud Platform project ID (e.g. winged-cargo-31) and a repo name within that project. # A combination of a project ID and a repo name. |
| 329 | "repoName": "A String", # The name of the repo. Leave empty for the default repo. |
| 330 | "projectId": "A String", # The ID of the project. |
| 331 | }, |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame^] | 332 | "uid": "A String", # A server-assigned, globally unique identifier. |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 333 | }, |
| 334 | "name": "A String", # The unique name of the workspace within the repo. This is the name chosen by the client in the Source API's CreateWorkspace method. |
| 335 | }, |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 336 | }, |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 337 | }, |
| 338 | ], |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 339 | "status": { # Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the `Breakpoint.status` field can indicate an error referring to the `BREAKPOINT_SOURCE_LOCATION` with the message `Location not found`. # Human readable message to be displayed to the user about this debuggee. Absence of this field indicates no status. The message can be either informational or an error status. |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 340 | "description": { # Represents a message with parameters. # Status message text. |
| 341 | "format": "A String", # Format template for the message. The `format` uses placeholders `$0`, `$1`, etc. to reference parameters. `$$` can be used to 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.` |
| 342 | "parameters": [ # Optional parameters to be embedded into the message. |
| 343 | "A String", |
| 344 | ], |
| 345 | }, |
| 346 | "refersTo": "A String", # Reference to which the message applies. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame^] | 347 | "isError": True or False, # Distinguishes errors from informational messages. |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 348 | }, |
| 349 | "project": "A String", # Project the debuggee is associated with. Use project number or id when registering a Google Cloud Platform project. |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 350 | "description": "A String", # Human readable description of the debuggee. Including a human-readable project name, environment name and version information is recommended. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame^] | 351 | "isDisabled": True or False, # If set to `true`, indicates that the agent should disable itself and detach from the debuggee. |
| 352 | "agentVersion": "A String", # Version ID of the agent. Schema: `domain/language-platform/vmajor.minor` (for example `google.com/java-gcp/v1.1`). |
Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 353 | }, |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame^] | 354 | "agentId": "A String", # A unique ID generated for the agent. Each RegisterDebuggee request will generate a new agent ID. |
Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 355 | }</pre> |
| 356 | </div> |
| 357 | |
| 358 | </body></html> |