Blame - docs/dyn/bigqueryreservation_v1beta1.projects.locations.capacityCommitments.html - platform/external/python/google-api-python-client

<h1><a href="bigqueryreservation_v1beta1.html">BigQuery Reservation API</a> . <a href="bigqueryreservation_v1beta1.projects.html">projects</a> . <a href="bigqueryreservation_v1beta1.projects.locations.html">locations</a> . <a href="bigqueryreservation_v1beta1.projects.locations.capacityCommitments.html">capacityCommitments</a></h1>

76

<h2>Instance Methods</h2>

77

78

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

79

<p class="firstline">Creates a new capacity commitment resource.</p>

80

81

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

82

<p class="firstline">Deletes a capacity commitment. Attempting to delete capacity commitment</p>

83

84

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

85

<p class="firstline">Returns information about the capacity commitment.</p>

86

87

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

88

<p class="firstline">Lists all the capacity commitments for the admin project.</p>

89

90

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

91

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

92

93

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

94

<p class="firstline">Merges capacity commitments of the same plan into one. Resulting capacity</p>

95

96

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

97

<p class="firstline">Updates an existing capacity commitment.</p>

98

99

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

100

<p class="firstline">Splits capacity commitment to two commitments of the same plan and</p>

101

<h3>Method Details</h3>

102

103

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

104

<pre>Creates a new capacity commitment resource.

105

106

Args:

107

parent: string, Required. Resource name of the parent reservation. E.g.,

108

projects/myproject/locations/US (required)

109

body: object, The request body.

110

The object takes the form of:

111

112

{ # Capacity commitment is a way to purchase compute capacity for BigQuery jobs

113

# (in the form of slots) with some committed period of usage. Annual

114

# commitments renew by default. Commitments can be removed after their

115

# commitment end time passes. In order to remove annual commitment, its plan

116

# needs to be changed to monthly or flex first.

117

#

118

# A capacity commitment resource exists as a child resource of the admin

119

# project.

120

"commitmentEndTime": "A String", # Output only. The end of the current commitment period. It is applicable only for ACTIVE

121

# capacity commitments.

122

"state": "A String", # Output only. State of the commitment.

123

"name": "A String", # Output only. The resource name of the capacity commitment, e.g.,

124

# projects/myproject/locations/US/capacityCommitments/123

125

"plan": "A String", # Capacity commitment commitment plan.

126

"slotCount": "A String", # Number of slots in this commitment.

127

"renewalPlan": "A String", # The plan this capacity commitment is converted to after commitment_end_time

128

# passes. Once the plan is changed, committed period is extended according to

129

# commitment plan. Only applicable for ANNUAL commitments.

130

"failureStatus": { # The `Status` type defines a logical error model that is suitable for # Output only. For FAILED commitment plan, provides the reason of failure.

131

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

132

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

133

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

134

#

135

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

136

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

137

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

138

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

139

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

140

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

141

# message types for APIs to use.

142

{

143

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

144

},

145

],

146

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

},

}

enforceSingleAdminProjectPerOrg: boolean, If true, fail the request if another project in the organization has a

151

capacity commitment.

152

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

159

160

{ # Capacity commitment is a way to purchase compute capacity for BigQuery jobs

161

# (in the form of slots) with some committed period of usage. Annual

162

# commitments renew by default. Commitments can be removed after their

163

# commitment end time passes. In order to remove annual commitment, its plan

164

# needs to be changed to monthly or flex first.

165

#

166

# A capacity commitment resource exists as a child resource of the admin

167

# project.

168

"commitmentEndTime": "A String", # Output only. The end of the current commitment period. It is applicable only for ACTIVE

169

# capacity commitments.

170

"state": "A String", # Output only. State of the commitment.

171

"name": "A String", # Output only. The resource name of the capacity commitment, e.g.,

172

# projects/myproject/locations/US/capacityCommitments/123

173

"plan": "A String", # Capacity commitment commitment plan.

174

"slotCount": "A String", # Number of slots in this commitment.

175

"renewalPlan": "A String", # The plan this capacity commitment is converted to after commitment_end_time

176

# passes. Once the plan is changed, committed period is extended according to

177

# commitment plan. Only applicable for ANNUAL commitments.

178

"failureStatus": { # The `Status` type defines a logical error model that is suitable for # Output only. For FAILED commitment plan, provides the reason of failure.

179

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

180

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

181

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

182

#

183

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

184

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

185

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

186

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

187

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

188

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

189

# message types for APIs to use.

190

{

191

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

192

},

193

],

194

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

},

}</pre>

</div>

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

201

<pre>Deletes a capacity commitment. Attempting to delete capacity commitment

202

before its commitment_end_time will fail with the error code

203

`google.rpc.Code.FAILED_PRECONDITION`.

204

205

Args:

206

name: string, Required. Resource name of the capacity commitment to delete. E.g.,

207

projects/myproject/locations/US/capacityCommitments/123 (required)

208

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

215

216

{ # A generic empty message that you can re-use to avoid defining duplicated

217

# empty messages in your APIs. A typical example is to use it as the request

218

# or the response type of an API method. For instance:

219

#

220

# service Foo {

221

# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);

222

# }

223

#

224

# The JSON representation for `Empty` is empty JSON object `{}`.

}</pre>

</div>

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

230

<pre>Returns information about the capacity commitment.

231

232

Args:

233

name: string, Required. Resource name of the capacity commitment to retrieve. E.g.,

234

projects/myproject/locations/US/capacityCommitments/123 (required)

235

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

242

243

{ # Capacity commitment is a way to purchase compute capacity for BigQuery jobs

244

# (in the form of slots) with some committed period of usage. Annual

245

# commitments renew by default. Commitments can be removed after their

246

# commitment end time passes. In order to remove annual commitment, its plan

247

# needs to be changed to monthly or flex first.

248

#

249

# A capacity commitment resource exists as a child resource of the admin

250

# project.

251

"commitmentEndTime": "A String", # Output only. The end of the current commitment period. It is applicable only for ACTIVE

252

# capacity commitments.

253

"state": "A String", # Output only. State of the commitment.

254

"name": "A String", # Output only. The resource name of the capacity commitment, e.g.,

255

# projects/myproject/locations/US/capacityCommitments/123

256

"plan": "A String", # Capacity commitment commitment plan.

257

"slotCount": "A String", # Number of slots in this commitment.

258

"renewalPlan": "A String", # The plan this capacity commitment is converted to after commitment_end_time

259

# passes. Once the plan is changed, committed period is extended according to

260

# commitment plan. Only applicable for ANNUAL commitments.

261

"failureStatus": { # The `Status` type defines a logical error model that is suitable for # Output only. For FAILED commitment plan, provides the reason of failure.

262

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

263

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

264

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

265

#

266

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

267

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

268

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

269

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

270

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

271

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

272

# message types for APIs to use.

273

{

274

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

275

},

276

],

277

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

},

}</pre>

</div>

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

284

<pre>Lists all the capacity commitments for the admin project.

285

286

Args:

287

parent: string, Required. Resource name of the parent reservation. E.g.,

288

projects/myproject/locations/US (required)

289

pageToken: string, The next_page_token value returned from a previous List request, if any.

290

pageSize: integer, The maximum number of items to return.

291

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

298

299

{ # The response for ReservationService.ListCapacityCommitments.

300

"capacityCommitments": [ # List of capacity commitments visible to the user.

301

{ # Capacity commitment is a way to purchase compute capacity for BigQuery jobs

302

# (in the form of slots) with some committed period of usage. Annual

303

# commitments renew by default. Commitments can be removed after their

304

# commitment end time passes. In order to remove annual commitment, its plan

305

# needs to be changed to monthly or flex first.

306

#

307

# A capacity commitment resource exists as a child resource of the admin

308

# project.

309

"commitmentEndTime": "A String", # Output only. The end of the current commitment period. It is applicable only for ACTIVE

310

# capacity commitments.

311

"state": "A String", # Output only. State of the commitment.

312

"name": "A String", # Output only. The resource name of the capacity commitment, e.g.,

313

# projects/myproject/locations/US/capacityCommitments/123

314

"plan": "A String", # Capacity commitment commitment plan.

315

"slotCount": "A String", # Number of slots in this commitment.

316

"renewalPlan": "A String", # The plan this capacity commitment is converted to after commitment_end_time

317

# passes. Once the plan is changed, committed period is extended according to

318

# commitment plan. Only applicable for ANNUAL commitments.

319

"failureStatus": { # The `Status` type defines a logical error model that is suitable for # Output only. For FAILED commitment plan, provides the reason of failure.

320

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

321

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

322

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

323

#

324

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

325

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

326

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

327

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

328

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

329

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

330

# message types for APIs to use.

331

{

332

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

333

},

334

],

335

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

},

},

],

"nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no

340

# more results in the list.

}</pre>

</div>

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

346

<pre>Retrieves the next page of results.

347

348

Args:

349

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

350

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

351

352

Returns:

353

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

354

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

</pre>

</div>

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

360

<pre>Merges capacity commitments of the same plan into one. Resulting capacity

361

commitment has the longer commitment_end_time out of the two. Attempting to

362

merge capacity commitments of different plan will fail with the error code

363

`google.rpc.Code.FAILED_PRECONDITION`.

364

365

Args:

366

parent: string, Parent resource that identifies admin project and location e.g.,

367

projects/myproject/locations/us (required)

368

body: object, The request body.

369

The object takes the form of:

370

371

{ # The request for ReservationService.MergeCapacityCommitments.

372

"capacityCommitmentIds": [ # Ids of capacity commitments to merge.

373

# These capacity commitments must exist under admin project and location

374

# specified in the parent.

"A String",

],

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

386

387

{ # Capacity commitment is a way to purchase compute capacity for BigQuery jobs

388

# (in the form of slots) with some committed period of usage. Annual

389

# commitments renew by default. Commitments can be removed after their

390

# commitment end time passes. In order to remove annual commitment, its plan

391

# needs to be changed to monthly or flex first.

392

#

393

# A capacity commitment resource exists as a child resource of the admin

394

# project.

395

"commitmentEndTime": "A String", # Output only. The end of the current commitment period. It is applicable only for ACTIVE

396

# capacity commitments.

397

"state": "A String", # Output only. State of the commitment.

398

"name": "A String", # Output only. The resource name of the capacity commitment, e.g.,

399

# projects/myproject/locations/US/capacityCommitments/123

400

"plan": "A String", # Capacity commitment commitment plan.

401

"slotCount": "A String", # Number of slots in this commitment.

402

"renewalPlan": "A String", # The plan this capacity commitment is converted to after commitment_end_time

403

# passes. Once the plan is changed, committed period is extended according to

404

# commitment plan. Only applicable for ANNUAL commitments.

405

"failureStatus": { # The `Status` type defines a logical error model that is suitable for # Output only. For FAILED commitment plan, provides the reason of failure.

406

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

407

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

408

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

409

#

410

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

411

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

412

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

413

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

414

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

415

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

416

# message types for APIs to use.

417

{

418

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

419

},

420

],

421

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

},

}</pre>

</div>

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

428

<pre>Updates an existing capacity commitment.

429

430

Only plan and renewal_plan fields can be updated.

431

Plan can only be changed to a plan of a longer commitment period.

432

Attempting to change to a plan with shorter commitment period will fail

433

with the error code `google.rpc.Code.FAILED_PRECONDITION`.

434

435

Args:

436

name: string, Output only. The resource name of the capacity commitment, e.g.,

437

projects/myproject/locations/US/capacityCommitments/123 (required)

438

body: object, The request body.

439

The object takes the form of:

440

441

{ # Capacity commitment is a way to purchase compute capacity for BigQuery jobs

442

# (in the form of slots) with some committed period of usage. Annual

443

# commitments renew by default. Commitments can be removed after their

444

# commitment end time passes. In order to remove annual commitment, its plan

445

# needs to be changed to monthly or flex first.

446

#

447

# A capacity commitment resource exists as a child resource of the admin

448

# project.

449

"commitmentEndTime": "A String", # Output only. The end of the current commitment period. It is applicable only for ACTIVE

450

# capacity commitments.

451

"state": "A String", # Output only. State of the commitment.

452

"name": "A String", # Output only. The resource name of the capacity commitment, e.g.,

453

# projects/myproject/locations/US/capacityCommitments/123

454

"plan": "A String", # Capacity commitment commitment plan.

455

"slotCount": "A String", # Number of slots in this commitment.

456

"renewalPlan": "A String", # The plan this capacity commitment is converted to after commitment_end_time

457

# passes. Once the plan is changed, committed period is extended according to

458

# commitment plan. Only applicable for ANNUAL commitments.

459

"failureStatus": { # The `Status` type defines a logical error model that is suitable for # Output only. For FAILED commitment plan, provides the reason of failure.

460

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

461

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

462

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

463

#

464

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

465

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

466

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

467

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

468

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

469

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

470

# message types for APIs to use.

471

{

472

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

473

},

474

],

475

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

},

}

updateMask: string, Standard field mask for the set of fields to be updated.

480

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

487

488

{ # Capacity commitment is a way to purchase compute capacity for BigQuery jobs

489

# (in the form of slots) with some committed period of usage. Annual

490

# commitments renew by default. Commitments can be removed after their

491

# commitment end time passes. In order to remove annual commitment, its plan

492

# needs to be changed to monthly or flex first.

493

#

494

# A capacity commitment resource exists as a child resource of the admin

495

# project.

496

"commitmentEndTime": "A String", # Output only. The end of the current commitment period. It is applicable only for ACTIVE

497

# capacity commitments.

498

"state": "A String", # Output only. State of the commitment.

499

"name": "A String", # Output only. The resource name of the capacity commitment, e.g.,

500

# projects/myproject/locations/US/capacityCommitments/123

501

"plan": "A String", # Capacity commitment commitment plan.

502

"slotCount": "A String", # Number of slots in this commitment.

503

"renewalPlan": "A String", # The plan this capacity commitment is converted to after commitment_end_time

504

# passes. Once the plan is changed, committed period is extended according to

505

# commitment plan. Only applicable for ANNUAL commitments.

506

"failureStatus": { # The `Status` type defines a logical error model that is suitable for # Output only. For FAILED commitment plan, provides the reason of failure.

507

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

508

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

509

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

510

#

511

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

512

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

513

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

514

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

515

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

516

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

517

# message types for APIs to use.

518

{

519

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

520

},

521

],

522

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

},

}</pre>

</div>

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

529

<pre>Splits capacity commitment to two commitments of the same plan and

530

commitment_end_time. A common use case to do that is to perform a downgrade

531

e.g., in order to downgrade from 10000 slots to 8000, one might split 10000

532

capacity commitment to 2000 and 8000, change the plan of the first one to

533

flex and then delete it.

534

535

Args:

536

name: string, Required. The resource name e.g.,:

537

projects/myproject/locations/US/capacityCommitments/123 (required)

538

body: object, The request body.

539

The object takes the form of:

540

541

{ # The request for ReservationService.SplitCapacityCommitment.

542

"slotCount": "A String", # Number of slots in the capacity commitment after the split.

543

}

544

545

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

552

553

{ # The response for ReservationService.SplitCapacityCommitment.

554

"second": { # Capacity commitment is a way to purchase compute capacity for BigQuery jobs # Second capacity commitment, result of a split.

555

# (in the form of slots) with some committed period of usage. Annual

556

# commitments renew by default. Commitments can be removed after their

557

# commitment end time passes. In order to remove annual commitment, its plan

558

# needs to be changed to monthly or flex first.

559

#

560

# A capacity commitment resource exists as a child resource of the admin

561

# project.

562

"commitmentEndTime": "A String", # Output only. The end of the current commitment period. It is applicable only for ACTIVE

563

# capacity commitments.

564

"state": "A String", # Output only. State of the commitment.

565

"name": "A String", # Output only. The resource name of the capacity commitment, e.g.,

566

# projects/myproject/locations/US/capacityCommitments/123

567

"plan": "A String", # Capacity commitment commitment plan.

568

"slotCount": "A String", # Number of slots in this commitment.

569

"renewalPlan": "A String", # The plan this capacity commitment is converted to after commitment_end_time

570

# passes. Once the plan is changed, committed period is extended according to

571

# commitment plan. Only applicable for ANNUAL commitments.

572

"failureStatus": { # The `Status` type defines a logical error model that is suitable for # Output only. For FAILED commitment plan, provides the reason of failure.

573

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

574

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

575

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

576

#

577

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

578

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

579

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

580

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

581

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

582

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

583

# message types for APIs to use.

584

{

585

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

586

},

587

],

588

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

589

},

590

},

591

"first": { # Capacity commitment is a way to purchase compute capacity for BigQuery jobs # First capacity commitment, result of a split.

592

# (in the form of slots) with some committed period of usage. Annual

593

# commitments renew by default. Commitments can be removed after their

594

# commitment end time passes. In order to remove annual commitment, its plan

595

# needs to be changed to monthly or flex first.

596

#

597

# A capacity commitment resource exists as a child resource of the admin

598

# project.

599

"commitmentEndTime": "A String", # Output only. The end of the current commitment period. It is applicable only for ACTIVE

600

# capacity commitments.

601

"state": "A String", # Output only. State of the commitment.

602

"name": "A String", # Output only. The resource name of the capacity commitment, e.g.,

603

# projects/myproject/locations/US/capacityCommitments/123

604

"plan": "A String", # Capacity commitment commitment plan.

605

"slotCount": "A String", # Number of slots in this commitment.

606

"renewalPlan": "A String", # The plan this capacity commitment is converted to after commitment_end_time

607

# passes. Once the plan is changed, committed period is extended according to

608

# commitment plan. Only applicable for ANNUAL commitments.

609

"failureStatus": { # The `Status` type defines a logical error model that is suitable for # Output only. For FAILED commitment plan, provides the reason of failure.

610

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

611

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

612

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

613

#

614

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

615

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