Event Python Filter
An event filter that filters based on Python code.
EventPythonFilter
info
EventPythonFilter is defined beneath the following ancestor nodes in the YAML structure:
Below are the properties for the EventPythonFilter. Each property links to the specific details section further down in this page.
| Property | Default | Type | Required | Description |
|---|---|---|---|---|
| types | array[string] | Yes | List of event types. | |
| python_filter | string | Yes | Python code used to filter events from the event stream. |
Property Details
Automation
An automation defines a set of actions to be performed when defined sensor or event triggers occur.
| Property | Default | Type | Required | Description |
|---|---|---|---|---|
| automation | AutomationOptions | Yes | Configuration options for the automation. |
AutomationOptions
Configuration options for an automation.
| Property | Default | Type | Required | Description |
|---|---|---|---|---|
| name | string | No | The name of the model | |
| description | string | No | A brief description of what the model does. | |
| metadata | ResourceMetadata | No | Meta information of a resource. In most cases it doesn't affect the system behavior but may be helpful to analyze project resources. | |
| enabled | boolean | No | A boolean flag indicating whether the automation is enabled (or not). Defaults to True. | |
| actions | array[Any of: (ActionOptions, string)] | No | List of actions that the automation performs when triggered. | |
| triggers | EventTrigger | No | List of automation triggers. |
EventTrigger
A trigger that triggers an automation based on events or sensors.
| Property | Default | Type | Required | Description |
|---|---|---|---|---|
| events | array[One of: (EventSqlFilter, EventPythonFilter, EventTypeFilter)] | No | List of event filters used to identify events that trigger the automation. | |
| sensors | array[Any of: (SensorOptions, string)] | No | List of sensors that trigger the automation. |