Blame - docs/dyn/serviceusage_v1beta1.services.consumerQuotaMetrics.html - platform/external/python/google-api-python-client

<h1><a href="serviceusage_v1beta1.html">Service Usage API</a> . <a href="serviceusage_v1beta1.services.html">services</a> . <a href="serviceusage_v1beta1.services.consumerQuotaMetrics.html">consumerQuotaMetrics</a></h1>

76

<h2>Instance Methods</h2>

77

78

<code><a href="serviceusage_v1beta1.services.consumerQuotaMetrics.limits.html">limits()</a></code>

79

</p>

80

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

81

82

83

<code><a href="#get">get(name, view=None, x__xgafv=None)</a></code></p>

84

<p class="firstline">Retrieves a summary of quota information for a specific quota metric</p>

85

86

<code><a href="#list">list(parent, pageSize=None, pageToken=None, view=None, x__xgafv=None)</a></code></p>

87

<p class="firstline">Retrieves a summary of all quota information visible to the service</p>

88

89

<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>

90

<p class="firstline">Retrieves the next page of results.</p>

91

<h3>Method Details</h3>

92

93

<code class="details" id="get">get(name, view=None, x__xgafv=None)</code>

94

<pre>Retrieves a summary of quota information for a specific quota metric

95

96

Args:

97

name: string, The resource name of the quota limit.

98

99

An example name would be:

100

projects/123/services/serviceusage.googleapis.com/quotas/metrics/serviceusage.googleapis.com%2Fmutate_requests (required)

101

view: string, Specifies the level of detail for quota information in the response.

102

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

109

110

{ # Consumer quota settings for a quota metric.

111

"consumerQuotaLimits": [ # The consumer quota for each quota limit defined on the metric.

112

{ # Consumer quota settings for a quota limit.

113

"allowsAdminOverrides": True or False, # Whether admin overrides are allowed on this limit

114

"quotaBuckets": [ # Summary of the enforced quota buckets, organized by quota dimension,

115

# ordered from least specific to most specific (for example, the global

116

# default bucket, with no quota dimensions, will always appear first).

117

{ # A quota bucket is a quota provisioning unit for a specific set of dimensions.

118

"consumerOverride": { # A quota override # Consumer override on this quota bucket.

119

"unit": "A String", # The limit unit of the limit to which this override applies.

120

#

121

# An example unit would be:

122

# `1/{project}/{region}`

123

# Note that `{project}` and `{region}` are not placeholders in this example;

124

# the literal characters `{` and `}` occur in the string.

125

"metric": "A String", # The name of the metric to which this override applies.

126

#

127

# An example name would be:

128

# `compute.googleapis.com/cpus`

129

"dimensions": { # If this map is nonempty, then this override applies only to specific values

130

# for dimensions defined in the limit unit.

131

#

132

# For example, an override on a limit with the unit 1/{project}/{region}

133

# could contain an entry with the key "region" and the value "us-east-1";

134

# the override is only applied to quota consumed in that region.

135

#

136

# This map has the following restrictions:

137

#

138

# * Keys that are not defined in the limit's unit are not valid keys.

139

# Any string appearing in {brackets} in the unit (besides {project} or

140

# {user}) is a defined key.

141

# * "project" is not a valid key; the project is already specified in

142

# the parent resource name.

143

# * "user" is not a valid key; the API does not support quota overrides

144

# that apply only to a specific user.

145

# * If "region" appears as a key, its value must be a valid Cloud region.

146

# * If "zone" appears as a key, its value must be a valid Cloud zone.

147

# * If any valid key other than "region" or "zone" appears in the map, then

148

# all valid keys other than "region" or "zone" must also appear in the

# map.

"a_key": "A String",

},

"name": "A String", # The resource name of the override.

153

# This name is generated by the server when the override is created.

154

#

155

# Example names would be:

156

# `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/adminOverrides/4a3f2c1d`

157

# `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/consumerOverrides/4a3f2c1d`

158

#

159

# The resource name is intended to be opaque and should not be parsed for

160

# its component strings, since its representation could change in the future.

161

"overrideValue": "A String", # The overriding quota limit value.

162

# Can be any nonnegative integer, or -1 (unlimited quota).

163

},

164

"defaultLimit": "A String", # The default limit of this quota bucket, as specified by the service

165

# configuration.

166

"effectiveLimit": "A String", # The effective limit of this quota bucket. Equal to default_limit if there

167

# are no overrides.

168

"producerOverride": { # A quota override # Producer override on this quota bucket.

169

"unit": "A String", # The limit unit of the limit to which this override applies.

170

#

171

# An example unit would be:

172

# `1/{project}/{region}`

173

# Note that `{project}` and `{region}` are not placeholders in this example;

174

# the literal characters `{` and `}` occur in the string.

175

"metric": "A String", # The name of the metric to which this override applies.

176

#

177

# An example name would be:

178

# `compute.googleapis.com/cpus`

179

"dimensions": { # If this map is nonempty, then this override applies only to specific values

180

# for dimensions defined in the limit unit.

181

#

182

# For example, an override on a limit with the unit 1/{project}/{region}

183

# could contain an entry with the key "region" and the value "us-east-1";

184

# the override is only applied to quota consumed in that region.

185

#

186

# This map has the following restrictions:

187

#

188

# * Keys that are not defined in the limit's unit are not valid keys.

189

# Any string appearing in {brackets} in the unit (besides {project} or

190

# {user}) is a defined key.

191

# * "project" is not a valid key; the project is already specified in

192

# the parent resource name.

193

# * "user" is not a valid key; the API does not support quota overrides

194

# that apply only to a specific user.

195

# * If "region" appears as a key, its value must be a valid Cloud region.

196

# * If "zone" appears as a key, its value must be a valid Cloud zone.

197

# * If any valid key other than "region" or "zone" appears in the map, then

198

# all valid keys other than "region" or "zone" must also appear in the

# map.

"a_key": "A String",

},

"name": "A String", # The resource name of the override.

203

# This name is generated by the server when the override is created.

204

#

205

# Example names would be:

206

# `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/adminOverrides/4a3f2c1d`

207

# `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/consumerOverrides/4a3f2c1d`

208

#

209

# The resource name is intended to be opaque and should not be parsed for

210

# its component strings, since its representation could change in the future.

211

"overrideValue": "A String", # The overriding quota limit value.

212

# Can be any nonnegative integer, or -1 (unlimited quota).

213

},

214

"dimensions": { # The dimensions of this quota bucket.

215

#

216

# If this map is empty, this is the global bucket, which is the default quota

217

# value applied to all requests that do not have a more specific override.

218

#

219

# If this map is nonempty, the default limit, effective limit, and quota

220

# overrides apply only to requests that have the dimensions given in the map.

221

#

222

# For example, if the map has key "region" and value "us-east-1", then the

223

# specified effective limit is only effective in that region, and the

224

# specified overrides apply only in that region.

225

"a_key": "A String",

226

},

227

"adminOverride": { # A quota override # Admin override on this quota bucket.

228

"unit": "A String", # The limit unit of the limit to which this override applies.

229

#

230

# An example unit would be:

231

# `1/{project}/{region}`

232

# Note that `{project}` and `{region}` are not placeholders in this example;

233

# the literal characters `{` and `}` occur in the string.

234

"metric": "A String", # The name of the metric to which this override applies.

235

#

236

# An example name would be:

237

# `compute.googleapis.com/cpus`

238

"dimensions": { # If this map is nonempty, then this override applies only to specific values

239

# for dimensions defined in the limit unit.

240

#

241

# For example, an override on a limit with the unit 1/{project}/{region}

242

# could contain an entry with the key "region" and the value "us-east-1";

243

# the override is only applied to quota consumed in that region.

244

#

245

# This map has the following restrictions:

246

#

247

# * Keys that are not defined in the limit's unit are not valid keys.

248

# Any string appearing in {brackets} in the unit (besides {project} or

249

# {user}) is a defined key.

250

# * "project" is not a valid key; the project is already specified in

251

# the parent resource name.

252

# * "user" is not a valid key; the API does not support quota overrides

253

# that apply only to a specific user.

254

# * If "region" appears as a key, its value must be a valid Cloud region.

255

# * If "zone" appears as a key, its value must be a valid Cloud zone.

256

# * If any valid key other than "region" or "zone" appears in the map, then

257

# all valid keys other than "region" or "zone" must also appear in the

# map.

"a_key": "A String",

},

"name": "A String", # The resource name of the override.

262

# This name is generated by the server when the override is created.

263

#

264

# Example names would be:

265

# `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/adminOverrides/4a3f2c1d`

266

# `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/consumerOverrides/4a3f2c1d`

267

#

268

# The resource name is intended to be opaque and should not be parsed for

269

# its component strings, since its representation could change in the future.

270

"overrideValue": "A String", # The overriding quota limit value.

271

# Can be any nonnegative integer, or -1 (unlimited quota).

},

},

],

"name": "A String", # The resource name of the quota limit.

276

#

277

# An example name would be:

278

# `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion`

279

#

280

# The resource name is intended to be opaque and should not be parsed for

281

# its component strings, since its representation could change in the future.

282

"unit": "A String", # The limit unit.

283

#

284

# An example unit would be

285

# `1/{project}/{region}`

286

# Note that `{project}` and `{region}` are not placeholders in this example;

287

# the literal characters `{` and `}` occur in the string.

288

"metric": "A String", # The name of the parent metric of this limit.

289

#

290

# An example name would be:

291

# `compute.googleapis.com/cpus`

292

"isPrecise": True or False, # Whether this limit is precise or imprecise.

293

},

294

],

295

"displayName": "A String", # The display name of the metric.

296

#

297

# An example name would be:

298

# "CPUs"

299

"name": "A String", # The resource name of the quota settings on this metric for this consumer.

300

#

301

# An example name would be:

302

# `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus

303

#

304

# The resource name is intended to be opaque and should not be parsed for

305

# its component strings, since its representation could change in the future.

306

"metric": "A String", # The name of the metric.

307

#

308

# An example name would be:

309

# `compute.googleapis.com/cpus`

}</pre>

</div>

<code class="details" id="list">list(parent, pageSize=None, pageToken=None, view=None, x__xgafv=None)</code>

315

<pre>Retrieves a summary of all quota information visible to the service

316

consumer, organized by service metric. Each metric includes information

317

about all of its defined limits. Each limit includes the limit

318

configuration (quota unit, preciseness, default value), the current

319

effective limit value, and all of the overrides applied to the limit.

320

321

Args:

322

parent: string, Parent of the quotas resource.

323

324

Some example names would be:

325

projects/123/services/serviceconsumermanagement.googleapis.com

326

folders/345/services/serviceconsumermanagement.googleapis.com

327

organizations/456/services/serviceconsumermanagement.googleapis.com (required)

328

pageSize: integer, Requested size of the next page of data.

329

pageToken: string, Token identifying which result to start with; returned by a previous list

330

call.

331

view: string, Specifies the level of detail for quota information in the response.

332

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

339

340

{ # Response message for ListConsumerQuotaMetrics

341

"metrics": [ # Quota settings for the consumer, organized by quota metric.

342

{ # Consumer quota settings for a quota metric.

343

"consumerQuotaLimits": [ # The consumer quota for each quota limit defined on the metric.

344

{ # Consumer quota settings for a quota limit.

345

"allowsAdminOverrides": True or False, # Whether admin overrides are allowed on this limit

346

"quotaBuckets": [ # Summary of the enforced quota buckets, organized by quota dimension,

347

# ordered from least specific to most specific (for example, the global

348

# default bucket, with no quota dimensions, will always appear first).

349

{ # A quota bucket is a quota provisioning unit for a specific set of dimensions.

350

"consumerOverride": { # A quota override # Consumer override on this quota bucket.

351

"unit": "A String", # The limit unit of the limit to which this override applies.

352

#

353

# An example unit would be:

354

# `1/{project}/{region}`

355

# Note that `{project}` and `{region}` are not placeholders in this example;

356

# the literal characters `{` and `}` occur in the string.

357

"metric": "A String", # The name of the metric to which this override applies.

358

#

359

# An example name would be:

360

# `compute.googleapis.com/cpus`

361

"dimensions": { # If this map is nonempty, then this override applies only to specific values

362

# for dimensions defined in the limit unit.

363

#

364

# For example, an override on a limit with the unit 1/{project}/{region}

365

# could contain an entry with the key "region" and the value "us-east-1";

366

# the override is only applied to quota consumed in that region.

367

#

368

# This map has the following restrictions:

369

#

370

# * Keys that are not defined in the limit's unit are not valid keys.

371

# Any string appearing in {brackets} in the unit (besides {project} or

372

# {user}) is a defined key.

373

# * "project" is not a valid key; the project is already specified in

374

# the parent resource name.

375

# * "user" is not a valid key; the API does not support quota overrides

376

# that apply only to a specific user.

377

# * If "region" appears as a key, its value must be a valid Cloud region.

378

# * If "zone" appears as a key, its value must be a valid Cloud zone.

379

# * If any valid key other than "region" or "zone" appears in the map, then

380

# all valid keys other than "region" or "zone" must also appear in the

# map.

"a_key": "A String",

},

"name": "A String", # The resource name of the override.

385

# This name is generated by the server when the override is created.

386

#

387

# Example names would be:

388

# `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/adminOverrides/4a3f2c1d`

389

# `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/consumerOverrides/4a3f2c1d`

390

#

391

# The resource name is intended to be opaque and should not be parsed for

392

# its component strings, since its representation could change in the future.

393

"overrideValue": "A String", # The overriding quota limit value.

394

# Can be any nonnegative integer, or -1 (unlimited quota).

395

},

396

"defaultLimit": "A String", # The default limit of this quota bucket, as specified by the service

397

# configuration.

398

"effectiveLimit": "A String", # The effective limit of this quota bucket. Equal to default_limit if there

399

# are no overrides.

400

"producerOverride": { # A quota override # Producer override on this quota bucket.

401

"unit": "A String", # The limit unit of the limit to which this override applies.

402

#

403

# An example unit would be:

404

# `1/{project}/{region}`

405

# Note that `{project}` and `{region}` are not placeholders in this example;

406

# the literal characters `{` and `}` occur in the string.

407

"metric": "A String", # The name of the metric to which this override applies.

408

#

409

# An example name would be:

410

# `compute.googleapis.com/cpus`

411

"dimensions": { # If this map is nonempty, then this override applies only to specific values

412

# for dimensions defined in the limit unit.

413

#

414

# For example, an override on a limit with the unit 1/{project}/{region}

415

# could contain an entry with the key "region" and the value "us-east-1";

416

# the override is only applied to quota consumed in that region.

417

#

418

# This map has the following restrictions:

419

#

420

# * Keys that are not defined in the limit's unit are not valid keys.

421

# Any string appearing in {brackets} in the unit (besides {project} or

422

# {user}) is a defined key.

423

# * "project" is not a valid key; the project is already specified in

424

# the parent resource name.

425

# * "user" is not a valid key; the API does not support quota overrides

426

# that apply only to a specific user.

427

# * If "region" appears as a key, its value must be a valid Cloud region.

428

# * If "zone" appears as a key, its value must be a valid Cloud zone.

429

# * If any valid key other than "region" or "zone" appears in the map, then

430

# all valid keys other than "region" or "zone" must also appear in the

# map.

"a_key": "A String",

},

"name": "A String", # The resource name of the override.

435

# This name is generated by the server when the override is created.

436

#

437

# Example names would be:

438

# `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/adminOverrides/4a3f2c1d`

439

# `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/consumerOverrides/4a3f2c1d`

440

#

441

# The resource name is intended to be opaque and should not be parsed for

442

# its component strings, since its representation could change in the future.

443

"overrideValue": "A String", # The overriding quota limit value.

444

# Can be any nonnegative integer, or -1 (unlimited quota).

445

},

446

"dimensions": { # The dimensions of this quota bucket.

447

#

448

# If this map is empty, this is the global bucket, which is the default quota

449

# value applied to all requests that do not have a more specific override.

450

#

451

# If this map is nonempty, the default limit, effective limit, and quota

452

# overrides apply only to requests that have the dimensions given in the map.

453

#

454

# For example, if the map has key "region" and value "us-east-1", then the

455

# specified effective limit is only effective in that region, and the

456

# specified overrides apply only in that region.

457

"a_key": "A String",

458

},

459

"adminOverride": { # A quota override # Admin override on this quota bucket.

460

"unit": "A String", # The limit unit of the limit to which this override applies.

461

#

462

# An example unit would be:

463

# `1/{project}/{region}`

464

# Note that `{project}` and `{region}` are not placeholders in this example;

465

# the literal characters `{` and `}` occur in the string.

466

"metric": "A String", # The name of the metric to which this override applies.

467

#

468

# An example name would be:

469

# `compute.googleapis.com/cpus`

470

"dimensions": { # If this map is nonempty, then this override applies only to specific values

471

# for dimensions defined in the limit unit.

472

#

473

# For example, an override on a limit with the unit 1/{project}/{region}

474

# could contain an entry with the key "region" and the value "us-east-1";

475

# the override is only applied to quota consumed in that region.

476

#

477

# This map has the following restrictions:

478

#

479

# * Keys that are not defined in the limit's unit are not valid keys.

480

# Any string appearing in {brackets} in the unit (besides {project} or

481

# {user}) is a defined key.

482

# * "project" is not a valid key; the project is already specified in

483

# the parent resource name.

484

# * "user" is not a valid key; the API does not support quota overrides

485

# that apply only to a specific user.

486

# * If "region" appears as a key, its value must be a valid Cloud region.

487

# * If "zone" appears as a key, its value must be a valid Cloud zone.

488

# * If any valid key other than "region" or "zone" appears in the map, then

489

# all valid keys other than "region" or "zone" must also appear in the

# map.

"a_key": "A String",

},

"name": "A String", # The resource name of the override.

494

# This name is generated by the server when the override is created.

495

#

496

# Example names would be:

497

# `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/adminOverrides/4a3f2c1d`

498

# `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/consumerOverrides/4a3f2c1d`

499

#

500

# The resource name is intended to be opaque and should not be parsed for

501

# its component strings, since its representation could change in the future.

502

"overrideValue": "A String", # The overriding quota limit value.

503

# Can be any nonnegative integer, or -1 (unlimited quota).

},

},

],

"name": "A String", # The resource name of the quota limit.

508

#

509

# An example name would be:

510

# `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion`

511

#

512

# The resource name is intended to be opaque and should not be parsed for

513

# its component strings, since its representation could change in the future.

514

"unit": "A String", # The limit unit.

515

#

516

# An example unit would be

517

# `1/{project}/{region}`

518

# Note that `{project}` and `{region}` are not placeholders in this example;

519

# the literal characters `{` and `}` occur in the string.

520

"metric": "A String", # The name of the parent metric of this limit.

521

#

522

# An example name would be:

523

# `compute.googleapis.com/cpus`

524

"isPrecise": True or False, # Whether this limit is precise or imprecise.

525

},

526

],

527

"displayName": "A String", # The display name of the metric.

528

#

529

# An example name would be:

530

# "CPUs"

531

"name": "A String", # The resource name of the quota settings on this metric for this consumer.

532

#

533

# An example name would be:

534

# `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus

535

#

536

# The resource name is intended to be opaque and should not be parsed for

537

# its component strings, since its representation could change in the future.

538

"metric": "A String", # The name of the metric.

539

#

540

# An example name would be:

541

# `compute.googleapis.com/cpus`

542

},

543

],

544

"nextPageToken": "A String", # Token identifying which result to start with; returned by a previous list

# call.

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

551

<pre>Retrieves the next page of results.

552

553

Args:

554

previous_request: The request for the previous page. (required)

555

previous_response: The response from the request for the previous page. (required)

556

557

Returns:

558

A request object that you can call 'execute()' on to request the next

559

page. Returns None if there are no more items in the collection.

</pre>

</div>

</body></html>