Skip to content

dataset

DatasetCreateV2

Bases: BaseModel

DatasetCreateV2

ATTRIBUTE DESCRIPTION
name

TYPE: NonEmptyStr

zarr_dir

TYPE: ZarrDirStr | None

Source code in fractal_server/app/schemas/v2/dataset.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
class DatasetCreateV2(BaseModel):
    """
    DatasetCreateV2

    Attributes:
        name:
        zarr_dir:
    """

    model_config = ConfigDict(extra="forbid")

    name: NonEmptyStr
    zarr_dir: ZarrDirStr | None = None

DatasetExportV2

Bases: BaseModel

Class for Dataset export.

ATTRIBUTE DESCRIPTION
name

TYPE: str

zarr_dir

TYPE: str

images

TYPE: list[SingleImage]

Source code in fractal_server/app/schemas/v2/dataset.py 
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
class DatasetExportV2(BaseModel):
    """
    Class for `Dataset` export.

    Attributes:
        name:
        zarr_dir:
        images:
    """

    name: str
    zarr_dir: str
    images: list[SingleImage]

DatasetImportV2

Bases: BaseModel

Class for Dataset import.

We are dropping model_config = ConfigDict(extra="forbid") so that any kind of legacy filters can be included in the payload, and ignored in the API.

ATTRIBUTE DESCRIPTION
name

TYPE: str

zarr_dir

TYPE: ZarrDirStr

images

TYPE: list[SingleImage]

Source code in fractal_server/app/schemas/v2/dataset.py 
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
class DatasetImportV2(BaseModel):
    """
    Class for `Dataset` import.

    We are dropping `model_config = ConfigDict(extra="forbid")` so that any
    kind of legacy filters can be included in the payload, and ignored in the
    API.

    Attributes:
        name:
        zarr_dir:
        images:
    """

    name: str
    zarr_dir: ZarrDirStr
    images: list[SingleImage] = Field(default_factory=list)

DatasetReadV2

Bases: BaseModel

DatasetReadV2

ATTRIBUTE DESCRIPTION
id

TYPE: int

name

TYPE: str

project_id

TYPE: int

project

TYPE: ProjectReadV2

timestamp_created

TYPE: AwareDatetime

zarr_dir

TYPE: str

Source code in fractal_server/app/schemas/v2/dataset.py 
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
class DatasetReadV2(BaseModel):
    """
    DatasetReadV2

    Attributes:
        id:
        name:
        project_id:
        project:
        timestamp_created:
        zarr_dir:
    """

    id: int
    name: str

    project_id: int
    project: ProjectReadV2

    timestamp_created: AwareDatetime

    zarr_dir: str

    @field_serializer("timestamp_created")
    def serialize_datetime(v: datetime) -> str:
        return v.isoformat()

DatasetUpdateV2

Bases: BaseModel

DatasetUpdateV2

ATTRIBUTE DESCRIPTION
name

TYPE: NonEmptyStr

zarr_dir

TYPE: ZarrDirStr | None

Source code in fractal_server/app/schemas/v2/dataset.py 
58
59
60
61
62
63
64
65
66
67
68
69
70
class DatasetUpdateV2(BaseModel):
    """
    DatasetUpdateV2

    Attributes:
        name:
        zarr_dir:
    """

    model_config = ConfigDict(extra="forbid")

    name: NonEmptyStr = None
    zarr_dir: ZarrDirStr | None = None