CRUD
delete_task(identifier, project=None, entity_id=None, delete_all_versions=False, cascade=True, **kwargs)
Delete object from backend.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
identifier |
str
|
Entity key (store://...) or entity name. |
required |
project |
str
|
Project name. |
None
|
entity_id |
str
|
Entity ID. |
None
|
delete_all_versions |
bool
|
Delete all versions of the named entity. If True, use entity name instead of entity key as identifier. |
False
|
cascade |
bool
|
Cascade delete. |
True
|
**kwargs |
dict
|
Parameters to pass to the API call. |
{}
|
Returns:
Type | Description |
---|---|
dict
|
Response from backend. |
Examples:
If delete_all_versions is False:
>>> obj = delete_task("store://my-task-key")
Otherwise:
>>> obj = delete_task("task-name",
>>> project="my-project",
>>> delete_all_versions=True)
Source code in digitalhub_core/entities/task/crud.py
184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 |
|
get_task(identifier, project=None, **kwargs)
Get object from backend.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
identifier |
str
|
Entity key (store://...) or entity ID. |
required |
project |
str
|
Project name. |
None
|
**kwargs |
dict
|
Parameters to pass to the API call. |
{}
|
Returns:
Type | Description |
---|---|
Task
|
Object instance. |
Examples:
Using entity key:
>>> obj = get_task("store://my-task-key")
Using entity ID:
>>> obj = get_task("my-task-id"
>>> project="my-project")
Source code in digitalhub_core/entities/task/crud.py
70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 |
|
import_task(file)
Get object from file.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
file |
str
|
Path to YAML file. |
required |
Returns:
Type | Description |
---|---|
Task
|
Object instance. |
Example
obj = import_task("my-task.yaml")
Source code in digitalhub_core/entities/task/crud.py
141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 |
|
list_tasks(project, **kwargs)
List all latest version objects from backend.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
project |
str
|
Project name. |
required |
**kwargs |
dict
|
Parameters to pass to the API call. |
{}
|
Returns:
Type | Description |
---|---|
list[Task]
|
List of object instances. |
Examples:
>>> objs = list_tasks(project="my-project")
Source code in digitalhub_core/entities/task/crud.py
113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 |
|
new_task(project, kind, uuid=None, labels=None, function=None, **kwargs)
Create a new object.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
project |
str
|
Project name. |
required |
kind |
str
|
Kind the object. |
required |
uuid |
str
|
ID of the object (UUID4, e.g. 40f25c4b-d26b-4221-b048-9527aff291e2). |
None
|
labels |
list[str]
|
List of labels. |
None
|
function |
str
|
Name of the executable associated with the task. |
None
|
**kwargs |
dict
|
Spec keyword arguments. |
{}
|
Returns:
Type | Description |
---|---|
Task
|
Object instance. |
Examples:
>>> obj = new_function(project="my-project",
>>> name="my-function",
>>> kind="python+task",
>>> task="task-string"
Source code in digitalhub_core/entities/task/crud.py
19 20 21 22 23 24 25 26 27 28 29 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 56 57 58 59 60 61 62 63 64 65 66 67 |
|
update_task(entity)
Update object. Note that object spec are immutable.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
entity |
Task
|
Object to update. |
required |
Returns:
Type | Description |
---|---|
Task
|
Entity updated. |
Examples:
>>> obj = update_task(obj)
Source code in digitalhub_core/entities/task/crud.py
163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 |
|