:py:mod:`viam.gen.app.dataset.v1.dataset_pb2`
=============================================

.. py:module:: viam.gen.app.dataset.v1.dataset_pb2

.. autoapi-nested-parse::

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



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

Classes
~~~~~~~

.. autoapisummary::

   viam.gen.app.dataset.v1.dataset_pb2.Dataset
   viam.gen.app.dataset.v1.dataset_pb2.CreateDatasetRequest
   viam.gen.app.dataset.v1.dataset_pb2.CreateDatasetResponse
   viam.gen.app.dataset.v1.dataset_pb2.DeleteDatasetRequest
   viam.gen.app.dataset.v1.dataset_pb2.DeleteDatasetResponse
   viam.gen.app.dataset.v1.dataset_pb2.RenameDatasetRequest
   viam.gen.app.dataset.v1.dataset_pb2.RenameDatasetResponse
   viam.gen.app.dataset.v1.dataset_pb2.ListDatasetsByOrganizationIDRequest
   viam.gen.app.dataset.v1.dataset_pb2.ListDatasetsByOrganizationIDResponse
   viam.gen.app.dataset.v1.dataset_pb2.ListDatasetsByIDsRequest
   viam.gen.app.dataset.v1.dataset_pb2.ListDatasetsByIDsResponse




Attributes
~~~~~~~~~~

.. autoapisummary::

   viam.gen.app.dataset.v1.dataset_pb2.DESCRIPTOR
   viam.gen.app.dataset.v1.dataset_pb2.global___Dataset
   viam.gen.app.dataset.v1.dataset_pb2.global___CreateDatasetRequest
   viam.gen.app.dataset.v1.dataset_pb2.global___CreateDatasetResponse
   viam.gen.app.dataset.v1.dataset_pb2.global___DeleteDatasetRequest
   viam.gen.app.dataset.v1.dataset_pb2.global___DeleteDatasetResponse
   viam.gen.app.dataset.v1.dataset_pb2.global___RenameDatasetRequest
   viam.gen.app.dataset.v1.dataset_pb2.global___RenameDatasetResponse
   viam.gen.app.dataset.v1.dataset_pb2.global___ListDatasetsByOrganizationIDRequest
   viam.gen.app.dataset.v1.dataset_pb2.global___ListDatasetsByOrganizationIDResponse
   viam.gen.app.dataset.v1.dataset_pb2.global___ListDatasetsByIDsRequest
   viam.gen.app.dataset.v1.dataset_pb2.global___ListDatasetsByIDsResponse


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

   

.. py:class:: Dataset(*, id: str = ..., name: str = ..., organization_id: str = ..., time_created: google.protobuf.timestamp_pb2.Timestamp | None = ...)


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

   Dataset stores the metadata of a dataset.

   .. py:property:: time_created
      :type: google.protobuf.timestamp_pb2.Timestamp


   .. py:attribute:: id
      :type: str

      

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

      

   .. py:attribute:: organization_id
      :type: str

      

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

   

.. py:class:: CreateDatasetRequest(*, name: str = ..., organization_id: str = ...)


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

   CreateDatasetRequest defines the name and organization ID of a dataset.

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

      

   .. py:attribute:: organization_id
      :type: str

      


.. py:data:: global___CreateDatasetRequest

   

.. py:class:: CreateDatasetResponse(*, id: str = ...)


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

   CreateDatasetResponse returns the dataset ID of the created dataset.

   .. py:attribute:: id
      :type: str

      


.. py:data:: global___CreateDatasetResponse

   

.. py:class:: DeleteDatasetRequest(*, id: str = ...)


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

   DeleteDatasetRequest deletes the dataset specified by the dataset ID.

   .. py:attribute:: id
      :type: str

      


.. py:data:: global___DeleteDatasetRequest

   

.. py:class:: DeleteDatasetResponse


   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___DeleteDatasetResponse

   

.. py:class:: RenameDatasetRequest(*, id: str = ..., name: str = ...)


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

   RenameDatasetRequest applies the new name to the dataset specified by the dataset ID.

   .. py:attribute:: id
      :type: str

      

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

      


.. py:data:: global___RenameDatasetRequest

   

.. py:class:: RenameDatasetResponse


   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___RenameDatasetResponse

   

.. py:class:: ListDatasetsByOrganizationIDRequest(*, organization_id: str = ...)


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

   ListDatasetsByOrganizationIDRequest requests all of the datasets for an organization.

   .. py:attribute:: organization_id
      :type: str

      


.. py:data:: global___ListDatasetsByOrganizationIDRequest

   

.. py:class:: ListDatasetsByOrganizationIDResponse(*, datasets: collections.abc.Iterable[global___Dataset] | None = ...)


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

   ListDatasetsByOrganizationIDResponse returns all the dataset metadata for the organization.

   .. py:property:: datasets
      :type: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___Dataset]



.. py:data:: global___ListDatasetsByOrganizationIDResponse

   

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


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

   ListDatasetsByIDsRequest requests all of the datasets by their dataset IDs.

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



.. py:data:: global___ListDatasetsByIDsRequest

   

.. py:class:: ListDatasetsByIDsResponse(*, datasets: collections.abc.Iterable[global___Dataset] | None = ...)


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

   ListDatasetsByIDsResponse returns all the dataset metadata for the associated dataset IDs.

   .. py:property:: datasets
      :type: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___Dataset]



.. py:data:: global___ListDatasetsByIDsResponse