Blame - docs/dyn/file_v1beta1.projects.locations.instances.html - platform/external/python/google-api-python-client

<h1><a href="file_v1beta1.html">Cloud Filestore API</a> . <a href="file_v1beta1.projects.html">projects</a> . <a href="file_v1beta1.projects.locations.html">locations</a> . <a href="file_v1beta1.projects.locations.instances.html">instances</a></h1>

76

<h2>Instance Methods</h2>

77

78

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

79

<p class="firstline">Creates an instance.</p>

80

81

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

82

<p class="firstline">Deletes an instance.</p>

83

84

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

85

<p class="firstline">Gets the details of a specific instance.</p>

86

87

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

88

<p class="firstline">Lists all instances in a project for either a specified location</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="#patch">patch(name, body, updateMask=None, x__xgafv=None)</a></code></p>

94

<p class="firstline">Updates the settings of a specific instance.</p>

95

<h3>Method Details</h3>

96

97

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

98

<pre>Creates an instance.

99

100

Args:

101

parent: string, The instance's project and location, in the format

102

projects/{project_id}/locations/{location}. In Cloud Filestore,

103

locations map to GCP zones, for example **us-west1-b**. (required)

104

body: object, The request body. (required)

105

The object takes the form of:

106

107

{ # A Cloud Filestore instance.

108

"description": "A String", # Optional. A description of the instance (2048 characters or less).

109

"labels": { # Resource labels to represent user provided metadata.

110

"a_key": "A String",

111

},

112

"networks": [ # VPC networks to which the instance is connected.

113

# For this version, only a single network is supported.

114

{ # Network configuration for the instance.

115

"reservedIpRange": "A String", # A /29 CIDR block in one of the

116

# [internal IP address

117

# ranges](https://www.arin.net/knowledge/address_filters.html) that

118

# identifies the range of IP addresses reserved for this instance. For

119

# example, 10.0.0.0/29 or 192.168.0.0/29. The range you specify can't overlap

120

# with either existing subnets or assigned IP address ranges for other Cloud

121

# Filestore instances in the selected VPC network.

122

"modes": [ # Internet protocol versions for which the instance has IP addresses

123

# assigned. For this version, only MODE_IPV4 is supported.

124

"A String",

125

],

126

"ipAddresses": [ # Output only.

127

# IPv4 addresses in the format

128

# {octet 1}.{octet 2}.{octet 3}.{octet 4} or IPv6 addresses in the format

129

# {block 1}:{block 2}:{block 3}:{block 4}:{block 5}:{block 6}:{block

# 7}:{block 8}.

"A String",

],

"network": "A String", # The name of the Google Compute Engine

134

# [VPC network](/compute/docs/networks-and-firewalls#networks) to which the

135

# instance is connected.

136

},

137

],

138

"state": "A String", # Output only.

139

# The instance state.

140

"etag": "A String", # Server-specified ETag for the instance resource to prevent simultaneous

141

# updates from overwriting each other.

142

"fileShares": [ # File system shares on the instance.

143

# For this version, only a single file share is supported.

144

{ # File share configuration for the instance.

145

"capacityGb": "A String", # File share capacity in gigabytes (GB).

146

# Cloud Filestore defines 1 GB as 1024^3 bytes.

147

"name": "A String", # The name of the file share (must be 16 characters or less).

148

},

149

],

150

"tier": "A String", # The service tier of the instance.

151

"createTime": "A String", # Output only.

152

# The time when the instance was created.

153

"statusMessage": "A String", # Output only.

154

# Additional information about the instance state, if available.

155

"name": "A String", # Output only.

156

# The resource name of the instance, in the format

157

# projects/{project_id}/locations/{location_id}/instances/{instance_id}.

158

}

159

160

instanceId: string, The name of the instance to create.

161

The name must be unique for the specified project and location.

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

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

173

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

174

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

175

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

176

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

177

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

178

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

179

# `TakeSnapshotResponse`.

180

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

181

},

182

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

183

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

184

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

185

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

186

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

187

},

188

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

189

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

190

# available.

191

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

192

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

193

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

194

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

195

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

196

# used by [gRPC](https://github.com/grpc). The error model is designed to be:

197

#

198

# - Simple to use and understand for most users

199

# - Flexible enough to meet unexpected needs

#

# # Overview

#

# The `Status` message contains three pieces of data: error code, error

204

# message, and error details. The error code should be an enum value of

205

# google.rpc.Code, but it may accept additional error codes if needed. The

206

# error message should be a developer-facing English message that helps

207

# developers *understand* and *resolve* the error. If a localized user-facing

208

# error message is needed, put the localized message in the error details or

209

# localize it in the client. The optional error details may contain arbitrary

210

# information about the error. There is a predefined set of error detail types

211

# in the package `google.rpc` that can be used for common error conditions.

#

# # Language mapping

#

# The `Status` message is the logical representation of the error model, but it

216

# is not necessarily the actual wire format. When the `Status` message is

217

# exposed in different client libraries and different wire protocols, it can be

218

# mapped differently. For example, it will likely be mapped to some exceptions

219

# in Java, but more likely mapped to some error codes in C.

#

# # Other uses

#

# The error model and the `Status` message can be used in a variety of

224

# environments, either with or without APIs, to provide a

225

# consistent developer experience across different environments.

226

#

227

# Example uses of this error model include:

228

#

229

# - Partial errors. If a service needs to return partial errors to the client,

230

# it may embed the `Status` in the normal response to indicate the partial

231

# errors.

232

#

233

# - Workflow errors. A typical workflow has multiple steps. Each step may

234

# have a `Status` message for error reporting.

235

#

236

# - Batch operations. If a client uses batch request and batch response, the

237

# `Status` message should be used directly inside batch response, one for

238

# each error sub-response.

239

#

240

# - Asynchronous operations. If an API call embeds asynchronous operation

241

# results in its response, the status of those operations should be

242

# represented directly using the `Status` message.

243

#

244

# - Logging. If some API errors are stored in logs, the message `Status` could

245

# be used directly after any stripping needed for security/privacy reasons.

246

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

247

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

248

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

249

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

250

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

251

# message types for APIs to use.

252

{

253

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

},

],

},

}</pre>

</div>

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

262

<pre>Deletes an instance.

Args:

projects/{project_id}/locations/{location}/instances/{instance_id} (required)

267

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

274

275

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

276

# network API call.

277

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

278

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

279

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

280

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

281

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

282

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

283

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

284

# `TakeSnapshotResponse`.

285

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

286

},

287

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

288

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

289

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

290

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

291

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

292

},

293

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

294

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

295

# available.

296

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

297

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

298

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

299

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

300

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

301

# used by [gRPC](https://github.com/grpc). The error model is designed to be:

302

#

303

# - Simple to use and understand for most users

304

# - Flexible enough to meet unexpected needs

#

# # Overview

#

# The `Status` message contains three pieces of data: error code, error

309

# message, and error details. The error code should be an enum value of

310

# google.rpc.Code, but it may accept additional error codes if needed. The

311

# error message should be a developer-facing English message that helps

312

# developers *understand* and *resolve* the error. If a localized user-facing

313

# error message is needed, put the localized message in the error details or

314

# localize it in the client. The optional error details may contain arbitrary

315

# information about the error. There is a predefined set of error detail types

316

# in the package `google.rpc` that can be used for common error conditions.

#

# # Language mapping

#

# The `Status` message is the logical representation of the error model, but it

321

# is not necessarily the actual wire format. When the `Status` message is

322

# exposed in different client libraries and different wire protocols, it can be

323

# mapped differently. For example, it will likely be mapped to some exceptions

324

# in Java, but more likely mapped to some error codes in C.

#

# # Other uses

#

# The error model and the `Status` message can be used in a variety of

329

# environments, either with or without APIs, to provide a

330

# consistent developer experience across different environments.

331

#

332

# Example uses of this error model include:

333

#

334

# - Partial errors. If a service needs to return partial errors to the client,

335

# it may embed the `Status` in the normal response to indicate the partial

336

# errors.

337

#

338

# - Workflow errors. A typical workflow has multiple steps. Each step may

339

# have a `Status` message for error reporting.

340

#

341

# - Batch operations. If a client uses batch request and batch response, the

342

# `Status` message should be used directly inside batch response, one for

343

# each error sub-response.

344

#

345

# - Asynchronous operations. If an API call embeds asynchronous operation

346

# results in its response, the status of those operations should be

347

# represented directly using the `Status` message.

348

#

349

# - Logging. If some API errors are stored in logs, the message `Status` could

350

# be used directly after any stripping needed for security/privacy reasons.

351

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

352

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

353

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

354

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

355

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

356

# message types for APIs to use.

357

{

358

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

},

],

},

}</pre>

</div>

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

367

<pre>Gets the details of a specific instance.

Args:

projects/{project_id}/locations/{location}/instances/{instance_id}. (required)

372

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

379

380

{ # A Cloud Filestore instance.

381

"description": "A String", # Optional. A description of the instance (2048 characters or less).

382

"labels": { # Resource labels to represent user provided metadata.

383

"a_key": "A String",

384

},

385

"networks": [ # VPC networks to which the instance is connected.

386

# For this version, only a single network is supported.

387

{ # Network configuration for the instance.

388

"reservedIpRange": "A String", # A /29 CIDR block in one of the

389

# [internal IP address

390

# ranges](https://www.arin.net/knowledge/address_filters.html) that

391

# identifies the range of IP addresses reserved for this instance. For

392

# example, 10.0.0.0/29 or 192.168.0.0/29. The range you specify can't overlap

393

# with either existing subnets or assigned IP address ranges for other Cloud

394

# Filestore instances in the selected VPC network.

395

"modes": [ # Internet protocol versions for which the instance has IP addresses

396

# assigned. For this version, only MODE_IPV4 is supported.

397

"A String",

398

],

399

"ipAddresses": [ # Output only.

400

# IPv4 addresses in the format

401

# {octet 1}.{octet 2}.{octet 3}.{octet 4} or IPv6 addresses in the format

402

# {block 1}:{block 2}:{block 3}:{block 4}:{block 5}:{block 6}:{block

# 7}:{block 8}.

"A String",

],

"network": "A String", # The name of the Google Compute Engine

407

# [VPC network](/compute/docs/networks-and-firewalls#networks) to which the

408

# instance is connected.

409

},

410

],

411

"state": "A String", # Output only.

412

# The instance state.

413

"etag": "A String", # Server-specified ETag for the instance resource to prevent simultaneous

414

# updates from overwriting each other.

415

"fileShares": [ # File system shares on the instance.

416

# For this version, only a single file share is supported.

417

{ # File share configuration for the instance.

418

"capacityGb": "A String", # File share capacity in gigabytes (GB).

419

# Cloud Filestore defines 1 GB as 1024^3 bytes.

420

"name": "A String", # The name of the file share (must be 16 characters or less).

421

},

422

],

423

"tier": "A String", # The service tier of the instance.

424

"createTime": "A String", # Output only.

425

# The time when the instance was created.

426

"statusMessage": "A String", # Output only.

427

# Additional information about the instance state, if available.

428

"name": "A String", # Output only.

429

# The resource name of the instance, in the format

430

# projects/{project_id}/locations/{location_id}/instances/{instance_id}.

}</pre>

</div>

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

436

<pre>Lists all instances in a project for either a specified location

437

or for all locations.

438

439

Args:

440

parent: string, The project and location for which to retrieve instance information,

441

in the format projects/{project_id}/locations/{location}. In Cloud

442

Filestore, locations map to GCP zones, for example **us-west1-b**. To

443

retrieve instance information for all locations, use "-" for the {location}

444

value. (required)

445

orderBy: string, Sort results. Supported values are "name", "name desc" or "" (unsorted).

446

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

447

pageToken: string, The next_page_token value to use if there are additional

448

results to retrieve for this list request.

449

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

filter: string, List filter.

454

455

Returns:

456

An object of the form:

457

458

{ # ListInstancesResponse is the result of ListInstancesRequest.

459

"nextPageToken": "A String", # The token you can use to retrieve the next page of results. Not returned

460

# if there are no more results in the list.

461

"unreachable": [ # Locations that could not be reached.

462

"A String",

463

],

464

"instances": [ # A list of instances in the project for the specified location.

465

#

466

# If the {location} value in the request is "-", the response contains a list

467

# of instances from all locations. If any location is unreachable, the

468

# response will only return instances in reachable locations and the

469

# "unreachable" field will be populated with a list of unreachable locations.

470

{ # A Cloud Filestore instance.

471

"description": "A String", # Optional. A description of the instance (2048 characters or less).

472

"labels": { # Resource labels to represent user provided metadata.

473

"a_key": "A String",

474

},

475

"networks": [ # VPC networks to which the instance is connected.

476

# For this version, only a single network is supported.

477

{ # Network configuration for the instance.

478

"reservedIpRange": "A String", # A /29 CIDR block in one of the

479

# [internal IP address

480

# ranges](https://www.arin.net/knowledge/address_filters.html) that

481

# identifies the range of IP addresses reserved for this instance. For

482

# example, 10.0.0.0/29 or 192.168.0.0/29. The range you specify can't overlap

483

# with either existing subnets or assigned IP address ranges for other Cloud

484

# Filestore instances in the selected VPC network.

485

"modes": [ # Internet protocol versions for which the instance has IP addresses

486

# assigned. For this version, only MODE_IPV4 is supported.

487

"A String",

488

],

489

"ipAddresses": [ # Output only.

490

# IPv4 addresses in the format

491

# {octet 1}.{octet 2}.{octet 3}.{octet 4} or IPv6 addresses in the format

492

# {block 1}:{block 2}:{block 3}:{block 4}:{block 5}:{block 6}:{block

# 7}:{block 8}.

"A String",

],

"network": "A String", # The name of the Google Compute Engine

497

# [VPC network](/compute/docs/networks-and-firewalls#networks) to which the

498

# instance is connected.

499

},

500

],

501

"state": "A String", # Output only.

502

# The instance state.

503

"etag": "A String", # Server-specified ETag for the instance resource to prevent simultaneous

504

# updates from overwriting each other.

505

"fileShares": [ # File system shares on the instance.

506

# For this version, only a single file share is supported.

507

{ # File share configuration for the instance.

508

"capacityGb": "A String", # File share capacity in gigabytes (GB).

509

# Cloud Filestore defines 1 GB as 1024^3 bytes.

510

"name": "A String", # The name of the file share (must be 16 characters or less).

511

},

512

],

513

"tier": "A String", # The service tier of the instance.

514

"createTime": "A String", # Output only.

515

# The time when the instance was created.

516

"statusMessage": "A String", # Output only.

517

# Additional information about the instance state, if available.

518

"name": "A String", # Output only.

519

# The resource name of the instance, in the format

520

# projects/{project_id}/locations/{location_id}/instances/{instance_id}.

},

],

}</pre>

</div>

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

528

<pre>Retrieves the next page of results.

529

530

Args:

531

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

532

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

533

534

Returns:

535

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

536

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

</pre>

</div>

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

542

<pre>Updates the settings of a specific instance.

Args:

The resource name of the instance, in the format

547

projects/{project_id}/locations/{location_id}/instances/{instance_id}. (required)

548

body: object, The request body. (required)

549

The object takes the form of:

550

551

{ # A Cloud Filestore instance.

552

"description": "A String", # Optional. A description of the instance (2048 characters or less).

553

"labels": { # Resource labels to represent user provided metadata.

554

"a_key": "A String",

555

},

556

"networks": [ # VPC networks to which the instance is connected.

557

# For this version, only a single network is supported.

558

{ # Network configuration for the instance.

559

"reservedIpRange": "A String", # A /29 CIDR block in one of the

560

# [internal IP address

561

# ranges](https://www.arin.net/knowledge/address_filters.html) that

562

# identifies the range of IP addresses reserved for this instance. For

563

# example, 10.0.0.0/29 or 192.168.0.0/29. The range you specify can't overlap

564

# with either existing subnets or assigned IP address ranges for other Cloud

565

# Filestore instances in the selected VPC network.

566

"modes": [ # Internet protocol versions for which the instance has IP addresses

567

# assigned. For this version, only MODE_IPV4 is supported.

568

"A String",

569

],

570

"ipAddresses": [ # Output only.

571

# IPv4 addresses in the format

572

# {octet 1}.{octet 2}.{octet 3}.{octet 4} or IPv6 addresses in the format

573

# {block 1}:{block 2}:{block 3}:{block 4}:{block 5}:{block 6}:{block

# 7}:{block 8}.

"A String",

],

"network": "A String", # The name of the Google Compute Engine

578

# [VPC network](/compute/docs/networks-and-firewalls#networks) to which the

579

# instance is connected.

580

},

581

],

582

"state": "A String", # Output only.

583

# The instance state.

584

"etag": "A String", # Server-specified ETag for the instance resource to prevent simultaneous

585

# updates from overwriting each other.

586

"fileShares": [ # File system shares on the instance.

587

# For this version, only a single file share is supported.

588

{ # File share configuration for the instance.

589

"capacityGb": "A String", # File share capacity in gigabytes (GB).

590

# Cloud Filestore defines 1 GB as 1024^3 bytes.

591

"name": "A String", # The name of the file share (must be 16 characters or less).

592

},

593

],

594

"tier": "A String", # The service tier of the instance.

595

"createTime": "A String", # Output only.

596

# The time when the instance was created.

597

"statusMessage": "A String", # Output only.

598

# Additional information about the instance state, if available.

599

"name": "A String", # Output only.

600

# The resource name of the instance, in the format

601

# projects/{project_id}/locations/{location_id}/instances/{instance_id}.

602

}

603

604

updateMask: string, Mask of fields to update. At least one path must be supplied in this

605

field. The elements of the repeated paths field may only include these

606

fields:

607

"description"

608

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

615

616

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

617

# network API call.

618

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

619

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

620

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

621

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

622

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

623

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

624

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

625

# `TakeSnapshotResponse`.

626

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

627

},

628

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

629

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

630

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

631

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

632

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

633

},

634

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

635

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

636

# available.

637

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

638

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

639

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

640

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

641

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

642

# used by [gRPC](https://github.com/grpc). The error model is designed to be:

643

#

644

# - Simple to use and understand for most users

645

# - Flexible enough to meet unexpected needs

#

# # Overview

#

# The `Status` message contains three pieces of data: error code, error

650

# message, and error details. The error code should be an enum value of

651

# google.rpc.Code, but it may accept additional error codes if needed. The

652

# error message should be a developer-facing English message that helps

653

# developers *understand* and *resolve* the error. If a localized user-facing

654

# error message is needed, put the localized message in the error details or

655

# localize it in the client. The optional error details may contain arbitrary

656

# information about the error. There is a predefined set of error detail types

657

# in the package `google.rpc` that can be used for common error conditions.

#

# # Language mapping

#

# The `Status` message is the logical representation of the error model, but it

662

# is not necessarily the actual wire format. When the `Status` message is

663

# exposed in different client libraries and different wire protocols, it can be

664

# mapped differently. For example, it will likely be mapped to some exceptions

665

# in Java, but more likely mapped to some error codes in C.

#

# # Other uses

#

# The error model and the `Status` message can be used in a variety of

670

# environments, either with or without APIs, to provide a

671

# consistent developer experience across different environments.

672

#

673

# Example uses of this error model include:

674

#

675

# - Partial errors. If a service needs to return partial errors to the client,

676

# it may embed the `Status` in the normal response to indicate the partial

677

# errors.

678

#

679

# - Workflow errors. A typical workflow has multiple steps. Each step may

680

# have a `Status` message for error reporting.

681

#

682

# - Batch operations. If a client uses batch request and batch response, the

683

# `Status` message should be used directly inside batch response, one for

684

# each error sub-response.

685

#

686

# - Asynchronous operations. If an API call embeds asynchronous operation

687

# results in its response, the status of those operations should be

688

# represented directly using the `Status` message.

689

#

690

# - Logging. If some API errors are stored in logs, the message `Status` could

691

# be used directly after any stripping needed for security/privacy reasons.

692

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

693

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

694

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

695

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

696

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

697

# message types for APIs to use.

698

{

699

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

},

],

},

}</pre>

</div>

</body></html>