xref: /aosp_15_r20/external/googleapis/google/rpc/README.md (revision d5c09012810ac0c9f33fe448fb6da8260d444cc9)
1*d5c09012SAndroid Build Coastguard Worker## RPC (Remote Procedure Call) Types
2*d5c09012SAndroid Build Coastguard Worker
3*d5c09012SAndroid Build Coastguard WorkerThis package contains [protocol buffer][protobuf] types that represent remote procedure
4*d5c09012SAndroid Build Coastguard Workercall concepts. While [gRPC](https://grpc.io) uses these types, we encourage their
5*d5c09012SAndroid Build Coastguard Workeruse in any interested RPC implementation to promote compatibility and consistency.
6*d5c09012SAndroid Build Coastguard Worker
7*d5c09012SAndroid Build Coastguard Worker### Key Concepts
8*d5c09012SAndroid Build Coastguard Worker
9*d5c09012SAndroid Build Coastguard Worker- **Code**: An enum that represents an error code returned by an RPC. These error codes
10*d5c09012SAndroid Build Coastguard Worker  map to HTTP codes, but are slightly finer-grained. Every gRPC code has exactly one
11*d5c09012SAndroid Build Coastguard Worker  corresponding HTTP code; however, some HTTP codes have more than one corresponding
12*d5c09012SAndroid Build Coastguard Worker  gRPC code.
13*d5c09012SAndroid Build Coastguard Worker- **Error details**: Any of the types contained in `error_details.proto` which provide
14*d5c09012SAndroid Build Coastguard Worker  extra details about particular types of failures.
15*d5c09012SAndroid Build Coastguard Worker- **Status**: Combines a code, message, and error details to represent the success or
16*d5c09012SAndroid Build Coastguard Worker  failure details of an RPC call.
17*d5c09012SAndroid Build Coastguard Worker
18*d5c09012SAndroid Build Coastguard Worker[protobuf]: https://developers.google.com/protocol-buffers/
19