CRUD
create_workflow(**kwargs)
Create a new Workflow instance with the specified parameters.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
**kwargs |
dict
|
Keyword arguments. |
{}
|
Returns:
Type | Description |
---|---|
Workflow
|
An instance of the created workflow. |
Source code in digitalhub_core/entities/workflows/crud.py
24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 |
|
create_workflow_from_dict(obj)
Create a new Workflow instance from a dictionary.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
obj |
dict
|
Dictionary to create object from. |
required |
Returns:
Type | Description |
---|---|
Workflow
|
Workflow object. |
Source code in digitalhub_core/entities/workflows/crud.py
41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 |
|
delete_workflow(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 or name. |
required |
project |
str
|
Project name. |
None
|
entity_id |
str
|
Entity ID. |
None
|
delete_all_versions |
bool
|
Delete all versions of the named entity. 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. |
Source code in digitalhub_core/entities/workflows/crud.py
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 236 237 238 239 240 241 242 243 244 245 246 |
|
get_workflow(identifier, project=None, entity_id=None, **kwargs)
Get object from backend.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
identifier |
str
|
Entity key or name. |
required |
project |
str
|
Project name. |
None
|
entity_id |
str
|
Entity ID. |
None
|
**kwargs |
dict
|
Parameters to pass to the API call. |
{}
|
Returns:
Type | Description |
---|---|
Workflow
|
Object instance. |
Source code in digitalhub_core/entities/workflows/crud.py
112 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 139 140 141 142 143 144 |
|
get_workflow_versions(identifier, project=None, **kwargs)
Get object versions from backend.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
identifier |
str
|
Entity key or name. |
required |
project |
str
|
Project name. |
None
|
**kwargs |
dict
|
Parameters to pass to the API call. |
{}
|
Returns:
Type | Description |
---|---|
list[Workflow]
|
List of object instances. |
Source code in digitalhub_core/entities/workflows/crud.py
147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 |
|
import_workflow(file)
Import an Workflow object from a file using the specified file path.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
file |
str
|
Path to the file. |
required |
Returns:
Type | Description |
---|---|
Workflow
|
Object instance. |
Source code in digitalhub_core/entities/workflows/crud.py
178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 |
|
list_workflows(project, **kwargs)
List all 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[Workflow]
|
List of workflows. |
Source code in digitalhub_core/entities/workflows/crud.py
275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 |
|
new_workflow(project, name, kind, uuid=None, description=None, git_source=None, labels=None, embedded=True, **kwargs)
Create a new Workflow instance with the specified parameters.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
project |
str
|
Project name. |
required |
name |
str
|
Object name. |
required |
uuid |
str
|
ID of the object (UUID4). |
None
|
description |
str
|
Description of the object (human readable). |
None
|
git_source |
str
|
Remote git source for object. |
None
|
labels |
list[str]
|
List of labels. |
None
|
embedded |
bool
|
Flag to determine if object must be embedded in project. |
True
|
**kwargs |
dict
|
Spec keyword arguments. |
{}
|
Returns:
Type | Description |
---|---|
Workflow
|
An instance of the created workflow. |
Source code in digitalhub_core/entities/workflows/crud.py
59 60 61 62 63 64 65 66 67 68 69 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 |
|
update_workflow(entity, **kwargs)
Update object in backend.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
entity |
Workflow
|
The object to update. |
required |
**kwargs |
dict
|
Parameters to pass to the API call. |
{}
|
Returns:
Type | Description |
---|---|
Workflow
|
Entity updated. |
Source code in digitalhub_core/entities/workflows/crud.py
249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 |
|