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 Attributes ---------- .. autoapisummary:: viam.gen.app.dataset.v1.dataset_pb2.DESCRIPTOR viam.gen.app.dataset.v1.dataset_pb2.DATASET_TYPE_BINARY_DATA viam.gen.app.dataset.v1.dataset_pb2.DATASET_TYPE_SEQUENCE_DATA viam.gen.app.dataset.v1.dataset_pb2.Global___DatasetType viam.gen.app.dataset.v1.dataset_pb2.SEQUENCE_DATASET_EXPORT_STATUS_UNSPECIFIED viam.gen.app.dataset.v1.dataset_pb2.SEQUENCE_DATASET_EXPORT_STATUS_RUNNING viam.gen.app.dataset.v1.dataset_pb2.SEQUENCE_DATASET_EXPORT_STATUS_COMPLETED viam.gen.app.dataset.v1.dataset_pb2.SEQUENCE_DATASET_EXPORT_STATUS_FAILED viam.gen.app.dataset.v1.dataset_pb2.Global___SequenceDatasetExportStatus 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 viam.gen.app.dataset.v1.dataset_pb2.Global___MergeDatasetsRequest viam.gen.app.dataset.v1.dataset_pb2.Global___MergeDatasetsResponse viam.gen.app.dataset.v1.dataset_pb2.Global___StartSequenceDatasetExportRequest viam.gen.app.dataset.v1.dataset_pb2.Global___StartSequenceDatasetExportResponse viam.gen.app.dataset.v1.dataset_pb2.Global___GetSequenceDatasetExportRequest viam.gen.app.dataset.v1.dataset_pb2.Global___GetSequenceDatasetExportResponse Classes ------- .. autoapisummary:: viam.gen.app.dataset.v1.dataset_pb2.DatasetType viam.gen.app.dataset.v1.dataset_pb2.SequenceDatasetExportStatus 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 viam.gen.app.dataset.v1.dataset_pb2.MergeDatasetsRequest viam.gen.app.dataset.v1.dataset_pb2.MergeDatasetsResponse viam.gen.app.dataset.v1.dataset_pb2.StartSequenceDatasetExportRequest viam.gen.app.dataset.v1.dataset_pb2.StartSequenceDatasetExportResponse viam.gen.app.dataset.v1.dataset_pb2.GetSequenceDatasetExportRequest viam.gen.app.dataset.v1.dataset_pb2.GetSequenceDatasetExportResponse Module Contents --------------- .. py:data:: DESCRIPTOR :type: google.protobuf.descriptor.FileDescriptor .. py:class:: DatasetType Bases: :py:obj:`_DatasetType` DatasetType describes the kind of membership a dataset stores. buf:lint:ignore ENUM_ZERO_VALUE_SUFFIX .. py:data:: DATASET_TYPE_BINARY_DATA :type: DatasetType DATASET_TYPE_BINARY_DATA is a dataset whose members are individual binary data objects (frames). This is the default for datasets created without an explicit type, including all pre-existing datasets. .. py:data:: DATASET_TYPE_SEQUENCE_DATA :type: DatasetType DATASET_TYPE_SEQUENCE_DATA is a dataset whose members are sequences. Binary-data writes (AddBinaryDataToDatasetByIDs, AddBinaryDataToDatasetByFilter) are rejected against datasets of this type; sequences are added/removed via AddSequencesToDataset / RemoveSequencesFromDataset. .. py:type:: Global___DatasetType :canonical: DatasetType .. py:class:: SequenceDatasetExportStatus Bases: :py:obj:`_SequenceDatasetExportStatus` SequenceDatasetExportStatus is the lifecycle state of an export job. .. py:data:: SEQUENCE_DATASET_EXPORT_STATUS_UNSPECIFIED :type: SequenceDatasetExportStatus .. py:data:: SEQUENCE_DATASET_EXPORT_STATUS_RUNNING :type: SequenceDatasetExportStatus PENDING — accepted, not yet picked up. .. py:data:: SEQUENCE_DATASET_EXPORT_STATUS_COMPLETED :type: SequenceDatasetExportStatus COMPLETED — Parquet file is uploaded; download_url is set. .. py:data:: SEQUENCE_DATASET_EXPORT_STATUS_FAILED :type: SequenceDatasetExportStatus FAILED — terminal; error_message describes the cause. .. py:type:: Global___SequenceDatasetExportStatus :canonical: SequenceDatasetExportStatus .. py:class:: Dataset(*, id: str = ..., name: str = ..., organization_id: str = ..., time_created: google.protobuf.timestamp_pb2.Timestamp | None = ..., type: Global___DatasetType = ...) Bases: :py:obj:`google.protobuf.message.Message` Dataset stores the metadata of a dataset. .. py:attribute:: id :type: str .. py:attribute:: name :type: str .. py:attribute:: organization_id :type: str .. py:attribute:: type :type: Global___DatasetType type is the membership kind of this dataset. Immutable after creation; defaults to DATASET_TYPE_BINARY_DATA when unset (including for pre-existing datasets). .. py:method:: time_created() -> google.protobuf.timestamp_pb2.Timestamp .. py:method:: HasField(field_name: _HasFieldArgType) -> 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:type:: Global___Dataset :canonical: Dataset .. py:class:: CreateDatasetRequest(*, name: str = ..., organization_id: str = ..., type: Global___DatasetType | None = ...) 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:attribute:: type :type: Global___DatasetType type is the membership kind for the new dataset. Defaults to DATASET_TYPE_BINARY_DATA when unset. .. py:method:: HasField(field_name: _HasFieldArgType) -> 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:method:: WhichOneof(oneof_group: _WhichOneofArgType__type) -> _WhichOneofReturnType__type | None Returns the name of the field that is set inside a oneof group. If no field is set, returns None. :param oneof_group: the name of the oneof group to check. :type oneof_group: str :returns: The name of the group that is set, or None. :rtype: str or None :raises ValueError: no group with the given name exists .. py:type:: Global___CreateDatasetRequest :canonical: 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:type:: Global___CreateDatasetResponse :canonical: 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:type:: Global___DeleteDatasetRequest :canonical: 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:type:: Global___DeleteDatasetResponse :canonical: 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:type:: Global___RenameDatasetRequest :canonical: 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:type:: Global___RenameDatasetResponse :canonical: RenameDatasetResponse .. py:class:: ListDatasetsByOrganizationIDRequest(*, organization_id: str = ..., type: Global___DatasetType | None = ...) Bases: :py:obj:`google.protobuf.message.Message` ListDatasetsByOrganizationIDRequest requests all of the datasets for an organization, optionally filtering on DatasetType .. py:attribute:: organization_id :type: str .. py:attribute:: type :type: Global___DatasetType Optional DataseType to filter on. If unset, will return all types. .. py:method:: HasField(field_name: _HasFieldArgType) -> 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:method:: WhichOneof(oneof_group: _WhichOneofArgType__type) -> _WhichOneofReturnType__type | None Returns the name of the field that is set inside a oneof group. If no field is set, returns None. :param oneof_group: the name of the oneof group to check. :type oneof_group: str :returns: The name of the group that is set, or None. :rtype: str or None :raises ValueError: no group with the given name exists .. py:type:: Global___ListDatasetsByOrganizationIDRequest :canonical: 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:method:: datasets() -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___Dataset] .. py:type:: Global___ListDatasetsByOrganizationIDResponse :canonical: 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:method:: ids() -> google.protobuf.internal.containers.RepeatedScalarFieldContainer[str] .. py:type:: Global___ListDatasetsByIDsRequest :canonical: 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:method:: datasets() -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___Dataset] .. py:type:: Global___ListDatasetsByIDsResponse :canonical: ListDatasetsByIDsResponse .. py:class:: MergeDatasetsRequest(*, dataset_ids: collections.abc.Iterable[str] | None = ..., name: str = ..., organization_id: str = ...) Bases: :py:obj:`google.protobuf.message.Message` MergeDatasetsRequest merges multiple datasets specified by their dataset IDs into a new dataset. .. py:attribute:: name :type: str .. py:attribute:: organization_id :type: str .. py:method:: dataset_ids() -> google.protobuf.internal.containers.RepeatedScalarFieldContainer[str] .. py:type:: Global___MergeDatasetsRequest :canonical: MergeDatasetsRequest .. py:class:: MergeDatasetsResponse(*, dataset_id: str = ...) Bases: :py:obj:`google.protobuf.message.Message` MergeDatasetsResponse returns the dataset ID of the newly created merged dataset. .. py:attribute:: dataset_id :type: str .. py:type:: Global___MergeDatasetsResponse :canonical: MergeDatasetsResponse .. py:class:: StartSequenceDatasetExportRequest(*, dataset_id: str = ...) Bases: :py:obj:`google.protobuf.message.Message` StartSequenceDatasetExportRequest specifies the sequence dataset to export. .. py:attribute:: dataset_id :type: str .. py:type:: Global___StartSequenceDatasetExportRequest :canonical: StartSequenceDatasetExportRequest .. py:class:: StartSequenceDatasetExportResponse(*, job_id: str = ...) Bases: :py:obj:`google.protobuf.message.Message` StartSequenceDatasetExportResponse returns the job_id to poll with .. py:attribute:: job_id :type: str .. py:type:: Global___StartSequenceDatasetExportResponse :canonical: StartSequenceDatasetExportResponse .. py:class:: GetSequenceDatasetExportRequest(*, job_id: str = ...) Bases: :py:obj:`google.protobuf.message.Message` GetSequenceDatasetExportRequest looks up an export job by its job_id. .. py:attribute:: job_id :type: str .. py:type:: Global___GetSequenceDatasetExportRequest :canonical: GetSequenceDatasetExportRequest .. py:class:: GetSequenceDatasetExportResponse(*, job_id: str = ..., status: Global___SequenceDatasetExportStatus = ..., download_url: str = ..., expires_at: google.protobuf.timestamp_pb2.Timestamp | None = ..., error_message: str = ..., created_at: google.protobuf.timestamp_pb2.Timestamp | None = ..., completed_at: google.protobuf.timestamp_pb2.Timestamp | None = ...) Bases: :py:obj:`google.protobuf.message.Message` GetSequenceDatasetExportResponse reports the current status of an export job. download_url and expires_at are set only when status is COMPLETED; error_message is set only when status is FAILED. .. py:attribute:: job_id :type: str .. py:attribute:: status :type: Global___SequenceDatasetExportStatus .. py:attribute:: download_url :type: str Short-lived (e.g. 1h) signed URL for direct download from backing storage. Empty unless status is COMPLETED. .. py:attribute:: error_message :type: str Human-readable cause; empty unless status is FAILED. .. py:method:: expires_at() -> google.protobuf.timestamp_pb2.Timestamp When download_url stops working. Empty unless status is COMPLETED. .. py:method:: created_at() -> google.protobuf.timestamp_pb2.Timestamp .. py:method:: completed_at() -> google.protobuf.timestamp_pb2.Timestamp .. py:method:: HasField(field_name: _HasFieldArgType) -> 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:type:: Global___GetSequenceDatasetExportResponse :canonical: GetSequenceDatasetExportResponse