1 <html><body> 2 <style> 3 4 body, 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 15 body { 16 font-size: 13px; 17 padding: 1em; 18 } 19 20 h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23 } 24 25 h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28 } 29 30 h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34 } 35 36 pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39 } 40 41 pre { 42 margin-top: 0.5em; 43 } 44 45 h1, h2, h3, p { 46 font-family: Arial, sans serif; 47 } 48 49 h1, 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">Stackdriver 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"> 83 <code><a href="#list">list(clientVersion=None, includeInactive=None, project=None, x__xgafv=None)</a></code></p> 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"> 87 <code class="details" id="list">list(clientVersion=None, includeInactive=None, project=None, x__xgafv=None)</code> 88 <pre>Lists all the debuggees that the user can set breakpoints to. 89 90 Args: 91 clientVersion: string, The client version making the call. 92 Following: `domain/type/version` (e.g., `google.com/intellij/v1`). 93 includeInactive: boolean, When set to `true`, the result includes all debuggees. Otherwise, the 94 result includes only debuggees that are active. 95 project: string, Project number of a Google Cloud project whose debuggees to list. 96 x__xgafv: string, V1 error format. 97 Allowed values 98 1 - v1 error format 99 2 - v2 error format 100 101 Returns: 102 An object of the form: 103 104 { # Response for listing debuggees. 105 "debuggees": [ # List of debuggees accessible to the calling user. 106 # Note that the `description` field is the only human readable field 107 # that should be displayed to the user. 108 # The fields `debuggee.id` and `description` fields are guaranteed to be 109 # set on each debuggee. 110 { # Represents the application to debug. The application may include one or more 111 # replicated processes executing the same code. Each of these processes is 112 # attached with a debugger agent, carrying out the debugging commands. 113 # The agents attached to the same debuggee are identified by using exactly the 114 # same field values when registering. 115 "status": { # Represents a contextual status message. # Human readable message to be displayed to the user about this debuggee. 116 # Absence of this field indicates no status. The message can be either 117 # informational or an error status. 118 # The message can indicate an error or informational status, and refer to 119 # specific parts of the containing object. 120 # For example, the `Breakpoint.status` field can indicate an error referring 121 # to the `BREAKPOINT_SOURCE_LOCATION` with the message `Location not found`. 122 "isError": True or False, # Distinguishes errors from informational messages. 123 "refersTo": "A String", # Reference to which the message applies. 124 "description": { # Represents a message with parameters. # Status message text. 125 "parameters": [ # Optional parameters to be embedded into the message. 126 "A String", 127 ], 128 "format": "A String", # Format template for the message. The `format` uses placeholders `$0`, 129 # `$1`, etc. to reference parameters. `$$` can be used to denote the `$` 130 # character. 131 # 132 # Examples: 133 # 134 # * `Failed to load '$0' which helps debug $1 the first time it 135 # is loaded. Again, $0 is very important.` 136 # * `Please pay $$10 to use $0 instead of $1.` 137 }, 138 }, 139 "description": "A String", # Human readable description of the debuggee. 140 # Including a human-readable project name, environment name and version 141 # information is recommended. 142 "isDisabled": True or False, # If set to `true`, indicates that the agent should disable itself and 143 # detach from the debuggee. 144 "labels": { # A set of custom debuggee properties, populated by the agent, to be 145 # displayed to the user. 146 "a_key": "A String", 147 }, 148 "uniquifier": "A String", # Debuggee uniquifier within the project. 149 # Any string that identifies the application within the project can be used. 150 # Including environment and version or build IDs is recommended. 151 "project": "A String", # Project the debuggee is associated with. 152 # Use the project number when registering a Google Cloud Platform project. 153 "sourceContexts": [ # References to the locations and revisions of the source code used in the 154 # deployed application. 155 # 156 # NOTE: This field is deprecated. Consumers should use 157 # `ext_source_contexts` if it is not empty. Debug agents should populate 158 # both this field and `ext_source_contexts`. 159 { # A SourceContext is a reference to a tree of files. A SourceContext together 160 # with a path point to a unique revision of a single file or directory. 161 "cloudWorkspace": { # A CloudWorkspaceSourceContext denotes a workspace at a particular snapshot. # A SourceContext referring to a snapshot in a cloud workspace. 162 "snapshotId": "A String", # The ID of the snapshot. 163 # An empty snapshot_id refers to the most recent snapshot. 164 "workspaceId": { # A CloudWorkspaceId is a unique identifier for a cloud workspace. # The ID of the workspace. 165 # A cloud workspace is a place associated with a repo where modified files 166 # can be stored before they are committed. 167 "name": "A String", # The unique name of the workspace within the repo. This is the name 168 # chosen by the client in the Source API's CreateWorkspace method. 169 "repoId": { # A unique identifier for a cloud repo. # The ID of the repo containing the workspace. 170 "projectRepoId": { # Selects a repo using a Google Cloud Platform project ID # A combination of a project ID and a repo name. 171 # (e.g. winged-cargo-31) and a repo name within that project. 172 "projectId": "A String", # The ID of the project. 173 "repoName": "A String", # The name of the repo. Leave empty for the default repo. 174 }, 175 "uid": "A String", # A server-assigned, globally unique identifier. 176 }, 177 }, 178 }, 179 "cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a cloud # A SourceContext referring to a revision in a cloud repo. 180 # repo (a repo hosted by the Google Cloud Platform). 181 "aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag. 182 "kind": "A String", # The alias kind. 183 "name": "A String", # The alias name. 184 }, 185 "revisionId": "A String", # A revision ID. 186 "aliasName": "A String", # The name of an alias (branch, tag, etc.). 187 "repoId": { # A unique identifier for a cloud repo. # The ID of the repo. 188 "projectRepoId": { # Selects a repo using a Google Cloud Platform project ID # A combination of a project ID and a repo name. 189 # (e.g. winged-cargo-31) and a repo name within that project. 190 "projectId": "A String", # The ID of the project. 191 "repoName": "A String", # The name of the repo. Leave empty for the default repo. 192 }, 193 "uid": "A String", # A server-assigned, globally unique identifier. 194 }, 195 }, 196 "git": { # A GitSourceContext denotes a particular revision in a third party Git # A SourceContext referring to any third party Git repo (e.g. GitHub). 197 # repository (e.g. GitHub). 198 "url": "A String", # Git repository URL. 199 "revisionId": "A String", # Git commit hash. 200 # required. 201 }, 202 "gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project. 203 "aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag. 204 "kind": "A String", # The alias kind. 205 "name": "A String", # The alias name. 206 }, 207 "revisionId": "A String", # A revision (commit) ID. 208 "hostUri": "A String", # The URI of a running Gerrit instance. 209 "aliasName": "A String", # The name of an alias (branch, tag, etc.). 210 "gerritProject": "A String", # The full project name within the host. Projects may be nested, so 211 # "project/subproject" is a valid project name. 212 # The "repo name" is hostURI/project. 213 }, 214 }, 215 ], 216 "extSourceContexts": [ # References to the locations and revisions of the source code used in the 217 # deployed application. 218 # 219 # Contexts describing a remote repo related to the source code 220 # have a `category` label of `remote_repo`. Source snapshot source 221 # contexts have a `category` of `snapshot`. 222 { # An ExtendedSourceContext is a SourceContext combined with additional 223 # details describing the context. 224 "labels": { # Labels with user defined metadata. 225 "a_key": "A String", 226 }, 227 "context": { # A SourceContext is a reference to a tree of files. A SourceContext together # Any source context. 228 # with a path point to a unique revision of a single file or directory. 229 "cloudWorkspace": { # A CloudWorkspaceSourceContext denotes a workspace at a particular snapshot. # A SourceContext referring to a snapshot in a cloud workspace. 230 "snapshotId": "A String", # The ID of the snapshot. 231 # An empty snapshot_id refers to the most recent snapshot. 232 "workspaceId": { # A CloudWorkspaceId is a unique identifier for a cloud workspace. # The ID of the workspace. 233 # A cloud workspace is a place associated with a repo where modified files 234 # can be stored before they are committed. 235 "name": "A String", # The unique name of the workspace within the repo. This is the name 236 # chosen by the client in the Source API's CreateWorkspace method. 237 "repoId": { # A unique identifier for a cloud repo. # The ID of the repo containing the workspace. 238 "projectRepoId": { # Selects a repo using a Google Cloud Platform project ID # A combination of a project ID and a repo name. 239 # (e.g. winged-cargo-31) and a repo name within that project. 240 "projectId": "A String", # The ID of the project. 241 "repoName": "A String", # The name of the repo. Leave empty for the default repo. 242 }, 243 "uid": "A String", # A server-assigned, globally unique identifier. 244 }, 245 }, 246 }, 247 "cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a cloud # A SourceContext referring to a revision in a cloud repo. 248 # repo (a repo hosted by the Google Cloud Platform). 249 "aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag. 250 "kind": "A String", # The alias kind. 251 "name": "A String", # The alias name. 252 }, 253 "revisionId": "A String", # A revision ID. 254 "aliasName": "A String", # The name of an alias (branch, tag, etc.). 255 "repoId": { # A unique identifier for a cloud repo. # The ID of the repo. 256 "projectRepoId": { # Selects a repo using a Google Cloud Platform project ID # A combination of a project ID and a repo name. 257 # (e.g. winged-cargo-31) and a repo name within that project. 258 "projectId": "A String", # The ID of the project. 259 "repoName": "A String", # The name of the repo. Leave empty for the default repo. 260 }, 261 "uid": "A String", # A server-assigned, globally unique identifier. 262 }, 263 }, 264 "git": { # A GitSourceContext denotes a particular revision in a third party Git # A SourceContext referring to any third party Git repo (e.g. GitHub). 265 # repository (e.g. GitHub). 266 "url": "A String", # Git repository URL. 267 "revisionId": "A String", # Git commit hash. 268 # required. 269 }, 270 "gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project. 271 "aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag. 272 "kind": "A String", # The alias kind. 273 "name": "A String", # The alias name. 274 }, 275 "revisionId": "A String", # A revision (commit) ID. 276 "hostUri": "A String", # The URI of a running Gerrit instance. 277 "aliasName": "A String", # The name of an alias (branch, tag, etc.). 278 "gerritProject": "A String", # The full project name within the host. Projects may be nested, so 279 # "project/subproject" is a valid project name. 280 # The "repo name" is hostURI/project. 281 }, 282 }, 283 }, 284 ], 285 "agentVersion": "A String", # Version ID of the agent release. The version ID is structured as 286 # following: `domain/type/vmajor.minor` (for example 287 # `google.com/gcp-java/v1.1`). 288 "isInactive": True or False, # If set to `true`, indicates that the debuggee is considered as inactive by 289 # the Controller service. 290 "id": "A String", # Unique identifier for the debuggee generated by the controller service. 291 }, 292 ], 293 }</pre> 294 </div> 295 296 </body></html>
