Public Member Functions | Private Member Functions | Private Attributes | List of all members
grpc.aio._call.AioRpcError Class Reference
Inheritance diagram for grpc.aio._call.AioRpcError:
Inheritance graph
[legend]

Public Member Functions

None __init__ (self, grpc.StatusCode code, Metadata initial_metadata, Metadata trailing_metadata, Optional[str] details=None, Optional[str] debug_error_string=None)
 
str __repr__ (self)
 
str __str__ (self)
 
grpc.StatusCode code (self)
 
str debug_error_string (self)
 
Optional[str] details (self)
 
Metadata initial_metadata (self)
 
Metadata trailing_metadata (self)
 

Private Member Functions

str _repr (self)
 

Private Attributes

 _code
 
 _debug_error_string
 
 _details
 
 _initial_metadata
 
 _trailing_metadata
 

Detailed Description

An implementation of RpcError to be used by the asynchronous API.

Raised RpcError is a snapshot of the final status of the RPC, values are
determined. Hence, its methods no longer needs to be coroutines.

Definition at line 60 of file _call.py.

Constructor & Destructor Documentation

◆ __init__()

None grpc.aio._call.AioRpcError.__init__ (   self,
grpc.StatusCode  code,
Metadata  initial_metadata,
Metadata  trailing_metadata,
Optional[str]   details = None,
Optional[str]   debug_error_string = None 
)
Constructor.

Args:
  code: The status code with which the RPC has been finalized.
  details: Optional details explaining the reason of the error.
  initial_metadata: Optional initial metadata that could be sent by the
    Server.
  trailing_metadata: Optional metadata that could be sent by the Server.

Definition at line 73 of file _call.py.

Member Function Documentation

◆ __repr__()

str grpc.aio._call.AioRpcError.__repr__ (   self)

Definition at line 142 of file _call.py.

◆ __str__()

str grpc.aio._call.AioRpcError.__str__ (   self)

Definition at line 145 of file _call.py.

◆ _repr()

str grpc.aio._call.AioRpcError._repr (   self)
private
Assembles the error string for the RPC error.

Definition at line 136 of file _call.py.

◆ code()

grpc.StatusCode grpc.aio._call.AioRpcError.code (   self)
Accesses the status code sent by the server.

Returns:
  The `grpc.StatusCode` status code.

Definition at line 96 of file _call.py.

◆ debug_error_string()

str grpc.aio._call.AioRpcError.debug_error_string (   self)
Accesses the debug error string sent by the server.

Returns:
  The debug error string received.

Definition at line 128 of file _call.py.

◆ details()

Optional[str] grpc.aio._call.AioRpcError.details (   self)
Accesses the details sent by the server.

Returns:
  The description of the error.

Definition at line 104 of file _call.py.

◆ initial_metadata()

Metadata grpc.aio._call.AioRpcError.initial_metadata (   self)
Accesses the initial metadata sent by the server.

Returns:
  The initial metadata received.

Definition at line 112 of file _call.py.

◆ trailing_metadata()

Metadata grpc.aio._call.AioRpcError.trailing_metadata (   self)
Accesses the trailing metadata sent by the server.

Returns:
  The trailing metadata received.

Definition at line 120 of file _call.py.

Member Data Documentation

◆ _code

grpc.aio._call.AioRpcError._code
private

Definition at line 85 of file _call.py.

◆ _debug_error_string

grpc.aio._call.AioRpcError._debug_error_string
private

Definition at line 89 of file _call.py.

◆ _details

grpc.aio._call.AioRpcError._details
private

Definition at line 86 of file _call.py.

◆ _initial_metadata

grpc.aio._call.AioRpcError._initial_metadata
private

Definition at line 87 of file _call.py.

◆ _trailing_metadata

grpc.aio._call.AioRpcError._trailing_metadata
private

Definition at line 88 of file _call.py.


The documentation for this class was generated from the following file:


grpc
Author(s):
autogenerated on Fri May 16 2025 03:03:32