:py:mod:`viam.proto.module` =========================== .. py:module:: viam.proto.module .. autoapi-nested-parse:: @generated by Viam. Do not edit manually! Package Contents ---------------- Classes ~~~~~~~ .. autoapisummary:: viam.proto.module.ModuleServiceBase viam.proto.module.ModuleServiceStub viam.proto.module.UnimplementedModuleServiceBase viam.proto.module.AddResourceRequest viam.proto.module.AddResourceResponse viam.proto.module.HandlerDefinition viam.proto.module.HandlerMap viam.proto.module.ReadyRequest viam.proto.module.ReadyResponse viam.proto.module.ReconfigureResourceRequest viam.proto.module.ReconfigureResourceResponse viam.proto.module.RemoveResourceRequest viam.proto.module.RemoveResourceResponse viam.proto.module.ValidateConfigRequest viam.proto.module.ValidateConfigResponse .. py:class:: ModuleServiceBase Bases: :py:obj:`abc.ABC` Helper class that provides a standard way to create an ABC using inheritance. .. py:method:: AddResource(stream: grpclib.server.Stream[module.v1.module_pb2.AddResourceRequest, module.v1.module_pb2.AddResourceResponse]) -> None :abstractmethod: :async: .. py:method:: ReconfigureResource(stream: grpclib.server.Stream[module.v1.module_pb2.ReconfigureResourceRequest, module.v1.module_pb2.ReconfigureResourceResponse]) -> None :abstractmethod: :async: .. py:method:: RemoveResource(stream: grpclib.server.Stream[module.v1.module_pb2.RemoveResourceRequest, module.v1.module_pb2.RemoveResourceResponse]) -> None :abstractmethod: :async: .. py:method:: Ready(stream: grpclib.server.Stream[module.v1.module_pb2.ReadyRequest, module.v1.module_pb2.ReadyResponse]) -> None :abstractmethod: :async: .. py:method:: ValidateConfig(stream: grpclib.server.Stream[module.v1.module_pb2.ValidateConfigRequest, module.v1.module_pb2.ValidateConfigResponse]) -> None :abstractmethod: :async: .. py:method:: __mapping__() -> Dict[str, grpclib.const.Handler] .. py:class:: ModuleServiceStub(channel: grpclib.client.Channel) .. py:class:: UnimplementedModuleServiceBase Bases: :py:obj:`ModuleServiceBase` Helper class that provides a standard way to create an ABC using inheritance. .. py:method:: AddResource(stream: grpclib.server.Stream[module.v1.module_pb2.AddResourceRequest, module.v1.module_pb2.AddResourceResponse]) -> None :async: .. py:method:: ReconfigureResource(stream: grpclib.server.Stream[module.v1.module_pb2.ReconfigureResourceRequest, module.v1.module_pb2.ReconfigureResourceResponse]) -> None :async: .. py:method:: RemoveResource(stream: grpclib.server.Stream[module.v1.module_pb2.RemoveResourceRequest, module.v1.module_pb2.RemoveResourceResponse]) -> None :async: .. py:method:: Ready(stream: grpclib.server.Stream[module.v1.module_pb2.ReadyRequest, module.v1.module_pb2.ReadyResponse]) -> None :async: .. py:method:: ValidateConfig(stream: grpclib.server.Stream[module.v1.module_pb2.ValidateConfigRequest, module.v1.module_pb2.ValidateConfigResponse]) -> None :async: .. py:class:: AddResourceRequest(*, config: viam.gen.app.v1.robot_pb2.ComponentConfig | None = ..., dependencies: collections.abc.Iterable[str] | 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:: config :type: viam.gen.app.v1.robot_pb2.ComponentConfig .. py:property:: dependencies :type: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str] .. py:method:: HasField(field_name: Literal[config, b'config']) -> 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:class:: AddResourceResponse 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:: HandlerDefinition(*, subtype: viam.gen.robot.v1.robot_pb2.ResourceRPCSubtype | None = ..., models: collections.abc.Iterable[str] | 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:: subtype :type: viam.gen.robot.v1.robot_pb2.ResourceRPCSubtype .. py:property:: models :type: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str] .. py:method:: HasField(field_name: Literal[subtype, b'subtype']) -> 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:class:: HandlerMap(*, handlers: collections.abc.Iterable[global___HandlerDefinition] | 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:: handlers :type: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___HandlerDefinition] .. py:class:: ReadyRequest(*, parent_address: str = ..., webrtc_offer: 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:: parent_address :type: str .. py:attribute:: webrtc_offer :type: str .. py:class:: ReadyResponse(*, ready: bool = ..., handlermap: global___HandlerMap | None = ..., webrtc_answer: 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:property:: handlermap :type: global___HandlerMap .. py:attribute:: ready :type: bool .. py:attribute:: webrtc_answer :type: str .. py:method:: HasField(field_name: Literal[handlermap, b'handlermap']) -> 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:class:: ReconfigureResourceRequest(*, config: viam.gen.app.v1.robot_pb2.ComponentConfig | None = ..., dependencies: collections.abc.Iterable[str] | 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:: config :type: viam.gen.app.v1.robot_pb2.ComponentConfig .. py:property:: dependencies :type: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str] .. py:method:: HasField(field_name: Literal[config, b'config']) -> 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:class:: ReconfigureResourceResponse 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:: RemoveResourceRequest(*, 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:class:: RemoveResourceResponse 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:: ValidateConfigRequest(*, config: viam.gen.app.v1.robot_pb2.ComponentConfig | 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:: config :type: viam.gen.app.v1.robot_pb2.ComponentConfig .. py:method:: HasField(field_name: Literal[config, b'config']) -> 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:class:: ValidateConfigResponse(*, dependencies: collections.abc.Iterable[str] | 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:: dependencies :type: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]