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