docs-archive/apache-airflow-providers-grpc/1.0.0/_sources/_api/airflow/providers/grpc/operators/grpc/index.rst.txt

:mod:`airflow.providers.grpc.operators.grpc`
============================================

.. py:module:: airflow.providers.grpc.operators.grpc


Module Contents
---------------

.. py:class:: GrpcOperator(*, stub_class: Callable, call_func: str, grpc_conn_id: str = 'grpc_default', data: Optional[dict] = None, interceptors: Optional[List[Callable]] = None, custom_connection_func: Optional[Callable] = None, streaming: bool = False, response_callback: Optional[Callable] = None, log_response: bool = False, **kwargs)

   Bases: :class:`airflow.models.BaseOperator`

   Calls a gRPC endpoint to execute an action

   :param stub_class: The stub client to use for this gRPC call
   :type stub_class: gRPC stub class generated from proto file
   :param call_func: The client function name to call the gRPC endpoint
   :type call_func: gRPC client function name for the endpoint generated from proto file, str
   :param grpc_conn_id: The connection to run the operator against
   :type grpc_conn_id: str
   :param data: The data to pass to the rpc call
   :type data: A dict with key value pairs as kwargs of the call_func
   :param interceptors: A list of gRPC interceptor objects to be used on the channel
   :type interceptors: A list of gRPC interceptor objects, has to be initialized
   :param custom_connection_func: The customized connection function to return channel object
   :type custom_connection_func: A python function that returns channel object, take in
       a connection object, can be a partial function
   :param streaming: A flag to indicate if the call is a streaming call
   :type streaming: boolean
   :param response_callback: The callback function to process the response from gRPC call
   :type response_callback: A python function that process the response from gRPC call,
       takes in response object and context object, context object can be used to perform
       push xcom or other after task actions
   :param log_response: A flag to indicate if we need to log the response
   :type log_response: boolean

   .. attribute:: template_fields
      :annotation: = ['stub_class', 'call_func', 'data']

      

   
   .. method:: _get_grpc_hook(self)



   
   .. method:: execute(self, context: Dict)



   
   .. method:: _handle_response(self, response: Any, context: Dict)