viam.gen.component.switch.v1.switch_pb2
=======================================

.. py:module:: viam.gen.component.switch.v1.switch_pb2

.. autoapi-nested-parse::

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



Attributes
----------

.. autoapisummary::

   viam.gen.component.switch.v1.switch_pb2.DESCRIPTOR
   viam.gen.component.switch.v1.switch_pb2.global___SetPositionRequest
   viam.gen.component.switch.v1.switch_pb2.global___SetPositionResponse
   viam.gen.component.switch.v1.switch_pb2.global___GetPositionRequest
   viam.gen.component.switch.v1.switch_pb2.global___GetPositionResponse
   viam.gen.component.switch.v1.switch_pb2.global___GetNumberOfPositionsRequest
   viam.gen.component.switch.v1.switch_pb2.global___GetNumberOfPositionsResponse


Classes
-------

.. autoapisummary::

   viam.gen.component.switch.v1.switch_pb2.SetPositionRequest
   viam.gen.component.switch.v1.switch_pb2.SetPositionResponse
   viam.gen.component.switch.v1.switch_pb2.GetPositionRequest
   viam.gen.component.switch.v1.switch_pb2.GetPositionResponse
   viam.gen.component.switch.v1.switch_pb2.GetNumberOfPositionsRequest
   viam.gen.component.switch.v1.switch_pb2.GetNumberOfPositionsResponse


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

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

.. py:class:: SetPositionRequest(*, name: str = ..., position: int = ..., 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:attribute:: name
      :type:  str


   .. py:attribute:: position
      :type:  int


   .. py:property:: extra
      :type: google.protobuf.struct_pb2.Struct



   .. py:method:: HasField(field_name: Literal['extra', b'extra']) -> 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:data:: global___SetPositionRequest

.. py:class:: SetPositionResponse

   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:data:: global___SetPositionResponse

.. py:class:: GetPositionRequest(*, name: str = ..., 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:attribute:: name
      :type:  str


   .. py:property:: extra
      :type: google.protobuf.struct_pb2.Struct



   .. py:method:: HasField(field_name: Literal['extra', b'extra']) -> 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:data:: global___GetPositionRequest

.. py:class:: GetPositionResponse(*, position: int = ...)

   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:: position
      :type:  int


.. py:data:: global___GetPositionResponse

.. py:class:: GetNumberOfPositionsRequest(*, name: str = ..., 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:attribute:: name
      :type:  str


   .. py:property:: extra
      :type: google.protobuf.struct_pb2.Struct



   .. py:method:: HasField(field_name: Literal['extra', b'extra']) -> 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:data:: global___GetNumberOfPositionsRequest

.. py:class:: GetNumberOfPositionsResponse(*, number_of_positions: int = ...)

   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:: number_of_positions
      :type:  int


.. py:data:: global___GetNumberOfPositionsResponse