blob: 404fd4b7a63e68f079d0d17b6ca3273b3ef3ff45 [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;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 -0400112 # Absence of this field indicates no status. The message can be either
113 # informational or an error status.
114 # The message can indicate an error or informational status, and refer to
115 # specific parts of the containing object.
116 # For example, the `Breakpoint.status` field can indicate an error referring
117 # to the `BREAKPOINT_SOURCE_LOCATION` with the message `Location not found`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700118 &quot;isError&quot;: True or False, # Distinguishes errors from informational messages.
119 &quot;description&quot;: { # Represents a message with parameters. # Status message text.
Bu Sun Kim65020912020-05-20 12:08:20 -0700120 &quot;format&quot;: &quot;A String&quot;, # Format template for the message. The `format` uses placeholders `$0`,
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400121 # `$1`, etc. to reference parameters. `$$` can be used to denote the `$`
122 # character.
123 #
124 # Examples:
125 #
Bu Sun Kim65020912020-05-20 12:08:20 -0700126 # * `Failed to load &#x27;$0&#x27; which helps debug $1 the first time it
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400127 # is loaded. Again, $0 is very important.`
128 # * `Please pay $$10 to use $0 instead of $1.`
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700129 &quot;parameters&quot;: [ # Optional parameters to be embedded into the message.
130 &quot;A String&quot;,
131 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700132 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700133 &quot;refersTo&quot;: &quot;A String&quot;, # Reference to which the message applies.
Takashi Matsuo06694102015-09-11 13:55:40 -0700134 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700135 &quot;extSourceContexts&quot;: [ # References to the locations and revisions of the source code used in the
136 # deployed application.
137 { # An ExtendedSourceContext is a SourceContext combined with additional
138 # details describing the context.
139 &quot;context&quot;: { # A SourceContext is a reference to a tree of files. A SourceContext together # Any source context.
140 # with a path point to a unique revision of a single file or directory.
141 &quot;cloudRepo&quot;: { # A CloudRepoSourceContext denotes a particular revision in a cloud # A SourceContext referring to a revision in a cloud repo.
142 # repo (a repo hosted by the Google Cloud Platform).
143 &quot;aliasName&quot;: &quot;A String&quot;, # The name of an alias (branch, tag, etc.).
144 &quot;revisionId&quot;: &quot;A String&quot;, # A revision ID.
145 &quot;aliasContext&quot;: { # An alias to a repo revision. # An alias, which may be a branch or tag.
146 &quot;name&quot;: &quot;A String&quot;, # The alias name.
147 &quot;kind&quot;: &quot;A String&quot;, # The alias kind.
148 },
149 &quot;repoId&quot;: { # A unique identifier for a cloud repo. # The ID of the repo.
150 &quot;uid&quot;: &quot;A String&quot;, # A server-assigned, globally unique identifier.
151 &quot;projectRepoId&quot;: { # Selects a repo using a Google Cloud Platform project ID # A combination of a project ID and a repo name.
152 # (e.g. winged-cargo-31) and a repo name within that project.
153 &quot;repoName&quot;: &quot;A String&quot;, # The name of the repo. Leave empty for the default repo.
154 &quot;projectId&quot;: &quot;A String&quot;, # The ID of the project.
155 },
156 },
157 },
158 &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).
159 # repository (e.g. GitHub).
160 &quot;revisionId&quot;: &quot;A String&quot;, # Git commit hash.
161 # required.
162 &quot;url&quot;: &quot;A String&quot;, # Git repository URL.
163 },
164 &quot;cloudWorkspace&quot;: { # A CloudWorkspaceSourceContext denotes a workspace at a particular snapshot. # A SourceContext referring to a snapshot in a cloud workspace.
165 &quot;snapshotId&quot;: &quot;A String&quot;, # The ID of the snapshot.
166 # An empty snapshot_id refers to the most recent snapshot.
167 &quot;workspaceId&quot;: { # A CloudWorkspaceId is a unique identifier for a cloud workspace. # The ID of the workspace.
168 # A cloud workspace is a place associated with a repo where modified files
169 # can be stored before they are committed.
170 &quot;repoId&quot;: { # A unique identifier for a cloud repo. # The ID of the repo containing the workspace.
171 &quot;uid&quot;: &quot;A String&quot;, # A server-assigned, globally unique identifier.
172 &quot;projectRepoId&quot;: { # Selects a repo using a Google Cloud Platform project ID # A combination of a project ID and a repo name.
173 # (e.g. winged-cargo-31) and a repo name within that project.
174 &quot;repoName&quot;: &quot;A String&quot;, # The name of the repo. Leave empty for the default repo.
175 &quot;projectId&quot;: &quot;A String&quot;, # The ID of the project.
176 },
177 },
178 &quot;name&quot;: &quot;A String&quot;, # The unique name of the workspace within the repo. This is the name
179 # chosen by the client in the Source API&#x27;s CreateWorkspace method.
180 },
181 },
182 &quot;gerrit&quot;: { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project.
183 &quot;aliasContext&quot;: { # An alias to a repo revision. # An alias, which may be a branch or tag.
184 &quot;name&quot;: &quot;A String&quot;, # The alias name.
185 &quot;kind&quot;: &quot;A String&quot;, # The alias kind.
186 },
187 &quot;revisionId&quot;: &quot;A String&quot;, # A revision (commit) ID.
188 &quot;gerritProject&quot;: &quot;A String&quot;, # The full project name within the host. Projects may be nested, so
189 # &quot;project/subproject&quot; is a valid project name.
190 # The &quot;repo name&quot; is hostURI/project.
191 &quot;aliasName&quot;: &quot;A String&quot;, # The name of an alias (branch, tag, etc.).
192 &quot;hostUri&quot;: &quot;A String&quot;, # The URI of a running Gerrit instance.
193 },
194 },
195 &quot;labels&quot;: { # Labels with user defined metadata.
196 &quot;a_key&quot;: &quot;A String&quot;,
197 },
198 },
199 ],
200 &quot;canaryMode&quot;: &quot;A String&quot;, # Used when setting breakpoint canary for this debuggee.
201 &quot;isDisabled&quot;: True or False, # If set to `true`, indicates that the agent should disable itself and
202 # detach from the debuggee.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700203 &quot;isInactive&quot;: True or False, # If set to `true`, indicates that Controller service does not detect any
204 # activity from the debuggee agents and the application is possibly stopped.
Bu Sun Kim65020912020-05-20 12:08:20 -0700205 &quot;id&quot;: &quot;A String&quot;, # Unique identifier for the debuggee generated by the controller service.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700206 &quot;project&quot;: &quot;A String&quot;, # Project the debuggee is associated with.
207 # Use project number or id when registering a Google Cloud Platform project.
208 &quot;uniquifier&quot;: &quot;A String&quot;, # Uniquifier to further distinguish the application.
209 # It is possible that different applications might have identical values in
210 # the debuggee message, thus, incorrectly identified as a single application
211 # by the Controller service. This field adds salt to further distinguish the
212 # application. Agents should consider seeding this field with value that
213 # identifies the code, binary, configuration and environment.
214 &quot;sourceContexts&quot;: [ # References to the locations and revisions of the source code used in the
215 # deployed application.
216 { # A SourceContext is a reference to a tree of files. A SourceContext together
217 # with a path point to a unique revision of a single file or directory.
218 &quot;cloudRepo&quot;: { # A CloudRepoSourceContext denotes a particular revision in a cloud # A SourceContext referring to a revision in a cloud repo.
219 # repo (a repo hosted by the Google Cloud Platform).
220 &quot;aliasName&quot;: &quot;A String&quot;, # The name of an alias (branch, tag, etc.).
221 &quot;revisionId&quot;: &quot;A String&quot;, # A revision ID.
222 &quot;aliasContext&quot;: { # An alias to a repo revision. # An alias, which may be a branch or tag.
223 &quot;name&quot;: &quot;A String&quot;, # The alias name.
224 &quot;kind&quot;: &quot;A String&quot;, # The alias kind.
225 },
226 &quot;repoId&quot;: { # A unique identifier for a cloud repo. # The ID of the repo.
227 &quot;uid&quot;: &quot;A String&quot;, # A server-assigned, globally unique identifier.
228 &quot;projectRepoId&quot;: { # Selects a repo using a Google Cloud Platform project ID # A combination of a project ID and a repo name.
229 # (e.g. winged-cargo-31) and a repo name within that project.
230 &quot;repoName&quot;: &quot;A String&quot;, # The name of the repo. Leave empty for the default repo.
231 &quot;projectId&quot;: &quot;A String&quot;, # The ID of the project.
232 },
233 },
234 },
235 &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).
236 # repository (e.g. GitHub).
237 &quot;revisionId&quot;: &quot;A String&quot;, # Git commit hash.
238 # required.
239 &quot;url&quot;: &quot;A String&quot;, # Git repository URL.
240 },
241 &quot;cloudWorkspace&quot;: { # A CloudWorkspaceSourceContext denotes a workspace at a particular snapshot. # A SourceContext referring to a snapshot in a cloud workspace.
242 &quot;snapshotId&quot;: &quot;A String&quot;, # The ID of the snapshot.
243 # An empty snapshot_id refers to the most recent snapshot.
244 &quot;workspaceId&quot;: { # A CloudWorkspaceId is a unique identifier for a cloud workspace. # The ID of the workspace.
245 # A cloud workspace is a place associated with a repo where modified files
246 # can be stored before they are committed.
247 &quot;repoId&quot;: { # A unique identifier for a cloud repo. # The ID of the repo containing the workspace.
248 &quot;uid&quot;: &quot;A String&quot;, # A server-assigned, globally unique identifier.
249 &quot;projectRepoId&quot;: { # Selects a repo using a Google Cloud Platform project ID # A combination of a project ID and a repo name.
250 # (e.g. winged-cargo-31) and a repo name within that project.
251 &quot;repoName&quot;: &quot;A String&quot;, # The name of the repo. Leave empty for the default repo.
252 &quot;projectId&quot;: &quot;A String&quot;, # The ID of the project.
253 },
254 },
255 &quot;name&quot;: &quot;A String&quot;, # The unique name of the workspace within the repo. This is the name
256 # chosen by the client in the Source API&#x27;s CreateWorkspace method.
257 },
258 },
259 &quot;gerrit&quot;: { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project.
260 &quot;aliasContext&quot;: { # An alias to a repo revision. # An alias, which may be a branch or tag.
261 &quot;name&quot;: &quot;A String&quot;, # The alias name.
262 &quot;kind&quot;: &quot;A String&quot;, # The alias kind.
263 },
264 &quot;revisionId&quot;: &quot;A String&quot;, # A revision (commit) ID.
265 &quot;gerritProject&quot;: &quot;A String&quot;, # The full project name within the host. Projects may be nested, so
266 # &quot;project/subproject&quot; is a valid project name.
267 # The &quot;repo name&quot; is hostURI/project.
268 &quot;aliasName&quot;: &quot;A String&quot;, # The name of an alias (branch, tag, etc.).
269 &quot;hostUri&quot;: &quot;A String&quot;, # The URI of a running Gerrit instance.
270 },
271 },
272 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700273 &quot;agentVersion&quot;: &quot;A String&quot;, # Version ID of the agent.
274 # Schema: `domain/language-platform/vmajor.minor` (for example
275 # `google.com/java-gcp/v1.1`).
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700276 &quot;description&quot;: &quot;A String&quot;, # Human readable description of the debuggee.
277 # Including a human-readable project name, environment name and version
278 # information is recommended.
279 &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 Kimd059ad82020-07-22 17:02:09 -0700295 &quot;agentId&quot;: &quot;A String&quot;, # A unique ID generated for the agent.
296 # Each RegisterDebuggee request will generate a new agent ID.
Bu Sun Kim65020912020-05-20 12:08:20 -0700297 &quot;debuggee&quot;: { # Represents the debugged application. The application may include one or more # Debuggee resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700298 # The field `id` is guaranteed to be set (in addition to the echoed fields).
299 # If the field `is_disabled` is set to `true`, the agent should disable
300 # itself by removing all breakpoints and detaching from the application.
301 # It should however continue to poll `RegisterDebuggee` until reenabled.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400302 # replicated processes executing the same code. Each of these processes is
303 # attached with a debugger agent, carrying out the debugging commands.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700304 # Agents attached to the same debuggee identify themselves as such by using
305 # exactly the same Debuggee message value when registering.
Bu Sun Kim65020912020-05-20 12:08:20 -0700306 &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 -0400307 # Absence of this field indicates no status. The message can be either
308 # informational or an error status.
309 # The message can indicate an error or informational status, and refer to
310 # specific parts of the containing object.
311 # For example, the `Breakpoint.status` field can indicate an error referring
312 # to the `BREAKPOINT_SOURCE_LOCATION` with the message `Location not found`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700313 &quot;isError&quot;: True or False, # Distinguishes errors from informational messages.
314 &quot;description&quot;: { # Represents a message with parameters. # Status message text.
Bu Sun Kim65020912020-05-20 12:08:20 -0700315 &quot;format&quot;: &quot;A String&quot;, # Format template for the message. The `format` uses placeholders `$0`,
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400316 # `$1`, etc. to reference parameters. `$$` can be used to denote the `$`
317 # character.
318 #
319 # Examples:
320 #
Bu Sun Kim65020912020-05-20 12:08:20 -0700321 # * `Failed to load &#x27;$0&#x27; which helps debug $1 the first time it
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400322 # is loaded. Again, $0 is very important.`
323 # * `Please pay $$10 to use $0 instead of $1.`
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700324 &quot;parameters&quot;: [ # Optional parameters to be embedded into the message.
325 &quot;A String&quot;,
326 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700327 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700328 &quot;refersTo&quot;: &quot;A String&quot;, # Reference to which the message applies.
Takashi Matsuo06694102015-09-11 13:55:40 -0700329 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700330 &quot;extSourceContexts&quot;: [ # References to the locations and revisions of the source code used in the
331 # deployed application.
332 { # An ExtendedSourceContext is a SourceContext combined with additional
333 # details describing the context.
334 &quot;context&quot;: { # A SourceContext is a reference to a tree of files. A SourceContext together # Any source context.
335 # with a path point to a unique revision of a single file or directory.
336 &quot;cloudRepo&quot;: { # A CloudRepoSourceContext denotes a particular revision in a cloud # A SourceContext referring to a revision in a cloud repo.
337 # repo (a repo hosted by the Google Cloud Platform).
338 &quot;aliasName&quot;: &quot;A String&quot;, # The name of an alias (branch, tag, etc.).
339 &quot;revisionId&quot;: &quot;A String&quot;, # A revision ID.
340 &quot;aliasContext&quot;: { # An alias to a repo revision. # An alias, which may be a branch or tag.
341 &quot;name&quot;: &quot;A String&quot;, # The alias name.
342 &quot;kind&quot;: &quot;A String&quot;, # The alias kind.
343 },
344 &quot;repoId&quot;: { # A unique identifier for a cloud repo. # The ID of the repo.
345 &quot;uid&quot;: &quot;A String&quot;, # A server-assigned, globally unique identifier.
346 &quot;projectRepoId&quot;: { # Selects a repo using a Google Cloud Platform project ID # A combination of a project ID and a repo name.
347 # (e.g. winged-cargo-31) and a repo name within that project.
348 &quot;repoName&quot;: &quot;A String&quot;, # The name of the repo. Leave empty for the default repo.
349 &quot;projectId&quot;: &quot;A String&quot;, # The ID of the project.
350 },
351 },
352 },
353 &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).
354 # repository (e.g. GitHub).
355 &quot;revisionId&quot;: &quot;A String&quot;, # Git commit hash.
356 # required.
357 &quot;url&quot;: &quot;A String&quot;, # Git repository URL.
358 },
359 &quot;cloudWorkspace&quot;: { # A CloudWorkspaceSourceContext denotes a workspace at a particular snapshot. # A SourceContext referring to a snapshot in a cloud workspace.
360 &quot;snapshotId&quot;: &quot;A String&quot;, # The ID of the snapshot.
361 # An empty snapshot_id refers to the most recent snapshot.
362 &quot;workspaceId&quot;: { # A CloudWorkspaceId is a unique identifier for a cloud workspace. # The ID of the workspace.
363 # A cloud workspace is a place associated with a repo where modified files
364 # can be stored before they are committed.
365 &quot;repoId&quot;: { # A unique identifier for a cloud repo. # The ID of the repo containing the workspace.
366 &quot;uid&quot;: &quot;A String&quot;, # A server-assigned, globally unique identifier.
367 &quot;projectRepoId&quot;: { # Selects a repo using a Google Cloud Platform project ID # A combination of a project ID and a repo name.
368 # (e.g. winged-cargo-31) and a repo name within that project.
369 &quot;repoName&quot;: &quot;A String&quot;, # The name of the repo. Leave empty for the default repo.
370 &quot;projectId&quot;: &quot;A String&quot;, # The ID of the project.
371 },
372 },
373 &quot;name&quot;: &quot;A String&quot;, # The unique name of the workspace within the repo. This is the name
374 # chosen by the client in the Source API&#x27;s CreateWorkspace method.
375 },
376 },
377 &quot;gerrit&quot;: { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project.
378 &quot;aliasContext&quot;: { # An alias to a repo revision. # An alias, which may be a branch or tag.
379 &quot;name&quot;: &quot;A String&quot;, # The alias name.
380 &quot;kind&quot;: &quot;A String&quot;, # The alias kind.
381 },
382 &quot;revisionId&quot;: &quot;A String&quot;, # A revision (commit) ID.
383 &quot;gerritProject&quot;: &quot;A String&quot;, # The full project name within the host. Projects may be nested, so
384 # &quot;project/subproject&quot; is a valid project name.
385 # The &quot;repo name&quot; is hostURI/project.
386 &quot;aliasName&quot;: &quot;A String&quot;, # The name of an alias (branch, tag, etc.).
387 &quot;hostUri&quot;: &quot;A String&quot;, # The URI of a running Gerrit instance.
388 },
389 },
390 &quot;labels&quot;: { # Labels with user defined metadata.
391 &quot;a_key&quot;: &quot;A String&quot;,
392 },
393 },
394 ],
395 &quot;canaryMode&quot;: &quot;A String&quot;, # Used when setting breakpoint canary for this debuggee.
396 &quot;isDisabled&quot;: True or False, # If set to `true`, indicates that the agent should disable itself and
397 # detach from the debuggee.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700398 &quot;isInactive&quot;: True or False, # If set to `true`, indicates that Controller service does not detect any
399 # activity from the debuggee agents and the application is possibly stopped.
Bu Sun Kim65020912020-05-20 12:08:20 -0700400 &quot;id&quot;: &quot;A String&quot;, # Unique identifier for the debuggee generated by the controller service.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700401 &quot;project&quot;: &quot;A String&quot;, # Project the debuggee is associated with.
402 # Use project number or id when registering a Google Cloud Platform project.
403 &quot;uniquifier&quot;: &quot;A String&quot;, # Uniquifier to further distinguish the application.
404 # It is possible that different applications might have identical values in
405 # the debuggee message, thus, incorrectly identified as a single application
406 # by the Controller service. This field adds salt to further distinguish the
407 # application. Agents should consider seeding this field with value that
408 # identifies the code, binary, configuration and environment.
409 &quot;sourceContexts&quot;: [ # References to the locations and revisions of the source code used in the
410 # deployed application.
411 { # A SourceContext is a reference to a tree of files. A SourceContext together
412 # with a path point to a unique revision of a single file or directory.
413 &quot;cloudRepo&quot;: { # A CloudRepoSourceContext denotes a particular revision in a cloud # A SourceContext referring to a revision in a cloud repo.
414 # repo (a repo hosted by the Google Cloud Platform).
415 &quot;aliasName&quot;: &quot;A String&quot;, # The name of an alias (branch, tag, etc.).
416 &quot;revisionId&quot;: &quot;A String&quot;, # A revision ID.
417 &quot;aliasContext&quot;: { # An alias to a repo revision. # An alias, which may be a branch or tag.
418 &quot;name&quot;: &quot;A String&quot;, # The alias name.
419 &quot;kind&quot;: &quot;A String&quot;, # The alias kind.
420 },
421 &quot;repoId&quot;: { # A unique identifier for a cloud repo. # The ID of the repo.
422 &quot;uid&quot;: &quot;A String&quot;, # A server-assigned, globally unique identifier.
423 &quot;projectRepoId&quot;: { # Selects a repo using a Google Cloud Platform project ID # A combination of a project ID and a repo name.
424 # (e.g. winged-cargo-31) and a repo name within that project.
425 &quot;repoName&quot;: &quot;A String&quot;, # The name of the repo. Leave empty for the default repo.
426 &quot;projectId&quot;: &quot;A String&quot;, # The ID of the project.
427 },
428 },
429 },
430 &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).
431 # repository (e.g. GitHub).
432 &quot;revisionId&quot;: &quot;A String&quot;, # Git commit hash.
433 # required.
434 &quot;url&quot;: &quot;A String&quot;, # Git repository URL.
435 },
436 &quot;cloudWorkspace&quot;: { # A CloudWorkspaceSourceContext denotes a workspace at a particular snapshot. # A SourceContext referring to a snapshot in a cloud workspace.
437 &quot;snapshotId&quot;: &quot;A String&quot;, # The ID of the snapshot.
438 # An empty snapshot_id refers to the most recent snapshot.
439 &quot;workspaceId&quot;: { # A CloudWorkspaceId is a unique identifier for a cloud workspace. # The ID of the workspace.
440 # A cloud workspace is a place associated with a repo where modified files
441 # can be stored before they are committed.
442 &quot;repoId&quot;: { # A unique identifier for a cloud repo. # The ID of the repo containing the workspace.
443 &quot;uid&quot;: &quot;A String&quot;, # A server-assigned, globally unique identifier.
444 &quot;projectRepoId&quot;: { # Selects a repo using a Google Cloud Platform project ID # A combination of a project ID and a repo name.
445 # (e.g. winged-cargo-31) and a repo name within that project.
446 &quot;repoName&quot;: &quot;A String&quot;, # The name of the repo. Leave empty for the default repo.
447 &quot;projectId&quot;: &quot;A String&quot;, # The ID of the project.
448 },
449 },
450 &quot;name&quot;: &quot;A String&quot;, # The unique name of the workspace within the repo. This is the name
451 # chosen by the client in the Source API&#x27;s CreateWorkspace method.
452 },
453 },
454 &quot;gerrit&quot;: { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project.
455 &quot;aliasContext&quot;: { # An alias to a repo revision. # An alias, which may be a branch or tag.
456 &quot;name&quot;: &quot;A String&quot;, # The alias name.
457 &quot;kind&quot;: &quot;A String&quot;, # The alias kind.
458 },
459 &quot;revisionId&quot;: &quot;A String&quot;, # A revision (commit) ID.
460 &quot;gerritProject&quot;: &quot;A String&quot;, # The full project name within the host. Projects may be nested, so
461 # &quot;project/subproject&quot; is a valid project name.
462 # The &quot;repo name&quot; is hostURI/project.
463 &quot;aliasName&quot;: &quot;A String&quot;, # The name of an alias (branch, tag, etc.).
464 &quot;hostUri&quot;: &quot;A String&quot;, # The URI of a running Gerrit instance.
465 },
466 },
467 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700468 &quot;agentVersion&quot;: &quot;A String&quot;, # Version ID of the agent.
469 # Schema: `domain/language-platform/vmajor.minor` (for example
470 # `google.com/java-gcp/v1.1`).
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700471 &quot;description&quot;: &quot;A String&quot;, # Human readable description of the debuggee.
472 # Including a human-readable project name, environment name and version
473 # information is recommended.
474 &quot;labels&quot;: { # A set of custom debuggee properties, populated by the agent, to be
475 # displayed to the user.
476 &quot;a_key&quot;: &quot;A String&quot;,
477 },
Takashi Matsuo06694102015-09-11 13:55:40 -0700478 },
Takashi Matsuo06694102015-09-11 13:55:40 -0700479 }</pre>
480</div>
481
482</body></html>