blob: 055d7941a8848f42998ded89a7851ed23805fee2 [file] [log] [blame]
Takashi Matsuo06694102015-09-11 13:55:40 -07001<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
Dan O'Mearadd494642020-05-01 07:42:23 -070075<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 Matsuo06694102015-09-11 13:55:40 -070076<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'Mearadd494642020-05-01 07:42:23 -070083 <code><a href="#register">register(body=None, x__xgafv=None)</a></code></p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -040084<p class="firstline">Registers the debuggee with the controller service.</p>
Takashi Matsuo06694102015-09-11 13:55:40 -070085<h3>Method Details</h3>
86<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -070087 <code class="details" id="register">register(body=None, x__xgafv=None)</code>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -040088 <pre>Registers the debuggee with the controller service.
89
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070090All 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.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -040094
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070095This 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.
Takashi Matsuo06694102015-09-11 13:55:40 -070098
99Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700100 body: object, The request body.
Takashi Matsuo06694102015-09-11 13:55:40 -0700101 The object takes the form of:
102
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800103{ # Request to register a debuggee.
Bu Sun Kim65020912020-05-20 12:08:20 -0700104 &quot;debuggee&quot;: { # Represents the debugged application. The application may include one or more # Required. Debuggee information to register.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400105 # 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 Kim715bd7f2019-06-14 16:50:42 -0700109 # Agents attached to the same debuggee identify themselves as such by using
110 # exactly the same Debuggee message value when registering.
Bu Sun Kim65020912020-05-20 12:08:20 -0700111 &quot;project&quot;: &quot;A String&quot;, # Project the debuggee is associated with.
112 # Use project number or id when registering a Google Cloud Platform project.
113 &quot;isDisabled&quot;: True or False, # If set to `true`, indicates that the agent should disable itself and
114 # detach from the debuggee.
115 &quot;uniquifier&quot;: &quot;A String&quot;, # 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 &quot;description&quot;: &quot;A String&quot;, # Human readable description of the debuggee.
122 # Including a human-readable project name, environment name and version
123 # information is recommended.
124 &quot;extSourceContexts&quot;: [ # 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 &quot;labels&quot;: { # Labels with user defined metadata.
129 &quot;a_key&quot;: &quot;A String&quot;,
130 },
131 &quot;context&quot;: { # 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 &quot;git&quot;: { # 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 &quot;revisionId&quot;: &quot;A String&quot;, # Git commit hash.
136 # required.
137 &quot;url&quot;: &quot;A String&quot;, # Git repository URL.
138 },
139 &quot;gerrit&quot;: { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project.
140 &quot;hostUri&quot;: &quot;A String&quot;, # The URI of a running Gerrit instance.
141 &quot;revisionId&quot;: &quot;A String&quot;, # A revision (commit) ID.
142 &quot;aliasName&quot;: &quot;A String&quot;, # The name of an alias (branch, tag, etc.).
143 &quot;gerritProject&quot;: &quot;A String&quot;, # The full project name within the host. Projects may be nested, so
144 # &quot;project/subproject&quot; is a valid project name.
145 # The &quot;repo name&quot; is hostURI/project.
146 &quot;aliasContext&quot;: { # An alias to a repo revision. # An alias, which may be a branch or tag.
147 &quot;kind&quot;: &quot;A String&quot;, # The alias kind.
148 &quot;name&quot;: &quot;A String&quot;, # The alias name.
149 },
150 },
151 &quot;cloudRepo&quot;: { # 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 &quot;revisionId&quot;: &quot;A String&quot;, # A revision ID.
154 &quot;aliasName&quot;: &quot;A String&quot;, # The name of an alias (branch, tag, etc.).
155 &quot;repoId&quot;: { # A unique identifier for a cloud repo. # The ID of the repo.
156 &quot;projectRepoId&quot;: { # 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 &quot;projectId&quot;: &quot;A String&quot;, # The ID of the project.
159 &quot;repoName&quot;: &quot;A String&quot;, # The name of the repo. Leave empty for the default repo.
160 },
161 &quot;uid&quot;: &quot;A String&quot;, # A server-assigned, globally unique identifier.
162 },
163 &quot;aliasContext&quot;: { # An alias to a repo revision. # An alias, which may be a branch or tag.
164 &quot;kind&quot;: &quot;A String&quot;, # The alias kind.
165 &quot;name&quot;: &quot;A String&quot;, # The alias name.
166 },
167 },
168 &quot;cloudWorkspace&quot;: { # A CloudWorkspaceSourceContext denotes a workspace at a particular snapshot. # A SourceContext referring to a snapshot in a cloud workspace.
169 &quot;snapshotId&quot;: &quot;A String&quot;, # The ID of the snapshot.
170 # An empty snapshot_id refers to the most recent snapshot.
171 &quot;workspaceId&quot;: { # 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 &quot;repoId&quot;: { # A unique identifier for a cloud repo. # The ID of the repo containing the workspace.
175 &quot;projectRepoId&quot;: { # 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 &quot;projectId&quot;: &quot;A String&quot;, # The ID of the project.
178 &quot;repoName&quot;: &quot;A String&quot;, # The name of the repo. Leave empty for the default repo.
179 },
180 &quot;uid&quot;: &quot;A String&quot;, # A server-assigned, globally unique identifier.
181 },
182 &quot;name&quot;: &quot;A String&quot;, # The unique name of the workspace within the repo. This is the name
183 # chosen by the client in the Source API&#x27;s CreateWorkspace method.
184 },
185 },
186 },
187 },
188 ],
189 &quot;isInactive&quot;: 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 &quot;status&quot;: { # Represents a contextual status message. # Human readable message to be displayed to the user about this debuggee.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400192 # 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 Kim65020912020-05-20 12:08:20 -0700198 &quot;isError&quot;: True or False, # Distinguishes errors from informational messages.
199 &quot;description&quot;: { # Represents a message with parameters. # Status message text.
200 &quot;parameters&quot;: [ # Optional parameters to be embedded into the message.
201 &quot;A String&quot;,
Takashi Matsuo06694102015-09-11 13:55:40 -0700202 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700203 &quot;format&quot;: &quot;A String&quot;, # Format template for the message. The `format` uses placeholders `$0`,
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400204 # `$1`, etc. to reference parameters. `$$` can be used to denote the `$`
205 # character.
206 #
207 # Examples:
208 #
Bu Sun Kim65020912020-05-20 12:08:20 -0700209 # * `Failed to load &#x27;$0&#x27; which helps debug $1 the first time it
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400210 # is loaded. Again, $0 is very important.`
211 # * `Please pay $$10 to use $0 instead of $1.`
Takashi Matsuo06694102015-09-11 13:55:40 -0700212 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700213 &quot;refersTo&quot;: &quot;A String&quot;, # Reference to which the message applies.
Takashi Matsuo06694102015-09-11 13:55:40 -0700214 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700215 &quot;canaryMode&quot;: &quot;A String&quot;, # Used when setting breakpoint canary for this debuggee.
216 &quot;id&quot;: &quot;A String&quot;, # Unique identifier for the debuggee generated by the controller service.
217 &quot;agentVersion&quot;: &quot;A String&quot;, # Version ID of the agent.
218 # Schema: `domain/language-platform/vmajor.minor` (for example
219 # `google.com/java-gcp/v1.1`).
220 &quot;sourceContexts&quot;: [ # References to the locations and revisions of the source code used in the
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400221 # deployed application.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400222 { # 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 Kim65020912020-05-20 12:08:20 -0700224 &quot;git&quot;: { # 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 &quot;revisionId&quot;: &quot;A String&quot;, # Git commit hash.
227 # required.
228 &quot;url&quot;: &quot;A String&quot;, # Git repository URL.
229 },
230 &quot;gerrit&quot;: { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project.
231 &quot;hostUri&quot;: &quot;A String&quot;, # The URI of a running Gerrit instance.
232 &quot;revisionId&quot;: &quot;A String&quot;, # A revision (commit) ID.
233 &quot;aliasName&quot;: &quot;A String&quot;, # The name of an alias (branch, tag, etc.).
234 &quot;gerritProject&quot;: &quot;A String&quot;, # The full project name within the host. Projects may be nested, so
235 # &quot;project/subproject&quot; is a valid project name.
236 # The &quot;repo name&quot; is hostURI/project.
237 &quot;aliasContext&quot;: { # An alias to a repo revision. # An alias, which may be a branch or tag.
238 &quot;kind&quot;: &quot;A String&quot;, # The alias kind.
239 &quot;name&quot;: &quot;A String&quot;, # The alias name.
240 },
241 },
242 &quot;cloudRepo&quot;: { # 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 &quot;revisionId&quot;: &quot;A String&quot;, # A revision ID.
245 &quot;aliasName&quot;: &quot;A String&quot;, # The name of an alias (branch, tag, etc.).
246 &quot;repoId&quot;: { # A unique identifier for a cloud repo. # The ID of the repo.
247 &quot;projectRepoId&quot;: { # 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 &quot;projectId&quot;: &quot;A String&quot;, # The ID of the project.
250 &quot;repoName&quot;: &quot;A String&quot;, # The name of the repo. Leave empty for the default repo.
251 },
252 &quot;uid&quot;: &quot;A String&quot;, # A server-assigned, globally unique identifier.
253 },
254 &quot;aliasContext&quot;: { # An alias to a repo revision. # An alias, which may be a branch or tag.
255 &quot;kind&quot;: &quot;A String&quot;, # The alias kind.
256 &quot;name&quot;: &quot;A String&quot;, # The alias name.
257 },
258 },
259 &quot;cloudWorkspace&quot;: { # A CloudWorkspaceSourceContext denotes a workspace at a particular snapshot. # A SourceContext referring to a snapshot in a cloud workspace.
260 &quot;snapshotId&quot;: &quot;A String&quot;, # The ID of the snapshot.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400261 # An empty snapshot_id refers to the most recent snapshot.
Bu Sun Kim65020912020-05-20 12:08:20 -0700262 &quot;workspaceId&quot;: { # A CloudWorkspaceId is a unique identifier for a cloud workspace. # The ID of the workspace.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400263 # A cloud workspace is a place associated with a repo where modified files
264 # can be stored before they are committed.
Bu Sun Kim65020912020-05-20 12:08:20 -0700265 &quot;repoId&quot;: { # A unique identifier for a cloud repo. # The ID of the repo containing the workspace.
266 &quot;projectRepoId&quot;: { # Selects a repo using a Google Cloud Platform project ID # A combination of a project ID and a repo name.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400267 # (e.g. winged-cargo-31) and a repo name within that project.
Bu Sun Kim65020912020-05-20 12:08:20 -0700268 &quot;projectId&quot;: &quot;A String&quot;, # The ID of the project.
269 &quot;repoName&quot;: &quot;A String&quot;, # The name of the repo. Leave empty for the default repo.
Takashi Matsuo06694102015-09-11 13:55:40 -0700270 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700271 &quot;uid&quot;: &quot;A String&quot;, # A server-assigned, globally unique identifier.
Takashi Matsuo06694102015-09-11 13:55:40 -0700272 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700273 &quot;name&quot;: &quot;A String&quot;, # The unique name of the workspace within the repo. This is the name
274 # chosen by the client in the Source API&#x27;s CreateWorkspace method.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800275 },
276 },
277 },
278 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700279 &quot;labels&quot;: { # A set of custom debuggee properties, populated by the agent, to be
280 # displayed to the user.
281 &quot;a_key&quot;: &quot;A String&quot;,
282 },
Takashi Matsuo06694102015-09-11 13:55:40 -0700283 },
284 }
285
286 x__xgafv: string, V1 error format.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400287 Allowed values
288 1 - v1 error format
289 2 - v2 error format
Takashi Matsuo06694102015-09-11 13:55:40 -0700290
291Returns:
292 An object of the form:
293
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800294 { # Response for registering a debuggee.
Bu Sun Kim65020912020-05-20 12:08:20 -0700295 &quot;debuggee&quot;: { # Represents the debugged application. The application may include one or more # Debuggee resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700296 # 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 Cheemalapatic30d2b52017-03-13 12:12:03 -0400300 # replicated processes executing the same code. Each of these processes is
301 # attached with a debugger agent, carrying out the debugging commands.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700302 # Agents attached to the same debuggee identify themselves as such by using
303 # exactly the same Debuggee message value when registering.
Bu Sun Kim65020912020-05-20 12:08:20 -0700304 &quot;project&quot;: &quot;A String&quot;, # Project the debuggee is associated with.
305 # Use project number or id when registering a Google Cloud Platform project.
306 &quot;isDisabled&quot;: True or False, # If set to `true`, indicates that the agent should disable itself and
307 # detach from the debuggee.
308 &quot;uniquifier&quot;: &quot;A String&quot;, # 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 &quot;description&quot;: &quot;A String&quot;, # Human readable description of the debuggee.
315 # Including a human-readable project name, environment name and version
316 # information is recommended.
317 &quot;extSourceContexts&quot;: [ # 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 &quot;labels&quot;: { # Labels with user defined metadata.
322 &quot;a_key&quot;: &quot;A String&quot;,
323 },
324 &quot;context&quot;: { # 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 &quot;git&quot;: { # 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 &quot;revisionId&quot;: &quot;A String&quot;, # Git commit hash.
329 # required.
330 &quot;url&quot;: &quot;A String&quot;, # Git repository URL.
331 },
332 &quot;gerrit&quot;: { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project.
333 &quot;hostUri&quot;: &quot;A String&quot;, # The URI of a running Gerrit instance.
334 &quot;revisionId&quot;: &quot;A String&quot;, # A revision (commit) ID.
335 &quot;aliasName&quot;: &quot;A String&quot;, # The name of an alias (branch, tag, etc.).
336 &quot;gerritProject&quot;: &quot;A String&quot;, # The full project name within the host. Projects may be nested, so
337 # &quot;project/subproject&quot; is a valid project name.
338 # The &quot;repo name&quot; is hostURI/project.
339 &quot;aliasContext&quot;: { # An alias to a repo revision. # An alias, which may be a branch or tag.
340 &quot;kind&quot;: &quot;A String&quot;, # The alias kind.
341 &quot;name&quot;: &quot;A String&quot;, # The alias name.
342 },
343 },
344 &quot;cloudRepo&quot;: { # 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 &quot;revisionId&quot;: &quot;A String&quot;, # A revision ID.
347 &quot;aliasName&quot;: &quot;A String&quot;, # The name of an alias (branch, tag, etc.).
348 &quot;repoId&quot;: { # A unique identifier for a cloud repo. # The ID of the repo.
349 &quot;projectRepoId&quot;: { # 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 &quot;projectId&quot;: &quot;A String&quot;, # The ID of the project.
352 &quot;repoName&quot;: &quot;A String&quot;, # The name of the repo. Leave empty for the default repo.
353 },
354 &quot;uid&quot;: &quot;A String&quot;, # A server-assigned, globally unique identifier.
355 },
356 &quot;aliasContext&quot;: { # An alias to a repo revision. # An alias, which may be a branch or tag.
357 &quot;kind&quot;: &quot;A String&quot;, # The alias kind.
358 &quot;name&quot;: &quot;A String&quot;, # The alias name.
359 },
360 },
361 &quot;cloudWorkspace&quot;: { # A CloudWorkspaceSourceContext denotes a workspace at a particular snapshot. # A SourceContext referring to a snapshot in a cloud workspace.
362 &quot;snapshotId&quot;: &quot;A String&quot;, # The ID of the snapshot.
363 # An empty snapshot_id refers to the most recent snapshot.
364 &quot;workspaceId&quot;: { # 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 &quot;repoId&quot;: { # A unique identifier for a cloud repo. # The ID of the repo containing the workspace.
368 &quot;projectRepoId&quot;: { # 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 &quot;projectId&quot;: &quot;A String&quot;, # The ID of the project.
371 &quot;repoName&quot;: &quot;A String&quot;, # The name of the repo. Leave empty for the default repo.
372 },
373 &quot;uid&quot;: &quot;A String&quot;, # A server-assigned, globally unique identifier.
374 },
375 &quot;name&quot;: &quot;A String&quot;, # The unique name of the workspace within the repo. This is the name
376 # chosen by the client in the Source API&#x27;s CreateWorkspace method.
377 },
378 },
379 },
380 },
381 ],
382 &quot;isInactive&quot;: 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 &quot;status&quot;: { # Represents a contextual status message. # Human readable message to be displayed to the user about this debuggee.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400385 # 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 Kim65020912020-05-20 12:08:20 -0700391 &quot;isError&quot;: True or False, # Distinguishes errors from informational messages.
392 &quot;description&quot;: { # Represents a message with parameters. # Status message text.
393 &quot;parameters&quot;: [ # Optional parameters to be embedded into the message.
394 &quot;A String&quot;,
Takashi Matsuo06694102015-09-11 13:55:40 -0700395 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700396 &quot;format&quot;: &quot;A String&quot;, # Format template for the message. The `format` uses placeholders `$0`,
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400397 # `$1`, etc. to reference parameters. `$$` can be used to denote the `$`
398 # character.
399 #
400 # Examples:
401 #
Bu Sun Kim65020912020-05-20 12:08:20 -0700402 # * `Failed to load &#x27;$0&#x27; which helps debug $1 the first time it
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400403 # is loaded. Again, $0 is very important.`
404 # * `Please pay $$10 to use $0 instead of $1.`
Takashi Matsuo06694102015-09-11 13:55:40 -0700405 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700406 &quot;refersTo&quot;: &quot;A String&quot;, # Reference to which the message applies.
Takashi Matsuo06694102015-09-11 13:55:40 -0700407 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700408 &quot;canaryMode&quot;: &quot;A String&quot;, # Used when setting breakpoint canary for this debuggee.
409 &quot;id&quot;: &quot;A String&quot;, # Unique identifier for the debuggee generated by the controller service.
410 &quot;agentVersion&quot;: &quot;A String&quot;, # Version ID of the agent.
411 # Schema: `domain/language-platform/vmajor.minor` (for example
412 # `google.com/java-gcp/v1.1`).
413 &quot;sourceContexts&quot;: [ # References to the locations and revisions of the source code used in the
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400414 # deployed application.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400415 { # 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 Kim65020912020-05-20 12:08:20 -0700417 &quot;git&quot;: { # 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 &quot;revisionId&quot;: &quot;A String&quot;, # Git commit hash.
420 # required.
421 &quot;url&quot;: &quot;A String&quot;, # Git repository URL.
422 },
423 &quot;gerrit&quot;: { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project.
424 &quot;hostUri&quot;: &quot;A String&quot;, # The URI of a running Gerrit instance.
425 &quot;revisionId&quot;: &quot;A String&quot;, # A revision (commit) ID.
426 &quot;aliasName&quot;: &quot;A String&quot;, # The name of an alias (branch, tag, etc.).
427 &quot;gerritProject&quot;: &quot;A String&quot;, # The full project name within the host. Projects may be nested, so
428 # &quot;project/subproject&quot; is a valid project name.
429 # The &quot;repo name&quot; is hostURI/project.
430 &quot;aliasContext&quot;: { # An alias to a repo revision. # An alias, which may be a branch or tag.
431 &quot;kind&quot;: &quot;A String&quot;, # The alias kind.
432 &quot;name&quot;: &quot;A String&quot;, # The alias name.
433 },
434 },
435 &quot;cloudRepo&quot;: { # 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 &quot;revisionId&quot;: &quot;A String&quot;, # A revision ID.
438 &quot;aliasName&quot;: &quot;A String&quot;, # The name of an alias (branch, tag, etc.).
439 &quot;repoId&quot;: { # A unique identifier for a cloud repo. # The ID of the repo.
440 &quot;projectRepoId&quot;: { # 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 &quot;projectId&quot;: &quot;A String&quot;, # The ID of the project.
443 &quot;repoName&quot;: &quot;A String&quot;, # The name of the repo. Leave empty for the default repo.
444 },
445 &quot;uid&quot;: &quot;A String&quot;, # A server-assigned, globally unique identifier.
446 },
447 &quot;aliasContext&quot;: { # An alias to a repo revision. # An alias, which may be a branch or tag.
448 &quot;kind&quot;: &quot;A String&quot;, # The alias kind.
449 &quot;name&quot;: &quot;A String&quot;, # The alias name.
450 },
451 },
452 &quot;cloudWorkspace&quot;: { # A CloudWorkspaceSourceContext denotes a workspace at a particular snapshot. # A SourceContext referring to a snapshot in a cloud workspace.
453 &quot;snapshotId&quot;: &quot;A String&quot;, # The ID of the snapshot.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400454 # An empty snapshot_id refers to the most recent snapshot.
Bu Sun Kim65020912020-05-20 12:08:20 -0700455 &quot;workspaceId&quot;: { # A CloudWorkspaceId is a unique identifier for a cloud workspace. # The ID of the workspace.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400456 # A cloud workspace is a place associated with a repo where modified files
457 # can be stored before they are committed.
Bu Sun Kim65020912020-05-20 12:08:20 -0700458 &quot;repoId&quot;: { # A unique identifier for a cloud repo. # The ID of the repo containing the workspace.
459 &quot;projectRepoId&quot;: { # Selects a repo using a Google Cloud Platform project ID # A combination of a project ID and a repo name.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400460 # (e.g. winged-cargo-31) and a repo name within that project.
Bu Sun Kim65020912020-05-20 12:08:20 -0700461 &quot;projectId&quot;: &quot;A String&quot;, # The ID of the project.
462 &quot;repoName&quot;: &quot;A String&quot;, # The name of the repo. Leave empty for the default repo.
Takashi Matsuo06694102015-09-11 13:55:40 -0700463 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700464 &quot;uid&quot;: &quot;A String&quot;, # A server-assigned, globally unique identifier.
Takashi Matsuo06694102015-09-11 13:55:40 -0700465 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700466 &quot;name&quot;: &quot;A String&quot;, # The unique name of the workspace within the repo. This is the name
467 # chosen by the client in the Source API&#x27;s CreateWorkspace method.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800468 },
469 },
470 },
471 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700472 &quot;labels&quot;: { # A set of custom debuggee properties, populated by the agent, to be
473 # displayed to the user.
474 &quot;a_key&quot;: &quot;A String&quot;,
475 },
Takashi Matsuo06694102015-09-11 13:55:40 -0700476 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700477 &quot;agentId&quot;: &quot;A String&quot;, # A unique ID generated for the agent.
Dan O'Mearadd494642020-05-01 07:42:23 -0700478 # Each RegisterDebuggee request will generate a new agent ID.
Takashi Matsuo06694102015-09-11 13:55:40 -0700479 }</pre>
480</div>
481
482</body></html>