Job¶
Bases: VizTools
The Job class is the result of running a workflow. It lets you download, visualize and manipulate the results of the job, and keep track of the status or cancel a job while still running.
Run a new job:
job = workflow.run_job(name="new_job", input_parameters={...})
Use an existing job:
job = up42.initialize_job(job_id="de5806aa-5ef1-4dc9-ab1d-06d7ec1a5021")
Source code in up42/job.py
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 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 110 111 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 145 146 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 176 177 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 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 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 |
|
info: dict
property
¶
Gets and updates the job metadata information.
is_succeeded: bool
property
¶
Gets True
if the job succeeded, False
otherwise.
Also see status attribute.
status: str
property
¶
Gets the job progress status. One of SUCCEEDED
, NOT STARTED
, PENDING
,
RUNNING
, CANCELLED
, CANCELLING
, FAILED
, ERROR
.
cancel_job()
¶
Cancels a pending or running job.
Source code in up42/job.py
127 128 129 130 131 |
|
download_quicklooks(output_directory=None)
¶
Conveniance function that downloads the quicklooks of the data (dirst) jobtask.
After download, can be plotted via job.plot_quicklooks().
Source code in up42/job.py
133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 |
|
download_results(output_directory=None, unpacking=True)
¶
Downloads the job results. Unpacking the final file will happen as default.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
output_directory |
Union[str, Path, None]
|
The file output directory, defaults to the current working directory. |
None
|
unpacking |
bool
|
By default the final result which is in TAR archive format will be unpacked. |
True
|
Returns:
Type | Description |
---|---|
List[str]
|
List of the downloaded results' filepaths. |
Source code in up42/job.py
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 |
|
get_credits()
¶
Gets the credit costs of the job.
Returns:
Type | Description |
---|---|
dict
|
The consumed credits for the job. |
Source code in up42/job.py
347 348 349 350 351 352 353 354 355 356 357 358 359 |
|
get_jobtasks(return_json=False)
¶
Get the individual items of the job as a list of JobTask objects or JSON.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
return_json |
bool
|
If True returns the JSON information of the job tasks. |
False
|
Returns:
Type | Description |
---|---|
Union[List[JobTask], List[dict]]
|
The job task objects in a list. |
Source code in up42/job.py
292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 |
|
get_jobtasks_results_json()
¶
Convenience function to get the resulting data.json of all job tasks in a dictionary of strings.
Returns:
Type | Description |
---|---|
dict
|
The data.json of all single job tasks. |
Source code in up42/job.py
326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 |
|
get_logs(as_print=True, as_return=False)
¶
Convenience function to print or return the logs of all job tasks.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
as_print |
bool
|
Prints the logs, no return. |
True
|
as_return |
bool
|
Also returns the log strings. |
False
|
Returns:
Type | Description |
---|---|
Optional[dict]
|
The log strings (only if as_return was selected). |
Source code in up42/job.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 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 |
|
get_results_json(as_dataframe=False)
¶
Gets the Job results data.json.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
as_dataframe |
bool
|
Return type, Default Feature Collection. GeoDataFrame if True. |
False
|
Returns:
Type | Description |
---|---|
Union[dict, GeoDataFrame]
|
The job data.json. |
Source code in up42/job.py
152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 |
|
track_status(report_time=30)
¶
` Continuously gets the job status until job has finished or failed.
Internally checks every five seconds for the status, prints the log every time interval given in report_time argument.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
report_time |
int
|
The intervall (in seconds) when to query the job status. |
30
|
Source code in up42/job.py
88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 |
|
upload_results_to_bucket(gs_client, bucket, folder, extension='.tgz', version='v0')
¶
Uploads the results of a job directly to a custom google cloud storage bucket.
Source code in up42/job.py
225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 |
|