roboto.domain.datasets.record

Module Contents

class roboto.domain.datasets.record.DatasetRecord(/, **data)

Bases: pydantic.BaseModel

Wire-transmissible representation of a dataset in the Roboto platform.

DatasetRecord contains all the metadata and properties associated with a dataset, including its identification, timestamps, metadata, tags, and organizational information. This is the data structure used for API communication and persistence.

DatasetRecord instances are typically created by the platform during dataset creation operations and are updated as datasets are modified. The Dataset domain class wraps DatasetRecord to provide a more convenient interface for dataset operations.

The record includes audit information (created/modified timestamps and users), organizational context, and user-defined metadata and tags for discovery and organization purposes.

Parameters:

data (Any)

administrator: str = 'Roboto'

Deprecated field maintained for backwards compatibility. Always defaults to ‘Roboto’.

created: datetime.datetime

Timestamp when this dataset was created in the Roboto platform.

created_by: str

User ID or service account that created this dataset.

dataset_id: str

Unique identifier for this dataset within the Roboto platform.

description: str | None = None

Human-readable description of the dataset’s contents and purpose.

device_id: str | None = None

Optional identifier of the device that generated this dataset’s data.

metadata: dict[str, Any] = None

User-defined key-value pairs for storing additional dataset information.

modified: datetime.datetime

Timestamp when this dataset was last modified.

modified_by: str

User ID or service account that last modified this dataset.

name: str | None = None

A short name for this dataset. This may be an org-specific unique ID that’s more meaningful than the dataset_id, or a short summary of the dataset’s contents. If provided, must be 120 characters or less.

org_id: str

Organization ID that owns this dataset.

roboto_record_version: int = 0

Internal version number for this record, automatically incremented on updates.

storage_ctx: dict[str, Any] = None

Deprecated storage context field maintained for backwards compatibility with SDK versions prior to 0.10.0.

storage_location: str = 'S3'

Deprecated storage location field maintained for backwards compatibility. Always defaults to ‘S3’.

tags: list[str] = None

List of tags for categorizing and discovering this dataset.

roboto.domain.datasets.record.make_backwards_compatible_placeholder_storage_ctx()

Because of some overly aggressive pydantic model validation, we need to return a storage_context with our original S3 description in order to stop SDK clients prior to 0.10.0 from throwing errors.

Return type:

dict[str, Any]