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

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

[diff] [blame^]

86

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

87

<p class="firstline">Create or update multiple consumer overrides atomically, all on the</p>

88

89

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

Bu Sun Kim

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

[diff] [blame]

90

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

91

92

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

93

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

94

<h3>Method Details</h3>

95

96

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

97

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

98

99

Args:

100

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

101

102

An example name would be:

103

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

104

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

105

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

112

113

{ # Consumer quota settings for a quota metric.

Bu Sun Kim

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

[diff] [blame^]

114

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

115

#

116

# An example name would be:

117

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

118

#

119

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

120

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

121

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

122

#

123

# An example name would be:

124

# `compute.googleapis.com/cpus`

125

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

126

#

127

# An example name would be:

128

# "CPUs"

129

"unit": "A String", # The units in which the metric value is reported.

Bu Sun Kim

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

[diff] [blame]

130

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

131

{ # Consumer quota settings for a quota limit.

Bu Sun Kim

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

[diff] [blame^]

132

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

133

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

134

#

135

# An example name would be:

136

# `compute.googleapis.com/cpus`

137

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

138

#

139

# An example unit would be

140

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

141

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

142

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

143

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

Bu Sun Kim

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

[diff] [blame]

144

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

145

#

146

# An example name would be:

147

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

148

#

149

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

150

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

Bu Sun Kim

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

[diff] [blame]

151

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

152

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

153

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

154

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

Bu Sun Kim

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

[diff] [blame]

155

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

Bu Sun Kim

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

[diff] [blame]

156

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

157

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

158

#

159

# Example names would be:

160

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

161

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

162

#

163

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

164

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

Bu Sun Kim

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

[diff] [blame^]

165

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

166

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

167

"adminOverrideAncestor": "A String", # The resource name of the ancestor that requested the override. For example:

168

# "organizations/12345" or "folders/67890".

169

# Used by admin overrides only.

170

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

171

#

172

# An example unit would be:

173

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

174

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

175

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

Bu Sun Kim

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

[diff] [blame]

176

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

177

#

178

# An example name would be:

179

# `compute.googleapis.com/cpus`

180

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

181

# for dimensions defined in the limit unit.

182

#

183

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

184

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

185

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

186

#

187

# This map has the following restrictions:

188

#

189

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

190

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

191

# {user}) is a defined key.

192

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

193

# the parent resource name.

194

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

195

# that apply only to a specific user.

196

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

197

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

198

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

199

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

200

# map.

201

"a_key": "A String",

202

},

Bu Sun Kim

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

[diff] [blame]

203

},

204

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

Bu Sun Kim

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

[diff] [blame]

205

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

206

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

207

#

208

# Example names would be:

209

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

210

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

211

#

212

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

213

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

Bu Sun Kim

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

[diff] [blame^]

214

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

215

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

216

"adminOverrideAncestor": "A String", # The resource name of the ancestor that requested the override. For example:

217

# "organizations/12345" or "folders/67890".

218

# Used by admin overrides only.

219

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

220

#

221

# An example unit would be:

222

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

223

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

224

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

Bu Sun Kim

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

[diff] [blame]

225

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

226

#

227

# An example name would be:

228

# `compute.googleapis.com/cpus`

229

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

230

# for dimensions defined in the limit unit.

231

#

232

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

233

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

234

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

235

#

236

# This map has the following restrictions:

237

#

238

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

239

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

240

# {user}) is a defined key.

241

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

242

# the parent resource name.

243

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

244

# that apply only to a specific user.

245

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

246

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

247

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

248

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

249

# map.

250

"a_key": "A String",

251

},

Bu Sun Kim

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

[diff] [blame]

252

},

253

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

254

#

255

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

256

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

257

#

258

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

259

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

260

#

261

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

262

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

263

# specified overrides apply only in that region.

264

"a_key": "A String",

265

},

Bu Sun Kim

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

[diff] [blame^]

266

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

267

# configuration.

268

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

269

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

270

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

271

#

272

# Example names would be:

273

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

274

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

275

#

276

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

277

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

278

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

279

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

280

"adminOverrideAncestor": "A String", # The resource name of the ancestor that requested the override. For example:

281

# "organizations/12345" or "folders/67890".

282

# Used by admin overrides only.

283

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

284

#

285

# An example unit would be:

286

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

287

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

288

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

289

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

290

#

291

# An example name would be:

292

# `compute.googleapis.com/cpus`

293

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

294

# for dimensions defined in the limit unit.

295

#

296

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

297

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

298

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

299

#

300

# This map has the following restrictions:

301

#

302

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

303

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

304

# {user}) is a defined key.

305

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

306

# the parent resource name.

307

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

308

# that apply only to a specific user.

309

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

310

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

311

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

312

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

# map.

"a_key": "A String",

},

},

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

318

# are no overrides.

Bu Sun Kim

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

[diff] [blame]

319

},

320

],

Bu Sun Kim

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

[diff] [blame]

321

},

322

],

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

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

[diff] [blame^]

327

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

328

<pre>Create or update multiple consumer overrides atomically, all on the

329

same consumer, but on many different metrics or limits.

330

The name field in the quota override message should not be set.

331

332

Args:

333

parent: string, The resource name of the consumer.

334

335

An example name would be:

336

`projects/123/services/compute.googleapis.com` (required)

337

body: object, The request body.

338

The object takes the form of:

339

340

{ # Request message for ImportConsumerOverrides

341

"force": True or False, # Whether to force the creation of the quota overrides.

342

# If creating an override would cause the effective quota for the consumer to

343

# decrease by more than 10 percent, the call is rejected, as a safety measure

344

# to avoid accidentally decreasing quota too quickly. Setting the force

345

# parameter to true ignores this restriction.

346

"inlineSource": { # Import data embedded in the request message # The import data is specified in the request message itself

347

"overrides": [ # The overrides to create.

348

# Each override must have a value for 'metric' and 'unit', to specify

349

# which metric and which limit the override should be applied to.

350

{ # A quota override

351

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

352

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

353

#

354

# Example names would be:

355

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

356

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

357

#

358

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

359

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

360

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

361

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

362

"adminOverrideAncestor": "A String", # The resource name of the ancestor that requested the override. For example:

363

# "organizations/12345" or "folders/67890".

364

# Used by admin overrides only.

365

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

366

#

367

# An example unit would be:

368

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

369

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

370

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

371

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

372

#

373

# An example name would be:

374

# `compute.googleapis.com/cpus`

375

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

376

# for dimensions defined in the limit unit.

377

#

378

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

379

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

380

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

381

#

382

# This map has the following restrictions:

383

#

384

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

385

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

386

# {user}) is a defined key.

387

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

388

# the parent resource name.

389

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

390

# that apply only to a specific user.

391

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

392

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

393

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

394

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

# map.

"a_key": "A String",

},

},

],

},

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

410

411

{ # This resource represents a long-running operation that is the result of a

412

# network API call.

413

"response": { # The normal response of the operation in case of success. If the original

414

# method returns no data on success, such as `Delete`, the response is

415

# `google.protobuf.Empty`. If the original method is standard

416

# `Get`/`Create`/`Update`, the response should be the resource. For other

417

# methods, the response should have the type `XxxResponse`, where `Xxx`

418

# is the original method name. For example, if the original method name

419

# is `TakeSnapshot()`, the inferred response type is

420

# `TakeSnapshotResponse`.

421

"a_key": "", # Properties of the object. Contains field @type with type URL.

422

},

423

"error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.

424

# different programming environments, including REST APIs and RPC APIs. It is

425

# used by [gRPC](https://github.com/grpc). Each `Status` message contains

426

# three pieces of data: error code, error message, and error details.

427

#

428

# You can find out more about this error model and how to work with it in the

429

# [API Design Guide](https://cloud.google.com/apis/design/errors).

430

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

431

"message": "A String", # A developer-facing error message, which should be in English. Any

432

# user-facing error message should be localized and sent in the

433

# google.rpc.Status.details field, or localized by the client.

434

"details": [ # A list of messages that carry the error details. There is a common set of

435

# message types for APIs to use.

436

{

437

"a_key": "", # Properties of the object. Contains field @type with type URL.

},

],

},

"metadata": { # Service-specific metadata associated with the operation. It typically

442

# contains progress information and common metadata such as create time.

443

# Some services might not provide such metadata. Any method that returns a

444

# long-running operation should document the metadata type, if any.

445

"a_key": "", # Properties of the object. Contains field @type with type URL.

446

},

447

"name": "A String", # The server-assigned name, which is only unique within the same service that

448

# originally returns it. If you use the default HTTP mapping, the

449

# `name` should be a resource name ending with `operations/{unique_id}`.

450

"done": True or False, # If the value is `false`, it means the operation is still in progress.

451

# If `true`, the operation is completed, and either `error` or `response` is

# available.

}</pre>

</div>

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

Bu Sun Kim

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

[diff] [blame]

458

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

459

consumer, organized by service metric. Each metric includes information

460

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

461

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

462

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

463

464

Args:

465

parent: string, Parent of the quotas resource.

466

467

Some example names would be:

468

projects/123/services/serviceconsumermanagement.googleapis.com

469

folders/345/services/serviceconsumermanagement.googleapis.com

470

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

Bu Sun Kim

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

[diff] [blame^]

471

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

Bu Sun Kim

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

[diff] [blame]

472

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

473

call.

474

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

475

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

482

483

{ # Response message for ListConsumerQuotaMetrics

Bu Sun Kim

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

[diff] [blame^]

484

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

485

# call.

Bu Sun Kim

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

[diff] [blame]

486

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

487

{ # Consumer quota settings for a quota metric.

Bu Sun Kim

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

[diff] [blame^]

488

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

489

#

490

# An example name would be:

491

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

492

#

493

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

494

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

495

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

496

#

497

# An example name would be:

498

# `compute.googleapis.com/cpus`

499

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

500

#

501

# An example name would be:

502

# "CPUs"

503

"unit": "A String", # The units in which the metric value is reported.

Bu Sun Kim

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

[diff] [blame]

504

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

505

{ # Consumer quota settings for a quota limit.

Bu Sun Kim

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

[diff] [blame^]

506

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

507

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

508

#

509

# An example name would be:

510

# `compute.googleapis.com/cpus`

511

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

512

#

513

# An example unit would be

514

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

515

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

516

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

517

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

Bu Sun Kim

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

[diff] [blame]

518

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

519

#

520

# An example name would be:

521

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

522

#

523

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

524

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

Bu Sun Kim

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

[diff] [blame]

525

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

526

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

527

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

528

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

Bu Sun Kim

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

[diff] [blame]

529

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

Bu Sun Kim

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

[diff] [blame]

530

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

531

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

532

#

533

# Example names would be:

534

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

535

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

536

#

537

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

538

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

Bu Sun Kim

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

[diff] [blame^]

539

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

540

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

541

"adminOverrideAncestor": "A String", # The resource name of the ancestor that requested the override. For example:

542

# "organizations/12345" or "folders/67890".

543

# Used by admin overrides only.

544

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

545

#

546

# An example unit would be:

547

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

548

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

549

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

Bu Sun Kim

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

[diff] [blame]

550

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

551

#

552

# An example name would be:

553

# `compute.googleapis.com/cpus`

554

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

555

# for dimensions defined in the limit unit.

556

#

557

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

558

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

559

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

560

#

561

# This map has the following restrictions:

562

#

563

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

564

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

565

# {user}) is a defined key.

566

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

567

# the parent resource name.

568

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

569

# that apply only to a specific user.

570

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

571

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

572

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

573

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

574

# map.

575

"a_key": "A String",

576

},

Bu Sun Kim

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

[diff] [blame]

577

},

578

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

Bu Sun Kim

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

[diff] [blame]

579

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

580

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

581

#

582

# Example names would be:

583

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

584

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

585

#

586

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

587

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

Bu Sun Kim

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

[diff] [blame^]

588

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

589

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

590

"adminOverrideAncestor": "A String", # The resource name of the ancestor that requested the override. For example:

591

# "organizations/12345" or "folders/67890".

592

# Used by admin overrides only.

593

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

594

#

595

# An example unit would be:

596

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

597

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

598

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

Bu Sun Kim

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

[diff] [blame]

599

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

600

#

601

# An example name would be:

602

# `compute.googleapis.com/cpus`

603

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

604

# for dimensions defined in the limit unit.

605

#

606

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

607

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

608

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

609

#

610

# This map has the following restrictions:

611

#

612

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

613

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

614

# {user}) is a defined key.

615

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

616

# the parent resource name.

617

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

618

# that apply only to a specific user.

619

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

620

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

621

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

622

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

623

# map.

624

"a_key": "A String",

625

},

Bu Sun Kim

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

[diff] [blame]

626

},

627

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

628

#

629

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

630

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

631

#

632

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

633

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

634

#

635

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

636

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

637

# specified overrides apply only in that region.

638

"a_key": "A String",

639

},

Bu Sun Kim

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

[diff] [blame^]

640

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

641

# configuration.

642

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

643

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

644

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

645

#

646

# Example names would be:

647

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

648

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

649

#

650

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

651

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

652

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

653

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

654

"adminOverrideAncestor": "A String", # The resource name of the ancestor that requested the override. For example:

655

# "organizations/12345" or "folders/67890".

656

# Used by admin overrides only.

657

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

658

#

659

# An example unit would be:

660

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

661

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

662

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

663

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

664

#

665

# An example name would be:

666

# `compute.googleapis.com/cpus`

667

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

668

# for dimensions defined in the limit unit.

669

#

670

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

671

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

672

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

673

#

674

# This map has the following restrictions:

675

#

676

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

677

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

678

# {user}) is a defined key.

679

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

680

# the parent resource name.

681

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

682

# that apply only to a specific user.

683

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

684

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

685

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

686

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

# map.

"a_key": "A String",

},

},

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

692

# are no overrides.

Bu Sun Kim

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

[diff] [blame]

693

},

694

],

Bu Sun Kim

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

[diff] [blame]

695

},

696

],

Bu Sun Kim

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

[diff] [blame]

697

},

698

],

Bu Sun Kim