Blame - docs/dyn/clouddebugger_v2.debugger.debuggees.html - platform/external/python/google-api-python-client

2015-09-11 13:55:40 -0700

[diff] [blame]

76

<h2>Instance Methods</h2>

77

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

Jon Wayne Parrott

0a471d3

2016-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 Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

84

<p class="firstline">Lists all the debuggees that the user has access to.</p>

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

85

<h3>Method Details</h3>

86

Jon Wayne Parrott

0a471d3

2016-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 Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

88

<pre>Lists all the debuggees that the user has access to.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

89

90

Args:

Dan O'Meara

dd49464

2020-05-01 07:42:23 -0700

[diff] [blame]

91

clientVersion: string, Required. The client version making the call.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

92

Schema: `domain/type/version` (e.g., `google.com/intellij/v1`).

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

93

includeInactive: boolean, When set to `true`, the result includes all debuggees. Otherwise, the

94

result includes only debuggees that are active.

Dan O'Meara

dd49464

2020-05-01 07:42:23 -0700

[diff] [blame]

95

project: string, Required. Project number of a Google Cloud project whose debuggees to list.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

96

x__xgafv: string, V1 error format.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

97

Allowed values

98

1 - v1 error format

99

2 - v2 error format

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

100

101

Returns:

102

An object of the form:

103

Jon Wayne Parrott

36e41bc

2016-02-19 16:02:29 -0800

[diff] [blame]

104

{ # Response for listing debuggees.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

105

"debuggees": [ # List of debuggees accessible to the calling user.

Bu Sun Kim

2019-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 Cheemalapati

2017-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 Kim

2019-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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

114

"project": "A String", # Project the debuggee is associated with.

115

# Use project number or id when registering a Google Cloud Platform project.

116

"isDisabled": True or False, # If set to `true`, indicates that the agent should disable itself and

117

# detach from the debuggee.

118

"uniquifier": "A String", # Uniquifier to further distinguish the application.

119

# It is possible that different applications might have identical values in

120

# the debuggee message, thus, incorrectly identified as a single application

121

# by the Controller service. This field adds salt to further distinguish the

122

# application. Agents should consider seeding this field with value that

123

# identifies the code, binary, configuration and environment.

124

"description": "A String", # Human readable description of the debuggee.

125

# Including a human-readable project name, environment name and version

126

# information is recommended.

127

"extSourceContexts": [ # References to the locations and revisions of the source code used in the

128

# deployed application.

129

{ # An ExtendedSourceContext is a SourceContext combined with additional

130

# details describing the context.

131

"labels": { # Labels with user defined metadata.

132

"a_key": "A String",

133

},

134

"context": { # A SourceContext is a reference to a tree of files. A SourceContext together # Any source context.

135

# with a path point to a unique revision of a single file or directory.

136

"git": { # A GitSourceContext denotes a particular revision in a third party Git # A SourceContext referring to any third party Git repo (e.g. GitHub).

137

# repository (e.g. GitHub).

138

"revisionId": "A String", # Git commit hash.

139

# required.

140

"url": "A String", # Git repository URL.

141

},

142

"gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project.

143

"hostUri": "A String", # The URI of a running Gerrit instance.

144

"revisionId": "A String", # A revision (commit) ID.

145

"aliasName": "A String", # The name of an alias (branch, tag, etc.).

146

"gerritProject": "A String", # The full project name within the host. Projects may be nested, so

147

# "project/subproject" is a valid project name.

148

# The "repo name" is hostURI/project.

149

"aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.

150

"kind": "A String", # The alias kind.

151

"name": "A String", # The alias name.

152

},

153

},

154

"cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a cloud # A SourceContext referring to a revision in a cloud repo.

155

# repo (a repo hosted by the Google Cloud Platform).

156

"revisionId": "A String", # A revision ID.

157

"aliasName": "A String", # The name of an alias (branch, tag, etc.).

158

"repoId": { # A unique identifier for a cloud repo. # The ID of the repo.

159

"projectRepoId": { # Selects a repo using a Google Cloud Platform project ID # A combination of a project ID and a repo name.

160

# (e.g. winged-cargo-31) and a repo name within that project.

161

"projectId": "A String", # The ID of the project.

162

"repoName": "A String", # The name of the repo. Leave empty for the default repo.

163

},

164

"uid": "A String", # A server-assigned, globally unique identifier.

165

},

166

"aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.

167

"kind": "A String", # The alias kind.

168

"name": "A String", # The alias name.

169

},

170

},

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.

173

# An empty snapshot_id refers to the most recent snapshot.

174

"workspaceId": { # A CloudWorkspaceId is a unique identifier for a cloud workspace. # The ID of the workspace.

175

# A cloud workspace is a place associated with a repo where modified files

176

# can be stored before they are committed.

177

"repoId": { # A unique identifier for a cloud repo. # The ID of the repo containing the workspace.

178

"projectRepoId": { # Selects a repo using a Google Cloud Platform project ID # A combination of a project ID and a repo name.

179

# (e.g. winged-cargo-31) and a repo name within that project.

180

"projectId": "A String", # The ID of the project.

181

"repoName": "A String", # The name of the repo. Leave empty for the default repo.

182

},

183

"uid": "A String", # A server-assigned, globally unique identifier.

184

},

185

"name": "A String", # The unique name of the workspace within the repo. This is the name

186

# chosen by the client in the Source API's CreateWorkspace method.

},

},

},

},

],

"isInactive": True or False, # If set to `true`, indicates that Controller service does not detect any

193

# activity from the debuggee agents and the application is possibly stopped.

194

"status": { # Represents a contextual status message. # Human readable message to be displayed to the user about this debuggee.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

195

# Absence of this field indicates no status. The message can be either

196

# informational or an error status.

197

# The message can indicate an error or informational status, and refer to

198

# specific parts of the containing object.

199

# For example, the `Breakpoint.status` field can indicate an error referring

200

# to the `BREAKPOINT_SOURCE_LOCATION` with the message `Location not found`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

201

"isError": True or False, # Distinguishes errors from informational messages.

202

"description": { # Represents a message with parameters. # Status message text.

203

"parameters": [ # Optional parameters to be embedded into the message.

204

"A String",

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

205

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

206

"format": "A String", # Format template for the message. The `format` uses placeholders `$0`,

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

207

# `$1`, etc. to reference parameters. `$$` can be used to denote the `$`

# character.

#

# Examples:

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

212

# * `Failed to load '$0' which helps debug $1 the first time it

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

213

# is loaded. Again, $0 is very important.`

214

# * `Please pay $$10 to use $0 instead of $1.`

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

215

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

216

"refersTo": "A String", # Reference to which the message applies.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

217

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

218

"canaryMode": "A String", # Used when setting breakpoint canary for this debuggee.

219

"id": "A String", # Unique identifier for the debuggee generated by the controller service.

220

"agentVersion": "A String", # Version ID of the agent.

221

# Schema: `domain/language-platform/vmajor.minor` (for example

222

# `google.com/java-gcp/v1.1`).

223

"sourceContexts": [ # References to the locations and revisions of the source code used in the

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

224

# deployed application.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

225

{ # A SourceContext is a reference to a tree of files. A SourceContext together

226

# with a path point to a unique revision of a single file or directory.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

227

"git": { # A GitSourceContext denotes a particular revision in a third party Git # A SourceContext referring to any third party Git repo (e.g. GitHub).

228

# repository (e.g. GitHub).

229

"revisionId": "A String", # Git commit hash.

230

# required.

231

"url": "A String", # Git repository URL.

232

},

233

"gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project.

234

"hostUri": "A String", # The URI of a running Gerrit instance.

235

"revisionId": "A String", # A revision (commit) ID.

236

"aliasName": "A String", # The name of an alias (branch, tag, etc.).

237

"gerritProject": "A String", # The full project name within the host. Projects may be nested, so

238

# "project/subproject" is a valid project name.

239

# The "repo name" is hostURI/project.

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

},

245

"cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a cloud # A SourceContext referring to a revision in a cloud repo.

246

# repo (a repo hosted by the Google Cloud Platform).

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.

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.

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

},

255

"uid": "A String", # A server-assigned, globally unique identifier.

256

},

257

"aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.

258

"kind": "A String", # The alias kind.

259

"name": "A String", # The alias name.

260

},

261

},

262

"cloudWorkspace": { # A CloudWorkspaceSourceContext denotes a workspace at a particular snapshot. # A SourceContext referring to a snapshot in a cloud workspace.

263

"snapshotId": "A String", # The ID of the snapshot.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

264

# An empty snapshot_id refers to the most recent snapshot.

Bu Sun Kim