Documentation Index Fetch the complete documentation index at: https://docs.prefect.io/llms.txt
Use this file to discover all available pages before exploring further.
prefect.events.schemas.deployment_triggersSchemas for defining triggers within a Prefect deployment YAML. This is a separate
parallel hierarchy for representing triggers so that they can also include the
information necessary to create an automation.
These triggers should follow the validation rules of the main Trigger class hierarchy as
closely as possible (because otherwise users will get validation errors creating
triggers), but we can be more liberal with the defaults here to make it simpler to
create them from YAML.
Functions deployment_trigger_discriminator deployment_trigger_discriminator(value: Any) -> str
Custom discriminator for deployment triggers that defaults to ‘event’ if no type is specified.
Classes BaseDeploymentTrigger Base class describing a set of criteria that must be satisfied in order to trigger
an automation.
Methods: model_validate_list model_validate_list( cls , obj: Any) -> list[Self]
reset_fields reset_fields( self : Self) -> Self
Reset the fields of the model that are in the _reset_fields set.
Returns:
A new instance of the model with the reset fields.
DeploymentEventTrigger A trigger that fires based on the presence or absence of events within a given
period of time.
Methods: describe_for_cli describe_for_cli( self , indent: int = 0 ) -> str
Return a human-readable description of this trigger for the CLI
enforce_minimum_within_for_proactive_triggers enforce_minimum_within_for_proactive_triggers( cls , data: Dict[ str , Any]) -> Dict[ str , Any]
DeploymentMetricTrigger A trigger that fires based on the results of a metric query.
Methods: describe_for_cli describe_for_cli( self , indent: int = 0 ) -> str
Return a human-readable description of this trigger for the CLI
DeploymentCompoundTrigger A composite trigger that requires some number of triggers to have
fired within the given time period
Methods: describe_for_cli describe_for_cli( self , indent: int = 0 ) -> str
Return a human-readable description of this trigger for the CLI
validate_require validate_require( self ) -> Self
DeploymentSequenceTrigger A composite trigger that requires some number of triggers to have fired
within the given time period in a specific order
Methods: describe_for_cli describe_for_cli( self , indent: int = 0 ) -> str
Return a human-readable description of this trigger for the CLI 
