:py:mod:`viam.gen.component.gripper.v1.gripper_pb2`
===================================================

.. py:module:: viam.gen.component.gripper.v1.gripper_pb2

.. autoapi-nested-parse::

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



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

Classes
~~~~~~~

.. autoapisummary::

   viam.gen.component.gripper.v1.gripper_pb2.OpenRequest
   viam.gen.component.gripper.v1.gripper_pb2.OpenResponse
   viam.gen.component.gripper.v1.gripper_pb2.GrabRequest
   viam.gen.component.gripper.v1.gripper_pb2.GrabResponse
   viam.gen.component.gripper.v1.gripper_pb2.StopRequest
   viam.gen.component.gripper.v1.gripper_pb2.StopResponse
   viam.gen.component.gripper.v1.gripper_pb2.IsMovingRequest
   viam.gen.component.gripper.v1.gripper_pb2.IsMovingResponse




Attributes
~~~~~~~~~~

.. autoapisummary::

   viam.gen.component.gripper.v1.gripper_pb2.DESCRIPTOR
   viam.gen.component.gripper.v1.gripper_pb2.global___OpenRequest
   viam.gen.component.gripper.v1.gripper_pb2.global___OpenResponse
   viam.gen.component.gripper.v1.gripper_pb2.global___GrabRequest
   viam.gen.component.gripper.v1.gripper_pb2.global___GrabResponse
   viam.gen.component.gripper.v1.gripper_pb2.global___StopRequest
   viam.gen.component.gripper.v1.gripper_pb2.global___StopResponse
   viam.gen.component.gripper.v1.gripper_pb2.global___IsMovingRequest
   viam.gen.component.gripper.v1.gripper_pb2.global___IsMovingResponse


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

   

.. py:class:: OpenRequest(*, 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:property:: extra
      :type: google.protobuf.struct_pb2.Struct


   .. py:attribute:: name
      :type: str

      

   .. 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___OpenRequest

   

.. py:class:: OpenResponse


   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___OpenResponse

   

.. py:class:: GrabRequest(*, 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:property:: extra
      :type: google.protobuf.struct_pb2.Struct


   .. py:attribute:: name
      :type: str

      

   .. 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___GrabRequest

   

.. py:class:: GrabResponse(*, success: bool = ..., 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:property:: extra
      :type: google.protobuf.struct_pb2.Struct


   .. py:attribute:: success
      :type: bool

      

   .. 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___GrabResponse

   

.. py:class:: StopRequest(*, 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:property:: extra
      :type: google.protobuf.struct_pb2.Struct


   .. py:attribute:: name
      :type: str

      Name of a gripper

   .. 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___StopRequest

   

.. py:class:: StopResponse


   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___StopResponse

   

.. py:class:: IsMovingRequest(*, name: str = ...)


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

   

.. py:class:: IsMovingResponse(*, is_moving: bool = ...)


   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:: is_moving
      :type: bool

      


.. py:data:: global___IsMovingResponse