prefect.events.schemas.automations

Functions

trigger_discriminator ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/schemas/automations.py#L430" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

trigger_discriminator(value: Any) -> str

Discriminator for triggers that defaults to 'event' if no type is specified.

Classes

Posture ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/schemas/automations.py#L40" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

Methods:

auto ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/collections.py#L70" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

auto() -> str

Exposes enum.auto() to avoid requiring a second import to use AutoEnum

Trigger ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/schemas/automations.py#L46" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

Base class describing a set of criteria that must be satisfied in order to trigger an automation.

Methods:

actions ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/schemas/automations.py#L69" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

actions(self) -> List[ActionTypes]

as_automation ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/schemas/automations.py#L81" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

as_automation(self) -> 'AutomationCore'

describe_for_cli ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/schemas/automations.py#L55" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

describe_for_cli(self, indent: int = 0) -> str

Return a human-readable description of this trigger for the CLI

model_validate_list ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/_internal/schemas/bases.py#L56" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

model_validate_list(cls, obj: Any) -> list[Self]

owner_resource ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/schemas/automations.py#L66" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

owner_resource(self) -> Optional[str]

reset_fields ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/_internal/schemas/bases.py#L85" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

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 ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/schemas/automations.py#L63" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

set_deployment_id(self, deployment_id: UUID) -> None

ResourceTrigger ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/schemas/automations.py#L104" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

Base class for triggers that may filter by the labels of resources.

Methods:

actions ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/schemas/automations.py#L69" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

actions(self) -> List[ActionTypes]

as_automation ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/schemas/automations.py#L81" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

as_automation(self) -> 'AutomationCore'

coerce_match ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/schemas/automations.py#L126" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

coerce_match(cls, v: Any) -> Any

coerce_match_related ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/schemas/automations.py#L133" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

coerce_match_related(cls, v: Any) -> Any

describe_for_cli ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/schemas/automations.py#L55" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

describe_for_cli(self, indent: int = 0) -> str

Return a human-readable description of this trigger for the CLI

owner_resource ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/schemas/automations.py#L66" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

owner_resource(self) -> Optional[str]

set_deployment_id ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/schemas/automations.py#L63" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

set_deployment_id(self, deployment_id: UUID) -> None

EventTrigger ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/schemas/automations.py#L146" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

A trigger that fires based on the presence or absence of events within a given period of time.

Methods:

coerce_match ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/schemas/automations.py#L126" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

coerce_match(cls, v: Any) -> Any

coerce_match_related ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/schemas/automations.py#L133" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

coerce_match_related(cls, v: Any) -> Any

describe_for_cli ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/schemas/automations.py#L239" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

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 ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/schemas/automations.py#L211" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

enforce_minimum_within_for_proactive_triggers(cls, data: Dict[str, Any]) -> Dict[str, Any]

MetricTriggerOperator ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/schemas/automations.py#L262" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

PrefectMetric ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/schemas/automations.py#L269" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

MetricTriggerQuery ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/schemas/automations.py#L275" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

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 ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/schemas/automations.py#L316" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

enforce_minimum_range(cls, value: timedelta) -> timedelta

model_validate_list ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/_internal/schemas/bases.py#L56" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

model_validate_list(cls, obj: Any) -> list[Self]

reset_fields ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/_internal/schemas/bases.py#L85" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

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 href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/schemas/automations.py#L322" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

A trigger that fires based on the results of a metric query.

Methods:

coerce_match ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/schemas/automations.py#L126" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

coerce_match(cls, v: Any) -> Any

coerce_match_related ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/schemas/automations.py#L133" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

coerce_match_related(cls, v: Any) -> Any

describe_for_cli ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/schemas/automations.py#L339" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

describe_for_cli(self, indent: int = 0) -> str

Return a human-readable description of this trigger for the CLI

CompositeTrigger ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/schemas/automations.py#L352" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

Requires some number of triggers to have fired within the given time period.

Methods:

actions ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/schemas/automations.py#L69" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

actions(self) -> List[ActionTypes]

as_automation ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/schemas/automations.py#L81" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

as_automation(self) -> 'AutomationCore'

describe_for_cli ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/schemas/automations.py#L55" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

describe_for_cli(self, indent: int = 0) -> str

Return a human-readable description of this trigger for the CLI

owner_resource ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/schemas/automations.py#L66" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

owner_resource(self) -> Optional[str]

set_deployment_id ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/schemas/automations.py#L63" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

set_deployment_id(self, deployment_id: UUID) -> None

CompoundTrigger ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/schemas/automations.py#L369" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

A composite trigger that requires some number of triggers to have fired within the given time period

Methods:

describe_for_cli ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/schemas/automations.py#L388" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

describe_for_cli(self, indent: int = 0) -> str

Return a human-readable description of this trigger for the CLI

validate_require ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/schemas/automations.py#L377" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

validate_require(self) -> Self

SequenceTrigger ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/schemas/automations.py#L406" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

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 ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/schemas/automations.py#L412" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

describe_for_cli(self, indent: int = 0) -> str

Return a human-readable description of this trigger for the CLI

AutomationCore ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/schemas/automations.py#L464" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

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 ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/_internal/schemas/bases.py#L56" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

model_validate_list(cls, obj: Any) -> list[Self]

reset_fields ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/_internal/schemas/bases.py#L85" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

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 ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/schemas/automations.py#L509" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}