Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / e833b79ffee531ae64e11175718bb2fffc504950 / . / docs / dyn / clouddebugger_v2.controller.debuggees.html
blob: 46ed047c223894533f7b24b4271a6e2888794ab6 [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
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]75<h1><a href="clouddebugger_v2.html">Stackdriver 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">
83 <code><a href="#register">register(body, 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">
87 <code class="details" id="register">register(body, x__xgafv=None)</code>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]88 <pre>Registers the debuggee with the controller service.
89
90All agents attached to the same application should call this method with
91the same request content to get back the same stable `debuggee_id`. Agents
92should call this method again whenever `google.rpc.Code.NOT_FOUND` is
93returned from any controller method.
94
95This allows the controller service to disable the agent or recover from any
96data loss. If the debuggee is disabled by the server, the response will
97have `is_disabled` set to `true`.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]98
99Args:
100 body: object, The request body. (required)
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.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]104 "debuggee": { # Represents the application to debug. The application may include one or more # Debuggee information to register.
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.
109 # The agents attached to the same debuggee are identified by using exactly the
110 # same field values when registering.
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 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]144 "uniquifier": "A String", # Debuggee uniquifier within the project.
145 # Any string that identifies the application within the project can be used.
146 # Including environment and version or build IDs is recommended.
147 "project": "A String", # Project the debuggee is associated with.
148 # Use the project number when registering a Google Cloud Platform project.
149 "sourceContexts": [ # References to the locations and revisions of the source code used in the
150 # deployed application.
151 #
152 # NOTE: This field is deprecated. Consumers should use
153 # `ext_source_contexts` if it is not empty. Debug agents should populate
154 # both this field and `ext_source_contexts`.
155 { # A SourceContext is a reference to a tree of files. A SourceContext together
156 # with a path point to a unique revision of a single file or directory.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]157 "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]158 "snapshotId": "A String", # The ID of the snapshot.
159 # An empty snapshot_id refers to the most recent snapshot.
160 "workspaceId": { # A CloudWorkspaceId is a unique identifier for a cloud workspace. # The ID of the workspace.
161 # A cloud workspace is a place associated with a repo where modified files
162 # can be stored before they are committed.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame^]163 "name": "A String", # The unique name of the workspace within the repo. This is the name
164 # chosen by the client in the Source API's CreateWorkspace method.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]165 "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]166 "projectRepoId": { # Selects a repo using a Google Cloud Platform project ID # A combination of a project ID and a repo name.
167 # (e.g. winged-cargo-31) and a repo name within that project.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]168 "projectId": "A String", # The ID of the project.
169 "repoName": "A String", # The name of the repo. Leave empty for the default repo.
170 },
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame^]171 "uid": "A String", # A server-assigned, globally unique identifier.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]172 },
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]173 },
174 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]175 "cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a cloud # A SourceContext referring to a revision in a cloud repo.
176 # repo (a repo hosted by the Google Cloud Platform).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]177 "aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.
178 "kind": "A String", # The alias kind.
179 "name": "A String", # The alias name.
180 },
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]181 "revisionId": "A String", # A revision ID.
182 "aliasName": "A String", # The name of an alias (branch, tag, etc.).
183 "repoId": { # A unique identifier for a cloud repo. # The ID of the repo.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]184 "projectRepoId": { # Selects a repo using a Google Cloud Platform project ID # A combination of a project ID and a repo name.
185 # (e.g. winged-cargo-31) and a repo name within that project.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]186 "projectId": "A String", # The ID of the project.
187 "repoName": "A String", # The name of the repo. Leave empty for the default repo.
188 },
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame^]189 "uid": "A String", # A server-assigned, globally unique identifier.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]190 },
191 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]192 "git": { # A GitSourceContext denotes a particular revision in a third party Git # A SourceContext referring to any third party Git repo (e.g. GitHub).
193 # repository (e.g. GitHub).
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]194 "url": "A String", # Git repository URL.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]195 "revisionId": "A String", # Git commit hash.
196 # required.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]197 },
198 "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]199 "aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.
200 "kind": "A String", # The alias kind.
201 "name": "A String", # The alias name.
202 },
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]203 "revisionId": "A String", # A revision (commit) ID.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]204 "gerritProject": "A String", # The full project name within the host. Projects may be nested, so
205 # "project/subproject" is a valid project name.
206 # The "repo name" is hostURI/project.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame^]207 "hostUri": "A String", # The URI of a running Gerrit instance.
208 "aliasName": "A String", # The name of an alias (branch, tag, etc.).
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]209 },
210 },
211 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]212 "extSourceContexts": [ # References to the locations and revisions of the source code used in the
213 # deployed application.
214 #
215 # Contexts describing a remote repo related to the source code
216 # have a `category` label of `remote_repo`. Source snapshot source
217 # contexts have a `category` of `snapshot`.
218 { # An ExtendedSourceContext is a SourceContext combined with additional
219 # details describing the context.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]220 "labels": { # Labels with user defined metadata.
221 "a_key": "A String",
222 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]223 "context": { # A SourceContext is a reference to a tree of files. A SourceContext together # Any source context.
224 # 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]225 "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]226 "snapshotId": "A String", # The ID of the snapshot.
227 # An empty snapshot_id refers to the most recent snapshot.
228 "workspaceId": { # A CloudWorkspaceId is a unique identifier for a cloud workspace. # The ID of the workspace.
229 # A cloud workspace is a place associated with a repo where modified files
230 # can be stored before they are committed.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame^]231 "name": "A String", # The unique name of the workspace within the repo. This is the name
232 # chosen by the client in the Source API's CreateWorkspace method.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]233 "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]234 "projectRepoId": { # Selects a repo using a Google Cloud Platform project ID # A combination of a project ID and a repo name.
235 # (e.g. winged-cargo-31) and a repo name within that project.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]236 "projectId": "A String", # The ID of the project.
237 "repoName": "A String", # The name of the repo. Leave empty for the default repo.
238 },
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame^]239 "uid": "A String", # A server-assigned, globally unique identifier.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]240 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]241 },
242 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]243 "cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a cloud # A SourceContext referring to a revision in a cloud repo.
244 # repo (a repo hosted by the Google Cloud Platform).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]245 "aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.
246 "kind": "A String", # The alias kind.
247 "name": "A String", # The alias name.
248 },
249 "revisionId": "A String", # A revision ID.
250 "aliasName": "A String", # The name of an alias (branch, tag, etc.).
251 "repoId": { # A unique identifier for a cloud repo. # The ID of the repo.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]252 "projectRepoId": { # Selects a repo using a Google Cloud Platform project ID # A combination of a project ID and a repo name.
253 # (e.g. winged-cargo-31) and a repo name within that project.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]254 "projectId": "A String", # The ID of the project.
255 "repoName": "A String", # The name of the repo. Leave empty for the default repo.
256 },
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame^]257 "uid": "A String", # A server-assigned, globally unique identifier.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]258 },
259 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]260 "git": { # A GitSourceContext denotes a particular revision in a third party Git # A SourceContext referring to any third party Git repo (e.g. GitHub).
261 # repository (e.g. GitHub).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]262 "url": "A String", # Git repository URL.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]263 "revisionId": "A String", # Git commit hash.
264 # required.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]265 },
266 "gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project.
267 "aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.
268 "kind": "A String", # The alias kind.
269 "name": "A String", # The alias name.
270 },
271 "revisionId": "A String", # A revision (commit) ID.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]272 "gerritProject": "A String", # The full project name within the host. Projects may be nested, so
273 # "project/subproject" is a valid project name.
274 # The "repo name" is hostURI/project.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame^]275 "hostUri": "A String", # The URI of a running Gerrit instance.
276 "aliasName": "A String", # The name of an alias (branch, tag, etc.).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]277 },
278 },
279 },
280 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]281 "agentVersion": "A String", # Version ID of the agent release. The version ID is structured as
282 # following: `domain/type/vmajor.minor` (for example
283 # `google.com/gcp-java/v1.1`).
284 "isInactive": True or False, # If set to `true`, indicates that the debuggee is considered as inactive by
285 # the Controller service.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]286 "id": "A String", # Unique identifier for the debuggee generated by the controller service.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]287 },
288 }
289
290 x__xgafv: string, V1 error format.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]291 Allowed values
292 1 - v1 error format
293 2 - v2 error format
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]294
295Returns:
296 An object of the form:
297
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]298 { # Response for registering a debuggee.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]299 "debuggee": { # Represents the application to debug. The application may include one or more # Debuggee resource.
300 # The field `id` is guranteed to be set (in addition to the echoed fields).
301 # replicated processes executing the same code. Each of these processes is
302 # attached with a debugger agent, carrying out the debugging commands.
303 # The agents attached to the same debuggee are identified by using exactly the
304 # same field values when registering.
305 "status": { # Represents a contextual status message. # Human readable message to be displayed to the user about this debuggee.
306 # Absence of this field indicates no status. The message can be either
307 # informational or an error status.
308 # The message can indicate an error or informational status, and refer to
309 # specific parts of the containing object.
310 # For example, the `Breakpoint.status` field can indicate an error referring
311 # to the `BREAKPOINT_SOURCE_LOCATION` with the message `Location not found`.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]312 "isError": True or False, # Distinguishes errors from informational messages.
313 "refersTo": "A String", # Reference to which the message applies.
314 "description": { # Represents a message with parameters. # Status message text.
315 "parameters": [ # Optional parameters to be embedded into the message.
316 "A String",
317 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]318 "format": "A String", # Format template for the message. The `format` uses placeholders `$0`,
319 # `$1`, etc. to reference parameters. `$$` can be used to denote the `$`
320 # character.
321 #
322 # Examples:
323 #
324 # * `Failed to load '$0' which helps debug $1 the first time it
325 # is loaded. Again, $0 is very important.`
326 # * `Please pay $$10 to use $0 instead of $1.`
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]327 },
328 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]329 "description": "A String", # Human readable description of the debuggee.
330 # Including a human-readable project name, environment name and version
331 # information is recommended.
332 "isDisabled": True or False, # If set to `true`, indicates that the agent should disable itself and
333 # detach from the debuggee.
334 "labels": { # A set of custom debuggee properties, populated by the agent, to be
335 # displayed to the user.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]336 "a_key": "A String",
337 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]338 "uniquifier": "A String", # Debuggee uniquifier within the project.
339 # Any string that identifies the application within the project can be used.
340 # Including environment and version or build IDs is recommended.
341 "project": "A String", # Project the debuggee is associated with.
342 # Use the project number when registering a Google Cloud Platform project.
343 "sourceContexts": [ # References to the locations and revisions of the source code used in the
344 # deployed application.
345 #
346 # NOTE: This field is deprecated. Consumers should use
347 # `ext_source_contexts` if it is not empty. Debug agents should populate
348 # both this field and `ext_source_contexts`.
349 { # A SourceContext is a reference to a tree of files. A SourceContext together
350 # with a path point to a unique revision of a single file or directory.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]351 "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]352 "snapshotId": "A String", # The ID of the snapshot.
353 # An empty snapshot_id refers to the most recent snapshot.
354 "workspaceId": { # A CloudWorkspaceId is a unique identifier for a cloud workspace. # The ID of the workspace.
355 # A cloud workspace is a place associated with a repo where modified files
356 # can be stored before they are committed.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame^]357 "name": "A String", # The unique name of the workspace within the repo. This is the name
358 # chosen by the client in the Source API's CreateWorkspace method.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]359 "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]360 "projectRepoId": { # Selects a repo using a Google Cloud Platform project ID # A combination of a project ID and a repo name.
361 # (e.g. winged-cargo-31) and a repo name within that project.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]362 "projectId": "A String", # The ID of the project.
363 "repoName": "A String", # The name of the repo. Leave empty for the default repo.
364 },
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame^]365 "uid": "A String", # A server-assigned, globally unique identifier.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]366 },
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]367 },
368 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]369 "cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a cloud # A SourceContext referring to a revision in a cloud repo.
370 # repo (a repo hosted by the Google Cloud Platform).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]371 "aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.
372 "kind": "A String", # The alias kind.
373 "name": "A String", # The alias name.
374 },
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]375 "revisionId": "A String", # A revision ID.
376 "aliasName": "A String", # The name of an alias (branch, tag, etc.).
377 "repoId": { # A unique identifier for a cloud repo. # The ID of the repo.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]378 "projectRepoId": { # Selects a repo using a Google Cloud Platform project ID # A combination of a project ID and a repo name.
379 # (e.g. winged-cargo-31) and a repo name within that project.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]380 "projectId": "A String", # The ID of the project.
381 "repoName": "A String", # The name of the repo. Leave empty for the default repo.
382 },
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame^]383 "uid": "A String", # A server-assigned, globally unique identifier.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]384 },
385 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]386 "git": { # A GitSourceContext denotes a particular revision in a third party Git # A SourceContext referring to any third party Git repo (e.g. GitHub).
387 # repository (e.g. GitHub).
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]388 "url": "A String", # Git repository URL.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]389 "revisionId": "A String", # Git commit hash.
390 # required.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]391 },
392 "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]393 "aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.
394 "kind": "A String", # The alias kind.
395 "name": "A String", # The alias name.
396 },
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]397 "revisionId": "A String", # A revision (commit) ID.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]398 "gerritProject": "A String", # The full project name within the host. Projects may be nested, so
399 # "project/subproject" is a valid project name.
400 # The "repo name" is hostURI/project.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame^]401 "hostUri": "A String", # The URI of a running Gerrit instance.
402 "aliasName": "A String", # The name of an alias (branch, tag, etc.).
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]403 },
404 },
405 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]406 "extSourceContexts": [ # References to the locations and revisions of the source code used in the
407 # deployed application.
408 #
409 # Contexts describing a remote repo related to the source code
410 # have a `category` label of `remote_repo`. Source snapshot source
411 # contexts have a `category` of `snapshot`.
412 { # An ExtendedSourceContext is a SourceContext combined with additional
413 # details describing the context.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]414 "labels": { # Labels with user defined metadata.
415 "a_key": "A String",
416 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]417 "context": { # A SourceContext is a reference to a tree of files. A SourceContext together # Any source context.
418 # 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]419 "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]420 "snapshotId": "A String", # The ID of the snapshot.
421 # An empty snapshot_id refers to the most recent snapshot.
422 "workspaceId": { # A CloudWorkspaceId is a unique identifier for a cloud workspace. # The ID of the workspace.
423 # A cloud workspace is a place associated with a repo where modified files
424 # can be stored before they are committed.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame^]425 "name": "A String", # The unique name of the workspace within the repo. This is the name
426 # chosen by the client in the Source API's CreateWorkspace method.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]427 "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]428 "projectRepoId": { # Selects a repo using a Google Cloud Platform project ID # A combination of a project ID and a repo name.
429 # (e.g. winged-cargo-31) and a repo name within that project.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]430 "projectId": "A String", # The ID of the project.
431 "repoName": "A String", # The name of the repo. Leave empty for the default repo.
432 },
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame^]433 "uid": "A String", # A server-assigned, globally unique identifier.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]434 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]435 },
436 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]437 "cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a cloud # A SourceContext referring to a revision in a cloud repo.
438 # repo (a repo hosted by the Google Cloud Platform).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]439 "aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.
440 "kind": "A String", # The alias kind.
441 "name": "A String", # The alias name.
442 },
443 "revisionId": "A String", # A revision ID.
444 "aliasName": "A String", # The name of an alias (branch, tag, etc.).
445 "repoId": { # A unique identifier for a cloud repo. # The ID of the repo.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]446 "projectRepoId": { # Selects a repo using a Google Cloud Platform project ID # A combination of a project ID and a repo name.
447 # (e.g. winged-cargo-31) and a repo name within that project.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]448 "projectId": "A String", # The ID of the project.
449 "repoName": "A String", # The name of the repo. Leave empty for the default repo.
450 },
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame^]451 "uid": "A String", # A server-assigned, globally unique identifier.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]452 },
453 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]454 "git": { # A GitSourceContext denotes a particular revision in a third party Git # A SourceContext referring to any third party Git repo (e.g. GitHub).
455 # repository (e.g. GitHub).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]456 "url": "A String", # Git repository URL.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]457 "revisionId": "A String", # Git commit hash.
458 # required.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]459 },
460 "gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project.
461 "aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.
462 "kind": "A String", # The alias kind.
463 "name": "A String", # The alias name.
464 },
465 "revisionId": "A String", # A revision (commit) ID.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]466 "gerritProject": "A String", # The full project name within the host. Projects may be nested, so
467 # "project/subproject" is a valid project name.
468 # The "repo name" is hostURI/project.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame^]469 "hostUri": "A String", # The URI of a running Gerrit instance.
470 "aliasName": "A String", # The name of an alias (branch, tag, etc.).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]471 },
472 },
473 },
474 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]475 "agentVersion": "A String", # Version ID of the agent release. The version ID is structured as
476 # following: `domain/type/vmajor.minor` (for example
477 # `google.com/gcp-java/v1.1`).
478 "isInactive": True or False, # If set to `true`, indicates that the debuggee is considered as inactive by
479 # the Controller service.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]480 "id": "A String", # Unique identifier for the debuggee generated by the controller service.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]481 },
482 }</pre>
483</div>
484
485</body></html>