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

Public Member Functions

def __await__ (self)
 
None __init__ (self, ResponseType response)
 
None add_done_callback (self, unused_callback)
 
bool cancel (self)
 
bool cancelled (self)
 
grpc.StatusCode code (self)
 
Optional[str] debug_error_string (self)
 
str details (self)
 
bool done (self)
 
Optional[Metadatainitial_metadata (self)
 
Optional[float] time_remaining (self)
 
Optional[Metadatatrailing_metadata (self)
 
None wait_for_connection (self)
 
- Public Member Functions inherited from grpc.aio._base_call.RpcContext
None add_done_callback (self, DoneCallbackType callback)
 

Private Attributes

 _response
 

Detailed Description

Final UnaryUnaryCall class finished with a response.

Definition at line 875 of file aio/_interceptor.py.

Constructor & Destructor Documentation

◆ __init__()

None grpc.aio._interceptor.UnaryUnaryCallResponse.__init__ (   self,
ResponseType  response 
)

Definition at line 879 of file aio/_interceptor.py.

Member Function Documentation

◆ __await__()

def grpc.aio._interceptor.UnaryUnaryCallResponse.__await__ (   self)
The abstract base class of an unary-unary RPC on the client-side.
Await the response message to be ready.

Returns:
  The response message of the RPC.

Reimplemented from grpc.aio._base_call.UnaryUnaryCall.

Definition at line 912 of file aio/_interceptor.py.

◆ add_done_callback()

None grpc.aio._interceptor.UnaryUnaryCallResponse.add_done_callback (   self,
  unused_callback 
)

Definition at line 891 of file aio/_interceptor.py.

◆ cancel()

bool grpc.aio._interceptor.UnaryUnaryCallResponse.cancel (   self)
Cancels the RPC.

Idempotent and has no effect if the RPC has already terminated.

Returns:
  A bool indicates if the cancellation is performed or not.

Reimplemented from grpc.aio._base_call.RpcContext.

Definition at line 882 of file aio/_interceptor.py.

◆ cancelled()

bool grpc.aio._interceptor.UnaryUnaryCallResponse.cancelled (   self)
Return True if the RPC is cancelled.

The RPC is cancelled when the cancellation was requested with cancel().

Returns:
  A bool indicates whether the RPC is cancelled or not.

Reimplemented from grpc.aio._base_call.RpcContext.

Definition at line 885 of file aio/_interceptor.py.

◆ code()

grpc.StatusCode grpc.aio._interceptor.UnaryUnaryCallResponse.code (   self)
Accesses the status code sent by the server.

Returns:
  The StatusCode value for the RPC.

Reimplemented from grpc.aio._base_call.Call.

Definition at line 903 of file aio/_interceptor.py.

◆ debug_error_string()

Optional[str] grpc.aio._interceptor.UnaryUnaryCallResponse.debug_error_string (   self)

Definition at line 909 of file aio/_interceptor.py.

◆ details()

str grpc.aio._interceptor.UnaryUnaryCallResponse.details (   self)
Accesses the details sent by the server.

Returns:
  The details string of the RPC.

Reimplemented from grpc.aio._base_call.Call.

Definition at line 906 of file aio/_interceptor.py.

◆ done()

bool grpc.aio._interceptor.UnaryUnaryCallResponse.done (   self)
Return True if the RPC is done.

An RPC is done if the RPC is completed, cancelled or aborted.

Returns:
  A bool indicates if the RPC is done.

Reimplemented from grpc.aio._base_call.RpcContext.

Definition at line 888 of file aio/_interceptor.py.

◆ initial_metadata()

Optional[Metadata] grpc.aio._interceptor.UnaryUnaryCallResponse.initial_metadata (   self)
The abstract base class of an RPC on the client-side.
Accesses the initial metadata sent by the server.

Returns:
  The initial :term:`metadata`.

Reimplemented from grpc.aio._base_call.Call.

Definition at line 897 of file aio/_interceptor.py.

◆ time_remaining()

Optional[float] grpc.aio._interceptor.UnaryUnaryCallResponse.time_remaining (   self)
Describes the length of allowed time remaining for the RPC.

Returns:
  A nonnegative float indicating the length of allowed time in seconds
  remaining for the RPC to complete before it is considered to have
  timed out, or None if no deadline was specified for the RPC.

Reimplemented from grpc.aio._base_call.RpcContext.

Definition at line 894 of file aio/_interceptor.py.

◆ trailing_metadata()

Optional[Metadata] grpc.aio._interceptor.UnaryUnaryCallResponse.trailing_metadata (   self)
Accesses the trailing metadata sent by the server.

Returns:
  The trailing :term:`metadata`.

Reimplemented from grpc.aio._base_call.Call.

Definition at line 900 of file aio/_interceptor.py.

◆ wait_for_connection()

None grpc.aio._interceptor.UnaryUnaryCallResponse.wait_for_connection (   self)
Waits until connected to peer and raises aio.AioRpcError if failed.

This is an EXPERIMENTAL method.

This method ensures the RPC has been successfully connected. Otherwise,
an AioRpcError will be raised to explain the reason of the connection
failure.

This method is recommended for building retry mechanisms.

Reimplemented from grpc.aio._base_call.Call.

Definition at line 919 of file aio/_interceptor.py.

Member Data Documentation

◆ _response

grpc.aio._interceptor.UnaryUnaryCallResponse._response
private

Definition at line 880 of file aio/_interceptor.py.


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


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