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

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

[diff] [blame]

90

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

Bu Sun Kim

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

[diff] [blame]

91

<p class="firstline">Updates an admin override.</p>

92

<h3>Method Details</h3>

93

94

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

95

<pre>Creates an admin override.

96

An admin override is applied by an administrator of a parent folder or

97

parent organization of the consumer receiving the override. An admin

98

override is intended to limit the amount of quota the consumer can use out

99

of the total quota pool allocated to all children of the folder or

organization.

Args:

parent: string, The resource name of the parent quota limit, returned by a

104

ListConsumerQuotaMetrics or GetConsumerQuotaMetric call.

105

106

An example name would be:

107

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

108

body: object, The request body.

109

The object takes the form of:

110

111

{ # A quota override

Bu Sun Kim

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

[diff] [blame]

112

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

113

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

114

#

115

# Example names would be:

116

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

117

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

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.

Bu Sun Kim

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

[diff] [blame]

121

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

122

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

123

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

124

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

125

# Used by admin overrides only.

126

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

127

#

128

# An example unit would be:

129

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

130

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

131

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

Bu Sun Kim

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

[diff] [blame]

132

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

133

#

134

# An example name would be:

135

# `compute.googleapis.com/cpus`

136

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

137

# for dimensions defined in the limit unit.

138

#

139

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

140

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

141

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

142

#

143

# This map has the following restrictions:

144

#

145

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

146

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

147

# {user}) is a defined key.

148

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

149

# the parent resource name.

150

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

151

# that apply only to a specific user.

152

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

153

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

154

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

155

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

156

# map.

157

"a_key": "A String",

158

},

Bu Sun Kim

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

[diff] [blame]

159

}

160

161

force: boolean, Whether to force the creation of the quota override.

162

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

163

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

164

to avoid accidentally decreasing quota too quickly. Setting the force

165

parameter to true ignores this restriction.

166

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

173

174

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

175

# network API call.

Bu Sun Kim

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

[diff] [blame]

176

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

177

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

178

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

179

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

180

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

181

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

182

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

183

# `TakeSnapshotResponse`.

184

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

185

},

Bu Sun Kim

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

[diff] [blame]

186

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

187

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

188

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

189

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

190

#

191

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

192

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

Bu Sun Kim

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

[diff] [blame]

193

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

Bu Sun Kim

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

[diff] [blame]

194

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

195

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

196

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

Bu Sun Kim

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

[diff] [blame]

197

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

198

# message types for APIs to use.

199

{

200

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

201

},

202

],

Bu Sun Kim

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

[diff] [blame]

203

},

Bu Sun Kim

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

[diff] [blame]

204

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

205

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

206

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

207

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

208

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

209

},

210

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

211

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

212

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

213

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

214

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

215

# available.

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

<code class="details" id="delete">delete(name, force=None, x__xgafv=None)</code>

221

<pre>Deletes an admin override.

222

223

Args:

224

name: string, The resource name of the override to delete.

225

226

An example name would be:

227

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

228

force: boolean, Whether to force the deletion of the quota override.

229

If deleting an override would cause the effective quota for the consumer to

230

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

231

to avoid accidentally decreasing quota too quickly. Setting the force

232

parameter to true ignores this restriction.

233

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

240

241

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

242

# network API call.

Bu Sun Kim

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

[diff] [blame]

243

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

244

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

245

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

246

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

247

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

248

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

249

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

250

# `TakeSnapshotResponse`.

251

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

252

},

Bu Sun Kim

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

[diff] [blame]

253

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

254

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

255

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

256

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

257

#

258

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

259

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

Bu Sun Kim

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

[diff] [blame]

260

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

Bu Sun Kim

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

[diff] [blame]

261

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

262

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

263

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

Bu Sun Kim

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

[diff] [blame]

264

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

265

# message types for APIs to use.

266

{

267

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

268

},

269

],

Bu Sun Kim

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

[diff] [blame]

270

},

Bu Sun Kim

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

[diff] [blame]

271

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

272

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

273

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

274

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

275

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

276

},

277

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

278

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

279

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

280

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

281

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

282

# available.

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

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

288

<pre>Lists all admin overrides on this limit.

289

290

Args:

291

parent: string, The resource name of the parent quota limit, returned by a

292

ListConsumerQuotaMetrics or GetConsumerQuotaMetric call.

293

294

An example name would be:

295

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

296

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

297

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

298

call.

299

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

306

307

{ # Response message for ListAdminOverrides.

Bu Sun Kim

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

[diff] [blame]

308

"overrides": [ # Admin overrides on this limit.

309

{ # A quota override

Bu Sun Kim

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

[diff] [blame]

310

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

311

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

312

#

313

# Example names would be:

314

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

315

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

316

#

317

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

318

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

Bu Sun Kim

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

[diff] [blame]

319

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

320

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

321

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

322

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

323

# Used by admin overrides only.

324

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

325

#

326

# An example unit would be:

327

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

328

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

329

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

Bu Sun Kim

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

[diff] [blame]

330

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

331

#

332

# An example name would be:

333

# `compute.googleapis.com/cpus`

334

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

335

# for dimensions defined in the limit unit.

336

#

337

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

338

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

339

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

340

#

341

# This map has the following restrictions:

342

#

343

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

344

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

345

# {user}) is a defined key.

346

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

347

# the parent resource name.

348

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

349

# that apply only to a specific user.

350

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

351

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

352

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

353

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

354

# map.

355

"a_key": "A String",

356

},

Bu Sun Kim

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

[diff] [blame]

357

},

358

],

Bu Sun Kim

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

[diff] [blame]

359

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

360

# call.

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

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

366

<pre>Retrieves the next page of results.

367

368

Args:

369

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

370

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

371

372

Returns:

373

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

374

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

</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

379

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

Bu Sun Kim

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

[diff] [blame]

380

<pre>Updates an admin override.

381

382

Args:

383

name: string, The resource name of the override to update.

384

385

An example name would be:

386

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

387

body: object, The request body.

388

The object takes the form of:

389

390

{ # A quota override

Bu Sun Kim

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

[diff] [blame]

391

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

392

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

393

#

394

# Example names would be:

395

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

396

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

397

#

398

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

399

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

Bu Sun Kim

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

[diff] [blame]

400

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

401

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

402

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

403

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

404

# Used by admin overrides only.

405

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

406

#

407

# An example unit would be:

408

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

409

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

410

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

Bu Sun Kim

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

[diff] [blame]

411

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

412

#

413

# An example name would be:

414

# `compute.googleapis.com/cpus`

415

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

416

# for dimensions defined in the limit unit.

417

#

418

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

419

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

420

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

421

#

422

# This map has the following restrictions:

423

#

424

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

425

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

426

# {user}) is a defined key.

427

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

428

# the parent resource name.

429

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

430

# that apply only to a specific user.

431

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

432

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

433

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

434

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

435

# map.

436

"a_key": "A String",

437

},

Bu Sun Kim

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

[diff] [blame]

438

}

439

Bu Sun Kim

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

[diff] [blame]

440

force: boolean, Whether to force the update of the quota override.

441

If updating an override would cause the effective quota for the consumer to

442

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

443

to avoid accidentally decreasing quota too quickly. Setting the force

444

parameter to true ignores this restriction.

Bu Sun Kim

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

[diff] [blame]

445

updateMask: string, Update only the specified fields of the override.

446

If unset, all fields will be updated.

Bu Sun Kim

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

[diff] [blame]

447

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

454

455

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

456

# network API call.

Bu Sun Kim

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

[diff] [blame]

457

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

458

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

459

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

460

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

461

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

462

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

463

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

464

# `TakeSnapshotResponse`.

465

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

466

},

Bu Sun Kim