Inheritance diagram for grpc.StreamUnaryMultiCallable:
Public Member Functions | |
| def | __call__ (self, request_iterator, timeout=None, metadata=None, credentials=None, wait_for_ready=None, compression=None) |
| def | future (self, request_iterator, timeout=None, metadata=None, credentials=None, wait_for_ready=None, compression=None) |
| def | with_call (self, request_iterator, timeout=None, metadata=None, credentials=None, wait_for_ready=None, compression=None) |
Detailed Description
Affords invoking a stream-unary RPC from client-side.
Definition at line 800 of file src/python/grpcio/grpc/__init__.py.
Member Function Documentation
◆ __call__()
| def grpc.StreamUnaryMultiCallable.__call__ | ( | self, | |
| request_iterator, | |||
timeout = None, |
|||
metadata = None, |
|||
credentials = None, |
|||
wait_for_ready = None, |
|||
compression = None |
|||
| ) |
Synchronously invokes the underlying RPC.
Args:
request_iterator: An iterator that yields request values for
the RPC.
timeout: An optional duration of time in seconds to allow for
the RPC. If None, the timeout is considered infinite.
metadata: Optional :term:`metadata` to be transmitted to the
service-side of the RPC.
credentials: An optional CallCredentials for the RPC. Only valid for
secure Channel.
wait_for_ready: This is an EXPERIMENTAL argument. An optional
flag to enable :term:`wait_for_ready` mechanism.
compression: An element of grpc.compression, e.g.
grpc.compression.Gzip. This is an EXPERIMENTAL option.
Returns:
The response value for the RPC.
Raises:
RpcError: Indicating that the RPC terminated with non-OK status. The
raised RpcError will also implement grpc.Call, affording methods
such as metadata, code, and details.
Reimplemented in grpc._channel._StreamUnaryMultiCallable, and grpc._interceptor._StreamUnaryMultiCallable.
Definition at line 804 of file src/python/grpcio/grpc/__init__.py.
◆ future()
| def grpc.StreamUnaryMultiCallable.future | ( | self, | |
| request_iterator, | |||
timeout = None, |
|||
metadata = None, |
|||
credentials = None, |
|||
wait_for_ready = None, |
|||
compression = None |
|||
| ) |
Asynchronously invokes the underlying RPC on the client.
Args:
request_iterator: An iterator that yields request values for the RPC.
timeout: An optional duration of time in seconds to allow for
the RPC. If None, the timeout is considered infinite.
metadata: Optional :term:`metadata` to be transmitted to the
service-side of the RPC.
credentials: An optional CallCredentials for the RPC. Only valid for
secure Channel.
wait_for_ready: This is an EXPERIMENTAL argument. An optional
flag to enable :term:`wait_for_ready` mechanism.
compression: An element of grpc.compression, e.g.
grpc.compression.Gzip. This is an EXPERIMENTAL option.
Returns:
An object that is both a Call for the RPC and a Future.
In the event of RPC completion, the return Call-Future's result value
will be the response message of the RPC. Should the event terminate
with non-OK status, the returned Call-Future's exception value will
be an RpcError.
Reimplemented in grpc._channel._StreamUnaryMultiCallable, and grpc._interceptor._StreamUnaryMultiCallable.
Definition at line 872 of file src/python/grpcio/grpc/__init__.py.
◆ with_call()
| def grpc.StreamUnaryMultiCallable.with_call | ( | self, | |
| request_iterator, | |||
timeout = None, |
|||
metadata = None, |
|||
credentials = None, |
|||
wait_for_ready = None, |
|||
compression = None |
|||
| ) |
Synchronously invokes the underlying RPC on the client.
Args:
request_iterator: An iterator that yields request values for
the RPC.
timeout: An optional duration of time in seconds to allow for
the RPC. If None, the timeout is considered infinite.
metadata: Optional :term:`metadata` to be transmitted to the
service-side of the RPC.
credentials: An optional CallCredentials for the RPC. Only valid for
secure Channel.
wait_for_ready: This is an EXPERIMENTAL argument. An optional
flag to enable :term:`wait_for_ready` mechanism.
compression: An element of grpc.compression, e.g.
grpc.compression.Gzip. This is an EXPERIMENTAL option.
Returns:
The response value for the RPC and a Call object for the RPC.
Raises:
RpcError: Indicating that the RPC terminated with non-OK status. The
raised RpcError will also be a Call for the RPC affording the RPC's
metadata, status code, and details.
Reimplemented in grpc._channel._StreamUnaryMultiCallable, and grpc._interceptor._StreamUnaryMultiCallable.
Definition at line 838 of file src/python/grpcio/grpc/__init__.py.
The documentation for this class was generated from the following file: