prefect.server.schemas.actions
¶
Reduced schemas for accepting API actions.
ArtifactCreate
¶
Bases: ActionBaseModel
Data used by the Prefect REST API to create an artifact.
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/server/schemas/actions.py
687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 |
|
json
¶
Returns a representation of the model as JSON.
If include_secrets=True
, then SecretStr
and SecretBytes
objects are
fully revealed. Otherwise they are obfuscated.
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/_internal/schemas/bases.py
85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 |
|
subclass
classmethod
¶
Creates a subclass of this model containing only the specified fields.
See pydantic_subclass()
.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
name |
str
|
a name for the subclass |
None
|
include_fields |
List[str]
|
fields to include |
None
|
exclude_fields |
List[str]
|
fields to exclude |
None
|
Returns:
Name | Type | Description |
---|---|---|
BaseModel |
Type[B]
|
a subclass of this class |
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/server/utilities/schemas.py
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 |
|
ArtifactUpdate
¶
Bases: ActionBaseModel
Data used by the Prefect REST API to update an artifact.
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/server/schemas/actions.py
704 705 706 707 708 709 710 |
|
json
¶
Returns a representation of the model as JSON.
If include_secrets=True
, then SecretStr
and SecretBytes
objects are
fully revealed. Otherwise they are obfuscated.
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/_internal/schemas/bases.py
85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 |
|
subclass
classmethod
¶
Creates a subclass of this model containing only the specified fields.
See pydantic_subclass()
.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
name |
str
|
a name for the subclass |
None
|
include_fields |
List[str]
|
fields to include |
None
|
exclude_fields |
List[str]
|
fields to exclude |
None
|
Returns:
Name | Type | Description |
---|---|---|
BaseModel |
Type[B]
|
a subclass of this class |
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/server/utilities/schemas.py
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 |
|
BlockDocumentCreate
¶
Bases: ActionBaseModel
Data used by the Prefect REST API to create a block document.
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/server/schemas/actions.py
503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 |
|
json
¶
Returns a representation of the model as JSON.
If include_secrets=True
, then SecretStr
and SecretBytes
objects are
fully revealed. Otherwise they are obfuscated.
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/_internal/schemas/bases.py
85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 |
|
subclass
classmethod
¶
Creates a subclass of this model containing only the specified fields.
See pydantic_subclass()
.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
name |
str
|
a name for the subclass |
None
|
include_fields |
List[str]
|
fields to include |
None
|
exclude_fields |
List[str]
|
fields to exclude |
None
|
Returns:
Name | Type | Description |
---|---|---|
BaseModel |
Type[B]
|
a subclass of this class |
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/server/utilities/schemas.py
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 |
|
BlockDocumentReferenceCreate
¶
Bases: ActionBaseModel
Data used to create block document reference.
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/server/schemas/actions.py
536 537 538 539 540 541 542 543 |
|
json
¶
Returns a representation of the model as JSON.
If include_secrets=True
, then SecretStr
and SecretBytes
objects are
fully revealed. Otherwise they are obfuscated.
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/_internal/schemas/bases.py
85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 |
|
subclass
classmethod
¶
Creates a subclass of this model containing only the specified fields.
See pydantic_subclass()
.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
name |
str
|
a name for the subclass |
None
|
include_fields |
List[str]
|
fields to include |
None
|
exclude_fields |
List[str]
|
fields to exclude |
None
|
Returns:
Name | Type | Description |
---|---|---|
BaseModel |
Type[B]
|
a subclass of this class |
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/server/utilities/schemas.py
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 |
|
BlockDocumentUpdate
¶
Bases: ActionBaseModel
Data used by the Prefect REST API to update a block document.
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/server/schemas/actions.py
525 526 527 528 529 530 531 532 533 |
|
json
¶
Returns a representation of the model as JSON.
If include_secrets=True
, then SecretStr
and SecretBytes
objects are
fully revealed. Otherwise they are obfuscated.
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/_internal/schemas/bases.py
85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 |
|
subclass
classmethod
¶
Creates a subclass of this model containing only the specified fields.
See pydantic_subclass()
.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
name |
str
|
a name for the subclass |
None
|
include_fields |
List[str]
|
fields to include |
None
|
exclude_fields |
List[str]
|
fields to exclude |
None
|
Returns:
Name | Type | Description |
---|---|---|
BaseModel |
Type[B]
|
a subclass of this class |
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/server/utilities/schemas.py
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 |
|
BlockSchemaCreate
¶
Bases: ActionBaseModel
Data used by the Prefect REST API to create a block schema.
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/server/schemas/actions.py
493 494 495 496 497 498 499 500 |
|
json
¶
Returns a representation of the model as JSON.
If include_secrets=True
, then SecretStr
and SecretBytes
objects are
fully revealed. Otherwise they are obfuscated.
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/_internal/schemas/bases.py
85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 |
|
subclass
classmethod
¶
Creates a subclass of this model containing only the specified fields.
See pydantic_subclass()
.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
name |
str
|
a name for the subclass |
None
|
include_fields |
List[str]
|
fields to include |
None
|
exclude_fields |
List[str]
|
fields to exclude |
None
|
Returns:
Name | Type | Description |
---|---|---|
BaseModel |
Type[B]
|
a subclass of this class |
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/server/utilities/schemas.py
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 |
|
BlockTypeCreate
¶
Bases: ActionBaseModel
Data used by the Prefect REST API to create a block type.
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/server/schemas/actions.py
458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 |
|
json
¶
Returns a representation of the model as JSON.
If include_secrets=True
, then SecretStr
and SecretBytes
objects are
fully revealed. Otherwise they are obfuscated.
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/_internal/schemas/bases.py
85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 |
|
subclass
classmethod
¶
Creates a subclass of this model containing only the specified fields.
See pydantic_subclass()
.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
name |
str
|
a name for the subclass |
None
|
include_fields |
List[str]
|
fields to include |
None
|
exclude_fields |
List[str]
|
fields to exclude |
None
|
Returns:
Name | Type | Description |
---|---|---|
BaseModel |
Type[B]
|
a subclass of this class |
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/server/utilities/schemas.py
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 |
|
BlockTypeUpdate
¶
Bases: ActionBaseModel
Data used by the Prefect REST API to update a block type.
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/server/schemas/actions.py
477 478 479 480 481 482 483 484 485 486 487 488 489 490 |
|
json
¶
Returns a representation of the model as JSON.
If include_secrets=True
, then SecretStr
and SecretBytes
objects are
fully revealed. Otherwise they are obfuscated.
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/_internal/schemas/bases.py
85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 |
|
subclass
classmethod
¶
Creates a subclass of this model containing only the specified fields.
See pydantic_subclass()
.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
name |
str
|
a name for the subclass |
None
|
include_fields |
List[str]
|
fields to include |
None
|
exclude_fields |
List[str]
|
fields to exclude |
None
|
Returns:
Name | Type | Description |
---|---|---|
BaseModel |
Type[B]
|
a subclass of this class |
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/server/utilities/schemas.py
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 |
|
ConcurrencyLimitCreate
¶
Bases: ActionBaseModel
Data used by the Prefect REST API to create a concurrency limit.
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/server/schemas/actions.py
426 427 428 429 430 431 |
|
json
¶
Returns a representation of the model as JSON.
If include_secrets=True
, then SecretStr
and SecretBytes
objects are
fully revealed. Otherwise they are obfuscated.
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/_internal/schemas/bases.py
85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 |
|
subclass
classmethod
¶
Creates a subclass of this model containing only the specified fields.
See pydantic_subclass()
.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
name |
str
|
a name for the subclass |
None
|
include_fields |
List[str]
|
fields to include |
None
|
exclude_fields |
List[str]
|
fields to exclude |
None
|
Returns:
Name | Type | Description |
---|---|---|
BaseModel |
Type[B]
|
a subclass of this class |
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/server/utilities/schemas.py
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 |
|
ConcurrencyLimitV2Create
¶
Bases: ActionBaseModel
Data used by the Prefect REST API to create a v2 concurrency limit.
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/server/schemas/actions.py
434 435 436 437 438 439 440 441 442 443 |
|
json
¶
Returns a representation of the model as JSON.
If include_secrets=True
, then SecretStr
and SecretBytes
objects are
fully revealed. Otherwise they are obfuscated.
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/_internal/schemas/bases.py
85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 |
|
subclass
classmethod
¶
Creates a subclass of this model containing only the specified fields.
See pydantic_subclass()
.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
name |
str
|
a name for the subclass |
None
|
include_fields |
List[str]
|
fields to include |
None
|
exclude_fields |
List[str]
|
fields to exclude |
None
|
Returns:
Name | Type | Description |
---|---|---|
BaseModel |
Type[B]
|
a subclass of this class |
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/server/utilities/schemas.py
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 |
|
ConcurrencyLimitV2Update
¶
Bases: ActionBaseModel
Data used by the Prefect REST API to update a v2 concurrency limit.
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/server/schemas/actions.py
446 447 448 449 450 451 452 453 454 455 |
|
json
¶
Returns a representation of the model as JSON.
If include_secrets=True
, then SecretStr
and SecretBytes
objects are
fully revealed. Otherwise they are obfuscated.
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/_internal/schemas/bases.py
85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 |
|
subclass
classmethod
¶
Creates a subclass of this model containing only the specified fields.
See pydantic_subclass()
.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
name |
str
|
a name for the subclass |
None
|
include_fields |
List[str]
|
fields to include |
None
|
exclude_fields |
List[str]
|
fields to exclude |
None
|
Returns:
Name | Type | Description |
---|---|---|
BaseModel |
Type[B]
|
a subclass of this class |
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/server/utilities/schemas.py
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 |
|
DeploymentCreate
¶
Bases: ActionBaseModel
Data used by the Prefect REST API to create a deployment.
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/server/schemas/actions.py
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 |
|
check_valid_configuration
¶
Check that the combination of base_job_template defaults and infra_overrides conforms to the specified schema.
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/server/schemas/actions.py
163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 |
|
json
¶
Returns a representation of the model as JSON.
If include_secrets=True
, then SecretStr
and SecretBytes
objects are
fully revealed. Otherwise they are obfuscated.
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/_internal/schemas/bases.py
85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 |
|
subclass
classmethod
¶
Creates a subclass of this model containing only the specified fields.
See pydantic_subclass()
.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
name |
str
|
a name for the subclass |
None
|
include_fields |
List[str]
|
fields to include |
None
|
exclude_fields |
List[str]
|
fields to exclude |
None
|
Returns:
Name | Type | Description |
---|---|---|
BaseModel |
Type[B]
|
a subclass of this class |
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/server/utilities/schemas.py
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 |
|
DeploymentFlowRunCreate
¶
Bases: ActionBaseModel
Data used by the Prefect REST API to create a flow run from a deployment.
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/server/schemas/actions.py
398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 |
|
json
¶
Returns a representation of the model as JSON.
If include_secrets=True
, then SecretStr
and SecretBytes
objects are
fully revealed. Otherwise they are obfuscated.
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/_internal/schemas/bases.py
85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 |
|
subclass
classmethod
¶
Creates a subclass of this model containing only the specified fields.
See pydantic_subclass()
.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
name |
str
|
a name for the subclass |
None
|
include_fields |
List[str]
|
fields to include |
None
|
exclude_fields |
List[str]
|
fields to exclude |
None
|
Returns:
Name | Type | Description |
---|---|---|
BaseModel |
Type[B]
|
a subclass of this class |
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/server/utilities/schemas.py
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 |
|
DeploymentUpdate
¶
Bases: ActionBaseModel
Data used by the Prefect REST API to update a deployment.
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/server/schemas/actions.py
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 |
|
check_valid_configuration
¶
Check that the combination of base_job_template defaults and infra_overrides conforms to the specified schema.
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/server/schemas/actions.py
271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 |
|
json
¶
Returns a representation of the model as JSON.
If include_secrets=True
, then SecretStr
and SecretBytes
objects are
fully revealed. Otherwise they are obfuscated.
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/_internal/schemas/bases.py
85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 |
|
subclass
classmethod
¶
Creates a subclass of this model containing only the specified fields.
See pydantic_subclass()
.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
name |
str
|
a name for the subclass |
None
|
include_fields |
List[str]
|
fields to include |
None
|
exclude_fields |
List[str]
|
fields to exclude |
None
|
Returns:
Name | Type | Description |
---|---|---|
BaseModel |
Type[B]
|
a subclass of this class |
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/server/utilities/schemas.py
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 |
|
FlowCreate
¶
Bases: ActionBaseModel
Data used by the Prefect REST API to create a flow.
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/server/schemas/actions.py
77 78 79 80 81 82 |
|
json
¶
Returns a representation of the model as JSON.
If include_secrets=True
, then SecretStr
and SecretBytes
objects are
fully revealed. Otherwise they are obfuscated.
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/_internal/schemas/bases.py
85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 |
|
subclass
classmethod
¶
Creates a subclass of this model containing only the specified fields.
See pydantic_subclass()
.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
name |
str
|
a name for the subclass |
None
|
include_fields |
List[str]
|
fields to include |
None
|
exclude_fields |
List[str]
|
fields to exclude |
None
|
Returns:
Name | Type | Description |
---|---|---|
BaseModel |
Type[B]
|
a subclass of this class |
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/server/utilities/schemas.py
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 |
|
FlowRunCreate
¶
Bases: ActionBaseModel
Data used by the Prefect REST API to create a flow run.
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/server/schemas/actions.py
363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 |
|
json
¶
Returns a representation of the model as JSON.
If include_secrets=True
, then SecretStr
and SecretBytes
objects are
fully revealed. Otherwise they are obfuscated.
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/_internal/schemas/bases.py
85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 |
|
subclass
classmethod
¶
Creates a subclass of this model containing only the specified fields.
See pydantic_subclass()
.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
name |
str
|
a name for the subclass |
None
|
include_fields |
List[str]
|
fields to include |
None
|
exclude_fields |
List[str]
|
fields to exclude |
None
|
Returns:
Name | Type | Description |
---|---|---|
BaseModel |
Type[B]
|
a subclass of this class |
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/server/utilities/schemas.py
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 |
|
FlowRunNotificationPolicyCreate
¶
Bases: ActionBaseModel
Data used by the Prefect REST API to create a flow run notification policy.
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/server/schemas/actions.py
663 664 665 666 667 668 669 670 671 |
|
json
¶
Returns a representation of the model as JSON.
If include_secrets=True
, then SecretStr
and SecretBytes
objects are
fully revealed. Otherwise they are obfuscated.
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/_internal/schemas/bases.py
85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 |
|
subclass
classmethod
¶
Creates a subclass of this model containing only the specified fields.
See pydantic_subclass()
.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
name |
str
|
a name for the subclass |
None
|
include_fields |
List[str]
|
fields to include |
None
|
exclude_fields |
List[str]
|
fields to exclude |
None
|
Returns:
Name | Type | Description |
---|---|---|
BaseModel |
Type[B]
|
a subclass of this class |
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/server/utilities/schemas.py
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 |
|
FlowRunNotificationPolicyUpdate
¶
Bases: ActionBaseModel
Data used by the Prefect REST API to update a flow run notification policy.
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/server/schemas/actions.py
674 675 676 677 678 679 680 681 682 683 684 |
|
json
¶
Returns a representation of the model as JSON.
If include_secrets=True
, then SecretStr
and SecretBytes
objects are
fully revealed. Otherwise they are obfuscated.
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/_internal/schemas/bases.py
85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 |
|
subclass
classmethod
¶
Creates a subclass of this model containing only the specified fields.
See pydantic_subclass()
.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
name |
str
|
a name for the subclass |
None
|
include_fields |
List[str]
|
fields to include |
None
|
exclude_fields |
List[str]
|
fields to exclude |
None
|
Returns:
Name | Type | Description |
---|---|---|
BaseModel |
Type[B]
|
a subclass of this class |
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/server/utilities/schemas.py
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 |
|
FlowRunUpdate
¶
Bases: ActionBaseModel
Data used by the Prefect REST API to update a flow run.
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/server/schemas/actions.py
292 293 294 295 296 297 298 299 300 301 |
|
json
¶
Returns a representation of the model as JSON.
If include_secrets=True
, then SecretStr
and SecretBytes
objects are
fully revealed. Otherwise they are obfuscated.
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/_internal/schemas/bases.py
85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 |
|
subclass
classmethod
¶
Creates a subclass of this model containing only the specified fields.
See pydantic_subclass()
.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
name |
str
|
a name for the subclass |
None
|
include_fields |
List[str]
|
fields to include |
None
|
exclude_fields |
List[str]
|
fields to exclude |
None
|
Returns:
Name | Type | Description |
---|---|---|
BaseModel |
Type[B]
|
a subclass of this class |
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/server/utilities/schemas.py
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 |
|
FlowUpdate
¶
Bases: ActionBaseModel
Data used by the Prefect REST API to update a flow.
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/server/schemas/actions.py
85 86 87 88 89 |
|
json
¶
Returns a representation of the model as JSON.
If include_secrets=True
, then SecretStr
and SecretBytes
objects are
fully revealed. Otherwise they are obfuscated.
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/_internal/schemas/bases.py
85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 |
|
subclass
classmethod
¶
Creates a subclass of this model containing only the specified fields.
See pydantic_subclass()
.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
name |
str
|
a name for the subclass |
None
|
include_fields |
List[str]
|
fields to include |
None
|
exclude_fields |
List[str]
|
fields to exclude |
None
|
Returns:
Name | Type | Description |
---|---|---|
BaseModel |
Type[B]
|
a subclass of this class |
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/server/utilities/schemas.py
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 |
|
LogCreate
¶
Bases: ActionBaseModel
Data used by the Prefect REST API to create a log.
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/server/schemas/actions.py
546 547 548 549 550 551 552 553 554 555 |
|
json
¶
Returns a representation of the model as JSON.
If include_secrets=True
, then SecretStr
and SecretBytes
objects are
fully revealed. Otherwise they are obfuscated.
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/_internal/schemas/bases.py
85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 |
|
subclass
classmethod
¶
Creates a subclass of this model containing only the specified fields.
See pydantic_subclass()
.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
name |
str
|
a name for the subclass |
None
|
include_fields |
List[str]
|
fields to include |
None
|
exclude_fields |
List[str]
|
fields to exclude |
None
|
Returns:
Name | Type | Description |
---|---|---|
BaseModel |
Type[B]
|
a subclass of this class |
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/server/utilities/schemas.py
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 |
|
SavedSearchCreate
¶
Bases: ActionBaseModel
Data used by the Prefect REST API to create a saved search.
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/server/schemas/actions.py
418 419 420 421 422 423 |
|
json
¶
Returns a representation of the model as JSON.
If include_secrets=True
, then SecretStr
and SecretBytes
objects are
fully revealed. Otherwise they are obfuscated.
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/_internal/schemas/bases.py
85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 |
|
subclass
classmethod
¶
Creates a subclass of this model containing only the specified fields.
See pydantic_subclass()
.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
name |
str
|
a name for the subclass |
None
|
include_fields |
List[str]
|
fields to include |
None
|
exclude_fields |
List[str]
|
fields to exclude |
None
|
Returns:
Name | Type | Description |
---|---|---|
BaseModel |
Type[B]
|
a subclass of this class |
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/server/utilities/schemas.py
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 |
|
StateCreate
¶
Bases: ActionBaseModel
Data used by the Prefect REST API to create a new state.
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/server/schemas/actions.py
304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 |
|
json
¶
Returns a representation of the model as JSON.
If include_secrets=True
, then SecretStr
and SecretBytes
objects are
fully revealed. Otherwise they are obfuscated.
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/_internal/schemas/bases.py
85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 |
|
subclass
classmethod
¶
Creates a subclass of this model containing only the specified fields.
See pydantic_subclass()
.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
name |
str
|
a name for the subclass |
None
|
include_fields |
List[str]
|
fields to include |
None
|
exclude_fields |
List[str]
|
fields to exclude |
None
|
Returns:
Name | Type | Description |
---|---|---|
BaseModel |
Type[B]
|
a subclass of this class |
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/server/utilities/schemas.py
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 |
|
TaskRunCreate
¶
Bases: ActionBaseModel
Data used by the Prefect REST API to create a task run
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/server/schemas/actions.py
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 |
|
json
¶
Returns a representation of the model as JSON.
If include_secrets=True
, then SecretStr
and SecretBytes
objects are
fully revealed. Otherwise they are obfuscated.
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/_internal/schemas/bases.py
85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 |
|
subclass
classmethod
¶
Creates a subclass of this model containing only the specified fields.
See pydantic_subclass()
.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
name |
str
|
a name for the subclass |
None
|
include_fields |
List[str]
|
fields to include |
None
|
exclude_fields |
List[str]
|
fields to exclude |
None
|
Returns:
Name | Type | Description |
---|---|---|
BaseModel |
Type[B]
|
a subclass of this class |
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/server/utilities/schemas.py
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 |
|
TaskRunUpdate
¶
Bases: ActionBaseModel
Data used by the Prefect REST API to update a task run
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/server/schemas/actions.py
356 357 358 359 360 |
|
json
¶
Returns a representation of the model as JSON.
If include_secrets=True
, then SecretStr
and SecretBytes
objects are
fully revealed. Otherwise they are obfuscated.
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/_internal/schemas/bases.py
85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 |
|
subclass
classmethod
¶
Creates a subclass of this model containing only the specified fields.
See pydantic_subclass()
.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
name |
str
|
a name for the subclass |
None
|
include_fields |
List[str]
|
fields to include |
None
|
exclude_fields |
List[str]
|
fields to exclude |
None
|
Returns:
Name | Type | Description |
---|---|---|
BaseModel |
Type[B]
|
a subclass of this class |
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/server/utilities/schemas.py
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 |
|
VariableCreate
¶
Bases: ActionBaseModel
Data used by the Prefect REST API to create a Variable.
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/server/schemas/actions.py
713 714 715 716 717 718 719 720 721 722 |
|
json
¶
Returns a representation of the model as JSON.
If include_secrets=True
, then SecretStr
and SecretBytes
objects are
fully revealed. Otherwise they are obfuscated.
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/_internal/schemas/bases.py
85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 |
|
subclass
classmethod
¶
Creates a subclass of this model containing only the specified fields.
See pydantic_subclass()
.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
name |
str
|
a name for the subclass |
None
|
include_fields |
List[str]
|
fields to include |
None
|
exclude_fields |
List[str]
|
fields to exclude |
None
|
Returns:
Name | Type | Description |
---|---|---|
BaseModel |
Type[B]
|
a subclass of this class |
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/server/utilities/schemas.py
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 |
|
VariableUpdate
¶
Bases: ActionBaseModel
Data used by the Prefect REST API to update a Variable.
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/server/schemas/actions.py
725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 |
|
json
¶
Returns a representation of the model as JSON.
If include_secrets=True
, then SecretStr
and SecretBytes
objects are
fully revealed. Otherwise they are obfuscated.
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/_internal/schemas/bases.py
85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 |
|
subclass
classmethod
¶
Creates a subclass of this model containing only the specified fields.
See pydantic_subclass()
.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
name |
str
|
a name for the subclass |
None
|
include_fields |
List[str]
|
fields to include |
None
|
exclude_fields |
List[str]
|
fields to exclude |
None
|
Returns:
Name | Type | Description |
---|---|---|
BaseModel |
Type[B]
|
a subclass of this class |
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/server/utilities/schemas.py
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 |
|
WorkPoolCreate
¶
Bases: ActionBaseModel
Data used by the Prefect REST API to create a work pool.
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/server/schemas/actions.py
589 590 591 592 593 594 595 596 597 598 599 600 601 602 |
|
json
¶
Returns a representation of the model as JSON.
If include_secrets=True
, then SecretStr
and SecretBytes
objects are
fully revealed. Otherwise they are obfuscated.
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/_internal/schemas/bases.py
85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 |
|
subclass
classmethod
¶
Creates a subclass of this model containing only the specified fields.
See pydantic_subclass()
.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
name |
str
|
a name for the subclass |
None
|
include_fields |
List[str]
|
fields to include |
None
|
exclude_fields |
List[str]
|
fields to exclude |
None
|
Returns:
Name | Type | Description |
---|---|---|
BaseModel |
Type[B]
|
a subclass of this class |
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/server/utilities/schemas.py
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 |
|
WorkPoolUpdate
¶
Bases: ActionBaseModel
Data used by the Prefect REST API to update a work pool.
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/server/schemas/actions.py
605 606 607 608 609 610 611 612 613 614 615 616 |
|
json
¶
Returns a representation of the model as JSON.
If include_secrets=True
, then SecretStr
and SecretBytes
objects are
fully revealed. Otherwise they are obfuscated.
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/_internal/schemas/bases.py
85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 |
|
subclass
classmethod
¶
Creates a subclass of this model containing only the specified fields.
See pydantic_subclass()
.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
name |
str
|
a name for the subclass |
None
|
include_fields |
List[str]
|
fields to include |
None
|
exclude_fields |
List[str]
|
fields to exclude |
None
|
Returns:
Name | Type | Description |
---|---|---|
BaseModel |
Type[B]
|
a subclass of this class |
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/server/utilities/schemas.py
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 |
|
WorkQueueCreate
¶
Bases: ActionBaseModel
Data used by the Prefect REST API to create a work queue.
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/server/schemas/actions.py
619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 |
|
json
¶
Returns a representation of the model as JSON.
If include_secrets=True
, then SecretStr
and SecretBytes
objects are
fully revealed. Otherwise they are obfuscated.
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/_internal/schemas/bases.py
85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 |
|
subclass
classmethod
¶
Creates a subclass of this model containing only the specified fields.
See pydantic_subclass()
.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
name |
str
|
a name for the subclass |
None
|
include_fields |
List[str]
|
fields to include |
None
|
exclude_fields |
List[str]
|
fields to exclude |
None
|
Returns:
Name | Type | Description |
---|---|---|
BaseModel |
Type[B]
|
a subclass of this class |
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/server/utilities/schemas.py
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 |
|
WorkQueueUpdate
¶
Bases: ActionBaseModel
Data used by the Prefect REST API to update a work queue.
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/server/schemas/actions.py
643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 |
|
json
¶
Returns a representation of the model as JSON.
If include_secrets=True
, then SecretStr
and SecretBytes
objects are
fully revealed. Otherwise they are obfuscated.
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/_internal/schemas/bases.py
85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 |
|
subclass
classmethod
¶
Creates a subclass of this model containing only the specified fields.
See pydantic_subclass()
.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
name |
str
|
a name for the subclass |
None
|
include_fields |
List[str]
|
fields to include |
None
|
exclude_fields |
List[str]
|
fields to exclude |
None
|
Returns:
Name | Type | Description |
---|---|---|
BaseModel |
Type[B]
|
a subclass of this class |
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/server/utilities/schemas.py
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 |
|