Blame - docs/dyn/serviceusage_v1beta1.services.consumerQuotaMetrics.limits.adminOverrides.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> . <a href="serviceusage_v1beta1.services.consumerQuotaMetrics.limits.html">limits</a> . <a href="serviceusage_v1beta1.services.consumerQuotaMetrics.limits.adminOverrides.html">adminOverrides</a></h1>

76

<h2>Instance Methods</h2>

77

78

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

79

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

80

81

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

82

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

83

84

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

85

<p class="firstline">Lists all admin overrides on this limit.</p>

86

87

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

88

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

89

Bu Sun Kim

4ed7d3f

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

6502091

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

112

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

113

#

114

# An example unit would be:

115

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

116

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

117

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

Bu Sun Kim

4ed7d3f

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

[diff] [blame]

118

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

119

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

120

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

121

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

122

#

123

# Example names would be:

124

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

125

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

126

#

127

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

128

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

Bu Sun Kim

6502091

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

[diff] [blame]

129

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

130

#

131

# An example name would be:

132

# `compute.googleapis.com/cpus`

133

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

134

# for dimensions defined in the limit unit.

135

#

136

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

137

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

138

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

139

#

140

# This map has the following restrictions:

141

#

142

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

143

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

144

# {user}) is a defined key.

145

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

146

# the parent resource name.

147

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

148

# that apply only to a specific user.

149

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

150

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

151

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

152

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

153

# map.

154

"a_key": "A String",

155

},

Bu Sun Kim

6502091

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

[diff] [blame]

156

}

157

158

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

159

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

160

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

161

to avoid accidentally decreasing quota too quickly. Setting the force

162

parameter to true ignores this restriction.

163

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

170

171

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

172

# network API call.

173

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

174

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

175

# available.

Bu Sun Kim

6502091

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

[diff] [blame]

176

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

177

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

178

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

Bu Sun Kim

4ed7d3f

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

[diff] [blame]

179

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

180

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

181

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

182

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

183

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

184

},

Bu Sun Kim

6502091

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

[diff] [blame]

185

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

186

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

187

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

188

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

189

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

190

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

191

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

192

# `TakeSnapshotResponse`.

193

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

194

},

Bu Sun Kim

4ed7d3f

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

[diff] [blame]

195

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

196

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

197

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

198

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

199

#

200

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

201

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

202

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

203

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

204

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

205

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

206

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

207

# message types for APIs to use.

208

{

209

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

210

},

211

],

Bu Sun Kim

6502091

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

[diff] [blame]

},

}</pre>

</div>

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

218

<pre>Deletes an admin override.

219

220

Args:

221

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

222

223

An example name would be:

224

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

225

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

226

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

227

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

228

to avoid accidentally decreasing quota too quickly. Setting the force

229

parameter to true ignores this restriction.

230

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

237

238

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

239

# network API call.

240

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

241

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

242

# available.

Bu Sun Kim

6502091

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

[diff] [blame]

243

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

244

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

245

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

Bu Sun Kim

4ed7d3f

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

[diff] [blame]

246

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

247

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

248

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

249

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

250

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

251

},

Bu Sun Kim

6502091

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

[diff] [blame]

252

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

253

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

254

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

255

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

256

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

257

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

258

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

259

# `TakeSnapshotResponse`.

260

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

261

},

Bu Sun Kim

4ed7d3f

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

[diff] [blame]

262

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

263

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

264

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

265

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

266

#

267

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

268

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

269

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

270

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

271

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

272

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

273

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

274

# message types for APIs to use.

275

{

276

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

277

},

278

],

Bu Sun Kim

6502091

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>

285

<pre>Lists all admin overrides on this limit.

286

287

Args:

288

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

289

ListConsumerQuotaMetrics or GetConsumerQuotaMetric call.

290

291

An example name would be:

292

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

293

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

294

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

295

call.

296

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

303

304

{ # Response message for ListAdminOverrides.

Bu Sun Kim

6502091

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

[diff] [blame]

305

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

306

{ # A quota override

307

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

308

#

309

# An example unit would be:

310

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

311

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

312

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

Bu Sun Kim

4ed7d3f

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

[diff] [blame]

313

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

314

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

315

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

316

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

317

#

318

# Example names would be:

319

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

320

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

321

#

322

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

323

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

Bu Sun Kim

6502091

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

[diff] [blame]

324

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

325

#

326

# An example name would be:

327

# `compute.googleapis.com/cpus`

328

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

329

# for dimensions defined in the limit unit.

330

#

331

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

332

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

333

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

334

#

335

# This map has the following restrictions:

336

#

337

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

338

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

339

# {user}) is a defined key.

340

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

341

# the parent resource name.

342

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

343

# that apply only to a specific user.

344

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

345

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

346

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

347

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

348

# map.

349

"a_key": "A String",

350

},

Bu Sun Kim

6502091

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

[diff] [blame]

351

},

352

],

Bu Sun Kim

4ed7d3f

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

[diff] [blame]

353

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

354

# call.

Bu Sun Kim

6502091

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

[diff] [blame]

}</pre>

</div>

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

360

<pre>Retrieves the next page of results.

361

362

Args:

363

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

364

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

365

366

Returns:

367

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

368

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]

373

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

Bu Sun Kim

6502091

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

[diff] [blame]

374

<pre>Updates an admin override.

375

376

Args:

377

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

378

379

An example name would be:

380

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

381

body: object, The request body.

382

The object takes the form of:

383

384

{ # A quota override

385

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

386

#

387

# An example unit would be:

388

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

389

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

390

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

Bu Sun Kim

4ed7d3f

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

[diff] [blame]

391

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

392

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

393

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

394

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

395

#

396

# Example names would be:

397

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

398

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

399

#

400

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

401

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

Bu Sun Kim

6502091

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

[diff] [blame]

402

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

403

#

404

# An example name would be:

405

# `compute.googleapis.com/cpus`

406

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

407

# for dimensions defined in the limit unit.

408

#

409

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

410

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

411

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

412

#

413

# This map has the following restrictions:

414

#

415

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

416

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

417

# {user}) is a defined key.

418

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

419

# the parent resource name.

420

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

421

# that apply only to a specific user.

422

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

423

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

424

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

425

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

426

# map.

427

"a_key": "A String",

428

},

Bu Sun Kim

6502091

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

[diff] [blame]

429

}

430

Bu Sun Kim

6502091

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

[diff] [blame]

431

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

432

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

433

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

434

to avoid accidentally decreasing quota too quickly. Setting the force

435

parameter to true ignores this restriction.

Bu Sun Kim

4ed7d3f

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

[diff] [blame]

436

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

437

If unset, all fields will be updated.

Bu Sun Kim

6502091

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

[diff] [blame]

438

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

445

446

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

447

# network API call.

448

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

449

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

450

# available.

Bu Sun Kim

6502091

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

[diff] [blame]

451

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

452

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

453

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

Bu Sun Kim

4ed7d3f

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

[diff] [blame]

454

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

455

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

456

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

457

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

458

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

459

},

Bu Sun Kim

6502091

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

[diff] [blame]

460

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

461

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

462

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

463

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

464

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

465

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

466

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

467

# `TakeSnapshotResponse`.

468

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

469

},

Bu Sun Kim

4ed7d3f

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

[diff] [blame]

470

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

471

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

472

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

473

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

474

#

475

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

476

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