roboto.domain.datasets.operations

Module Contents

BeginSingleFileUploadRequest

class roboto.domain.datasets.operations.BeginSingleFileUploadRequest(/, **data)#

Bases: pydantic.BaseModel

Request payload to begin a single file upload

Parameters

data Any

Attributes

BeginSingleFileUploadRequest.file_path

file_path str = None #

BeginSingleFileUploadRequest.file_size

file_size int = None #

BeginSingleFileUploadRequest.origination

origination str | None = None #

BeginSingleFileUploadResponse

class roboto.domain.datasets.operations.BeginSingleFileUploadResponse(/, **data)#

Bases: pydantic.BaseModel

Response to a single file upload

Parameters

data Any

Attributes

BeginSingleFileUploadResponse.upload_id

upload_id str #

BeginSingleFileUploadResponse.upload_url

upload_url str #

CreateDatasetIfNotExistsRequest

class roboto.domain.datasets.operations.CreateDatasetIfNotExistsRequest(/, **data)#

Bases: pydantic.BaseModel

Request payload to create a dataset if no existing dataset matches the specified query.

Searches for existing datasets using the provided RoboQL query. If a matching dataset is found, returns that dataset. If no match is found, creates a new dataset with the specified properties and returns it.

Parameters

data Any

Attributes

CreateDatasetIfNotExistsRequest.create_request

create_request CreateDatasetRequest #

CreateDatasetIfNotExistsRequest.match_roboql_query

match_roboql_query str #

CreateDatasetRequest

class roboto.domain.datasets.operations.CreateDatasetRequest(**data)#

Bases: pydantic.BaseModel

Request payload for creating a new dataset.

Used to specify the initial properties of a dataset during creation, including optional metadata, tags, name, and description.

Attributes

CreateDatasetRequest.custom_fields

custom_fields dict[str, Any] | None = None #

Initial values for Ready custom fields on this dataset.

Each key must be the name of a CustomField that is Ready for the caller’s org and the Dataset entity type; each value must satisfy the field’s declared type. Names that are undefined or not Ready, and values that don’t match the field’s type, are rejected with a structured error.

CreateDatasetRequest.description

description str | None = None #

Optional human-readable description of the dataset.

CreateDatasetRequest.device_id

device_id str | None = None #

Optional identifier of the device that generated this data.

CreateDatasetRequest.metadata

metadata dict[str, Any] = None #

Key-value metadata pairs to associate with the dataset for discovery and search.

CreateDatasetRequest.name

name str | None = None #

Optional short name for the dataset (max 120 characters).

CreateDatasetRequest.tags

tags list[str] = None #

List of tags for dataset discovery and organization.

CreateDirectoryRequest

class roboto.domain.datasets.operations.CreateDirectoryRequest(/, **data)#

Bases: pydantic.BaseModel

Request payload to create a directory among the files of one association.

Parameters

data Any

Attributes

CreateDirectoryRequest.create_intermediate_dirs

create_intermediate_dirs bool = False #

If True, creates intermediate directories in the path if they don’t exist. If False, requires all parent directories to already exist.

CreateDirectoryRequest.error_if_exists

error_if_exists bool = False #

CreateDirectoryRequest.name

name str #

CreateDirectoryRequest.origination

origination str | None = None #

CreateDirectoryRequest.parent_path

parent_path str | None = None #

DeleteDirectoriesRequest

class roboto.domain.datasets.operations.DeleteDirectoriesRequest(/, **data)#

Bases: pydantic.BaseModel

Request payload for deleting directories within a dataset.

Used to remove entire directory structures and all contained files from a dataset. This is a bulk operation that affects multiple files.

Parameters

data Any

Attributes

DeleteDirectoriesRequest.directory_paths

directory_paths list[str] #

List of directory paths to delete from the dataset.

QueryDatasetFilesRequest

class roboto.domain.datasets.operations.QueryDatasetFilesRequest(/, **data)#

Bases: pydantic.BaseModel

Request payload for listing the files associated with a dataset, an org, or a device.

Supports gitignore-style patterns for flexible file selection and pagination. Despite the name, the same body lists the files of any association type.

Parameters

data Any

Attributes

QueryDatasetFilesRequest.exclude_patterns

exclude_patterns list[str] | None = None #

List of gitignore-style patterns for files to exclude from results.

QueryDatasetFilesRequest.include_patterns

include_patterns list[str] | None = None #

List of gitignore-style patterns for files to include in results.

QueryDatasetFilesRequest.limit

limit int | None = None #

Maximum number of files to return per page.

QueryDatasetFilesRequest.page_token

page_token str | None = None #

Token for retrieving the next page of results in paginated queries.

QueryDatasetFilesRequest.sort_by

sort_by str | None = None #

Field to sort results by. Defaults to ‘created’.

QueryDatasetFilesRequest.sort_direction

sort_direction str | None = None #

Sort direction (‘ASC’ or ‘DESC’). Defaults to ‘DESC’.

QueryDatasetsRequest

class roboto.domain.datasets.operations.QueryDatasetsRequest(/, **data)#

Bases: pydantic.BaseModel

Request payload for querying datasets with filters.

Used to search for datasets based on various criteria such as metadata, tags, and other dataset properties. The filters are applied server-side to efficiently return matching datasets.

Parameters

data Any

Attributes

QueryDatasetsRequest.filters

filters dict[str, Any] = None #

Dictionary of filter criteria to apply when searching for datasets.

QueryDatasetsRequest.model_config

model_config #

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

RenameDirectoryRequest

class roboto.domain.datasets.operations.RenameDirectoryRequest(/, **data)#

Bases: pydantic.BaseModel

Request payload for renaming a directory among the files of one association.

Changes the path of a directory and all its contained files. This updates the logical organization without moving actual file content.

Parameters

data Any

Attributes

RenameDirectoryRequest.new_path

new_path str #

New path for the directory.

RenameDirectoryRequest.old_path

old_path str #

Current path of the directory to rename.

UpdateDatasetRequest

class roboto.domain.datasets.operations.UpdateDatasetRequest(/, **data)#

Bases: pydantic.BaseModel

Request payload for updating dataset properties.

Used to modify dataset metadata, description, name, and other properties. Only specified fields will be updated; others remain unchanged.

Parameters

data Any

Attributes

UpdateDatasetRequest.custom_fields_changeset

custom_fields_changeset roboto.updates.CustomFieldChangeset | None = None #

Changes to apply to Ready custom-field values on this dataset.

Each referenced field name must be a Ready custom field for this dataset’s org and the Dataset entity type; each set_fields value must satisfy the field’s declared type. Names that are undefined or not Ready are rejected with a structured error. Field names not mentioned by the changeset are left unchanged.

UpdateDatasetRequest.description

description str | roboto.sentinels.NotSetType | None #

New description for the dataset. Set to None to clear the description.

UpdateDatasetRequest.device_id

device_id str | roboto.sentinels.NotSetType | None #

New device ID for the dataset. Set to None to clear the device association.

UpdateDatasetRequest.metadata_changeset

metadata_changeset roboto.updates.MetadataChangeset | roboto.sentinels.NotSetType #

Metadata changes to apply (add, update, or remove fields/tags).

UpdateDatasetRequest.model_config

model_config #

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

UpdateDatasetRequest.name

name Annotated[str, pydantic.StringConstraints(max_length=120)] | roboto.sentinels.NotSetType | None #

New name for the dataset (max 120 characters). Set to None to clear the name.