> ## 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. # events # `prefect.server.events.schemas.events` ## Functions ### `matches` ```python theme={null} 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` An observable business object of interest to the user **Methods:** #### `as_label_value_array` ```python theme={null} as_label_value_array(self) -> List[Dict[str, str]] ``` #### `enforce_maximum_labels` ```python theme={null} enforce_maximum_labels(self) -> Self ``` #### `get` ```python theme={null} get(self, label: str, default: Optional[str] = None) -> Optional[str] ``` #### `has_all_labels` ```python theme={null} has_all_labels(self, labels: Dict[str, str]) -> bool ``` #### `id` ```python theme={null} id(self) -> str ``` #### `items` ```python theme={null} items(self) -> Iterable[Tuple[str, str]] ``` #### `keys` ```python theme={null} keys(self) -> Iterable[str] ``` #### `labels` ```python theme={null} labels(self) -> LabelDiver ``` #### `name` ```python theme={null} name(self) -> Optional[str] ``` #### `prefect_object_id` ```python theme={null} 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` ```python theme={null} requires_resource_id(self) -> Self ``` ### `RelatedResource` A Resource with a specific role in an Event **Methods:** #### `enforce_maximum_labels` ```python theme={null} enforce_maximum_labels(self) -> Self ``` #### `id` ```python theme={null} id(self) -> str ``` #### `name` ```python theme={null} name(self) -> Optional[str] ``` #### `prefect_object_id` ```python theme={null} 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` ```python theme={null} requires_resource_id(self) -> Self ``` #### `requires_resource_role` ```python theme={null} requires_resource_role(self) -> Self ``` #### `role` ```python theme={null} role(self) -> str ``` ### `Event` The client-side view of an event that has happened to a Resource **Methods:** #### `enforce_maximum_related_resources` ```python theme={null} enforce_maximum_related_resources(cls, value: List[RelatedResource]) -> List[RelatedResource] ``` #### `find_resource_label` ```python theme={null} 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::`, search for the first matching label in a related resource with that role. #### `involved_resources` ```python theme={null} involved_resources(self) -> Sequence[Resource] ``` #### `model_validate_list` ```python theme={null} model_validate_list(cls, obj: Any) -> list[Self] ``` #### `receive` ```python theme={null} receive(self, received: Optional[prefect.types._datetime.DateTime] = None) -> 'ReceivedEvent' ``` #### `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. #### `resource_in_role` ```python theme={null} resource_in_role(self) -> Mapping[str, RelatedResource] ``` Returns a mapping of roles to the first related resource in that role #### `resources_in_role` ```python theme={null} resources_in_role(self) -> Mapping[str, Sequence[RelatedResource]] ``` Returns a mapping of roles to related resources in that role #### `size_bytes` ```python theme={null} size_bytes(self) -> int ``` ### `ReceivedEvent` 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` ```python theme={null} as_database_resource_rows(self) -> List[Dict[str, Any]] ``` #### `as_database_row` ```python theme={null} as_database_row(self) -> dict[str, Any] ``` #### `is_set` ```python theme={null} is_set(self) ``` #### `set` ```python theme={null} 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` ```python theme={null} 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` ```python theme={null} 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` **Methods:** #### `deepcopy` ```python theme={null} deepcopy(self) -> 'ResourceSpecification' ``` #### `get` ```python theme={null} get(self, key: str, default: Optional[Union[str, List[str]]] = None) -> Optional[List[str]] ``` #### `includes` ```python theme={null} includes(self, candidates: Iterable[Resource]) -> bool ``` #### `items` ```python theme={null} items(self) -> Iterable[Tuple[str, List[str]]] ``` #### `matches` ```python theme={null} matches(self, resource: Resource) -> bool ``` #### `matches_every_resource` ```python theme={null} matches_every_resource(self) -> bool ``` #### `matches_every_resource_of_kind` ```python theme={null} matches_every_resource_of_kind(self, prefix: str) -> bool ``` #### `pop` ```python theme={null} pop(self, key: str, default: Optional[Union[str, List[str]]] = None) -> Optional[List[str]] ``` ### `EventPage` A single page of events returned from the API, with an optional link to the next page of results **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. ### `EventCount` The count of events with the given filter value **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. Built with [Mintlify](https://mintlify.com).