ni.measurementlink.pin_map_context_pb2 ====================================== .. py:module:: ni.measurementlink.pin_map_context_pb2 Attributes ---------- .. autoapisummary:: ni.measurementlink.pin_map_context_pb2.DESCRIPTOR ni.measurementlink.pin_map_context_pb2.global___PinMapContext Classes ------- .. autoapisummary:: ni.measurementlink.pin_map_context_pb2.PinMapContext Package Contents ---------------- .. py:data:: DESCRIPTOR :type: google.protobuf.descriptor.FileDescriptor .. py:class:: PinMapContext(*, pin_map_id = ..., sites = ...) Bases: :py:obj:`google.protobuf.message.Message` Abstract base class for protocol messages. Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below. .. py:attribute:: DESCRIPTOR :type: google.protobuf.descriptor.Descriptor .. py:attribute:: PIN_MAP_ID_FIELD_NUMBER :type: int .. py:attribute:: SITES_FIELD_NUMBER :type: int .. py:attribute:: pin_map_id :type: str Required. The resource id of the pin map in the Pin Map service that should be used for the call. .. py:property:: sites :type: google.protobuf.internal.containers.RepeatedScalarFieldContainer[int] Optional. List of site numbers being used for the call. If unspecified, use all sites in the pin map. .. py:method:: ClearField(field_name) Clears the contents of a given field. Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, :exc:`ValueError` is raised. :param field_name: The name of the field to check for presence. :type field_name: str :raises ValueError: if the `field_name` is not a member of this message. .. py:data:: global___PinMapContext