ni.measurementlink.pinmap.v1.client
===================================

.. py:module:: ni.measurementlink.pinmap.v1.client

.. autoapi-nested-parse::

   Public API for accessing the NI Pin Map Service.



Classes
-------

.. autoapisummary::

   ni.measurementlink.pinmap.v1.client.PinMapClient


Package Contents
----------------

.. py:class:: PinMapClient(*, discovery_client = None, grpc_channel = None, grpc_channel_pool = None)

   Bases: :py:obj:`ni.measurementlink.pinmap.v1.client._client_base.GrpcServiceClientBase`\ [\ :py:obj:`ni.measurementlink.pinmap.v1.pin_map_service_pb2_grpc.PinMapServiceStub`\ ]


   Client for accessing the NI Pin Map Service via gRPC.

   Initialize the pin map client.

   :param discovery_client: An optional discovery client (recommended).
   :param grpc_channel: An optional pin map gRPC channel.
   :param grpc_channel_pool: An optional gRPC channel pool (recommended).


   .. py:attribute:: __slots__
      :value: ()



   .. py:method:: update_pin_map(pin_map_path)

      Update registered pin map contents.

      Create and register a pin map if a pin map resource for the specified pin map id is not
      found.

      :param pin_map_path: The file path of the pin map to register as a pin map resource.

      :returns: The resource id of the pin map that is registered to the pin map service.