Label wait-for-ready argument in multicallables as experimental

pull/17189/head
Lidi Zheng 6 years ago
parent 27bab0c631
commit 9b65b40247
  1. 35
      src/python/grpcio/grpc/__init__.py

@ -389,7 +389,8 @@ class ClientCallDetails(six.with_metaclass(abc.ABCMeta)):
metadata: Optional :term:`metadata` to be transmitted to metadata: Optional :term:`metadata` to be transmitted to
the service-side of the RPC. the service-side of the RPC.
credentials: An optional CallCredentials for the RPC. credentials: An optional CallCredentials for the RPC.
wait_for_ready: An optional flag to enable wait for ready mechanism. wait_for_ready: This is an EXPERIMENTAL argument. An optional flag t
enable wait for ready mechanism.
""" """
@ -656,8 +657,8 @@ class UnaryUnaryMultiCallable(six.with_metaclass(abc.ABCMeta)):
metadata: Optional :term:`metadata` to be transmitted to the metadata: Optional :term:`metadata` to be transmitted to the
service-side of the RPC. service-side of the RPC.
credentials: An optional CallCredentials for the RPC. credentials: An optional CallCredentials for the RPC.
wait_for_ready: An optional flag to enable wait for ready wait_for_ready: This is an EXPERIMENTAL argument. An optional
mechanism flag to enable wait for ready mechanism
Returns: Returns:
The response value for the RPC. The response value for the RPC.
@ -685,8 +686,8 @@ class UnaryUnaryMultiCallable(six.with_metaclass(abc.ABCMeta)):
metadata: Optional :term:`metadata` to be transmitted to the metadata: Optional :term:`metadata` to be transmitted to the
service-side of the RPC. service-side of the RPC.
credentials: An optional CallCredentials for the RPC. credentials: An optional CallCredentials for the RPC.
wait_for_ready: An optional flag to enable wait for ready wait_for_ready: This is an EXPERIMENTAL argument. An optional
mechanism flag to enable wait for ready mechanism
Returns: Returns:
The response value for the RPC and a Call value for the RPC. The response value for the RPC and a Call value for the RPC.
@ -714,8 +715,8 @@ class UnaryUnaryMultiCallable(six.with_metaclass(abc.ABCMeta)):
metadata: Optional :term:`metadata` to be transmitted to the metadata: Optional :term:`metadata` to be transmitted to the
service-side of the RPC. service-side of the RPC.
credentials: An optional CallCredentials for the RPC. credentials: An optional CallCredentials for the RPC.
wait_for_ready: An optional flag to enable wait for ready wait_for_ready: This is an EXPERIMENTAL argument. An optional
mechanism flag to enable wait for ready mechanism
Returns: Returns:
An object that is both a Call for the RPC and a Future. An object that is both a Call for the RPC and a Future.
@ -746,8 +747,8 @@ class UnaryStreamMultiCallable(six.with_metaclass(abc.ABCMeta)):
metadata: An optional :term:`metadata` to be transmitted to the metadata: An optional :term:`metadata` to be transmitted to the
service-side of the RPC. service-side of the RPC.
credentials: An optional CallCredentials for the RPC. credentials: An optional CallCredentials for the RPC.
wait_for_ready: An optional flag to enable wait for ready wait_for_ready: This is an EXPERIMENTAL argument. An optional
mechanism flag to enable wait for ready mechanism
Returns: Returns:
An object that is both a Call for the RPC and an iterator of An object that is both a Call for the RPC and an iterator of
@ -778,8 +779,8 @@ class StreamUnaryMultiCallable(six.with_metaclass(abc.ABCMeta)):
metadata: Optional :term:`metadata` to be transmitted to the metadata: Optional :term:`metadata` to be transmitted to the
service-side of the RPC. service-side of the RPC.
credentials: An optional CallCredentials for the RPC. credentials: An optional CallCredentials for the RPC.
wait_for_ready: An optional flag to enable wait for ready wait_for_ready: This is an EXPERIMENTAL argument. An optional
mechanism flag to enable wait for ready mechanism
Returns: Returns:
The response value for the RPC. The response value for the RPC.
@ -808,8 +809,8 @@ class StreamUnaryMultiCallable(six.with_metaclass(abc.ABCMeta)):
metadata: Optional :term:`metadata` to be transmitted to the metadata: Optional :term:`metadata` to be transmitted to the
service-side of the RPC. service-side of the RPC.
credentials: An optional CallCredentials for the RPC. credentials: An optional CallCredentials for the RPC.
wait_for_ready: An optional flag to enable wait for ready wait_for_ready: This is an EXPERIMENTAL argument. An optional
mechanism flag to enable wait for ready mechanism
Returns: Returns:
The response value for the RPC and a Call object for the RPC. The response value for the RPC and a Call object for the RPC.
@ -837,8 +838,8 @@ class StreamUnaryMultiCallable(six.with_metaclass(abc.ABCMeta)):
metadata: Optional :term:`metadata` to be transmitted to the metadata: Optional :term:`metadata` to be transmitted to the
service-side of the RPC. service-side of the RPC.
credentials: An optional CallCredentials for the RPC. credentials: An optional CallCredentials for the RPC.
wait_for_ready: An optional flag to enable wait for ready wait_for_ready: This is an EXPERIMENTAL argument. An optional
mechanism flag to enable wait for ready mechanism
Returns: Returns:
An object that is both a Call for the RPC and a Future. An object that is both a Call for the RPC and a Future.
@ -869,8 +870,8 @@ class StreamStreamMultiCallable(six.with_metaclass(abc.ABCMeta)):
metadata: Optional :term:`metadata` to be transmitted to the metadata: Optional :term:`metadata` to be transmitted to the
service-side of the RPC. service-side of the RPC.
credentials: An optional CallCredentials for the RPC. credentials: An optional CallCredentials for the RPC.
wait_for_ready: An optional flag to enable wait for ready wait_for_ready: This is an EXPERIMENTAL argument. An optional
mechanism flag to enable wait for ready mechanism
Returns: Returns:
An object that is both a Call for the RPC and an iterator of An object that is both a Call for the RPC and an iterator of

Loading…
Cancel
Save