Blame - docs/dyn/clouddebugger_v2.controller.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.controller.debuggees.breakpoints.html">breakpoints()</a></code>

79

</p>

80

<p class="firstline">Returns the breakpoints Resource.</p>

81

82

Dan O'Meara

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

[diff] [blame]

83

<code><a href="#register">register(body=None, x__xgafv=None)</a></code></p>

Sai Cheemalapati

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

[diff] [blame]

84

<p class="firstline">Registers the debuggee with the controller service.</p>

Takashi Matsuo

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

[diff] [blame]

85

<h3>Method Details</h3>

86

Dan O'Meara

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

[diff] [blame]

87

<code class="details" id="register">register(body=None, x__xgafv=None)</code>

Sai Cheemalapati

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

[diff] [blame]

88

<pre>Registers the debuggee with the controller service.

89

Bu Sun Kim

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

[diff] [blame]

90

All agents attached to the same application must call this method with

91

exactly the same request content to get back the same stable `debuggee_id`.

92

Agents should call this method again whenever `google.rpc.Code.NOT_FOUND`

93

is returned from any controller method.

Sai Cheemalapati

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

[diff] [blame]

94

Bu Sun Kim

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

[diff] [blame]

95

This protocol allows the controller service to disable debuggees, recover

96

from data loss, or change the `debuggee_id` format. Agents must handle

97

`debuggee_id` value changing upon re-registration.

Takashi Matsuo

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

[diff] [blame]

98

99

Args:

Dan O'Meara

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

[diff] [blame]

100

body: object, The request body.

Takashi Matsuo

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

[diff] [blame]

101

The object takes the form of:

102

Jon Wayne Parrott

36e41bc

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

[diff] [blame]

103

{ # Request to register a debuggee.

Bu Sun Kim

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

[diff] [blame]

104

"debuggee": { # Represents the debugged application. The application may include one or more # Required. Debuggee information to register.

Sai Cheemalapati

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

[diff] [blame]

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.

Bu Sun Kim

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

[diff] [blame]

109

# Agents attached to the same debuggee identify themselves as such by using

110

# exactly the same Debuggee message value when registering.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

111

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

112

# deployed application.

113

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

114

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

115

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

116

# repository (e.g. GitHub).

117

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

118

# required.

119

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

120

},

121

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

122

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

123

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

124

# The "repo name" is hostURI/project.

125

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

126

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

127

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

128

},

129

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

130

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

131

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

132

},

133

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

134

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

135

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

136

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

137

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

138

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

139

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

140

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

141

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

142

},

143

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

144

},

145

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

146

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

147

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

148

},

149

},

150

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

151

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

152

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

153

# can be stored before they are committed.

154

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

155

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

156

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

157

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

158

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

159

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

160

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

161

},

162

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

163

},

164

},

165

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

166

# An empty snapshot_id refers to the most recent snapshot.

},

},

],

"labels": { # A set of custom debuggee properties, populated by the agent, to be

171

# displayed to the user.

172

"a_key": "A String",

173

},

Bu Sun Kim

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

[diff] [blame]

174

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

175

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

176

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

177

# detach from the debuggee.

178

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

179

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

180

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

181

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

182

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

183

# identifies the code, binary, configuration and environment.

184

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

185

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

186

# information is recommended.

187

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

188

# deployed application.

189

{ # An ExtendedSourceContext is a SourceContext combined with additional

190

# details describing the context.

Bu Sun Kim

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

[diff] [blame]

191

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

192

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

193

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

194

# repository (e.g. GitHub).

195

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

196

# required.

197

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

198

},

199

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

Bu Sun Kim

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

[diff] [blame]

200

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

201

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

202

# The "repo name" is hostURI/project.

203

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

Bu Sun Kim

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

[diff] [blame]

204

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

205

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

Bu Sun Kim

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

[diff] [blame]

206

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

207

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

208

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

209

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

Bu Sun Kim

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

[diff] [blame]

210

},

211

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

212

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

213

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

214

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

215

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

216

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

217

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

218

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

219

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

220

},

221

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

222

},

223

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

Bu Sun Kim

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

[diff] [blame]

224

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

225

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

Bu Sun Kim

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

[diff] [blame]

226

},

227

},

228

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

Bu Sun Kim

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

[diff] [blame]

229

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

230

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

231

# can be stored before they are committed.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

232

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

233

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

Bu Sun Kim

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

[diff] [blame]

234

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

235

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

236

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

237

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

238

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

239

},

240

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

241

},

Bu Sun Kim

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

[diff] [blame]

242

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

243

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

244

# An empty snapshot_id refers to the most recent snapshot.

Bu Sun Kim

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

[diff] [blame]

245

},

246

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

247

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

248

"a_key": "A String",

249

},

Bu Sun Kim

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

[diff] [blame]

250

},

251

],

Bu Sun Kim

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

[diff] [blame]

252

"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]

253

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

254

# informational or an error status.

255

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

256

# specific parts of the containing object.

257

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

258

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

Bu Sun Kim

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

[diff] [blame]

259

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

260

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

Bu Sun Kim

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

[diff] [blame]

261

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

Sai Cheemalapati

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

[diff] [blame]

262

# `$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]

267

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

Sai Cheemalapati

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

[diff] [blame]

268

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

269

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

270

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

271

"A String",

272

],

Takashi Matsuo

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

[diff] [blame]

273

},

Bu Sun Kim

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

[diff] [blame]

274

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

Takashi Matsuo

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

[diff] [blame]

275

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

276

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

277

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

Bu Sun Kim

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

[diff] [blame]

278

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

279

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

280

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

281

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

282

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

Takashi Matsuo

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

[diff] [blame]

},

}

x__xgafv: string, V1 error format.

Sai Cheemalapati

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

[diff] [blame]

287

Allowed values

288

1 - v1 error format

289

2 - v2 error format

Takashi Matsuo

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

[diff] [blame]

290

291

Returns:

292

An object of the form:

293

Jon Wayne Parrott

36e41bc

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

[diff] [blame]

294

{ # Response for registering a debuggee.

Bu Sun Kim

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

[diff] [blame]

295

"debuggee": { # Represents the debugged application. The application may include one or more # Debuggee resource.

Bu Sun Kim

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

[diff] [blame]

296

# The field `id` is guaranteed to be set (in addition to the echoed fields).

297

# If the field `is_disabled` is set to `true`, the agent should disable

298

# itself by removing all breakpoints and detaching from the application.

299

# It should however continue to poll `RegisterDebuggee` until reenabled.

Sai Cheemalapati

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

[diff] [blame]

300

# replicated processes executing the same code. Each of these processes is

301

# attached with a debugger agent, carrying out the debugging commands.

Bu Sun Kim

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

[diff] [blame]

302

# Agents attached to the same debuggee identify themselves as such by using

303

# exactly the same Debuggee message value when registering.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

304

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

305

# deployed application.

306

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

307

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

308

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

309

# repository (e.g. GitHub).

310

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

311

# required.

312

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

313

},

314

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

315

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

316

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

317

# The "repo name" is hostURI/project.

318

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

319

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

320

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

321

},

322

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

323

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

324

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

325

},

326

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

327

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

328

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

329

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

330

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

331

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

332

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

333

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

334

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

335

},

336

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

337

},

338

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

339

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

340

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

341

},

342

},

343

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

344

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

345

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

346

# can be stored before they are committed.

347

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

348

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

349

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

350

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

351

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

352

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

353

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

354

},

355

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

356

},

357

},

358

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

359

# An empty snapshot_id refers to the most recent snapshot.

},

},

],

"labels": { # A set of custom debuggee properties, populated by the agent, to be

364

# displayed to the user.

365

"a_key": "A String",

366

},

Bu Sun Kim

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

[diff] [blame]

367

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

368

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

369

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

370

# detach from the debuggee.

371

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

372

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

373

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

374

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

375

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

376

# identifies the code, binary, configuration and environment.

377

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

378

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

379

# information is recommended.

380

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

381

# deployed application.

382

{ # An ExtendedSourceContext is a SourceContext combined with additional

383

# details describing the context.

Bu Sun Kim

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

[diff] [blame]

384

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

385

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

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

388

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

389

# required.

390

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

391

},

392

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

Bu Sun Kim

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

[diff] [blame]

393

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

394

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

395

# The "repo name" is hostURI/project.

396

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

Bu Sun Kim

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

[diff] [blame]

397

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

398

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

Bu Sun Kim

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

[diff] [blame]

399

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

400

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

401

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

402

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

Bu Sun Kim

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

[diff] [blame]

403

},

404

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

405

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

406

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

407

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

408

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

409

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

410

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

411

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

412

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

413

},

414

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

415

},

416

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

Bu Sun Kim

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

[diff] [blame]

417

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

418

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

Bu Sun Kim

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

[diff] [blame]

419

},

420

},

421

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

Bu Sun Kim

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

[diff] [blame]

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.

Bu Sun Kim

2020-05-27 12:20:54 -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.

Bu Sun Kim

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

[diff] [blame]

427

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

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.

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

},

433

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

434

},

Bu Sun Kim

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

[diff] [blame]

435

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

436

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

437

# An empty snapshot_id refers to the most recent snapshot.

Bu Sun Kim

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

[diff] [blame]

438

},

439

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

440

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

441

"a_key": "A String",

442

},

Bu Sun Kim

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

[diff] [blame]

443

},

444

],

Bu Sun Kim

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

[diff] [blame]

445

"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]

446

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

447

# informational or an error status.

448

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

449

# specific parts of the containing object.

450

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

451

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

Bu Sun Kim

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

[diff] [blame]

452

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

453

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

Bu Sun Kim

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

[diff] [blame]

454

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

Sai Cheemalapati

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

[diff] [blame]

455

# `$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]

460

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

Sai Cheemalapati

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

[diff] [blame]

461

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

462

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

463

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

464

"A String",

465

],

Takashi Matsuo

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

[diff] [blame]

466

},

Bu Sun Kim

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

[diff] [blame]

467

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

Takashi Matsuo

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

[diff] [blame]

468

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

469

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

470

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

Bu Sun Kim

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

[diff] [blame]

471

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

472

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

473

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

474

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

475

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

Takashi Matsuo

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

[diff] [blame]

476

},

Bu Sun Kim

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

[diff] [blame]

477

"agentId": "A String", # A unique ID generated for the agent.

Dan O'Meara

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

[diff] [blame]

478

# Each RegisterDebuggee request will generate a new agent ID.

Takashi Matsuo