viam.proto.app.dataset

@generated by Viam. Do not edit manually!

Classes

`DatasetServiceBase`	Helper class that provides a standard way to create an ABC using
`DatasetServiceStub`
`UnimplementedDatasetServiceBase`	Helper class that provides a standard way to create an ABC using
`CreateDatasetRequest`	CreateDatasetRequest defines the name and organization ID of a dataset.
`CreateDatasetResponse`	CreateDatasetResponse returns the dataset ID of the created dataset.
`Dataset`	Dataset stores the metadata of a dataset.
`DeleteDatasetRequest`	DeleteDatasetRequest deletes the dataset specified by the dataset ID.
`DeleteDatasetResponse`	Abstract base class for protocol messages.
`ListDatasetsByIDsRequest`	ListDatasetsByIDsRequest requests all of the datasets by their dataset IDs.
`ListDatasetsByIDsResponse`	ListDatasetsByIDsResponse returns all the dataset metadata for the associated dataset IDs.
`ListDatasetsByOrganizationIDRequest`	ListDatasetsByOrganizationIDRequest requests all of the datasets for an organization.
`ListDatasetsByOrganizationIDResponse`	ListDatasetsByOrganizationIDResponse returns all the dataset metadata for the organization.
`RenameDatasetRequest`	RenameDatasetRequest applies the new name to the dataset specified by the dataset ID.
`RenameDatasetResponse`	Abstract base class for protocol messages.

Package Contents

class viam.proto.app.dataset.DatasetServiceBase[source]

Bases: abc.ABC

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

abstract CreateDataset(stream: grpclib.server.Stream[app.dataset.v1.dataset_pb2.CreateDatasetRequest, app.dataset.v1.dataset_pb2.CreateDatasetResponse]) → None[source]

Async:

abstract DeleteDataset(stream: grpclib.server.Stream[app.dataset.v1.dataset_pb2.DeleteDatasetRequest, app.dataset.v1.dataset_pb2.DeleteDatasetResponse]) → None[source]

Async:

abstract RenameDataset(stream: grpclib.server.Stream[app.dataset.v1.dataset_pb2.RenameDatasetRequest, app.dataset.v1.dataset_pb2.RenameDatasetResponse]) → None[source]

Async:

abstract ListDatasetsByOrganizationID(stream: grpclib.server.Stream[app.dataset.v1.dataset_pb2.ListDatasetsByOrganizationIDRequest, app.dataset.v1.dataset_pb2.ListDatasetsByOrganizationIDResponse]) → None[source]

Async:

abstract ListDatasetsByIDs(stream: grpclib.server.Stream[app.dataset.v1.dataset_pb2.ListDatasetsByIDsRequest, app.dataset.v1.dataset_pb2.ListDatasetsByIDsResponse]) → None[source]

Async:

__mapping__() → Dict[str, grpclib.const.Handler][source]

class viam.proto.app.dataset.DatasetServiceStub(channel: grpclib.client.Channel)[source]

CreateDataset

DeleteDataset

RenameDataset

ListDatasetsByOrganizationID

ListDatasetsByIDs

class viam.proto.app.dataset.UnimplementedDatasetServiceBase[source]

Bases: DatasetServiceBase

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

async CreateDataset(stream: grpclib.server.Stream[app.dataset.v1.dataset_pb2.CreateDatasetRequest, app.dataset.v1.dataset_pb2.CreateDatasetResponse]) → None[source]

async DeleteDataset(stream: grpclib.server.Stream[app.dataset.v1.dataset_pb2.DeleteDatasetRequest, app.dataset.v1.dataset_pb2.DeleteDatasetResponse]) → None[source]

async RenameDataset(stream: grpclib.server.Stream[app.dataset.v1.dataset_pb2.RenameDatasetRequest, app.dataset.v1.dataset_pb2.RenameDatasetResponse]) → None[source]

async ListDatasetsByOrganizationID(stream: grpclib.server.Stream[app.dataset.v1.dataset_pb2.ListDatasetsByOrganizationIDRequest, app.dataset.v1.dataset_pb2.ListDatasetsByOrganizationIDResponse]) → None[source]

async ListDatasetsByIDs(stream: grpclib.server.Stream[app.dataset.v1.dataset_pb2.ListDatasetsByIDsRequest, app.dataset.v1.dataset_pb2.ListDatasetsByIDsResponse]) → None[source]

class viam.proto.app.dataset.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

class viam.proto.app.dataset.CreateDatasetResponse(*, id: str = ...)

Bases: google.protobuf.message.Message

CreateDatasetResponse returns the dataset ID of the created dataset.

id: str

class viam.proto.app.dataset.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.

id: str

name: str

organization_id: str

property time_created: google.protobuf.timestamp_pb2.Timestamp

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.

class viam.proto.app.dataset.DeleteDatasetRequest(*, id: str = ...)

Bases: google.protobuf.message.Message

DeleteDatasetRequest deletes the dataset specified by the dataset ID.

id: str

class viam.proto.app.dataset.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.

class viam.proto.app.dataset.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]

class viam.proto.app.dataset.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]

class viam.proto.app.dataset.ListDatasetsByOrganizationIDRequest(*, organization_id: str = ...)

Bases: google.protobuf.message.Message

ListDatasetsByOrganizationIDRequest requests all of the datasets for an organization.

organization_id: str

class viam.proto.app.dataset.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]

class viam.proto.app.dataset.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

class viam.proto.app.dataset.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.