¶
prefect.client.schemas.actions
¶
StateCreate
¶
Bases: ActionBaseModel
Data used by the Prefect REST API to create a new state.
Source code in prefect/client/schemas/actions.py
65 66 67 68 69 70 71 72 73 74 |
|
FlowCreate
¶
Bases: ActionBaseModel
Data used by the Prefect REST API to create a flow.
Source code in prefect/client/schemas/actions.py
77 78 79 80 81 82 83 84 85 86 87 |
|
FlowUpdate
¶
Bases: ActionBaseModel
Data used by the Prefect REST API to update a flow.
Source code in prefect/client/schemas/actions.py
90 91 92 93 94 95 96 97 |
|
DeploymentCreate
¶
Bases: DeprecatedInfraOverridesField
, ActionBaseModel
Data used by the Prefect REST API to create a deployment.
Source code in prefect/client/schemas/actions.py
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 |
|
check_valid_configuration
¶
Check that the combination of base_job_template defaults and job_variables conforms to the specified schema.
Source code in prefect/client/schemas/actions.py
205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 |
|
DeploymentUpdate
¶
Bases: DeprecatedInfraOverridesField
, ActionBaseModel
Data used by the Prefect REST API to update a deployment.
Source code in prefect/client/schemas/actions.py
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 |
|
check_valid_configuration
¶
Check that the combination of base_job_template defaults and job_variables conforms to the specified schema.
Source code in prefect/client/schemas/actions.py
267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 |
|
FlowRunUpdate
¶
Bases: ActionBaseModel
Data used by the Prefect REST API to update a flow run.
Source code in prefect/client/schemas/actions.py
288 289 290 291 292 293 294 295 296 297 298 299 |
|
TaskRunCreate
¶
Bases: ActionBaseModel
Data used by the Prefect REST API to create a task run
Source code in prefect/client/schemas/actions.py
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 |
|
TaskRunUpdate
¶
Bases: ActionBaseModel
Data used by the Prefect REST API to update a task run
Source code in prefect/client/schemas/actions.py
344 345 346 347 |
|
FlowRunCreate
¶
Bases: ActionBaseModel
Data used by the Prefect REST API to create a flow run.
Source code in prefect/client/schemas/actions.py
350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 |
|
DeploymentFlowRunCreate
¶
Bases: ActionBaseModel
Data used by the Prefect REST API to create a flow run from a deployment.
Source code in prefect/client/schemas/actions.py
380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 |
|
SavedSearchCreate
¶
Bases: ActionBaseModel
Data used by the Prefect REST API to create a saved search.
Source code in prefect/client/schemas/actions.py
406 407 408 409 410 411 412 |
|
ConcurrencyLimitCreate
¶
Bases: ActionBaseModel
Data used by the Prefect REST API to create a concurrency limit.
Source code in prefect/client/schemas/actions.py
415 416 417 418 419 420 421 |
|
BlockTypeCreate
¶
Bases: ActionBaseModel
Data used by the Prefect REST API to create a block type.
Source code in prefect/client/schemas/actions.py
424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 |
|
BlockTypeUpdate
¶
Bases: ActionBaseModel
Data used by the Prefect REST API to update a block type.
Source code in prefect/client/schemas/actions.py
450 451 452 453 454 455 456 457 458 459 460 |
|
BlockSchemaCreate
¶
Bases: ActionBaseModel
Data used by the Prefect REST API to create a block schema.
Source code in prefect/client/schemas/actions.py
463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 |
|
BlockDocumentCreate
¶
Bases: ActionBaseModel
Data used by the Prefect REST API to create a block document.
Source code in prefect/client/schemas/actions.py
480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 |
|
BlockDocumentUpdate
¶
Bases: ActionBaseModel
Data used by the Prefect REST API to update a block document.
Source code in prefect/client/schemas/actions.py
512 513 514 515 516 517 518 519 520 521 522 523 524 |
|
BlockDocumentReferenceCreate
¶
Bases: ActionBaseModel
Data used to create block document reference.
Source code in prefect/client/schemas/actions.py
527 528 529 530 531 532 533 534 535 536 537 538 539 |
|
LogCreate
¶
Bases: ActionBaseModel
Data used by the Prefect REST API to create a log.
Source code in prefect/client/schemas/actions.py
542 543 544 545 546 547 548 549 550 |
|
WorkPoolCreate
¶
Bases: ActionBaseModel
Data used by the Prefect REST API to create a work pool.
Source code in prefect/client/schemas/actions.py
553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 |
|
WorkPoolUpdate
¶
Bases: ActionBaseModel
Data used by the Prefect REST API to update a work pool.
Source code in prefect/client/schemas/actions.py
576 577 578 579 580 581 582 |
|
WorkQueueCreate
¶
Bases: ActionBaseModel
Data used by the Prefect REST API to create a work queue.
Source code in prefect/client/schemas/actions.py
585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 |
|
WorkQueueUpdate
¶
Bases: ActionBaseModel
Data used by the Prefect REST API to update a work queue.
Source code in prefect/client/schemas/actions.py
614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 |
|
FlowRunNotificationPolicyCreate
¶
Bases: ActionBaseModel
Data used by the Prefect REST API to create a flow run notification policy.
Source code in prefect/client/schemas/actions.py
635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 |
|
FlowRunNotificationPolicyUpdate
¶
Bases: ActionBaseModel
Data used by the Prefect REST API to update a flow run notification policy.
Source code in prefect/client/schemas/actions.py
669 670 671 672 673 674 675 676 |
|
ArtifactCreate
¶
Bases: ActionBaseModel
Data used by the Prefect REST API to create an artifact.
Source code in prefect/client/schemas/actions.py
679 680 681 682 683 684 685 686 687 688 689 690 691 692 |
|
ArtifactUpdate
¶
Bases: ActionBaseModel
Data used by the Prefect REST API to update an artifact.
Source code in prefect/client/schemas/actions.py
695 696 697 698 699 700 |
|
VariableCreate
¶
Bases: ActionBaseModel
Data used by the Prefect REST API to create a Variable.
Source code in prefect/client/schemas/actions.py
703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 |
|
VariableUpdate
¶
Bases: ActionBaseModel
Data used by the Prefect REST API to update a Variable.
Source code in prefect/client/schemas/actions.py
724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 |
|
GlobalConcurrencyLimitCreate
¶
Bases: ActionBaseModel
Data used by the Prefect REST API to create a global concurrency limit.
Source code in prefect/client/schemas/actions.py
745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 |
|
GlobalConcurrencyLimitUpdate
¶
Bases: ActionBaseModel
Data used by the Prefect REST API to update a global concurrency limit.
Source code in prefect/client/schemas/actions.py
776 777 778 779 780 781 782 783 784 785 786 787 |
|
¶
prefect.client.schemas.filters
¶
Schemas that define Prefect REST API filtering operations.
Operator
¶
Bases: AutoEnum
Operators for combining filter criteria.
Source code in prefect/client/schemas/filters.py
21 22 23 24 25 |
|
OperatorMixin
¶
Base model for Prefect filters that combines criteria with a user-provided operator
Source code in prefect/client/schemas/filters.py
28 29 30 31 32 33 34 |
|
FlowFilterId
¶
Bases: PrefectBaseModel
Filter by Flow.id
.
Source code in prefect/client/schemas/filters.py
37 38 39 40 41 42 |
|
FlowFilterName
¶
Bases: PrefectBaseModel
Filter by Flow.name
.
Source code in prefect/client/schemas/filters.py
45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 |
|
FlowFilterTags
¶
Bases: PrefectBaseModel
, OperatorMixin
Filter by Flow.tags
.
Source code in prefect/client/schemas/filters.py
65 66 67 68 69 70 71 72 73 74 75 76 77 78 |
|
FlowFilter
¶
Bases: PrefectBaseModel
, OperatorMixin
Filter for flows. Only flows matching all criteria will be returned.
Source code in prefect/client/schemas/filters.py
81 82 83 84 85 86 87 88 89 90 91 92 |
|
FlowRunFilterId
¶
Bases: PrefectBaseModel
Filter by FlowRun.id.
Source code in prefect/client/schemas/filters.py
95 96 97 98 99 100 101 102 103 |
|
FlowRunFilterName
¶
Bases: PrefectBaseModel
Filter by FlowRun.name
.
Source code in prefect/client/schemas/filters.py
106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 |
|
FlowRunFilterTags
¶
Bases: PrefectBaseModel
, OperatorMixin
Filter by FlowRun.tags
.
Source code in prefect/client/schemas/filters.py
126 127 128 129 130 131 132 133 134 135 136 137 138 139 |
|
FlowRunFilterDeploymentId
¶
Bases: PrefectBaseModel
, OperatorMixin
Filter by FlowRun.deployment_id
.
Source code in prefect/client/schemas/filters.py
142 143 144 145 146 147 148 149 150 151 |
|
FlowRunFilterWorkQueueName
¶
Bases: PrefectBaseModel
, OperatorMixin
Filter by FlowRun.work_queue_name
.
Source code in prefect/client/schemas/filters.py
154 155 156 157 158 159 160 161 162 163 164 165 |
|
FlowRunFilterStateType
¶
Bases: PrefectBaseModel
Filter by FlowRun.state_type
.
Source code in prefect/client/schemas/filters.py
168 169 170 171 172 173 |
|
FlowRunFilterFlowVersion
¶
Bases: PrefectBaseModel
Filter by FlowRun.flow_version
.
Source code in prefect/client/schemas/filters.py
187 188 189 190 191 192 |
|
FlowRunFilterStartTime
¶
Bases: PrefectBaseModel
Filter by FlowRun.start_time
.
Source code in prefect/client/schemas/filters.py
195 196 197 198 199 200 201 202 203 204 205 206 207 208 |
|
FlowRunFilterExpectedStartTime
¶
Bases: PrefectBaseModel
Filter by FlowRun.expected_start_time
.
Source code in prefect/client/schemas/filters.py
211 212 213 214 215 216 217 218 219 220 221 |
|
FlowRunFilterNextScheduledStartTime
¶
Bases: PrefectBaseModel
Filter by FlowRun.next_scheduled_start_time
.
Source code in prefect/client/schemas/filters.py
224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 |
|
FlowRunFilterParentFlowRunId
¶
Bases: PrefectBaseModel
, OperatorMixin
Filter for subflows of the given flow runs
Source code in prefect/client/schemas/filters.py
243 244 245 246 247 248 |
|
FlowRunFilterParentTaskRunId
¶
Bases: PrefectBaseModel
, OperatorMixin
Filter by FlowRun.parent_task_run_id
.
Source code in prefect/client/schemas/filters.py
251 252 253 254 255 256 257 258 259 260 |
|
FlowRunFilterIdempotencyKey
¶
Bases: PrefectBaseModel
Filter by FlowRun.idempotency_key.
Source code in prefect/client/schemas/filters.py
263 264 265 266 267 268 269 270 271 |
|
FlowRunFilter
¶
Bases: PrefectBaseModel
, OperatorMixin
Filter flow runs. Only flow runs matching all criteria will be returned
Source code in prefect/client/schemas/filters.py
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 |
|
TaskRunFilterFlowRunId
¶
Bases: PrefectBaseModel
Filter by TaskRun.flow_run_id
.
Source code in prefect/client/schemas/filters.py
319 320 321 322 323 324 325 326 327 328 329 |
|
TaskRunFilterId
¶
Bases: PrefectBaseModel
Filter by TaskRun.id
.
Source code in prefect/client/schemas/filters.py
332 333 334 335 336 337 |
|
TaskRunFilterName
¶
Bases: PrefectBaseModel
Filter by TaskRun.name
.
Source code in prefect/client/schemas/filters.py
340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 |
|
TaskRunFilterTags
¶
Bases: PrefectBaseModel
, OperatorMixin
Filter by TaskRun.tags
.
Source code in prefect/client/schemas/filters.py
360 361 362 363 364 365 366 367 368 369 370 371 372 373 |
|
TaskRunFilterStateType
¶
Bases: PrefectBaseModel
Filter by TaskRun.state_type
.
Source code in prefect/client/schemas/filters.py
376 377 378 379 380 381 |
|
TaskRunFilterSubFlowRuns
¶
Bases: PrefectBaseModel
Filter by TaskRun.subflow_run
.
Source code in prefect/client/schemas/filters.py
395 396 397 398 399 400 401 402 403 404 |
|
TaskRunFilterStartTime
¶
Bases: PrefectBaseModel
Filter by TaskRun.start_time
.
Source code in prefect/client/schemas/filters.py
407 408 409 410 411 412 413 414 415 416 417 418 419 420 |
|
TaskRunFilter
¶
Bases: PrefectBaseModel
, OperatorMixin
Filter task runs. Only task runs matching all criteria will be returned
Source code in prefect/client/schemas/filters.py
423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 |
|
DeploymentFilterId
¶
Bases: PrefectBaseModel
Filter by Deployment.id
.
Source code in prefect/client/schemas/filters.py
449 450 451 452 453 454 |
|
DeploymentFilterName
¶
Bases: PrefectBaseModel
Filter by Deployment.name
.
Source code in prefect/client/schemas/filters.py
457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 |
|
DeploymentFilterWorkQueueName
¶
Bases: PrefectBaseModel
Filter by Deployment.work_queue_name
.
Source code in prefect/client/schemas/filters.py
477 478 479 480 481 482 483 484 |
|
DeploymentFilterIsScheduleActive
¶
Bases: PrefectBaseModel
Filter by Deployment.is_schedule_active
.
Source code in prefect/client/schemas/filters.py
487 488 489 490 491 492 493 |
|
DeploymentFilterTags
¶
Bases: PrefectBaseModel
, OperatorMixin
Filter by Deployment.tags
.
Source code in prefect/client/schemas/filters.py
496 497 498 499 500 501 502 503 504 505 506 507 508 509 |
|
DeploymentFilter
¶
Bases: PrefectBaseModel
, OperatorMixin
Filter for deployments. Only deployments matching all criteria will be returned.
Source code in prefect/client/schemas/filters.py
512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 |
|
LogFilterName
¶
Bases: PrefectBaseModel
Filter by Log.name
.
Source code in prefect/client/schemas/filters.py
532 533 534 535 536 537 538 539 |
|
LogFilterLevel
¶
Bases: PrefectBaseModel
Filter by Log.level
.
Source code in prefect/client/schemas/filters.py
542 543 544 545 546 547 548 549 550 551 552 553 554 555 |
|
LogFilterTimestamp
¶
Bases: PrefectBaseModel
Filter by Log.timestamp
.
Source code in prefect/client/schemas/filters.py
558 559 560 561 562 563 564 565 566 567 568 |
|
LogFilterFlowRunId
¶
Bases: PrefectBaseModel
Filter by Log.flow_run_id
.
Source code in prefect/client/schemas/filters.py
571 572 573 574 575 576 |
|
LogFilterTaskRunId
¶
Bases: PrefectBaseModel
Filter by Log.task_run_id
.
Source code in prefect/client/schemas/filters.py
579 580 581 582 583 584 |
|
LogFilter
¶
Bases: PrefectBaseModel
, OperatorMixin
Filter logs. Only logs matching all criteria will be returned
Source code in prefect/client/schemas/filters.py
587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 |
|
FilterSet
¶
Bases: PrefectBaseModel
A collection of filters for common objects
Source code in prefect/client/schemas/filters.py
604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 |
|
BlockTypeFilterName
¶
Bases: PrefectBaseModel
Filter by BlockType.name
Source code in prefect/client/schemas/filters.py
622 623 624 625 626 627 628 629 630 631 632 633 |
|
BlockTypeFilterSlug
¶
Bases: PrefectBaseModel
Filter by BlockType.slug
Source code in prefect/client/schemas/filters.py
636 637 638 639 640 641 |
|
BlockTypeFilter
¶
Bases: PrefectBaseModel
Filter BlockTypes
Source code in prefect/client/schemas/filters.py
644 645 646 647 648 649 650 651 652 653 |
|
BlockSchemaFilterBlockTypeId
¶
Bases: PrefectBaseModel
Filter by BlockSchema.block_type_id
.
Source code in prefect/client/schemas/filters.py
656 657 658 659 660 661 |
|
BlockSchemaFilterId
¶
Bases: PrefectBaseModel
Filter by BlockSchema.id
Source code in prefect/client/schemas/filters.py
664 665 666 667 668 669 |
|
BlockSchemaFilterCapabilities
¶
Bases: PrefectBaseModel
Filter by BlockSchema.capabilities
Source code in prefect/client/schemas/filters.py
672 673 674 675 676 677 678 679 680 681 682 |
|
BlockSchemaFilterVersion
¶
Bases: PrefectBaseModel
Filter by BlockSchema.capabilities
Source code in prefect/client/schemas/filters.py
685 686 687 688 689 690 691 692 |
|
BlockSchemaFilter
¶
Bases: PrefectBaseModel
, OperatorMixin
Filter BlockSchemas
Source code in prefect/client/schemas/filters.py
695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 |
|
BlockDocumentFilterIsAnonymous
¶
Bases: PrefectBaseModel
Filter by BlockDocument.is_anonymous
.
Source code in prefect/client/schemas/filters.py
712 713 714 715 716 717 718 719 720 |
|
BlockDocumentFilterBlockTypeId
¶
Bases: PrefectBaseModel
Filter by BlockDocument.block_type_id
.
Source code in prefect/client/schemas/filters.py
723 724 725 726 727 728 |
|
BlockDocumentFilterId
¶
Bases: PrefectBaseModel
Filter by BlockDocument.id
.
Source code in prefect/client/schemas/filters.py
731 732 733 734 735 736 |
|
BlockDocumentFilterName
¶
Bases: PrefectBaseModel
Filter by BlockDocument.name
.
Source code in prefect/client/schemas/filters.py
739 740 741 742 743 744 745 746 747 748 749 750 751 752 |
|
BlockDocumentFilter
¶
Bases: PrefectBaseModel
, OperatorMixin
Filter BlockDocuments. Only BlockDocuments matching all criteria will be returned
Source code in prefect/client/schemas/filters.py
755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 |
|
FlowRunNotificationPolicyFilterIsActive
¶
Bases: PrefectBaseModel
Filter by FlowRunNotificationPolicy.is_active
.
Source code in prefect/client/schemas/filters.py
777 778 779 780 781 782 783 784 785 |
|
FlowRunNotificationPolicyFilter
¶
Bases: PrefectBaseModel
Filter FlowRunNotificationPolicies.
Source code in prefect/client/schemas/filters.py
788 789 790 791 792 793 794 |
|
WorkQueueFilterId
¶
Bases: PrefectBaseModel
Filter by WorkQueue.id
.
Source code in prefect/client/schemas/filters.py
797 798 799 800 801 802 803 |
|
WorkQueueFilterName
¶
Bases: PrefectBaseModel
Filter by WorkQueue.name
.
Source code in prefect/client/schemas/filters.py
806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 |
|
WorkQueueFilter
¶
Bases: PrefectBaseModel
, OperatorMixin
Filter work queues. Only work queues matching all criteria will be returned
Source code in prefect/client/schemas/filters.py
826 827 828 829 830 831 832 833 834 835 836 |
|
WorkPoolFilterId
¶
Bases: PrefectBaseModel
Filter by WorkPool.id
.
Source code in prefect/client/schemas/filters.py
839 840 841 842 843 844 |
|
WorkPoolFilterName
¶
Bases: PrefectBaseModel
Filter by WorkPool.name
.
Source code in prefect/client/schemas/filters.py
847 848 849 850 851 852 |
|
WorkPoolFilterType
¶
Bases: PrefectBaseModel
Filter by WorkPool.type
.
Source code in prefect/client/schemas/filters.py
855 856 857 858 859 860 |
|
WorkerFilterWorkPoolId
¶
Bases: PrefectBaseModel
Filter by Worker.worker_config_id
.
Source code in prefect/client/schemas/filters.py
875 876 877 878 879 880 |
|
WorkerFilterLastHeartbeatTime
¶
Bases: PrefectBaseModel
Filter by Worker.last_heartbeat_time
.
Source code in prefect/client/schemas/filters.py
883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 |
|
ArtifactFilterId
¶
Bases: PrefectBaseModel
Filter by Artifact.id
.
Source code in prefect/client/schemas/filters.py
911 912 913 914 915 916 |
|
ArtifactFilterKey
¶
Bases: PrefectBaseModel
Filter by Artifact.key
.
Source code in prefect/client/schemas/filters.py
919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 |
|
ArtifactFilterFlowRunId
¶
Bases: PrefectBaseModel
Filter by Artifact.flow_run_id
.
Source code in prefect/client/schemas/filters.py
944 945 946 947 948 949 |
|
ArtifactFilterTaskRunId
¶
Bases: PrefectBaseModel
Filter by Artifact.task_run_id
.
Source code in prefect/client/schemas/filters.py
952 953 954 955 956 957 |
|
ArtifactFilterType
¶
Bases: PrefectBaseModel
Filter by Artifact.type
.
Source code in prefect/client/schemas/filters.py
960 961 962 963 964 965 966 967 968 |
|
ArtifactFilter
¶
Bases: PrefectBaseModel
, OperatorMixin
Filter artifacts. Only artifacts matching all criteria will be returned
Source code in prefect/client/schemas/filters.py
971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 |
|
ArtifactCollectionFilterLatestId
¶
Bases: PrefectBaseModel
Filter by ArtifactCollection.latest_id
.
Source code in prefect/client/schemas/filters.py
991 992 993 994 995 996 |
|
ArtifactCollectionFilterKey
¶
Bases: PrefectBaseModel
Filter by ArtifactCollection.key
.
Source code in prefect/client/schemas/filters.py
999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 |
|
ArtifactCollectionFilterFlowRunId
¶
Bases: PrefectBaseModel
Filter by ArtifactCollection.flow_run_id
.
Source code in prefect/client/schemas/filters.py
1025 1026 1027 1028 1029 1030 |
|
ArtifactCollectionFilterTaskRunId
¶
Bases: PrefectBaseModel
Filter by ArtifactCollection.task_run_id
.
Source code in prefect/client/schemas/filters.py
1033 1034 1035 1036 1037 1038 |
|
ArtifactCollectionFilterType
¶
Bases: PrefectBaseModel
Filter by ArtifactCollection.type
.
Source code in prefect/client/schemas/filters.py
1041 1042 1043 1044 1045 1046 1047 1048 1049 |
|
ArtifactCollectionFilter
¶
Bases: PrefectBaseModel
, OperatorMixin
Filter artifact collections. Only artifact collections matching all criteria will be returned
Source code in prefect/client/schemas/filters.py
1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 |
|
VariableFilterId
¶
Bases: PrefectBaseModel
Filter by Variable.id
.
Source code in prefect/client/schemas/filters.py
1072 1073 1074 1075 1076 1077 |
|
VariableFilterName
¶
Bases: PrefectBaseModel
Filter by Variable.name
.
Source code in prefect/client/schemas/filters.py
1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 |
|
VariableFilterValue
¶
Bases: PrefectBaseModel
Filter by Variable.value
.
Source code in prefect/client/schemas/filters.py
1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 |
|
VariableFilterTags
¶
Bases: PrefectBaseModel
, OperatorMixin
Filter by Variable.tags
.
Source code in prefect/client/schemas/filters.py
1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 |
|
VariableFilter
¶
Bases: PrefectBaseModel
, OperatorMixin
Filter variables. Only variables matching all criteria will be returned
Source code in prefect/client/schemas/filters.py
1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 |
|
¶
prefect.client.schemas.objects
¶
StateType
¶
Bases: AutoEnum
Enumeration of state types.
Source code in prefect/client/schemas/objects.py
80 81 82 83 84 85 86 87 88 89 90 91 |
|
WorkPoolStatus
¶
Bases: AutoEnum
Enumeration of work pool statuses.
Source code in prefect/client/schemas/objects.py
94 95 96 97 98 99 100 101 102 103 |
|
WorkerStatus
¶
Bases: AutoEnum
Enumeration of worker statuses.
Source code in prefect/client/schemas/objects.py
106 107 108 109 110 |
|
DeploymentStatus
¶
Bases: AutoEnum
Enumeration of deployment statuses.
Source code in prefect/client/schemas/objects.py
113 114 115 116 117 |
|
WorkQueueStatus
¶
Bases: AutoEnum
Enumeration of work queue statuses.
Source code in prefect/client/schemas/objects.py
120 121 122 123 124 125 |
|
State
¶
Bases: ObjectBaseModel
, Generic[R]
The state of a run.
Source code in prefect/client/schemas/objects.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 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 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 |
|
result
¶
result
result
Retrieve the result attached to this state.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
raise_on_failure
|
bool
|
a boolean specifying whether to raise an exception
if the state is of type |
True
|
fetch
|
Optional[bool]
|
a boolean specifying whether to resolve references to persisted
results into data. For synchronous users, this defaults to |
None
|
Raises:
Type | Description |
---|---|
TypeError
|
If the state is failed but the result is not an exception. |
Returns:
Type | Description |
---|---|
Union[R, Exception]
|
The result of the run |
Examples:
>>> from prefect import flow, task
>>> @task
>>> def my_task(x):
>>> return x
Get the result from a task future in a flow
>>> @flow
>>> def my_flow():
>>> future = my_task("hello")
>>> state = future.wait()
>>> result = state.result()
>>> print(result)
>>> my_flow()
hello
Get the result from a flow state
>>> @flow
>>> def my_flow():
>>> return "hello"
>>> my_flow(return_state=True).result()
hello
Get the result from a failed state
>>> @flow
>>> def my_flow():
>>> raise ValueError("oh no!")
>>> state = my_flow(return_state=True) # Error is wrapped in FAILED state
>>> state.result() # Raises `ValueError`
Get the result from a failed state without erroring
>>> @flow
>>> def my_flow():
>>> raise ValueError("oh no!")
>>> state = my_flow(return_state=True)
>>> result = state.result(raise_on_failure=False)
>>> print(result)
ValueError("oh no!")
Get the result from a flow state in an async context
>>> @flow
>>> async def my_flow():
>>> return "hello"
>>> state = await my_flow(return_state=True)
>>> await state.result()
hello
Source code in prefect/client/schemas/objects.py
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 |
|
to_state_create
¶
Convert this state to a StateCreate
type which can be used to set the state of
a run in the API.
This method will drop this state's data
if it is not a result type. Only
results should be sent to the API. Other data is only available locally.
Source code in prefect/client/schemas/objects.py
246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 |
|
default_scheduled_start_time
¶
This should throw an error instead of setting a default but is out of
scope for https://github.com/PrefectHQ/orion/pull/174/ and can be rolled into work refactoring state initialization
Source code in prefect/client/schemas/objects.py
269 270 271 272 273 274 275 276 277 278 279 280 281 282 |
|
FlowRunPolicy
¶
Bases: PrefectBaseModel
Defines of how a flow run should be orchestrated.
Source code in prefect/client/schemas/objects.py
384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 |
|
FlowRun
¶
Bases: ObjectBaseModel
Source code in prefect/client/schemas/objects.py
419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 |
|
TaskRunPolicy
¶
Bases: PrefectBaseModel
Defines of how a task run should retry.
Source code in prefect/client/schemas/objects.py
578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 |
|
TaskRunInput
¶
Bases: PrefectBaseModel
Base class for classes that represent inputs to task runs, which could include, constants, parameters, or other task runs.
Source code in prefect/client/schemas/objects.py
619 620 621 622 623 624 625 626 627 628 629 |
|
TaskRunResult
¶
Bases: TaskRunInput
Represents a task run result input to another task run.
Source code in prefect/client/schemas/objects.py
632 633 634 635 636 |
|
Parameter
¶
Bases: TaskRunInput
Represents a parameter input to a task run.
Source code in prefect/client/schemas/objects.py
639 640 641 642 643 |
|
Constant
¶
Bases: TaskRunInput
Represents constant input value to a task run.
Source code in prefect/client/schemas/objects.py
646 647 648 649 650 |
|
Workspace
¶
Bases: PrefectBaseModel
A Prefect Cloud workspace.
Expected payload for each workspace returned by the me/workspaces
route.
Source code in prefect/client/schemas/objects.py
763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 |
|
handle: str
property
¶
The full handle of the workspace as account_handle
/ workspace_handle
api_url
¶
Generate the API URL for accessing this workspace
Source code in prefect/client/schemas/objects.py
788 789 790 791 792 793 794 795 796 |
|
ui_url
¶
Generate the UI URL for accessing this workspace
Source code in prefect/client/schemas/objects.py
798 799 800 801 802 803 804 805 806 |
|
BlockType
¶
Bases: ObjectBaseModel
An ORM representation of a block type
Source code in prefect/client/schemas/objects.py
812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 |
|
BlockDocument
¶
Bases: ObjectBaseModel
An ORM representation of a block document.
Source code in prefect/client/schemas/objects.py
861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 |
|
Flow
¶
Bases: ObjectBaseModel
An ORM representation of flow data.
Source code in prefect/client/schemas/objects.py
904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 |
|
Deployment
¶
Bases: DeprecatedInfraOverridesField
, ObjectBaseModel
An ORM representation of deployment data.
Source code in prefect/client/schemas/objects.py
959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 |
|
ConcurrencyLimit
¶
Bases: ObjectBaseModel
An ORM representation of a concurrency limit.
Source code in prefect/client/schemas/objects.py
1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 |
|
BlockSchema
¶
Bases: ObjectBaseModel
An ORM representation of a block schema.
Source code in prefect/client/schemas/objects.py
1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 |
|
BlockSchemaReference
¶
Bases: ObjectBaseModel
An ORM representation of a block schema reference.
Source code in prefect/client/schemas/objects.py
1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 |
|
BlockDocumentReference
¶
Bases: ObjectBaseModel
An ORM representation of a block document reference.
Source code in prefect/client/schemas/objects.py
1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 |
|
SavedSearchFilter
¶
Bases: PrefectBaseModel
A filter for a saved search model. Intended for use by the Prefect UI.
Source code in prefect/client/schemas/objects.py
1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 |
|
SavedSearch
¶
Bases: ObjectBaseModel
An ORM representation of saved search data. Represents a set of filter criteria.
Source code in prefect/client/schemas/objects.py
1171 1172 1173 1174 1175 1176 1177 |
|
Log
¶
Bases: ObjectBaseModel
An ORM representation of log data.
Source code in prefect/client/schemas/objects.py
1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 |
|
QueueFilter
¶
Bases: PrefectBaseModel
Filter criteria definition for a work queue.
Source code in prefect/client/schemas/objects.py
1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 |
|
WorkQueue
¶
Bases: ObjectBaseModel
An ORM representation of a work queue
Source code in prefect/client/schemas/objects.py
1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 |
|
WorkQueueHealthPolicy
¶
Bases: PrefectBaseModel
Source code in prefect/client/schemas/objects.py
1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 |
|
evaluate_health_status
¶
Given empirical information about the state of the work queue, evaluate its health status.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
late_runs
|
the count of late runs for the work queue. |
required | |
last_polled
|
Optional[DateTimeTZ]
|
the last time the work queue was polled, if available. |
None
|
Returns:
Name | Type | Description |
---|---|---|
bool |
bool
|
whether or not the work queue is healthy. |
Source code in prefect/client/schemas/objects.py
1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 |
|
FlowRunNotificationPolicy
¶
Bases: ObjectBaseModel
An ORM representation of a flow run notification.
Source code in prefect/client/schemas/objects.py
1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 |
|
Agent
¶
Bases: ObjectBaseModel
An ORM representation of an agent
Source code in prefect/client/schemas/objects.py
1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 |
|
WorkPool
¶
Bases: ObjectBaseModel
An ORM representation of a work pool
Source code in prefect/client/schemas/objects.py
1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 |
|
Worker
¶
Bases: ObjectBaseModel
An ORM representation of a worker
Source code in prefect/client/schemas/objects.py
1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 |
|
FlowRunInput
¶
Bases: ObjectBaseModel
Source code in prefect/client/schemas/objects.py
1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 |
|
decoded_value: Any
property
¶
Decode the value of the input.
Returns:
Name | Type | Description |
---|---|---|
Any |
Any
|
the decoded value |
GlobalConcurrencyLimit
¶
Bases: ObjectBaseModel
An ORM representation of a global concurrency limit
Source code in prefect/client/schemas/objects.py
1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 |
|
¶
prefect.client.schemas.responses
¶
SetStateStatus
¶
Bases: AutoEnum
Enumerates return statuses for setting run states.
Source code in prefect/client/schemas/responses.py
25 26 27 28 29 30 31 |
|
StateAcceptDetails
¶
Bases: PrefectBaseModel
Details associated with an ACCEPT state transition.
Source code in prefect/client/schemas/responses.py
34 35 36 37 38 39 40 41 42 43 |
|
StateRejectDetails
¶
Bases: PrefectBaseModel
Details associated with a REJECT state transition.
Source code in prefect/client/schemas/responses.py
46 47 48 49 50 51 52 53 54 55 56 57 58 |
|
StateAbortDetails
¶
Bases: PrefectBaseModel
Details associated with an ABORT state transition.
Source code in prefect/client/schemas/responses.py
61 62 63 64 65 66 67 68 69 70 71 72 73 |
|
StateWaitDetails
¶
Bases: PrefectBaseModel
Details associated with a WAIT state transition.
Source code in prefect/client/schemas/responses.py
76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 |
|
HistoryResponseState
¶
Bases: PrefectBaseModel
Represents a single state's history over an interval.
Source code in prefect/client/schemas/responses.py
98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 |
|
HistoryResponse
¶
Bases: PrefectBaseModel
Represents a history of aggregation states over an interval
Source code in prefect/client/schemas/responses.py
120 121 122 123 124 125 126 127 128 129 130 131 |
|
OrchestrationResult
¶
Bases: PrefectBaseModel
A container for the output of state orchestration.
Source code in prefect/client/schemas/responses.py
139 140 141 142 143 144 145 146 |
|
FlowRunResponse
¶
Bases: ObjectBaseModel
Source code in prefect/client/schemas/responses.py
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 |
|
GlobalConcurrencyLimitResponse
¶
Bases: ObjectBaseModel
A response object for global concurrency limits.
Source code in prefect/client/schemas/responses.py
434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 |
|
¶
prefect.client.schemas.schedules
¶
Schedule schemas
IntervalSchedule
¶
Bases: PrefectBaseModel
A schedule formed by adding interval
increments to an anchor_date
. If no
anchor_date
is supplied, the current UTC time is used. If a
timezone-naive datetime is provided for anchor_date
, it is assumed to be
in the schedule's timezone (or UTC). Even if supplied with an IANA timezone,
anchor dates are always stored as UTC offsets, so a timezone
can be
provided to determine localization behaviors like DST boundary handling. If
none is provided it will be inferred from the anchor date.
NOTE: If the IntervalSchedule
anchor_date
or timezone
is provided in a
DST-observing timezone, then the schedule will adjust itself appropriately.
Intervals greater than 24 hours will follow DST conventions, while intervals
of less than 24 hours will follow UTC intervals. For example, an hourly
schedule will fire every UTC hour, even across DST boundaries. When clocks
are set back, this will result in two runs that appear to both be
scheduled for 1am local time, even though they are an hour apart in UTC
time. For longer intervals, like a daily schedule, the interval schedule
will adjust for DST boundaries so that the clock-hour remains constant. This
means that a daily schedule that always fires at 9am will observe DST and
continue to fire at 9am in the local time zone.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
interval
|
timedelta
|
an interval to schedule on |
required |
anchor_date
|
DateTimeTZ
|
an anchor date to schedule increments against; if not provided, the current timestamp will be used |
required |
timezone
|
str
|
a valid timezone string |
required |
Source code in prefect/client/schemas/schedules.py
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 |
|
CronSchedule
¶
Bases: PrefectBaseModel
Cron schedule
NOTE: If the timezone is a DST-observing one, then the schedule will adjust itself appropriately. Cron's rules for DST are based on schedule times, not intervals. This means that an hourly cron schedule will fire on every new schedule hour, not every elapsed hour; for example, when clocks are set back this will result in a two-hour pause as the schedule will fire the first time 1am is reached and the first time 2am is reached, 120 minutes later. Longer schedules, such as one that fires at 9am every morning, will automatically adjust for DST.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
cron
|
str
|
a valid cron string |
required |
timezone
|
str
|
a valid timezone string in IANA tzdata format (for example, America/New_York). |
required |
day_or
|
bool
|
Control how croniter handles |
required |
Source code in prefect/client/schemas/schedules.py
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 |
|
RRuleSchedule
¶
Bases: PrefectBaseModel
RRule schedule, based on the iCalendar standard
(RFC 5545) as
implemented in dateutils.rrule
.
RRules are appropriate for any kind of calendar-date manipulation, including irregular intervals, repetition, exclusions, week day or day-of-month adjustments, and more.
Note that as a calendar-oriented standard, RRuleSchedules
are sensitive to
to the initial timezone provided. A 9am daily schedule with a daylight saving
time-aware start date will maintain a local 9am time through DST boundaries;
a 9am daily schedule with a UTC start date will maintain a 9am UTC time.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
rrule
|
str
|
a valid RRule string |
required |
timezone
|
str
|
a valid timezone string |
required |
Source code in prefect/client/schemas/schedules.py
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 |
|
to_rrule
¶
Since rrule doesn't properly serialize/deserialize timezones, we localize dates here
Source code in prefect/client/schemas/schedules.py
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 |
|
construct_schedule
¶
Construct a schedule from the provided arguments.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
interval
|
Optional[Union[int, float, timedelta]]
|
An interval on which to schedule runs. Accepts either a number or a timedelta object. If a number is given, it will be interpreted as seconds. |
None
|
anchor_date
|
Optional[Union[datetime, str]]
|
The start date for an interval schedule. |
None
|
cron
|
Optional[str]
|
A cron schedule for runs. |
None
|
rrule
|
Optional[str]
|
An rrule schedule of when to execute runs of this flow. |
None
|
timezone
|
Optional[str]
|
A timezone to use for the schedule. Defaults to UTC. |
None
|
Source code in prefect/client/schemas/schedules.py
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 |
|
¶
prefect.client.schemas.sorting
¶
FlowRunSort
¶
Bases: AutoEnum
Defines flow run sorting options.
Source code in prefect/client/schemas/sorting.py
4 5 6 7 8 9 10 11 12 13 14 15 |
|
TaskRunSort
¶
Bases: AutoEnum
Defines task run sorting options.
Source code in prefect/client/schemas/sorting.py
18 19 20 21 22 23 24 25 26 27 |
|
AutomationSort
¶
Bases: AutoEnum
Defines automation sorting options.
Source code in prefect/client/schemas/sorting.py
30 31 32 33 34 35 36 |
|
LogSort
¶
Bases: AutoEnum
Defines log sorting options.
Source code in prefect/client/schemas/sorting.py
39 40 41 42 43 |
|
FlowSort
¶
Bases: AutoEnum
Defines flow sorting options.
Source code in prefect/client/schemas/sorting.py
46 47 48 49 50 51 52 |
|
DeploymentSort
¶
Bases: AutoEnum
Defines deployment sorting options.
Source code in prefect/client/schemas/sorting.py
55 56 57 58 59 60 61 |
|
ArtifactSort
¶
Bases: AutoEnum
Defines artifact sorting options.
Source code in prefect/client/schemas/sorting.py
64 65 66 67 68 69 70 71 |
|
ArtifactCollectionSort
¶
Bases: AutoEnum
Defines artifact collection sorting options.
Source code in prefect/client/schemas/sorting.py
74 75 76 77 78 79 80 81 |
|
VariableSort
¶
Bases: AutoEnum
Defines variables sorting options.
Source code in prefect/client/schemas/sorting.py
84 85 86 87 88 89 90 |
|
BlockDocumentSort
¶
Bases: AutoEnum
Defines block document sorting options.
Source code in prefect/client/schemas/sorting.py
93 94 95 96 97 98 |
|