prefect.events
¶
TriggerTypes: TypeAlias = Union[EventTrigger, MetricTrigger, CompoundTrigger, SequenceTrigger]
module-attribute
¶
The union of all concrete trigger types that a user may actually create
Action
¶
Bases: PrefectBaseModel
, ABC
An Action that may be performed when an Automation is triggered
Source code in prefect/events/actions.py
18 19 20 21 22 23 24 25 |
|
describe_for_cli
¶
A human-readable description of the action
Source code in prefect/events/actions.py
23 24 25 |
|
AutomationCore
¶
Bases: PrefectBaseModel
Defines an action a user wants to take when a certain number of events do or don't happen to the matching resources
Source code in prefect/events/schemas/automations.py
394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 |
|
CallWebhook
¶
Bases: Action
Call a webhook when an Automation is triggered.
Source code in prefect/events/actions.py
128 129 130 131 132 133 134 135 136 137 138 |
|
CancelFlowRun
¶
Bases: Action
Cancels a flow run associated with the trigger
Source code in prefect/events/actions.py
116 117 118 119 |
|
ChangeFlowRunState
¶
Bases: Action
Changes the state of a flow run associated with the trigger
Source code in prefect/events/actions.py
97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 |
|
CompositeTrigger
¶
Bases: Trigger
, ABC
Requires some number of triggers to have fired within the given time period.
Source code in prefect/events/schemas/automations.py
312 313 314 315 316 317 318 319 |
|
CompoundTrigger
¶
Bases: CompositeTrigger
A composite trigger that requires some number of triggers to have fired within the given time period
Source code in prefect/events/schemas/automations.py
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 |
|
describe_for_cli
¶
Return a human-readable description of this trigger for the CLI
Source code in prefect/events/schemas/automations.py
343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 |
|
DeclareIncident
¶
Bases: Action
Declares an incident for the triggering event. Only available on Prefect Cloud
Source code in prefect/events/actions.py
268 269 270 271 |
|
DeploymentCompoundTrigger
¶
Bases: BaseDeploymentTrigger
, CompoundTrigger
A composite trigger that requires some number of triggers to have fired within the given time period
Source code in prefect/events/schemas/deployment_triggers.py
100 101 102 103 104 |
|
DeploymentEventTrigger
¶
Bases: BaseDeploymentTrigger
, EventTrigger
A trigger that fires based on the presence or absence of events within a given period of time.
Source code in prefect/events/schemas/deployment_triggers.py
83 84 85 86 87 88 89 |
|
DeploymentMetricTrigger
¶
Bases: BaseDeploymentTrigger
, MetricTrigger
A trigger that fires based on the results of a metric query.
Source code in prefect/events/schemas/deployment_triggers.py
92 93 94 95 96 97 |
|
DeploymentSequenceTrigger
¶
Bases: BaseDeploymentTrigger
, SequenceTrigger
A composite trigger that requires some number of triggers to have fired within the given time period in a specific order
Source code in prefect/events/schemas/deployment_triggers.py
107 108 109 110 111 |
|
DoNothing
¶
Bases: Action
Do nothing when an Automation is triggered
Source code in prefect/events/actions.py
28 29 30 31 |
|
Event
¶
Bases: PrefectBaseModel
The client-side view of an event that has happened to a Resource
Source code in prefect/events/schemas/events.py
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 |
|
resource_in_role: Mapping[str, RelatedResource]
property
¶
Returns a mapping of roles to the first related resource in that role
resources_in_role: Mapping[str, Sequence[RelatedResource]]
property
¶
Returns a mapping of roles to related resources in that role
find_resource_label
¶
Finds the value of the given label in this event's resource or one of its
related resources. If the label starts with related:<role>:
, search for the
first matching label in a related resource with that role.
Source code in prefect/events/schemas/events.py
167 168 169 170 171 172 173 174 175 176 177 |
|
EventTrigger
¶
Bases: ResourceTrigger
A trigger that fires based on the presence or absence of events within a given period of time.
Source code in prefect/events/schemas/automations.py
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 |
|
describe_for_cli
¶
Return a human-readable description of this trigger for the CLI
Source code in prefect/events/schemas/automations.py
201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 |
|
MetricTrigger
¶
Bases: ResourceTrigger
A trigger that fires based on the results of a metric query.
Source code in prefect/events/schemas/automations.py
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 |
|
describe_for_cli
¶
Return a human-readable description of this trigger for the CLI
Source code in prefect/events/schemas/automations.py
299 300 301 302 303 304 305 306 307 308 309 |
|
MetricTriggerQuery
¶
Bases: PrefectBaseModel
Defines a subset of the Trigger subclass, which is specific to Metric automations, that specify the query configurations and breaching conditions for the Automation
Source code in prefect/events/schemas/automations.py
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 |
|
PauseAutomation
¶
Bases: AutomationAction
Pauses a Work Queue
Source code in prefect/events/actions.py
256 257 258 259 |
|
PauseDeployment
¶
Bases: DeploymentAction
Pauses the given Deployment
Source code in prefect/events/actions.py
85 86 87 88 |
|
PauseWorkPool
¶
Bases: WorkPoolAction
Pauses a Work Pool
Source code in prefect/events/actions.py
172 173 174 175 |
|
PauseWorkQueue
¶
Bases: WorkQueueAction
Pauses a Work Queue
Source code in prefect/events/actions.py
214 215 216 217 |
|
ReceivedEvent
¶
Bases: Event
The server-side view of an event that has happened to a Resource after it has been received by the server
Source code in prefect/events/schemas/events.py
180 181 182 183 184 185 186 187 188 189 190 |
|
RelatedResource
¶
Bases: Resource
A Resource with a specific role in an Event
Source code in prefect/events/schemas/events.py
80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 |
|
Resource
¶
Bases: Labelled
An observable business object of interest to the user
Source code in prefect/events/schemas/events.py
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 |
|
ResourceSpecification
¶
Bases: PrefectBaseModel
A specification that may match zero, one, or many resources, used to target or select a set of resources in a query or automation. A resource must match at least one value of all of the provided labels
Source code in prefect/events/schemas/events.py
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 |
|
ResourceTrigger
¶
Bases: Trigger
, ABC
Base class for triggers that may filter by the labels of resources.
Source code in prefect/events/schemas/automations.py
99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 |
|
ResumeAutomation
¶
Bases: AutomationAction
Resumes a Work Queue
Source code in prefect/events/actions.py
262 263 264 265 |
|
ResumeDeployment
¶
Bases: DeploymentAction
Resumes the given Deployment
Source code in prefect/events/actions.py
91 92 93 94 |
|
ResumeWorkPool
¶
Bases: WorkPoolAction
Resumes a Work Pool
Source code in prefect/events/actions.py
178 179 180 181 |
|
ResumeWorkQueue
¶
Bases: WorkQueueAction
Resumes a Work Queue
Source code in prefect/events/actions.py
220 221 222 223 |
|
RunDeployment
¶
Bases: DeploymentAction
Runs the given deployment with the given parameters
Source code in prefect/events/actions.py
64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 |
|
SendNotification
¶
Bases: Action
Send a notification when an Automation is triggered
Source code in prefect/events/actions.py
141 142 143 144 145 146 147 148 149 |
|
SequenceTrigger
¶
Bases: CompositeTrigger
A composite trigger that requires some number of triggers to have fired within the given time period in a specific order
Source code in prefect/events/schemas/automations.py
361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 |
|
describe_for_cli
¶
Return a human-readable description of this trigger for the CLI
Source code in prefect/events/schemas/automations.py
367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 |
|
SuspendFlowRun
¶
Bases: Action
Suspends a flow run associated with the trigger
Source code in prefect/events/actions.py
122 123 124 125 |
|
Trigger
¶
Bases: PrefectBaseModel
, ABC
Base class describing a set of criteria that must be satisfied in order to trigger an automation.
Source code in prefect/events/schemas/automations.py
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 |
|
describe_for_cli
abstractmethod
¶
Return a human-readable description of this trigger for the CLI
Source code in prefect/events/schemas/automations.py
50 51 52 |
|
emit_event
¶
Send an event to Prefect Cloud.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
event |
str
|
The name of the event that happened. |
required |
resource |
Dict[str, str]
|
The primary Resource this event concerns. |
required |
occurred |
Optional[DateTimeTZ]
|
When the event happened from the sender's perspective. Defaults to the current datetime. |
None
|
related |
Optional[Union[List[Dict[str, str]], List[RelatedResource]]]
|
A list of additional Resources involved in this event. |
None
|
payload |
Optional[Dict[str, Any]]
|
An open-ended set of data describing what happened. |
None
|
id |
Optional[UUID]
|
The sender-provided identifier for this event. Defaults to a random UUID. |
None
|
follows |
Optional[Event]
|
The event that preceded this one. If the preceding event happened more than 5 minutes prior to this event the follows relationship will not be set. |
None
|
Returns:
Type | Description |
---|---|
Optional[Event]
|
The event that was emitted if worker is using a client that emit |
Optional[Event]
|
events, otherwise None |
Source code in prefect/events/utilities.py
21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 |
|