prefect.server.events.schemas.events

Functions

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

matches(expected: str, value: Optional[str]) -> bool

Returns true if the given value matches the expected string.

Args:

• expected: A glob pattern to match against; if it starts with an !, the pattern is negated.
• value: The value of the label.

Classes

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

An observable business object of interest to the user

Methods:

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

as_label_value_array(self) -> List[Dict[str, str]]

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

enforce_maximum_labels(self) -> Self

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

get(self, label: str, default: Optional[str] = None) -> Optional[str]

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

has_all_labels(self, labels: Dict[str, str]) -> bool

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

id(self) -> str

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

items(self) -> Iterable[Tuple[str, str]]

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

keys(self) -> Iterable[str]

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

labels(self) -> LabelDiver

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

name(self) -> Optional[str]

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

prefect_object_id(self, kind: str) -> UUID

Extracts the UUID from an event's resource ID if it's the expected kind of prefect resource

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

requires_resource_id(self) -> Self

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

A Resource with a specific role in an Event

Methods:

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

enforce_maximum_labels(self) -> Self

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

id(self) -> str

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

name(self) -> Optional[str]

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

prefect_object_id(self, kind: str) -> UUID

Extracts the UUID from an event's resource ID if it's the expected kind of prefect resource

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

requires_resource_id(self) -> Self

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

requires_resource_role(self) -> Self

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

role(self) -> str

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

The client-side view of an event that has happened to a Resource

Methods:

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

enforce_maximum_related_resources(cls, value: List[RelatedResource]) -> List[RelatedResource]

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

find_resource_label(self, label: str) -> Optional[str]

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.

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

involved_resources(self) -> Sequence[Resource]

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]

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

receive(self, received: Optional[prefect.types._datetime.DateTime] = None) -> 'ReceivedEvent'

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.

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

resource_in_role(self) -> Mapping[str, RelatedResource]

Returns a mapping of roles to the first related resource in that role

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

resources_in_role(self) -> Mapping[str, Sequence[RelatedResource]]

Returns a mapping of roles to related resources in that role

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

size_bytes(self) -> int

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

The server-side view of an event that has happened to a Resource after it has been received by the server

Methods:

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

as_database_resource_rows(self) -> List[Dict[str, Any]]

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

as_database_row(self) -> dict[str, Any]

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

is_set(self)

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

set(self) -> None

Set the flag, notifying all waiters.

Unlike asyncio.Event, waiters may not be notified immediately when this is called; instead, notification will be placed on the owning loop of each waiter for thread safety.

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

url(self) -> Optional[str]

Returns the UI URL for this event, allowing users to link to events in automation templates without parsing date strings.

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

wait(self) -> Literal[True]

Block until the internal flag is true.

If the internal flag is true on entry, return True immediately. Otherwise, block until another set() is called, then return True.

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

Methods:

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

deepcopy(self) -> 'ResourceSpecification'

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

get(self, key: str, default: Optional[Union[str, List[str]]] = None) -> Optional[List[str]]

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

includes(self, candidates: Iterable[Resource]) -> bool

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

items(self) -> Iterable[Tuple[str, List[str]]]

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

matches(self, resource: Resource) -> bool

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

matches_every_resource(self) -> bool

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

matches_every_resource_of_kind(self, prefix: str) -> bool

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

pop(self, key: str, default: Optional[Union[str, List[str]]] = None) -> Optional[List[str]]

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

A single page of events returned from the API, with an optional link to the next page of results

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.

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

The count of events with the given filter value

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.