viam.gen.app.dataset.v1.dataset_pb2

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

Attributes

`DESCRIPTOR`
`DATASET_TYPE_BINARY_DATA`	DATASET_TYPE_BINARY_DATA is a dataset whose members are individual binary data objects (frames).
`DATASET_TYPE_SEQUENCE_DATA`	DATASET_TYPE_SEQUENCE_DATA is a dataset whose members are sequences. Binary-data writes
`Global___DatasetType`
`SEQUENCE_DATASET_EXPORT_STATUS_UNSPECIFIED`
`SEQUENCE_DATASET_EXPORT_STATUS_RUNNING`	PENDING — accepted, not yet picked up.
`SEQUENCE_DATASET_EXPORT_STATUS_COMPLETED`	COMPLETED — Parquet file is uploaded; download_url is set.
`SEQUENCE_DATASET_EXPORT_STATUS_FAILED`	FAILED — terminal; error_message describes the cause.
`Global___SequenceDatasetExportStatus`
`Global___Dataset`
`Global___CreateDatasetRequest`
`Global___CreateDatasetResponse`
`Global___DeleteDatasetRequest`
`Global___DeleteDatasetResponse`
`Global___RenameDatasetRequest`
`Global___RenameDatasetResponse`
`Global___ListDatasetsByOrganizationIDRequest`
`Global___ListDatasetsByOrganizationIDResponse`
`Global___ListDatasetsByIDsRequest`
`Global___ListDatasetsByIDsResponse`
`Global___MergeDatasetsRequest`
`Global___MergeDatasetsResponse`
`Global___StartSequenceDatasetExportRequest`
`Global___StartSequenceDatasetExportResponse`
`Global___GetSequenceDatasetExportRequest`
`Global___GetSequenceDatasetExportResponse`

Classes

`DatasetType`	DatasetType describes the kind of membership a dataset stores.
`SequenceDatasetExportStatus`	SequenceDatasetExportStatus is the lifecycle state of an export job.
`Dataset`	Dataset stores the metadata of a dataset.
`CreateDatasetRequest`	CreateDatasetRequest defines the name and organization ID of a dataset.
`CreateDatasetResponse`	CreateDatasetResponse returns the dataset ID of the created dataset.
`DeleteDatasetRequest`	DeleteDatasetRequest deletes the dataset specified by the dataset ID.
`DeleteDatasetResponse`	Abstract base class for protocol messages.
`RenameDatasetRequest`	RenameDatasetRequest applies the new name to the dataset specified by the dataset ID.
`RenameDatasetResponse`	Abstract base class for protocol messages.
`ListDatasetsByOrganizationIDRequest`	ListDatasetsByOrganizationIDRequest requests all of the datasets for an organization,
`ListDatasetsByOrganizationIDResponse`	ListDatasetsByOrganizationIDResponse returns all the dataset metadata for the organization.
`ListDatasetsByIDsRequest`	ListDatasetsByIDsRequest requests all of the datasets by their dataset IDs.
`ListDatasetsByIDsResponse`	ListDatasetsByIDsResponse returns all the dataset metadata for the associated dataset IDs.
`MergeDatasetsRequest`	MergeDatasetsRequest merges multiple datasets specified by their dataset IDs into a new dataset.
`MergeDatasetsResponse`	MergeDatasetsResponse returns the dataset ID of the newly created merged dataset.
`StartSequenceDatasetExportRequest`	StartSequenceDatasetExportRequest specifies the sequence dataset to export.
`StartSequenceDatasetExportResponse`	StartSequenceDatasetExportResponse returns the job_id to poll with
`GetSequenceDatasetExportRequest`	GetSequenceDatasetExportRequest looks up an export job by its job_id.
`GetSequenceDatasetExportResponse`	GetSequenceDatasetExportResponse reports the current status of an export

Module Contents

viam.gen.app.dataset.v1.dataset_pb2.DESCRIPTOR: google.protobuf.descriptor.FileDescriptor

class viam.gen.app.dataset.v1.dataset_pb2.DatasetType

Bases: _DatasetType

DatasetType describes the kind of membership a dataset stores. buf:lint:ignore ENUM_ZERO_VALUE_SUFFIX

viam.gen.app.dataset.v1.dataset_pb2.DATASET_TYPE_BINARY_DATA: 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.

viam.gen.app.dataset.v1.dataset_pb2.DATASET_TYPE_SEQUENCE_DATA: 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.

type viam.gen.app.dataset.v1.dataset_pb2.Global___DatasetType = DatasetType

class viam.gen.app.dataset.v1.dataset_pb2.SequenceDatasetExportStatus

Bases: _SequenceDatasetExportStatus

SequenceDatasetExportStatus is the lifecycle state of an export job.

viam.gen.app.dataset.v1.dataset_pb2.SEQUENCE_DATASET_EXPORT_STATUS_UNSPECIFIED: SequenceDatasetExportStatus

viam.gen.app.dataset.v1.dataset_pb2.SEQUENCE_DATASET_EXPORT_STATUS_RUNNING: SequenceDatasetExportStatus: PENDING — accepted, not yet picked up.

viam.gen.app.dataset.v1.dataset_pb2.SEQUENCE_DATASET_EXPORT_STATUS_COMPLETED: SequenceDatasetExportStatus: COMPLETED — Parquet file is uploaded; download_url is set.

viam.gen.app.dataset.v1.dataset_pb2.SEQUENCE_DATASET_EXPORT_STATUS_FAILED: SequenceDatasetExportStatus: FAILED — terminal; error_message describes the cause.

type viam.gen.app.dataset.v1.dataset_pb2.Global___SequenceDatasetExportStatus = SequenceDatasetExportStatus

class viam.gen.app.dataset.v1.dataset_pb2.Dataset(*, id: str = ..., name: str = ..., organization_id: str = ..., time_created: google.protobuf.timestamp_pb2.Timestamp | None = ..., type: Global___DatasetType = ...)

Bases: google.protobuf.message.Message

Dataset stores the metadata of a dataset.

id: str

name: str

organization_id: str

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

time_created() → google.protobuf.timestamp_pb2.Timestamp

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, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

type viam.gen.app.dataset.v1.dataset_pb2.Global___Dataset = Dataset

class viam.gen.app.dataset.v1.dataset_pb2.CreateDatasetRequest(*, name: str = ..., organization_id: str = ..., type: Global___DatasetType | None = ...)

Bases: google.protobuf.message.Message

CreateDatasetRequest defines the name and organization ID of a dataset.

name: str

organization_id: str

type: Global___DatasetType: type is the membership kind for the new dataset. Defaults to DATASET_TYPE_BINARY_DATA when unset.

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, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

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.

Parameters:: oneof_group (str) – the name of the oneof group to check.
Returns:: The name of the group that is set, or None.
Return type:: str or None
Raises:: ValueError – no group with the given name exists

type viam.gen.app.dataset.v1.dataset_pb2.Global___CreateDatasetRequest = CreateDatasetRequest

class viam.gen.app.dataset.v1.dataset_pb2.CreateDatasetResponse(*, id: str = ...)

Bases: google.protobuf.message.Message

CreateDatasetResponse returns the dataset ID of the created dataset.

id: str

type viam.gen.app.dataset.v1.dataset_pb2.Global___CreateDatasetResponse = CreateDatasetResponse

class viam.gen.app.dataset.v1.dataset_pb2.DeleteDatasetRequest(*, id: str = ...)

Bases: google.protobuf.message.Message

DeleteDatasetRequest deletes the dataset specified by the dataset ID.

id: str

type viam.gen.app.dataset.v1.dataset_pb2.Global___DeleteDatasetRequest = DeleteDatasetRequest

class viam.gen.app.dataset.v1.dataset_pb2.DeleteDatasetResponse

Bases: 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.

type viam.gen.app.dataset.v1.dataset_pb2.Global___DeleteDatasetResponse = DeleteDatasetResponse

class viam.gen.app.dataset.v1.dataset_pb2.RenameDatasetRequest(*, id: str = ..., name: str = ...)

Bases: google.protobuf.message.Message

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

id: str

name: str

type viam.gen.app.dataset.v1.dataset_pb2.Global___RenameDatasetRequest = RenameDatasetRequest

class viam.gen.app.dataset.v1.dataset_pb2.RenameDatasetResponse

Bases: 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.

type viam.gen.app.dataset.v1.dataset_pb2.Global___RenameDatasetResponse = RenameDatasetResponse

class viam.gen.app.dataset.v1.dataset_pb2.ListDatasetsByOrganizationIDRequest(*, organization_id: str = ..., type: Global___DatasetType | None = ...)

Bases: google.protobuf.message.Message

ListDatasetsByOrganizationIDRequest requests all of the datasets for an organization, optionally filtering on DatasetType

organization_id: str

type: Global___DatasetType: Optional DataseType to filter on. If unset, will return all types.

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, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

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.

Parameters:: oneof_group (str) – the name of the oneof group to check.
Returns:: The name of the group that is set, or None.
Return type:: str or None
Raises:: ValueError – no group with the given name exists

type viam.gen.app.dataset.v1.dataset_pb2.Global___ListDatasetsByOrganizationIDRequest = ListDatasetsByOrganizationIDRequest

class viam.gen.app.dataset.v1.dataset_pb2.ListDatasetsByOrganizationIDResponse(*, datasets: collections.abc.Iterable[Global___Dataset] | None = ...)

Bases: google.protobuf.message.Message

ListDatasetsByOrganizationIDResponse returns all the dataset metadata for the organization.

datasets() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___Dataset]

type viam.gen.app.dataset.v1.dataset_pb2.Global___ListDatasetsByOrganizationIDResponse = ListDatasetsByOrganizationIDResponse

class viam.gen.app.dataset.v1.dataset_pb2.ListDatasetsByIDsRequest(*, ids: collections.abc.Iterable[str] | None = ...)

Bases: google.protobuf.message.Message

ListDatasetsByIDsRequest requests all of the datasets by their dataset IDs.

ids() → google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

type viam.gen.app.dataset.v1.dataset_pb2.Global___ListDatasetsByIDsRequest = ListDatasetsByIDsRequest

class viam.gen.app.dataset.v1.dataset_pb2.ListDatasetsByIDsResponse(*, datasets: collections.abc.Iterable[Global___Dataset] | None = ...)

Bases: google.protobuf.message.Message

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

datasets() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___Dataset]

type viam.gen.app.dataset.v1.dataset_pb2.Global___ListDatasetsByIDsResponse = ListDatasetsByIDsResponse

class viam.gen.app.dataset.v1.dataset_pb2.MergeDatasetsRequest(*, dataset_ids: collections.abc.Iterable[str] | None = ..., name: str = ..., organization_id: str = ...)

Bases: google.protobuf.message.Message

MergeDatasetsRequest merges multiple datasets specified by their dataset IDs into a new dataset.

name: str

organization_id: str

dataset_ids() → google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

type viam.gen.app.dataset.v1.dataset_pb2.Global___MergeDatasetsRequest = MergeDatasetsRequest

class viam.gen.app.dataset.v1.dataset_pb2.MergeDatasetsResponse(*, dataset_id: str = ...)

Bases: google.protobuf.message.Message

MergeDatasetsResponse returns the dataset ID of the newly created merged dataset.

dataset_id: str

type viam.gen.app.dataset.v1.dataset_pb2.Global___MergeDatasetsResponse = MergeDatasetsResponse

class viam.gen.app.dataset.v1.dataset_pb2.StartSequenceDatasetExportRequest(*, dataset_id: str = ...)

Bases: google.protobuf.message.Message

StartSequenceDatasetExportRequest specifies the sequence dataset to export.

dataset_id: str

type viam.gen.app.dataset.v1.dataset_pb2.Global___StartSequenceDatasetExportRequest = StartSequenceDatasetExportRequest

class viam.gen.app.dataset.v1.dataset_pb2.StartSequenceDatasetExportResponse(*, job_id: str = ...)

Bases: google.protobuf.message.Message

StartSequenceDatasetExportResponse returns the job_id to poll with

job_id: str

type viam.gen.app.dataset.v1.dataset_pb2.Global___StartSequenceDatasetExportResponse = StartSequenceDatasetExportResponse

class viam.gen.app.dataset.v1.dataset_pb2.GetSequenceDatasetExportRequest(*, job_id: str = ...)

Bases: google.protobuf.message.Message

GetSequenceDatasetExportRequest looks up an export job by its job_id.

job_id: str

type viam.gen.app.dataset.v1.dataset_pb2.Global___GetSequenceDatasetExportRequest = GetSequenceDatasetExportRequest

class viam.gen.app.dataset.v1.dataset_pb2.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: 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.

job_id: str

status: Global___SequenceDatasetExportStatus

download_url: str: Short-lived (e.g. 1h) signed URL for direct download from backing storage. Empty unless status is COMPLETED.

error_message: str: Human-readable cause; empty unless status is FAILED.

expires_at() → google.protobuf.timestamp_pb2.Timestamp: When download_url stops working. Empty unless status is COMPLETED.

created_at() → google.protobuf.timestamp_pb2.Timestamp

completed_at() → google.protobuf.timestamp_pb2.Timestamp

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, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

type viam.gen.app.dataset.v1.dataset_pb2.Global___GetSequenceDatasetExportResponse = GetSequenceDatasetExportResponse