blob: f1c579fe0083b8845ea0e520a6dc45642daac894 [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">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070083 <code><a href="#close">close()</a></code></p>
84<p class="firstline">Close httplib2 connections.</p>
85<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070086 <code><a href="#register">register(body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070087<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 Matsuo06694102015-09-11 13:55:40 -070088<h3>Method Details</h3>
89<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070090 <code class="details" id="close">close()</code>
91 <pre>Close httplib2 connections.</pre>
92</div>
93
94<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -070095 <code class="details" id="register">register(body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070096 <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 Matsuo06694102015-09-11 13:55:40 -070097
98Args:
Dan O'Mearadd494642020-05-01 07:42:23 -070099 body: object, The request body.
Takashi Matsuo06694102015-09-11 13:55:40 -0700100 The object takes the form of:
101
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800102{ # Request to register a debuggee.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700103 &quot;debuggee&quot;: { # 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.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700104 &quot;sourceContexts&quot;: [ # References to the locations and revisions of the source code used in the deployed application.
105 { # 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.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700106 &quot;cloudRepo&quot;: { # 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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700107 &quot;aliasContext&quot;: { # An alias to a repo revision. # An alias, which may be a branch or tag.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700108 &quot;kind&quot;: &quot;A String&quot;, # The alias kind.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700109 &quot;name&quot;: &quot;A String&quot;, # The alias name.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700110 },
111 &quot;repoId&quot;: { # A unique identifier for a cloud repo. # The ID of the repo.
112 &quot;uid&quot;: &quot;A String&quot;, # A server-assigned, globally unique identifier.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700113 &quot;projectRepoId&quot;: { # 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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700114 &quot;repoName&quot;: &quot;A String&quot;, # The name of the repo. Leave empty for the default repo.
115 &quot;projectId&quot;: &quot;A String&quot;, # The ID of the project.
116 },
117 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700118 &quot;revisionId&quot;: &quot;A String&quot;, # A revision ID.
119 &quot;aliasName&quot;: &quot;A String&quot;, # The name of an alias (branch, tag, etc.).
120 },
121 &quot;git&quot;: { # 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).
122 &quot;url&quot;: &quot;A String&quot;, # Git repository URL.
123 &quot;revisionId&quot;: &quot;A String&quot;, # Git commit hash. required.
124 },
125 &quot;gerrit&quot;: { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project.
126 &quot;revisionId&quot;: &quot;A String&quot;, # A revision (commit) ID.
127 &quot;aliasName&quot;: &quot;A String&quot;, # The name of an alias (branch, tag, etc.).
128 &quot;aliasContext&quot;: { # An alias to a repo revision. # An alias, which may be a branch or tag.
129 &quot;kind&quot;: &quot;A String&quot;, # The alias kind.
130 &quot;name&quot;: &quot;A String&quot;, # The alias name.
131 },
132 &quot;hostUri&quot;: &quot;A String&quot;, # The URI of a running Gerrit instance.
133 &quot;gerritProject&quot;: &quot;A String&quot;, # The full project name within the host. Projects may be nested, so &quot;project/subproject&quot; is a valid project name. The &quot;repo name&quot; is hostURI/project.
134 },
135 &quot;cloudWorkspace&quot;: { # A CloudWorkspaceSourceContext denotes a workspace at a particular snapshot. # A SourceContext referring to a snapshot in a cloud workspace.
136 &quot;snapshotId&quot;: &quot;A String&quot;, # The ID of the snapshot. An empty snapshot_id refers to the most recent snapshot.
137 &quot;workspaceId&quot;: { # 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.
138 &quot;repoId&quot;: { # A unique identifier for a cloud repo. # The ID of the repo containing the workspace.
139 &quot;uid&quot;: &quot;A String&quot;, # A server-assigned, globally unique identifier.
140 &quot;projectRepoId&quot;: { # 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.
141 &quot;repoName&quot;: &quot;A String&quot;, # The name of the repo. Leave empty for the default repo.
142 &quot;projectId&quot;: &quot;A String&quot;, # The ID of the project.
143 },
144 },
145 &quot;name&quot;: &quot;A String&quot;, # The unique name of the workspace within the repo. This is the name chosen by the client in the Source API&#x27;s CreateWorkspace method.
146 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700147 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700148 },
149 ],
150 &quot;isInactive&quot;: 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.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700151 &quot;labels&quot;: { # A set of custom debuggee properties, populated by the agent, to be displayed to the user.
152 &quot;a_key&quot;: &quot;A String&quot;,
153 },
154 &quot;status&quot;: { # 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.
155 &quot;isError&quot;: True or False, # Distinguishes errors from informational messages.
156 &quot;description&quot;: { # Represents a message with parameters. # Status message text.
157 &quot;format&quot;: &quot;A String&quot;, # 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 &#x27;$0&#x27; which helps debug $1 the first time it is loaded. Again, $0 is very important.` * `Please pay $$10 to use $0 instead of $1.`
158 &quot;parameters&quot;: [ # Optional parameters to be embedded into the message.
159 &quot;A String&quot;,
160 ],
161 },
162 &quot;refersTo&quot;: &quot;A String&quot;, # Reference to which the message applies.
163 },
164 &quot;project&quot;: &quot;A String&quot;, # Project the debuggee is associated with. Use project number or id when registering a Google Cloud Platform project.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700165 &quot;extSourceContexts&quot;: [ # References to the locations and revisions of the source code used in the deployed application.
166 { # An ExtendedSourceContext is a SourceContext combined with additional details describing the context.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700167 &quot;labels&quot;: { # Labels with user defined metadata.
168 &quot;a_key&quot;: &quot;A String&quot;,
169 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700170 &quot;context&quot;: { # 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.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700171 &quot;cloudRepo&quot;: { # 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.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700172 &quot;aliasContext&quot;: { # An alias to a repo revision. # An alias, which may be a branch or tag.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700173 &quot;kind&quot;: &quot;A String&quot;, # The alias kind.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700174 &quot;name&quot;: &quot;A String&quot;, # The alias name.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700175 },
176 &quot;repoId&quot;: { # A unique identifier for a cloud repo. # The ID of the repo.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700177 &quot;uid&quot;: &quot;A String&quot;, # A server-assigned, globally unique identifier.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700178 &quot;projectRepoId&quot;: { # 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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700179 &quot;repoName&quot;: &quot;A String&quot;, # The name of the repo. Leave empty for the default repo.
180 &quot;projectId&quot;: &quot;A String&quot;, # The ID of the project.
181 },
182 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700183 &quot;revisionId&quot;: &quot;A String&quot;, # A revision ID.
184 &quot;aliasName&quot;: &quot;A String&quot;, # The name of an alias (branch, tag, etc.).
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700185 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700186 &quot;git&quot;: { # 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).
187 &quot;url&quot;: &quot;A String&quot;, # Git repository URL.
188 &quot;revisionId&quot;: &quot;A String&quot;, # Git commit hash. required.
189 },
190 &quot;gerrit&quot;: { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project.
191 &quot;revisionId&quot;: &quot;A String&quot;, # A revision (commit) ID.
192 &quot;aliasName&quot;: &quot;A String&quot;, # The name of an alias (branch, tag, etc.).
193 &quot;aliasContext&quot;: { # An alias to a repo revision. # An alias, which may be a branch or tag.
194 &quot;kind&quot;: &quot;A String&quot;, # The alias kind.
195 &quot;name&quot;: &quot;A String&quot;, # The alias name.
196 },
197 &quot;hostUri&quot;: &quot;A String&quot;, # The URI of a running Gerrit instance.
198 &quot;gerritProject&quot;: &quot;A String&quot;, # The full project name within the host. Projects may be nested, so &quot;project/subproject&quot; is a valid project name. The &quot;repo name&quot; is hostURI/project.
199 },
200 &quot;cloudWorkspace&quot;: { # A CloudWorkspaceSourceContext denotes a workspace at a particular snapshot. # A SourceContext referring to a snapshot in a cloud workspace.
201 &quot;snapshotId&quot;: &quot;A String&quot;, # The ID of the snapshot. An empty snapshot_id refers to the most recent snapshot.
202 &quot;workspaceId&quot;: { # 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.
203 &quot;repoId&quot;: { # A unique identifier for a cloud repo. # The ID of the repo containing the workspace.
204 &quot;uid&quot;: &quot;A String&quot;, # A server-assigned, globally unique identifier.
205 &quot;projectRepoId&quot;: { # 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.
206 &quot;repoName&quot;: &quot;A String&quot;, # The name of the repo. Leave empty for the default repo.
207 &quot;projectId&quot;: &quot;A String&quot;, # The ID of the project.
208 },
209 },
210 &quot;name&quot;: &quot;A String&quot;, # The unique name of the workspace within the repo. This is the name chosen by the client in the Source API&#x27;s CreateWorkspace method.
211 },
212 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700213 },
214 },
215 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700216 &quot;agentVersion&quot;: &quot;A String&quot;, # Version ID of the agent. Schema: `domain/language-platform/vmajor.minor` (for example `google.com/java-gcp/v1.1`).
217 &quot;isDisabled&quot;: True or False, # If set to `true`, indicates that the agent should disable itself and detach from the debuggee.
218 &quot;canaryMode&quot;: &quot;A String&quot;, # Used when setting breakpoint canary for this debuggee.
219 &quot;id&quot;: &quot;A String&quot;, # Unique identifier for the debuggee generated by the controller service.
220 &quot;uniquifier&quot;: &quot;A String&quot;, # 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.
221 &quot;description&quot;: &quot;A String&quot;, # Human readable description of the debuggee. Including a human-readable project name, environment name and version information is recommended.
Takashi Matsuo06694102015-09-11 13:55:40 -0700222 },
223 }
224
225 x__xgafv: string, V1 error format.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400226 Allowed values
227 1 - v1 error format
228 2 - v2 error format
Takashi Matsuo06694102015-09-11 13:55:40 -0700229
230Returns:
231 An object of the form:
232
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800233 { # Response for registering a debuggee.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700234 &quot;agentId&quot;: &quot;A String&quot;, # A unique ID generated for the agent. Each RegisterDebuggee request will generate a new agent ID.
235 &quot;debuggee&quot;: { # 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.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700236 &quot;sourceContexts&quot;: [ # References to the locations and revisions of the source code used in the deployed application.
237 { # 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.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700238 &quot;cloudRepo&quot;: { # 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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700239 &quot;aliasContext&quot;: { # An alias to a repo revision. # An alias, which may be a branch or tag.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700240 &quot;kind&quot;: &quot;A String&quot;, # The alias kind.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700241 &quot;name&quot;: &quot;A String&quot;, # The alias name.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700242 },
243 &quot;repoId&quot;: { # A unique identifier for a cloud repo. # The ID of the repo.
244 &quot;uid&quot;: &quot;A String&quot;, # A server-assigned, globally unique identifier.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700245 &quot;projectRepoId&quot;: { # 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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700246 &quot;repoName&quot;: &quot;A String&quot;, # The name of the repo. Leave empty for the default repo.
247 &quot;projectId&quot;: &quot;A String&quot;, # The ID of the project.
248 },
249 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700250 &quot;revisionId&quot;: &quot;A String&quot;, # A revision ID.
251 &quot;aliasName&quot;: &quot;A String&quot;, # The name of an alias (branch, tag, etc.).
252 },
253 &quot;git&quot;: { # 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).
254 &quot;url&quot;: &quot;A String&quot;, # Git repository URL.
255 &quot;revisionId&quot;: &quot;A String&quot;, # Git commit hash. required.
256 },
257 &quot;gerrit&quot;: { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project.
258 &quot;revisionId&quot;: &quot;A String&quot;, # A revision (commit) ID.
259 &quot;aliasName&quot;: &quot;A String&quot;, # The name of an alias (branch, tag, etc.).
260 &quot;aliasContext&quot;: { # An alias to a repo revision. # An alias, which may be a branch or tag.
261 &quot;kind&quot;: &quot;A String&quot;, # The alias kind.
262 &quot;name&quot;: &quot;A String&quot;, # The alias name.
263 },
264 &quot;hostUri&quot;: &quot;A String&quot;, # The URI of a running Gerrit instance.
265 &quot;gerritProject&quot;: &quot;A String&quot;, # The full project name within the host. Projects may be nested, so &quot;project/subproject&quot; is a valid project name. The &quot;repo name&quot; is hostURI/project.
266 },
267 &quot;cloudWorkspace&quot;: { # A CloudWorkspaceSourceContext denotes a workspace at a particular snapshot. # A SourceContext referring to a snapshot in a cloud workspace.
268 &quot;snapshotId&quot;: &quot;A String&quot;, # The ID of the snapshot. An empty snapshot_id refers to the most recent snapshot.
269 &quot;workspaceId&quot;: { # 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.
270 &quot;repoId&quot;: { # A unique identifier for a cloud repo. # The ID of the repo containing the workspace.
271 &quot;uid&quot;: &quot;A String&quot;, # A server-assigned, globally unique identifier.
272 &quot;projectRepoId&quot;: { # 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.
273 &quot;repoName&quot;: &quot;A String&quot;, # The name of the repo. Leave empty for the default repo.
274 &quot;projectId&quot;: &quot;A String&quot;, # The ID of the project.
275 },
276 },
277 &quot;name&quot;: &quot;A String&quot;, # The unique name of the workspace within the repo. This is the name chosen by the client in the Source API&#x27;s CreateWorkspace method.
278 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700279 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700280 },
281 ],
282 &quot;isInactive&quot;: 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.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700283 &quot;labels&quot;: { # A set of custom debuggee properties, populated by the agent, to be displayed to the user.
284 &quot;a_key&quot;: &quot;A String&quot;,
285 },
286 &quot;status&quot;: { # 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.
287 &quot;isError&quot;: True or False, # Distinguishes errors from informational messages.
288 &quot;description&quot;: { # Represents a message with parameters. # Status message text.
289 &quot;format&quot;: &quot;A String&quot;, # 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 &#x27;$0&#x27; which helps debug $1 the first time it is loaded. Again, $0 is very important.` * `Please pay $$10 to use $0 instead of $1.`
290 &quot;parameters&quot;: [ # Optional parameters to be embedded into the message.
291 &quot;A String&quot;,
292 ],
293 },
294 &quot;refersTo&quot;: &quot;A String&quot;, # Reference to which the message applies.
295 },
296 &quot;project&quot;: &quot;A String&quot;, # Project the debuggee is associated with. Use project number or id when registering a Google Cloud Platform project.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700297 &quot;extSourceContexts&quot;: [ # References to the locations and revisions of the source code used in the deployed application.
298 { # An ExtendedSourceContext is a SourceContext combined with additional details describing the context.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700299 &quot;labels&quot;: { # Labels with user defined metadata.
300 &quot;a_key&quot;: &quot;A String&quot;,
301 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700302 &quot;context&quot;: { # 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.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700303 &quot;cloudRepo&quot;: { # 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.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700304 &quot;aliasContext&quot;: { # An alias to a repo revision. # An alias, which may be a branch or tag.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700305 &quot;kind&quot;: &quot;A String&quot;, # The alias kind.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700306 &quot;name&quot;: &quot;A String&quot;, # The alias name.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700307 },
308 &quot;repoId&quot;: { # A unique identifier for a cloud repo. # The ID of the repo.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700309 &quot;uid&quot;: &quot;A String&quot;, # A server-assigned, globally unique identifier.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700310 &quot;projectRepoId&quot;: { # 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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700311 &quot;repoName&quot;: &quot;A String&quot;, # The name of the repo. Leave empty for the default repo.
312 &quot;projectId&quot;: &quot;A String&quot;, # The ID of the project.
313 },
314 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700315 &quot;revisionId&quot;: &quot;A String&quot;, # A revision ID.
316 &quot;aliasName&quot;: &quot;A String&quot;, # The name of an alias (branch, tag, etc.).
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700317 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700318 &quot;git&quot;: { # 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).
319 &quot;url&quot;: &quot;A String&quot;, # Git repository URL.
320 &quot;revisionId&quot;: &quot;A String&quot;, # Git commit hash. required.
321 },
322 &quot;gerrit&quot;: { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project.
323 &quot;revisionId&quot;: &quot;A String&quot;, # A revision (commit) ID.
324 &quot;aliasName&quot;: &quot;A String&quot;, # The name of an alias (branch, tag, etc.).
325 &quot;aliasContext&quot;: { # An alias to a repo revision. # An alias, which may be a branch or tag.
326 &quot;kind&quot;: &quot;A String&quot;, # The alias kind.
327 &quot;name&quot;: &quot;A String&quot;, # The alias name.
328 },
329 &quot;hostUri&quot;: &quot;A String&quot;, # The URI of a running Gerrit instance.
330 &quot;gerritProject&quot;: &quot;A String&quot;, # The full project name within the host. Projects may be nested, so &quot;project/subproject&quot; is a valid project name. The &quot;repo name&quot; is hostURI/project.
331 },
332 &quot;cloudWorkspace&quot;: { # A CloudWorkspaceSourceContext denotes a workspace at a particular snapshot. # A SourceContext referring to a snapshot in a cloud workspace.
333 &quot;snapshotId&quot;: &quot;A String&quot;, # The ID of the snapshot. An empty snapshot_id refers to the most recent snapshot.
334 &quot;workspaceId&quot;: { # 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.
335 &quot;repoId&quot;: { # A unique identifier for a cloud repo. # The ID of the repo containing the workspace.
336 &quot;uid&quot;: &quot;A String&quot;, # A server-assigned, globally unique identifier.
337 &quot;projectRepoId&quot;: { # 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.
338 &quot;repoName&quot;: &quot;A String&quot;, # The name of the repo. Leave empty for the default repo.
339 &quot;projectId&quot;: &quot;A String&quot;, # The ID of the project.
340 },
341 },
342 &quot;name&quot;: &quot;A String&quot;, # The unique name of the workspace within the repo. This is the name chosen by the client in the Source API&#x27;s CreateWorkspace method.
343 },
344 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700345 },
346 },
347 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700348 &quot;agentVersion&quot;: &quot;A String&quot;, # Version ID of the agent. Schema: `domain/language-platform/vmajor.minor` (for example `google.com/java-gcp/v1.1`).
349 &quot;isDisabled&quot;: True or False, # If set to `true`, indicates that the agent should disable itself and detach from the debuggee.
350 &quot;canaryMode&quot;: &quot;A String&quot;, # Used when setting breakpoint canary for this debuggee.
351 &quot;id&quot;: &quot;A String&quot;, # Unique identifier for the debuggee generated by the controller service.
352 &quot;uniquifier&quot;: &quot;A String&quot;, # 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.
353 &quot;description&quot;: &quot;A String&quot;, # Human readable description of the debuggee. Including a human-readable project name, environment name and version information is recommended.
Takashi Matsuo06694102015-09-11 13:55:40 -0700354 },
Takashi Matsuo06694102015-09-11 13:55:40 -0700355 }</pre>
356</div>
357
358</body></html>