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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

83

<code><a href="#close">close()</a></code></p>

84

<p class="firstline">Close httplib2 connections.</p>

85

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

86

<code><a href="#list">list(clientVersion=None, project=None, includeInactive=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

715bd7f

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

[diff] [blame]

87

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

88

<h3>Method Details</h3>

89

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

90

<code class="details" id="close">close()</code>

91

<pre>Close httplib2 connections.</pre>

</div>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

95

<code class="details" id="list">list(clientVersion=None, project=None, includeInactive=None, x__xgafv=None)</code>

Bu Sun Kim

715bd7f

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

[diff] [blame]

96

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

Takashi Matsuo

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

[diff] [blame]

97

98

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

99

clientVersion: string, Required. The client version making the call. Schema: `domain/type/version` (e.g., `google.com/intellij/v1`).

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

100

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

101

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

Takashi Matsuo

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

[diff] [blame]

102

x__xgafv: string, V1 error format.

Sai Cheemalapati

c30d2b5

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

[diff] [blame]

103

Allowed values

104

1 - v1 error format

105

2 - v2 error format

Takashi Matsuo

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

[diff] [blame]

106

107

Returns:

108

An object of the form:

109

Jon Wayne Parrott

36e41bc

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

[diff] [blame]

110

{ # Response for listing debuggees.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

111

"debuggees": [ # List of debuggees accessible to the calling user. The fields `debuggee.id` and `description` are guaranteed to be set. The `description` field is a human readable field provided by agents and can be displayed to users.

112

{ # Represents the debugged application. 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. Agents attached to the same debuggee identify themselves as such by using exactly the same Debuggee message value when registering.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

113

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

114

{ # 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.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

115

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

116

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

117

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

118

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

119

},

120

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

121

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

122

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

123

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

124

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

125

},

126

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

127

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

128

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

129

},

130

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

131

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

132

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

133

},

134

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

135

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

136

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

137

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

138

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

139

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

140

},

141

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

142

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

143

},

144

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

145

"snapshotId": "A String", # The ID of the snapshot. An empty snapshot_id refers to the most recent snapshot.

146

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

147

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

148

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

149

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

150

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

151

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

152

},

153

},

154

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

155

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

156

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

157

},

158

],

159

"isInactive": True or False, # If set to `true`, indicates that Controller service does not detect any activity from the debuggee agents and the application is possibly stopped.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

160

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

161

"a_key": "A String",

162

},

163

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

164

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

165

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

166

"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.`

167

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

"A String",

],

},

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

172

},

173

"project": "A String", # Project the debuggee is associated with. Use project number or id when registering a Google Cloud Platform project.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

174

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

175

{ # An ExtendedSourceContext is a SourceContext combined with additional details describing the context.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

176

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

177

"a_key": "A String",

178

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

179

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

180

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

181

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

182

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

183

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

184

},

185

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

186

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

187

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

188

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

189

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

190

},

191

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

192

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

193

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

194

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

195

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

196

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

197

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

198

},

199

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

200

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

201

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

202

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

203

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

204

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

205

},

206

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

207

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

208

},

209

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

210

"snapshotId": "A String", # The ID of the snapshot. An empty snapshot_id refers to the most recent snapshot.

211

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

212

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

213

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

214

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

215

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

216

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

217

},

218

},

219

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

220

},

221

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

222

},

223

},

224

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

225

"agentVersion": "A String", # Version ID of the agent. Schema: `domain/language-platform/vmajor.minor` (for example `google.com/java-gcp/v1.1`).

226

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

227

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

228

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

229

"uniquifier": "A String", # Uniquifier to further distinguish the application. It is possible that different applications might have identical values in the debuggee message, thus, incorrectly identified as a single application by the Controller service. This field adds salt to further distinguish the application. Agents should consider seeding this field with value that identifies the code, binary, configuration and environment.

230

"description": "A String", # Human readable description of the debuggee. Including a human-readable project name, environment name and version information is recommended.

Takashi Matsuo