viam.gen.app.dataset.v1.dataset_pb2

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

Module Contents

Classes

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.

Attributes

DESCRIPTOR
global___Dataset
global___CreateDatasetRequest
global___CreateDatasetResponse
global___DeleteDatasetRequest
global___DeleteDatasetResponse
global___RenameDatasetRequest
global___RenameDatasetResponse
global___ListDatasetsByOrganizationIDRequest
global___ListDatasetsByOrganizationIDResponse
global___ListDatasetsByIDsRequest
global___ListDatasetsByIDsResponse

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

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

Bases: google.protobuf.message.Message

Dataset stores the metadata of a dataset.

property time_created: google.protobuf.timestamp_pb2.Timestamp

id: str

name: str

organization_id: str

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

viam.gen.app.dataset.v1.dataset_pb2.global___Dataset

class viam.gen.app.dataset.v1.dataset_pb2.CreateDatasetRequest(*, name: str = ..., organization_id: str = ...)

Bases: google.protobuf.message.Message

CreateDatasetRequest defines the name and organization ID of a dataset.

name: str

organization_id: str

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

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

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

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

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

viam.gen.app.dataset.v1.dataset_pb2.global___RenameDatasetResponse

class viam.gen.app.dataset.v1.dataset_pb2.ListDatasetsByOrganizationIDRequest(*, organization_id: str = ...)

Bases: google.protobuf.message.Message

ListDatasetsByOrganizationIDRequest requests all of the datasets for an organization.

organization_id: str

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

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

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

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

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

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

viam.gen.app.dataset.v1.dataset_pb2.global___ListDatasetsByIDsResponse