:py:mod:`viam.proto.stream`
===========================

.. py:module:: viam.proto.stream

.. autoapi-nested-parse::

   @generated by Viam.
   Do not edit manually!



Package Contents
----------------

Classes
~~~~~~~

.. autoapisummary::

   viam.proto.stream.StreamServiceBase
   viam.proto.stream.StreamServiceStub
   viam.proto.stream.UnimplementedStreamServiceBase
   viam.proto.stream.AddStreamRequest
   viam.proto.stream.AddStreamResponse
   viam.proto.stream.ListStreamsRequest
   viam.proto.stream.ListStreamsResponse
   viam.proto.stream.RemoveStreamRequest
   viam.proto.stream.RemoveStreamResponse




.. py:class:: StreamServiceBase


   Bases: :py:obj:`abc.ABC`

   Helper class that provides a standard way to create an ABC using
   inheritance.

   .. py:method:: ListStreams(stream: grpclib.server.Stream[stream.v1.stream_pb2.ListStreamsRequest, stream.v1.stream_pb2.ListStreamsResponse]) -> None
      :abstractmethod:
      :async:


   .. py:method:: AddStream(stream: grpclib.server.Stream[stream.v1.stream_pb2.AddStreamRequest, stream.v1.stream_pb2.AddStreamResponse]) -> None
      :abstractmethod:
      :async:


   .. py:method:: RemoveStream(stream: grpclib.server.Stream[stream.v1.stream_pb2.RemoveStreamRequest, stream.v1.stream_pb2.RemoveStreamResponse]) -> None
      :abstractmethod:
      :async:


   .. py:method:: __mapping__() -> Dict[str, grpclib.const.Handler]



.. py:class:: StreamServiceStub(channel: grpclib.client.Channel)



.. py:class:: UnimplementedStreamServiceBase


   Bases: :py:obj:`StreamServiceBase`

   Helper class that provides a standard way to create an ABC using
   inheritance.

   .. py:method:: ListStreams(stream: grpclib.server.Stream[stream.v1.stream_pb2.ListStreamsRequest, stream.v1.stream_pb2.ListStreamsResponse]) -> None
      :async:


   .. py:method:: AddStream(stream: grpclib.server.Stream[stream.v1.stream_pb2.AddStreamRequest, stream.v1.stream_pb2.AddStreamResponse]) -> None
      :async:


   .. py:method:: RemoveStream(stream: grpclib.server.Stream[stream.v1.stream_pb2.RemoveStreamRequest, stream.v1.stream_pb2.RemoveStreamResponse]) -> None
      :async:



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


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

   A AddStreamRequest requests the given stream be added to the connection.

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

      


.. py:class:: AddStreamResponse


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

   AddStreamResponse is returned after a successful AddStreamRequest.


.. py:class:: ListStreamsRequest


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

   ListStreamsRequest requests all streams registered.


.. py:class:: ListStreamsResponse(*, names: collections.abc.Iterable[str] | None = ...)


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

   A ListStreamsResponse details streams registered.

   .. py:property:: names
      :type: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]



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


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

   A RemoveStreamRequest requests the given stream be removed from the connection.

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

      


.. py:class:: RemoveStreamResponse


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

   RemoveStreamResponse is returned after a successful RemoveStreamRequest.