Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / bf7066efaaa091e67f39440232ab73d38e51b5b1 / . / docs / dyn / clouddebugger_v2.debugger.debuggees.html
blob: 06bf7c5d5add05220c142b9ac0ea29e279fcd519 [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
75<h1><a href="clouddebugger_v2.html">Google Cloud Debugger API</a> . <a href="clouddebugger_v2.debugger.html">debugger</a> . <a href="clouddebugger_v2.debugger.debuggees.html">debuggees</a></h1>
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>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]84<p class="firstline">Lists all the debuggees that the user can set breakpoints to.</p>
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>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]88 <pre>Lists all the debuggees that the user can set breakpoints to.
89
90Args:
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]91 clientVersion: string, The client version making the call. Following: `domain/type/version` (e.g., `google.com/intellij/v1`).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]92 includeInactive: boolean, When set to `true`, the result includes all debuggees. Otherwise, the result includes only debuggees that are active.
93 project: string, Project number of a Google Cloud project whose debuggees to list.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]94 x__xgafv: string, V1 error format.
95
96Returns:
97 An object of the form:
98
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]99 { # Response for listing debuggees.
100 "debuggees": [ # List of debuggees accessible to the calling user. Note that the `description` field is the only human readable field that should be displayed to the user. The fields `debuggee.id` and `description` fields are guaranteed to be set on each debuggee.
101 { # Represents the application to debug. 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. The agents attached to the same debuggee are identified by using exactly the same field values when registering.
102 "status": { # 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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]103 "isError": True or False, # Distinguishes errors from informational messages.
104 "refersTo": "A String", # Reference to which the message applies.
105 "description": { # Represents a message with parameters. # Status message text.
106 "parameters": [ # Optional parameters to be embedded into the message.
107 "A String",
108 ],
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]109 "format": "A String", # 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 '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important.` * `Please pay $$10 to use $0 instead of $1.`
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]110 },
111 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]112 "description": "A String", # Human readable description of the debuggee. Including a human-readable project name, environment name and version information is recommended.
113 "isDisabled": True or False, # If set to `true`, indicates that the agent should disable itself and detach from the debuggee.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]114 "labels": { # A set of custom debuggee properties, populated by the agent, to be displayed to the user.
115 "a_key": "A String",
116 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]117 "uniquifier": "A String", # Debuggee uniquifier within the project. Any string that identifies the application within the project can be used. Including environment and version or build IDs is recommended.
118 "project": "A String", # Project the debuggee is associated with. Use the project number when registering a Google Cloud Platform project.
119 "sourceContexts": [ # References to the locations and revisions of the source code used in the deployed application. NOTE: This field is deprecated. Consumers should use `ext_source_contexts` if it is not empty. Debug agents should populate both this field and `ext_source_contexts`.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]120 { # 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.
121 "cloudWorkspace": { # A CloudWorkspaceSourceContext denotes a workspace at a particular snapshot. # A SourceContext referring to a snapshot in a cloud workspace.
122 "snapshotId": "A String", # The ID of the snapshot. An empty snapshot_id refers to the most recent snapshot.
123 "workspaceId": { # 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.
124 "repoId": { # A unique identifier for a cloud repo. # The ID of the repo containing the workspace.
125 "projectRepoId": { # 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.
126 "projectId": "A String", # The ID of the project.
127 "repoName": "A String", # The name of the repo. Leave empty for the default repo.
128 },
129 "uid": "A String", # A server-assigned, globally unique identifier.
130 },
131 "name": "A String", # The unique name of the workspace within the repo. This is the name chosen by the client in the Source API's CreateWorkspace method.
132 },
133 },
134 "cloudRepo": { # 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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]135 "aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.
136 "kind": "A String", # The alias kind.
137 "name": "A String", # The alias name.
138 },
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]139 "revisionId": "A String", # A revision ID.
140 "aliasName": "A String", # The name of an alias (branch, tag, etc.).
141 "repoId": { # A unique identifier for a cloud repo. # The ID of the repo.
142 "projectRepoId": { # 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.
143 "projectId": "A String", # The ID of the project.
144 "repoName": "A String", # The name of the repo. Leave empty for the default repo.
145 },
146 "uid": "A String", # A server-assigned, globally unique identifier.
147 },
148 },
149 "git": { # 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).
150 "url": "A String", # Git repository URL.
151 "revisionId": "A String", # Git commit hash. required.
152 },
153 "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]154 "aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.
155 "kind": "A String", # The alias kind.
156 "name": "A String", # The alias name.
157 },
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]158 "revisionId": "A String", # A revision (commit) ID.
159 "hostUri": "A String", # The URI of a running Gerrit instance.
160 "aliasName": "A String", # The name of an alias (branch, tag, etc.).
161 "gerritProject": "A String", # The full project name within the host. Projects may be nested, so "project/subproject" is a valid project name. The "repo name" is hostURI/project.
162 },
163 },
164 ],
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]165 "extSourceContexts": [ # References to the locations and revisions of the source code used in the deployed application. Contexts describing a remote repo related to the source code have a `category` label of `remote_repo`. Source snapshot source contexts have a `category` of `snapshot`.
166 { # An ExtendedSourceContext is a SourceContext combined with additional details describing the context.
167 "labels": { # Labels with user defined metadata.
168 "a_key": "A String",
169 },
170 "context": { # 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.
171 "cloudWorkspace": { # A CloudWorkspaceSourceContext denotes a workspace at a particular snapshot. # A SourceContext referring to a snapshot in a cloud workspace.
172 "snapshotId": "A String", # The ID of the snapshot. An empty snapshot_id refers to the most recent snapshot.
173 "workspaceId": { # 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.
174 "repoId": { # A unique identifier for a cloud repo. # The ID of the repo containing the workspace.
175 "projectRepoId": { # 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.
176 "projectId": "A String", # The ID of the project.
177 "repoName": "A String", # The name of the repo. Leave empty for the default repo.
178 },
179 "uid": "A String", # A server-assigned, globally unique identifier.
180 },
181 "name": "A String", # The unique name of the workspace within the repo. This is the name chosen by the client in the Source API's CreateWorkspace method.
182 },
183 },
184 "cloudRepo": { # 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.
185 "aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.
186 "kind": "A String", # The alias kind.
187 "name": "A String", # The alias name.
188 },
189 "revisionId": "A String", # A revision ID.
190 "aliasName": "A String", # The name of an alias (branch, tag, etc.).
191 "repoId": { # A unique identifier for a cloud repo. # The ID of the repo.
192 "projectRepoId": { # 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.
193 "projectId": "A String", # The ID of the project.
194 "repoName": "A String", # The name of the repo. Leave empty for the default repo.
195 },
196 "uid": "A String", # A server-assigned, globally unique identifier.
197 },
198 },
199 "git": { # 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).
200 "url": "A String", # Git repository URL.
201 "revisionId": "A String", # Git commit hash. required.
202 },
203 "gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project.
204 "aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.
205 "kind": "A String", # The alias kind.
206 "name": "A String", # The alias name.
207 },
208 "revisionId": "A String", # A revision (commit) ID.
209 "hostUri": "A String", # The URI of a running Gerrit instance.
210 "aliasName": "A String", # The name of an alias (branch, tag, etc.).
211 "gerritProject": "A String", # The full project name within the host. Projects may be nested, so "project/subproject" is a valid project name. The "repo name" is hostURI/project.
212 },
213 },
214 },
215 ],
216 "agentVersion": "A String", # Version ID of the agent release. The version ID is structured as following: `domain/type/vmajor.minor` (for example `google.com/gcp-java/v1.1`).
217 "isInactive": True or False, # If set to `true`, indicates that the debuggee is considered as inactive by the Controller service.
218 "id": "A String", # Unique identifier for the debuggee generated by the controller service.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]219 },
220 ],
221 }</pre>
222</div>
223
224</body></html>