Blame - docs/dyn/serviceusage_v1beta1.services.consumerQuotaMetrics.limits.consumerOverrides.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.consumerOverrides.html">consumerOverrides</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 a consumer override.</p>

80

81

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

82

<p class="firstline">Deletes a consumer 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 consumer 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

90

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

91

<p class="firstline">Updates a consumer 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 a consumer override.

96

A consumer override is applied to the consumer on its own authority to

97

limit its own quota usage. Consumer overrides cannot be used to grant more

98

quota than would be allowed by admin overrides, producer overrides, or the

99

default limit of the service.

100

101

Args:

102

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

103

ListConsumerQuotaMetrics or GetConsumerQuotaMetric call.

104

105

An example name would be:

106

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

107

body: object, The request body.

108

The object takes the form of:

109

110

{ # A quota override

111

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

112

#

113

# An example unit would be:

114

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

115

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

116

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

117

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

118

#

119

# An example name would be:

120

# `compute.googleapis.com/cpus`

121

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

122

# for dimensions defined in the limit unit.

123

#

124

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

125

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

126

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

127

#

128

# This map has the following restrictions:

129

#

130

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

131

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

132

# {user}) is a defined key.

133

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

134

# the parent resource name.

135

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

136

# that apply only to a specific user.

137

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

138

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

139

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

140

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

145

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

146

#

147

# Example names would be:

148

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

149

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

150

#

151

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

152

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

153

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

154

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

155

}

156

157

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

158

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

159

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

160

to avoid accidentally decreasing quota too quickly. Setting the force

161

parameter to true ignores this restriction.

162

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

169

170

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

171

# network API call.

172

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

173

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

174

# available.

175

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

176

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

177

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

178

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

179

#

180

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

181

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

182

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

183

# message types for APIs to use.

184

{

185

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

186

},

187

],

188

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

189

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

190

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

191

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

192

},

193

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

194

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

195

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

196

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

197

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

198

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

199

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

200

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

201

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

202

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

203

# `TakeSnapshotResponse`.

204

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

205

},

206

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

207

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

208

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

209

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

210

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

},

}</pre>

</div>

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

217

<pre>Deletes a consumer override.

218

219

Args:

220

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

221

222

An example name would be:

223

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

224

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

225

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

226

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

227

to avoid accidentally decreasing quota too quickly. Setting the force

228

parameter to true ignores this restriction.

229

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

236

237

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

238

# network API call.

239

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

240

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

241

# available.

242

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

243

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

244

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

245

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

246

#

247

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

248

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

249

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

250

# message types for APIs to use.

251

{

252

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

253

},

254

],

255

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

256

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

257

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

258

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

259

},

260

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

261

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

262

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

263

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

264

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

265

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

266

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

267

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

268

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

269

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

270

# `TakeSnapshotResponse`.

271

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

272

},

273

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

274

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

275

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

276

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

277

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

},

}</pre>

</div>

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

284

<pre>Lists all consumer overrides on this limit.

285

286

Args:

287

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

288

ListConsumerQuotaMetrics or GetConsumerQuotaMetric call.

289

290

An example name would be:

291

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

292

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

293

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

294

call.

295

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

302

303

{ # Response message for ListConsumerOverrides.

304

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

305

# call.

306

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

307

{ # A quota override

308

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

309

#

310

# An example unit would be:

311

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

312

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

313

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

314

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

315

#

316

# An example name would be:

317

# `compute.googleapis.com/cpus`

318

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

319

# for dimensions defined in the limit unit.

320

#

321

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

322

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

323

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

324

#

325

# This map has the following restrictions:

326

#

327

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

328

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

329

# {user}) is a defined key.

330

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

331

# the parent resource name.

332

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

333

# that apply only to a specific user.

334

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

335

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

336

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

337

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

342

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

343

#

344

# Example names would be:

345

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

346

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

347

#

348

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

349

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

350

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

351

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

},

],

}</pre>

</div>

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

359

<pre>Retrieves the next page of results.

360

361

Args:

362

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

363

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

364

365

Returns:

366

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

367

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

</pre>

</div>

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

373

<pre>Updates a consumer override.

374

375

Args:

376

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

377

378

An example name would be:

379

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

380

body: object, The request body.

381

The object takes the form of:

382

383

{ # A quota override

384

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

385

#

386

# An example unit would be:

387

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

388

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

389

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

390

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

391

#

392

# An example name would be:

393

# `compute.googleapis.com/cpus`

394

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

395

# for dimensions defined in the limit unit.

396

#

397

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

398

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

399

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

400

#

401

# This map has the following restrictions:

402

#

403

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

404

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

405

# {user}) is a defined key.

406

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

407

# the parent resource name.

408

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

409

# that apply only to a specific user.

410

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

411

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

412

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

413

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

418

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

419

#

420

# Example names would be:

421

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

422

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

423

#

424

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

425

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

426

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

427

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

428

}

429

430

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

431

If unset, all fields will be updated.

432

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

433

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

434

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

435

to avoid accidentally decreasing quota too quickly. Setting the force

436

parameter to true ignores this restriction.

437

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

444

445

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

446

# network API call.

447

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

448

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

449

# available.

450

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

451

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

452

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

453

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

454

#

455

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

456

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

457

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

458

# message types for APIs to use.

459

{

460

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

461

},

462

],

463

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

464

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

465

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

466

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

467

},

468

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

469

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

470

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

471

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

472

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

473

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

474

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

475

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

476

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

477

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

478

# `TakeSnapshotResponse`.

479

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

480

},

481

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

482

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

483

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

484

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

485

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

},

}</pre>

</div>

</body></html>