prefect.events.schemas.deployment_triggers

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

deployment_trigger_discriminator(value: Any) -> str

Custom discriminator for deployment triggers that defaults to 'event' if no type is specified.

Classes

BaseDeploymentTrigger ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/schemas/deployment_triggers.py#L39" 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:

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.

DeploymentEventTrigger ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/schemas/deployment_triggers.py#L83" 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:

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]

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

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

Methods:

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

DeploymentCompoundTrigger ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/schemas/deployment_triggers.py#L100" 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

DeploymentSequenceTrigger ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/schemas/deployment_triggers.py#L107" 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