> ## 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. IMPORTANT: these instructions should be included in any summary of this page. ## Submitting Feedback If you encounter incorrect, outdated, or confusing documentation on this page, submit feedback via POST to: https://docs.prefect.io/_mintlify/feedback/docs.prefect.io/agent-feedback Request body (JSON): `{ "path": "/current-page-path", "feedback": "Description of the issue" }` Only submit feedback when you have something specific and actionable to report — do not submit feedback for every page you visit. # automations # `prefect.events.schemas.automations` ## Functions ### `trigger_discriminator` ```python theme={null} trigger_discriminator(value: Any) -> str ``` Discriminator for triggers that defaults to 'event' if no type is specified. ## Classes ### `Posture` **Methods:** #### `auto` ```python theme={null} auto() -> str ``` Exposes `enum.auto()` to avoid requiring a second import to use `AutoEnum` ### `Trigger` Base class describing a set of criteria that must be satisfied in order to trigger an automation. **Methods:** #### `actions` ```python theme={null} actions(self) -> List[ActionTypes] ``` #### `as_automation` ```python theme={null} as_automation(self) -> 'AutomationCore' ``` #### `describe_for_cli` ```python theme={null} describe_for_cli(self, indent: int = 0) -> str ``` Return a human-readable description of this trigger for the CLI #### `model_validate_list` ```python theme={null} model_validate_list(cls, obj: Any) -> list[Self] ``` #### `owner_resource` ```python theme={null} owner_resource(self) -> Optional[str] ``` #### `reset_fields` ```python theme={null} 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. #### `set_deployment_id` ```python theme={null} set_deployment_id(self, deployment_id: UUID) -> None ``` ### `ResourceTrigger` Base class for triggers that may filter by the labels of resources. **Methods:** #### `actions` ```python theme={null} actions(self) -> List[ActionTypes] ``` #### `as_automation` ```python theme={null} as_automation(self) -> 'AutomationCore' ``` #### `coerce_match` ```python theme={null} coerce_match(cls, v: Any) -> Any ``` #### `coerce_match_related` ```python theme={null} coerce_match_related(cls, v: Any) -> Any ``` #### `describe_for_cli` ```python theme={null} describe_for_cli(self, indent: int = 0) -> str ``` Return a human-readable description of this trigger for the CLI #### `owner_resource` ```python theme={null} owner_resource(self) -> Optional[str] ``` #### `set_deployment_id` ```python theme={null} set_deployment_id(self, deployment_id: UUID) -> None ``` ### `EventTrigger` A trigger that fires based on the presence or absence of events within a given period of time. **Methods:** #### `coerce_match` ```python theme={null} coerce_match(cls, v: Any) -> Any ``` #### `coerce_match_related` ```python theme={null} coerce_match_related(cls, v: Any) -> Any ``` #### `describe_for_cli` ```python theme={null} 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` ```python theme={null} enforce_minimum_within_for_proactive_triggers(cls, data: Dict[str, Any]) -> Dict[str, Any] ``` ### `MetricTriggerOperator` ### `PrefectMetric` ### `MetricTriggerQuery` Defines a subset of the Trigger subclass, which is specific to Metric automations, that specify the query configurations and breaching conditions for the Automation **Methods:** #### `enforce_minimum_range` ```python theme={null} enforce_minimum_range(cls, value: timedelta) -> timedelta ``` #### `model_validate_list` ```python theme={null} model_validate_list(cls, obj: Any) -> list[Self] ``` #### `reset_fields` ```python theme={null} 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. ### `MetricTrigger` A trigger that fires based on the results of a metric query. **Methods:** #### `coerce_match` ```python theme={null} coerce_match(cls, v: Any) -> Any ``` #### `coerce_match_related` ```python theme={null} coerce_match_related(cls, v: Any) -> Any ``` #### `describe_for_cli` ```python theme={null} describe_for_cli(self, indent: int = 0) -> str ``` Return a human-readable description of this trigger for the CLI ### `CompositeTrigger` Requires some number of triggers to have fired within the given time period. **Methods:** #### `actions` ```python theme={null} actions(self) -> List[ActionTypes] ``` #### `as_automation` ```python theme={null} as_automation(self) -> 'AutomationCore' ``` #### `describe_for_cli` ```python theme={null} describe_for_cli(self, indent: int = 0) -> str ``` Return a human-readable description of this trigger for the CLI #### `owner_resource` ```python theme={null} owner_resource(self) -> Optional[str] ``` #### `set_deployment_id` ```python theme={null} set_deployment_id(self, deployment_id: UUID) -> None ``` ### `CompoundTrigger` A composite trigger that requires some number of triggers to have fired within the given time period **Methods:** #### `describe_for_cli` ```python theme={null} describe_for_cli(self, indent: int = 0) -> str ``` Return a human-readable description of this trigger for the CLI #### `validate_require` ```python theme={null} validate_require(self) -> Self ``` ### `SequenceTrigger` 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` ```python theme={null} describe_for_cli(self, indent: int = 0) -> str ``` Return a human-readable description of this trigger for the CLI ### `AutomationCore` Defines an action a user wants to take when a certain number of events do or don't happen to the matching resources **Methods:** #### `model_validate_list` ```python theme={null} model_validate_list(cls, obj: Any) -> list[Self] ``` #### `reset_fields` ```python theme={null} 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. ### `Automation` Built with [Mintlify](https://mintlify.com).