dataset
DatasetCreateV1
¶
Bases: _DatasetBaseV1
Class for Dataset
creation.
Source code in fractal_server/app/schemas/v1/dataset.py
124 125 126 127 128 129 130 131 |
|
DatasetReadV1
¶
Bases: _DatasetBaseV1
Class for Dataset
read from database.
Attributes:
Name | Type | Description |
---|---|---|
id |
int
|
|
read_only |
bool
|
|
resource_list |
list[ResourceReadV1]
|
|
project_id |
int
|
|
project |
ProjectReadV1
|
|
Source code in fractal_server/app/schemas/v1/dataset.py
134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 |
|
DatasetStatusReadV1
¶
Bases: BaseModel
Response type for the
/project/{project_id}/dataset/{dataset_id}/status/
endpoint
Source code in fractal_server/app/schemas/v1/dataset.py
154 155 156 157 158 159 160 161 162 163 164 165 |
|
DatasetUpdateV1
¶
Bases: _DatasetBaseV1
Class for Dataset
update.
Attributes:
Name | Type | Description |
---|---|---|
name |
Optional[str]
|
|
meta |
Optional[dict[str, Any]]
|
|
history |
Optional[list[_DatasetHistoryItemV1]]
|
|
read_only |
Optional[bool]
|
|
Source code in fractal_server/app/schemas/v1/dataset.py
103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 |
|
ResourceCreateV1
¶
Bases: _ResourceBaseV1
Class for Resource
creation.
Source code in fractal_server/app/schemas/v1/dataset.py
37 38 39 40 41 42 43 |
|
ResourceReadV1
¶
Bases: _ResourceBaseV1
Class for Resource
read from database.
Attributes:
Name | Type | Description |
---|---|---|
id |
int
|
|
dataset_id |
int
|
|
Source code in fractal_server/app/schemas/v1/dataset.py
55 56 57 58 59 60 61 62 63 64 65 |
|
ResourceUpdateV1
¶
Bases: _ResourceBaseV1
Class for Resource
update.
Source code in fractal_server/app/schemas/v1/dataset.py
46 47 48 49 50 51 52 |
|
_DatasetBaseV1
¶
Bases: BaseModel
Base class for Dataset
.
Attributes:
Name | Type | Description |
---|---|---|
name |
str
|
|
type |
Optional[str]
|
|
meta |
dict[str, Any]
|
|
history |
list[_DatasetHistoryItemV1]
|
|
read_only |
bool
|
|
Source code in fractal_server/app/schemas/v1/dataset.py
84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 |
|
_DatasetHistoryItemV1
¶
Bases: BaseModel
Class for an item of Dataset.history
.
Attributes:
Name | Type | Description |
---|---|---|
workflowtask |
WorkflowTaskDumpV1
|
|
status |
WorkflowTaskStatusTypeV1
|
|
parallelization |
Optional[dict]
|
If provided, it includes keys |
Source code in fractal_server/app/schemas/v1/dataset.py
68 69 70 71 72 73 74 75 76 77 78 79 80 81 |
|
_ResourceBaseV1
¶
Bases: BaseModel
Base class for Resource
.
Attributes:
Name | Type | Description |
---|---|---|
path |
str
|
|
Source code in fractal_server/app/schemas/v1/dataset.py
26 27 28 29 30 31 32 33 34 |
|