Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / f80be181200f4aae910badec3f4bddea08ae5044 / . / docs / dyn / clouddebugger_v2.debugger.debuggees.html
blob: e859d6bb6cc99f455798fec1c8a4df6abeeb9e2b [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.debugger.html">debugger</a> . <a href="clouddebugger_v2.debugger.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.debugger.debuggees.breakpoints.html">breakpoints()</a></code>
79</p>
80<p class="firstline">Returns the breakpoints Resource.</p>
81
82<p class="toc_element">
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]83 <code><a href="#list">list(clientVersion=None, includeInactive=None, project=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]84<p class="firstline">Lists all the debuggees that the user has access to.</p>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]85<h3>Method Details</h3>
86<div class="method">
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]87 <code class="details" id="list">list(clientVersion=None, includeInactive=None, project=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]88 <pre>Lists all the debuggees that the user has access to.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]89
90Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]91 clientVersion: string, Required. The client version making the call.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]92Schema: `domain/type/version` (e.g., `google.com/intellij/v1`).
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]93 includeInactive: boolean, When set to `true`, the result includes all debuggees. Otherwise, the
94result includes only debuggees that are active.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]95 project: string, Required. Project number of a Google Cloud project whose debuggees to list.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]96 x__xgafv: string, V1 error format.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]97 Allowed values
98 1 - v1 error format
99 2 - v2 error format
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]100
101Returns:
102 An object of the form:
103
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]104 { # Response for listing debuggees.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]105 "debuggees": [ # List of debuggees accessible to the calling user.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]106 # The fields `debuggee.id` and `description` are guaranteed to be set.
107 # The `description` field is a human readable field provided by agents and
108 # can be displayed to users.
109 { # Represents the debugged application. The application may include one or more
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]110 # replicated processes executing the same code. Each of these processes is
111 # attached with a debugger agent, carrying out the debugging commands.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]112 # Agents attached to the same debuggee identify themselves as such by using
113 # exactly the same Debuggee message value when registering.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]114 "status": { # Represents a contextual status message. # Human readable message to be displayed to the user about this debuggee.
115 # Absence of this field indicates no status. The message can be either
116 # informational or an error status.
117 # The message can indicate an error or informational status, and refer to
118 # specific parts of the containing object.
119 # For example, the `Breakpoint.status` field can indicate an error referring
120 # to the `BREAKPOINT_SOURCE_LOCATION` with the message `Location not found`.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]121 "isError": True or False, # Distinguishes errors from informational messages.
122 "refersTo": "A String", # Reference to which the message applies.
123 "description": { # Represents a message with parameters. # Status message text.
124 "parameters": [ # Optional parameters to be embedded into the message.
125 "A String",
126 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]127 "format": "A String", # Format template for the message. The `format` uses placeholders `$0`,
128 # `$1`, etc. to reference parameters. `$$` can be used to denote the `$`
129 # character.
130 #
131 # Examples:
132 #
133 # * `Failed to load '$0' which helps debug $1 the first time it
134 # is loaded. Again, $0 is very important.`
135 # * `Please pay $$10 to use $0 instead of $1.`
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]136 },
137 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]138 "description": "A String", # Human readable description of the debuggee.
139 # Including a human-readable project name, environment name and version
140 # information is recommended.
141 "isDisabled": True or False, # If set to `true`, indicates that the agent should disable itself and
142 # detach from the debuggee.
143 "labels": { # A set of custom debuggee properties, populated by the agent, to be
144 # displayed to the user.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]145 "a_key": "A String",
146 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]147 "uniquifier": "A String", # Uniquifier to further distinguish the application.
148 # It is possible that different applications might have identical values in
149 # the debuggee message, thus, incorrectly identified as a single application
150 # by the Controller service. This field adds salt to further distinguish the
151 # application. Agents should consider seeding this field with value that
152 # identifies the code, binary, configuration and environment.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]153 "project": "A String", # Project the debuggee is associated with.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]154 # Use project number or id when registering a Google Cloud Platform project.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]155 "sourceContexts": [ # References to the locations and revisions of the source code used in the
156 # deployed application.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]157 { # A SourceContext is a reference to a tree of files. A SourceContext together
158 # with a path point to a unique revision of a single file or directory.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]159 "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]160 "snapshotId": "A String", # The ID of the snapshot.
161 # An empty snapshot_id refers to the most recent snapshot.
162 "workspaceId": { # A CloudWorkspaceId is a unique identifier for a cloud workspace. # The ID of the workspace.
163 # A cloud workspace is a place associated with a repo where modified files
164 # can be stored before they are committed.
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 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]171 "uid": "A String", # A server-assigned, globally unique identifier.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]172 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]173 "name": "A String", # The unique name of the workspace within the repo. This is the name
174 # chosen by the client in the Source API's CreateWorkspace method.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]175 },
176 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]177 "cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a cloud # A SourceContext referring to a revision in a cloud repo.
178 # repo (a repo hosted by the Google Cloud Platform).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]179 "aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.
180 "kind": "A String", # The alias kind.
181 "name": "A String", # The alias name.
182 },
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]183 "revisionId": "A String", # A revision ID.
184 "aliasName": "A String", # The name of an alias (branch, tag, etc.).
185 "repoId": { # A unique identifier for a cloud repo. # The ID of the repo.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]186 "projectRepoId": { # Selects a repo using a Google Cloud Platform project ID # A combination of a project ID and a repo name.
187 # (e.g. winged-cargo-31) and a repo name within that project.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]188 "projectId": "A String", # The ID of the project.
189 "repoName": "A String", # The name of the repo. Leave empty for the default repo.
190 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]191 "uid": "A String", # A server-assigned, globally unique identifier.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]192 },
193 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]194 "git": { # A GitSourceContext denotes a particular revision in a third party Git # A SourceContext referring to any third party Git repo (e.g. GitHub).
195 # repository (e.g. GitHub).
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]196 "url": "A String", # Git repository URL.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]197 "revisionId": "A String", # Git commit hash.
198 # required.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]199 },
200 "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]201 "aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.
202 "kind": "A String", # The alias kind.
203 "name": "A String", # The alias name.
204 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]205 "hostUri": "A String", # The URI of a running Gerrit instance.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]206 "gerritProject": "A String", # The full project name within the host. Projects may be nested, so
207 # "project/subproject" is a valid project name.
208 # The "repo name" is hostURI/project.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]209 "aliasName": "A String", # The name of an alias (branch, tag, etc.).
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]210 "revisionId": "A String", # A revision (commit) ID.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]211 },
212 },
213 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]214 "extSourceContexts": [ # References to the locations and revisions of the source code used in the
215 # deployed application.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]216 { # An ExtendedSourceContext is a SourceContext combined with additional
217 # details describing the context.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]218 "labels": { # Labels with user defined metadata.
219 "a_key": "A String",
220 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]221 "context": { # A SourceContext is a reference to a tree of files. A SourceContext together # Any source context.
222 # 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]223 "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]224 "snapshotId": "A String", # The ID of the snapshot.
225 # An empty snapshot_id refers to the most recent snapshot.
226 "workspaceId": { # A CloudWorkspaceId is a unique identifier for a cloud workspace. # The ID of the workspace.
227 # A cloud workspace is a place associated with a repo where modified files
228 # can be stored before they are committed.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]229 "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]230 "projectRepoId": { # Selects a repo using a Google Cloud Platform project ID # A combination of a project ID and a repo name.
231 # (e.g. winged-cargo-31) and a repo name within that project.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]232 "projectId": "A String", # The ID of the project.
233 "repoName": "A String", # The name of the repo. Leave empty for the default repo.
234 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]235 "uid": "A String", # A server-assigned, globally unique identifier.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]236 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]237 "name": "A String", # The unique name of the workspace within the repo. This is the name
238 # chosen by the client in the Source API's CreateWorkspace method.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]239 },
240 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]241 "cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a cloud # A SourceContext referring to a revision in a cloud repo.
242 # repo (a repo hosted by the Google Cloud Platform).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]243 "aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.
244 "kind": "A String", # The alias kind.
245 "name": "A String", # The alias name.
246 },
247 "revisionId": "A String", # A revision ID.
248 "aliasName": "A String", # The name of an alias (branch, tag, etc.).
249 "repoId": { # A unique identifier for a cloud repo. # The ID of the repo.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]250 "projectRepoId": { # Selects a repo using a Google Cloud Platform project ID # A combination of a project ID and a repo name.
251 # (e.g. winged-cargo-31) and a repo name within that project.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]252 "projectId": "A String", # The ID of the project.
253 "repoName": "A String", # The name of the repo. Leave empty for the default repo.
254 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]255 "uid": "A String", # A server-assigned, globally unique identifier.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]256 },
257 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]258 "git": { # A GitSourceContext denotes a particular revision in a third party Git # A SourceContext referring to any third party Git repo (e.g. GitHub).
259 # repository (e.g. GitHub).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]260 "url": "A String", # Git repository URL.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]261 "revisionId": "A String", # Git commit hash.
262 # required.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]263 },
264 "gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project.
265 "aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.
266 "kind": "A String", # The alias kind.
267 "name": "A String", # The alias name.
268 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]269 "hostUri": "A String", # The URI of a running Gerrit instance.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]270 "gerritProject": "A String", # The full project name within the host. Projects may be nested, so
271 # "project/subproject" is a valid project name.
272 # The "repo name" is hostURI/project.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]273 "aliasName": "A String", # The name of an alias (branch, tag, etc.).
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]274 "revisionId": "A String", # A revision (commit) ID.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]275 },
276 },
277 },
278 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]279 "agentVersion": "A String", # Version ID of the agent.
280 # Schema: `domain/language-platform/vmajor.minor` (for example
281 # `google.com/java-gcp/v1.1`).
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]282 "canaryMode": "A String", # Used when setting breakpoint canary for this debuggee.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]283 "isInactive": True or False, # If set to `true`, indicates that Controller service does not detect any
284 # activity from the debuggee agents and the application is possibly stopped.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]285 "id": "A String", # Unique identifier for the debuggee generated by the controller service.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]286 },
287 ],
288 }</pre>
289</div>
290
291</body></html>