viam.gen.service.sensors.v1.sensors_pb2
=======================================

.. py:module:: viam.gen.service.sensors.v1.sensors_pb2

.. autoapi-nested-parse::

   @generated by mypy-protobuf.  Do not edit manually!
   isort:skip_file



Attributes
----------

.. autoapisummary::

   viam.gen.service.sensors.v1.sensors_pb2.DESCRIPTOR
   viam.gen.service.sensors.v1.sensors_pb2.Global___GetSensorsRequest
   viam.gen.service.sensors.v1.sensors_pb2.Global___GetSensorsResponse
   viam.gen.service.sensors.v1.sensors_pb2.Global___GetReadingsRequest
   viam.gen.service.sensors.v1.sensors_pb2.Global___Readings
   viam.gen.service.sensors.v1.sensors_pb2.Global___GetReadingsResponse


Classes
-------

.. autoapisummary::

   viam.gen.service.sensors.v1.sensors_pb2.GetSensorsRequest
   viam.gen.service.sensors.v1.sensors_pb2.GetSensorsResponse
   viam.gen.service.sensors.v1.sensors_pb2.GetReadingsRequest
   viam.gen.service.sensors.v1.sensors_pb2.Readings
   viam.gen.service.sensors.v1.sensors_pb2.GetReadingsResponse


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

.. py:data:: DESCRIPTOR
   :type:  google.protobuf.descriptor.FileDescriptor

.. py:class:: GetSensorsRequest(*, name: str = ..., extra: google.protobuf.struct_pb2.Struct | None = ...)

   Bases: :py:obj:`google.protobuf.message.Message`


   The sensors service messages are deprecated


   .. py:method:: name() -> str


   .. py:method:: extra() -> google.protobuf.struct_pb2.Struct

      Additional arguments to the method



   .. py:method:: HasField(field_name: _HasFieldArgType) -> bool

      Checks if a certain field is set for the message.

      For a oneof group, checks if any field inside is set. Note that if the
      field_name is not defined in the message descriptor, :exc:`ValueError` will
      be raised.

      :param field_name: The name of the field to check for presence.
      :type field_name: str

      :returns: Whether a value has been set for the named field.
      :rtype: bool

      :raises ValueError: if the `field_name` is not a member of this message.



.. py:type:: Global___GetSensorsRequest
   :canonical: GetSensorsRequest


.. py:class:: GetSensorsResponse(*, sensor_names: collections.abc.Iterable[common.v1.common_pb2.ResourceName] | None = ...)

   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:method:: sensor_names() -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[common.v1.common_pb2.ResourceName]


.. py:type:: Global___GetSensorsResponse
   :canonical: GetSensorsResponse


.. py:class:: GetReadingsRequest(*, name: str = ..., sensor_names: collections.abc.Iterable[common.v1.common_pb2.ResourceName] | None = ..., extra: google.protobuf.struct_pb2.Struct | None = ...)

   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:method:: name() -> str


   .. py:method:: sensor_names() -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[common.v1.common_pb2.ResourceName]


   .. py:method:: extra() -> google.protobuf.struct_pb2.Struct

      Additional arguments to the method



   .. py:method:: HasField(field_name: _HasFieldArgType) -> bool

      Checks if a certain field is set for the message.

      For a oneof group, checks if any field inside is set. Note that if the
      field_name is not defined in the message descriptor, :exc:`ValueError` will
      be raised.

      :param field_name: The name of the field to check for presence.
      :type field_name: str

      :returns: Whether a value has been set for the named field.
      :rtype: bool

      :raises ValueError: if the `field_name` is not a member of this message.



.. py:type:: Global___GetReadingsRequest
   :canonical: GetReadingsRequest


.. py:class:: Readings(*, name: common.v1.common_pb2.ResourceName | None = ..., readings: collections.abc.Mapping[str, google.protobuf.struct_pb2.Value] | None = ...)

   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:class:: ReadingsEntry(*, key: str = ..., value: google.protobuf.struct_pb2.Value | None = ...)

      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:: key
         :type:  str


      .. py:method:: value() -> google.protobuf.struct_pb2.Value


      .. py:method:: HasField(field_name: _HasFieldArgType) -> bool

         Checks if a certain field is set for the message.

         For a oneof group, checks if any field inside is set. Note that if the
         field_name is not defined in the message descriptor, :exc:`ValueError` will
         be raised.

         :param field_name: The name of the field to check for presence.
         :type field_name: str

         :returns: Whether a value has been set for the named field.
         :rtype: bool

         :raises ValueError: if the `field_name` is not a member of this message.




   .. py:method:: name() -> common.v1.common_pb2.ResourceName


   .. py:method:: readings() -> google.protobuf.internal.containers.MessageMap[str, google.protobuf.struct_pb2.Value]


   .. py:method:: HasField(field_name: _HasFieldArgType) -> bool

      Checks if a certain field is set for the message.

      For a oneof group, checks if any field inside is set. Note that if the
      field_name is not defined in the message descriptor, :exc:`ValueError` will
      be raised.

      :param field_name: The name of the field to check for presence.
      :type field_name: str

      :returns: Whether a value has been set for the named field.
      :rtype: bool

      :raises ValueError: if the `field_name` is not a member of this message.



.. py:type:: Global___Readings
   :canonical: Readings


.. py:class:: GetReadingsResponse(*, readings: collections.abc.Iterable[Global___Readings] | None = ...)

   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:method:: readings() -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___Readings]


.. py:type:: Global___GetReadingsResponse
   :canonical: GetReadingsResponse