Blame - docs/dyn/cloudprofiler_v2.projects.profiles.html - platform/external/python/google-api-python-client

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

[diff] [blame]

78

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

Bu Sun Kim

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

[diff] [blame]

79

<p class="firstline">CreateProfile creates a new profile resource in the online mode.</p>

80

Dan O'Meara

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

[diff] [blame]

81

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

Bu Sun Kim

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

[diff] [blame]

82

<p class="firstline">CreateOfflineProfile creates a new profile resource in the offline mode.</p>

83

Dan O'Meara

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

[diff] [blame]

84

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

Bu Sun Kim

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

[diff] [blame]

85

<p class="firstline">UpdateProfile updates the profile bytes and labels on the profile resource</p>

86

<h3>Method Details</h3>

87

Dan O'Meara

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

[diff] [blame]

88

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

Bu Sun Kim

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

[diff] [blame]

89

<pre>CreateProfile creates a new profile resource in the online mode.

90

91

The server ensures that the new profiles are created at a constant rate per

92

deployment, so the creation request may hang for some time until the next

93

profile session is available.

94

95

The request may fail with ABORTED error if the creation is not available

96

within ~1m, the response will indicate the duration of the backoff the

97

client should take before attempting creating a profile again. The backoff

98

duration is returned in google.rpc.RetryInfo extension on the response

99

status. To a gRPC client, the extension will be return as a

100

binary-serialized proto in the trailing metadata item named

Bu Sun Kim

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

[diff] [blame]

101

"google.rpc.retryinfo-bin".

Bu Sun Kim

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

[diff] [blame]

102

103

Args:

104

parent: string, Parent project to create the profile in. (required)

Dan O'Meara

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

[diff] [blame]

105

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

106

The object takes the form of:

107

108

{ # CreateProfileRequest describes a profile resource online creation request.

109

# The deployment field must be populated. The profile_type specifies the list

110

# of profile types supported by the agent. The creation call will hang until a

111

# profile of one of these types needs to be collected.

Bu Sun Kim

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

[diff] [blame]

112

"profileType": [ # One or more profile types that the agent is capable of providing.

113

"A String",

Bu Sun Kim

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

[diff] [blame]

114

],

Bu Sun Kim

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

[diff] [blame]

115

"deployment": { # Deployment contains the deployment identification information. # Deployment details.

Bu Sun Kim

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

[diff] [blame^]

116

"target": "A String", # Target is the service name used to group related deployments:

117

# * Service name for GAE Flex / Standard.

118

# * Cluster and container name for GKE.

119

# * User-specified string for direct GCE profiling (e.g. Java).

120

# * Job name for Dataflow.

121

# Validation regex: `^[a-z]([-a-z0-9_.]{0,253}[a-z0-9])?$`.

122

"projectId": "A String", # Project ID is the ID of a cloud project.

123

# Validation regex: `^a-z{4,61}[a-z0-9]$`.

Bu Sun Kim

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

[diff] [blame]

124

"labels": { # Labels identify the deployment within the user universe and same target.

Bu Sun Kim

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

[diff] [blame]

125

# Validation regex for label names: `^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$`.

Dan O'Meara

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

[diff] [blame]

126

# Value for an individual label must be <= 512 bytes, the total

127

# size of all label names and values must be <= 1024 bytes.

Bu Sun Kim

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

[diff] [blame]

128

#

Bu Sun Kim

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

[diff] [blame]

129

# Label named "language" can be used to record the programming language of

130

# the profiled deployment. The standard choices for the value include "java",

131

# "go", "python", "ruby", "nodejs", "php", "dotnet".

Bu Sun Kim

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

[diff] [blame]

132

#

Bu Sun Kim

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

[diff] [blame]

133

# For deployments running on Google Cloud Platform, "zone" or "region" label

Bu Sun Kim

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

[diff] [blame]

134

# should be present describing the deployment location. An example of a zone

Bu Sun Kim

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

[diff] [blame]

135

# is "us-central1-a", an example of a region is "us-central1" or

136

# "us-central".

137

"a_key": "A String",

Bu Sun Kim

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

[diff] [blame]

138

},

Bu Sun Kim

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

[diff] [blame]

},

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

149

150

{ # Profile resource.

Bu Sun Kim

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

[diff] [blame]

151

"profileType": "A String", # Type of profile.

152

# For offline mode, this must be specified when creating the profile. For

153

# online mode it is assigned and returned by the server.

154

"deployment": { # Deployment contains the deployment identification information. # Deployment this profile corresponds to.

Bu Sun Kim

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

[diff] [blame^]

155

"target": "A String", # Target is the service name used to group related deployments:

156

# * Service name for GAE Flex / Standard.

157

# * Cluster and container name for GKE.

158

# * User-specified string for direct GCE profiling (e.g. Java).

159

# * Job name for Dataflow.

160

# Validation regex: `^[a-z]([-a-z0-9_.]{0,253}[a-z0-9])?$`.

161

"projectId": "A String", # Project ID is the ID of a cloud project.

162

# Validation regex: `^a-z{4,61}[a-z0-9]$`.

Bu Sun Kim

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

[diff] [blame]

163

"labels": { # Labels identify the deployment within the user universe and same target.

164

# Validation regex for label names: `^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$`.

165

# Value for an individual label must be <= 512 bytes, the total

166

# size of all label names and values must be <= 1024 bytes.

167

#

168

# Label named "language" can be used to record the programming language of

169

# the profiled deployment. The standard choices for the value include "java",

170

# "go", "python", "ruby", "nodejs", "php", "dotnet".

171

#

172

# For deployments running on Google Cloud Platform, "zone" or "region" label

173

# should be present describing the deployment location. An example of a zone

174

# is "us-central1-a", an example of a region is "us-central1" or

175

# "us-central".

176

"a_key": "A String",

177

},

Bu Sun Kim

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

[diff] [blame]

178

},

Bu Sun Kim

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

[diff] [blame]

179

"labels": { # Input only. Labels associated to this specific profile. These labels will

180

# get merged with the deployment labels for the final data set. See

181

# documentation on deployment labels for validation rules and limits.

182

"a_key": "A String",

183

},

184

"profileBytes": "A String", # Input only. Profile bytes, as a gzip compressed serialized proto, the

185

# format is https://github.com/google/pprof/blob/master/proto/profile.proto.

186

"name": "A String", # Output only. Opaque, server-assigned, unique ID for this profile.

187

"duration": "A String", # Duration of the profiling session.

188

# Input (for the offline mode) or output (for the online mode).

189

# The field represents requested profiling duration. It may slightly differ

190

# from the effective profiling duration, which is recorded in the profile

191

# data, in case the profiling can't be stopped immediately (e.g. in case

192

# stopping the profiling is handled asynchronously).

193

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

Dan O'Meara

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

[diff] [blame]

197

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

Bu Sun Kim

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

[diff] [blame]

198

<pre>CreateOfflineProfile creates a new profile resource in the offline mode.

199

The client provides the profile to create along with the profile bytes, the

server records it.

Args:

parent: string, Parent project to create the profile in. (required)

Dan O'Meara

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

[diff] [blame]

204

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

205

The object takes the form of:

206

207

{ # Profile resource.

Bu Sun Kim

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

[diff] [blame]

208

"profileType": "A String", # Type of profile.

209

# For offline mode, this must be specified when creating the profile. For

210

# online mode it is assigned and returned by the server.

211

"deployment": { # Deployment contains the deployment identification information. # Deployment this profile corresponds to.

Bu Sun Kim

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

[diff] [blame^]

212

"target": "A String", # Target is the service name used to group related deployments:

213

# * Service name for GAE Flex / Standard.

214

# * Cluster and container name for GKE.

215

# * User-specified string for direct GCE profiling (e.g. Java).

216

# * Job name for Dataflow.

217

# Validation regex: `^[a-z]([-a-z0-9_.]{0,253}[a-z0-9])?$`.

218

"projectId": "A String", # Project ID is the ID of a cloud project.

219

# Validation regex: `^a-z{4,61}[a-z0-9]$`.

Bu Sun Kim

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

[diff] [blame]

220

"labels": { # Labels identify the deployment within the user universe and same target.

221

# Validation regex for label names: `^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$`.

222

# Value for an individual label must be <= 512 bytes, the total

223

# size of all label names and values must be <= 1024 bytes.

224

#

225

# Label named "language" can be used to record the programming language of

226

# the profiled deployment. The standard choices for the value include "java",

227

# "go", "python", "ruby", "nodejs", "php", "dotnet".

228

#

229

# For deployments running on Google Cloud Platform, "zone" or "region" label

230

# should be present describing the deployment location. An example of a zone

231

# is "us-central1-a", an example of a region is "us-central1" or

232

# "us-central".

233

"a_key": "A String",

234

},

Bu Sun Kim

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

[diff] [blame]

235

},

Bu Sun Kim

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

[diff] [blame]

236

"labels": { # Input only. Labels associated to this specific profile. These labels will

237

# get merged with the deployment labels for the final data set. See

238

# documentation on deployment labels for validation rules and limits.

239

"a_key": "A String",

240

},

241

"profileBytes": "A String", # Input only. Profile bytes, as a gzip compressed serialized proto, the

242

# format is https://github.com/google/pprof/blob/master/proto/profile.proto.

243

"name": "A String", # Output only. Opaque, server-assigned, unique ID for this profile.

244

"duration": "A String", # Duration of the profiling session.

245

# Input (for the offline mode) or output (for the online mode).

246

# The field represents requested profiling duration. It may slightly differ

247

# from the effective profiling duration, which is recorded in the profile

248

# data, in case the profiling can't be stopped immediately (e.g. in case

249

# stopping the profiling is handled asynchronously).

250

}

Bu Sun Kim

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

[diff] [blame]

251

252

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

259

260

{ # Profile resource.

Bu Sun Kim

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

[diff] [blame]

261

"profileType": "A String", # Type of profile.

262

# For offline mode, this must be specified when creating the profile. For

263

# online mode it is assigned and returned by the server.

264

"deployment": { # Deployment contains the deployment identification information. # Deployment this profile corresponds to.

Bu Sun Kim

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

[diff] [blame^]

265

"target": "A String", # Target is the service name used to group related deployments:

266

# * Service name for GAE Flex / Standard.

267

# * Cluster and container name for GKE.

268

# * User-specified string for direct GCE profiling (e.g. Java).

269

# * Job name for Dataflow.

270

# Validation regex: `^[a-z]([-a-z0-9_.]{0,253}[a-z0-9])?$`.

271

"projectId": "A String", # Project ID is the ID of a cloud project.

272

# Validation regex: `^a-z{4,61}[a-z0-9]$`.

Bu Sun Kim

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

[diff] [blame]

273

"labels": { # Labels identify the deployment within the user universe and same target.

274

# Validation regex for label names: `^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$`.

275

# Value for an individual label must be <= 512 bytes, the total

276

# size of all label names and values must be <= 1024 bytes.

277

#

278

# Label named "language" can be used to record the programming language of

279

# the profiled deployment. The standard choices for the value include "java",

280

# "go", "python", "ruby", "nodejs", "php", "dotnet".

281

#

282

# For deployments running on Google Cloud Platform, "zone" or "region" label

283

# should be present describing the deployment location. An example of a zone

284

# is "us-central1-a", an example of a region is "us-central1" or

285

# "us-central".

286

"a_key": "A String",

287

},

Bu Sun Kim

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

[diff] [blame]

288

},

Bu Sun Kim

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

[diff] [blame]

289

"labels": { # Input only. Labels associated to this specific profile. These labels will

290

# get merged with the deployment labels for the final data set. See

291

# documentation on deployment labels for validation rules and limits.

292

"a_key": "A String",

293

},

294

"profileBytes": "A String", # Input only. Profile bytes, as a gzip compressed serialized proto, the

295

# format is https://github.com/google/pprof/blob/master/proto/profile.proto.

296

"name": "A String", # Output only. Opaque, server-assigned, unique ID for this profile.

297

"duration": "A String", # Duration of the profiling session.

298

# Input (for the offline mode) or output (for the online mode).

299

# The field represents requested profiling duration. It may slightly differ

300

# from the effective profiling duration, which is recorded in the profile

301

# data, in case the profiling can't be stopped immediately (e.g. in case

302

# stopping the profiling is handled asynchronously).

303

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

Dan O'Meara

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

[diff] [blame]

307

<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>

Bu Sun Kim

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

[diff] [blame]

308

<pre>UpdateProfile updates the profile bytes and labels on the profile resource

309

created in the online mode. Updating the bytes for profiles created in the

310

offline mode is currently not supported: the profile content must be

311

provided at the time of the profile creation.

312

313

Args:

314

name: string, Output only. Opaque, server-assigned, unique ID for this profile. (required)

Dan O'Meara

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

[diff] [blame]

315

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

316

The object takes the form of:

317

318

{ # Profile resource.

Bu Sun Kim

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

[diff] [blame]

319

"profileType": "A String", # Type of profile.

320

# For offline mode, this must be specified when creating the profile. For

321

# online mode it is assigned and returned by the server.

322

"deployment": { # Deployment contains the deployment identification information. # Deployment this profile corresponds to.

Bu Sun Kim

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

[diff] [blame^]

323

"target": "A String", # Target is the service name used to group related deployments:

324

# * Service name for GAE Flex / Standard.

325

# * Cluster and container name for GKE.

326

# * User-specified string for direct GCE profiling (e.g. Java).

327

# * Job name for Dataflow.

328

# Validation regex: `^[a-z]([-a-z0-9_.]{0,253}[a-z0-9])?$`.

329

"projectId": "A String", # Project ID is the ID of a cloud project.

330

# Validation regex: `^a-z{4,61}[a-z0-9]$`.

Bu Sun Kim

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

[diff] [blame]

331

"labels": { # Labels identify the deployment within the user universe and same target.

332

# Validation regex for label names: `^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$`.

333

# Value for an individual label must be <= 512 bytes, the total

334

# size of all label names and values must be <= 1024 bytes.

335

#

336

# Label named "language" can be used to record the programming language of

337

# the profiled deployment. The standard choices for the value include "java",

338

# "go", "python", "ruby", "nodejs", "php", "dotnet".

339

#

340

# For deployments running on Google Cloud Platform, "zone" or "region" label

341

# should be present describing the deployment location. An example of a zone

342

# is "us-central1-a", an example of a region is "us-central1" or

343

# "us-central".

344

"a_key": "A String",

345

},

Bu Sun Kim

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

[diff] [blame]

346

},

Bu Sun Kim

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

[diff] [blame]

347

"labels": { # Input only. Labels associated to this specific profile. These labels will

348

# get merged with the deployment labels for the final data set. See

349

# documentation on deployment labels for validation rules and limits.

350

"a_key": "A String",

351

},

352

"profileBytes": "A String", # Input only. Profile bytes, as a gzip compressed serialized proto, the

353

# format is https://github.com/google/pprof/blob/master/proto/profile.proto.

354

"name": "A String", # Output only. Opaque, server-assigned, unique ID for this profile.

355

"duration": "A String", # Duration of the profiling session.

356

# Input (for the offline mode) or output (for the online mode).

357

# The field represents requested profiling duration. It may slightly differ

358

# from the effective profiling duration, which is recorded in the profile

359

# data, in case the profiling can't be stopped immediately (e.g. in case

360

# stopping the profiling is handled asynchronously).

361

}

Bu Sun Kim

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

[diff] [blame]

362

363

updateMask: string, Field mask used to specify the fields to be overwritten. Currently only

364

profile_bytes and labels fields are supported by UpdateProfile, so only

365

those fields can be specified in the mask. When no mask is provided, all

366

fields are overwritten.

367

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

374

375

{ # Profile resource.

Bu Sun Kim

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

[diff] [blame]

376

"profileType": "A String", # Type of profile.

377

# For offline mode, this must be specified when creating the profile. For

378

# online mode it is assigned and returned by the server.

379

"deployment": { # Deployment contains the deployment identification information. # Deployment this profile corresponds to.

Bu Sun Kim

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

[diff] [blame^]

380

"target": "A String", # Target is the service name used to group related deployments:

381

# * Service name for GAE Flex / Standard.

382

# * Cluster and container name for GKE.

383

# * User-specified string for direct GCE profiling (e.g. Java).

384

# * Job name for Dataflow.

385

# Validation regex: `^[a-z]([-a-z0-9_.]{0,253}[a-z0-9])?$`.

386

"projectId": "A String", # Project ID is the ID of a cloud project.

387

# Validation regex: `^a-z{4,61}[a-z0-9]$`.

Bu Sun Kim

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

[diff] [blame]

388

"labels": { # Labels identify the deployment within the user universe and same target.

389

# Validation regex for label names: `^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$`.

390

# Value for an individual label must be <= 512 bytes, the total

391

# size of all label names and values must be <= 1024 bytes.

392

#

393

# Label named "language" can be used to record the programming language of

394

# the profiled deployment. The standard choices for the value include "java",

395

# "go", "python", "ruby", "nodejs", "php", "dotnet".

396

#

397

# For deployments running on Google Cloud Platform, "zone" or "region" label

398

# should be present describing the deployment location. An example of a zone

399

# is "us-central1-a", an example of a region is "us-central1" or

400

# "us-central".

401

"a_key": "A String",

402

},

Bu Sun Kim

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

[diff] [blame]

403

},

Bu Sun Kim

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

[diff] [blame]

404

"labels": { # Input only. Labels associated to this specific profile. These labels will

405

# get merged with the deployment labels for the final data set. See

406

# documentation on deployment labels for validation rules and limits.

407

"a_key": "A String",

408

},

409

"profileBytes": "A String", # Input only. Profile bytes, as a gzip compressed serialized proto, the

410

# format is https://github.com/google/pprof/blob/master/proto/profile.proto.

411

"name": "A String", # Output only. Opaque, server-assigned, unique ID for this profile.

412

"duration": "A String", # Duration of the profiling session.

413

# Input (for the offline mode) or output (for the online mode).

414

# The field represents requested profiling duration. It may slightly differ

415

# from the effective profiling duration, which is recorded in the profile

416

# data, in case the profiling can't be stopped immediately (e.g. in case

417

# stopping the profiling is handled asynchronously).

418

}</pre>

Bu Sun Kim