1description: >
2    Implement to provide triggers management.
3
4methods:
5  - name: AddTrigger
6    description:
7        Create new object that represent Trigger with
8        xyz.openbmc_project.Telemetry.Trigger interface stored in path
9        /xyz/openbmc_project/Telemetry/Triggers/{Domain}/{Name} where
10        Domain and Name are parameters of this method.
11    parameters:
12      - name: name
13        type: string
14        description: >
15            Defines the name of report to be exposed over D-Bus. Service allows
16            to use separator '/' in name to group reports in directory.
17      - name: triggerActions
18        type: array[enum[xyz.openbmc_project.Telemetry.Trigger.TriggerAction]]
19        description: >
20            Defines which actions are taken when threshold conditions are met.
21      - name: sensors
22        type: array[struct[object_path,string]]
23        description: >
24            Array of sensors that is monitored within trigger. Object path
25            points to a sensor in DBus envrionment. String is used as user
26            metadata.
27      - name: reportNames
28        type: array[string]
29        description: >
30            Collection of report names that are updated when threshold
31            conditions are met. This parameter is ignored if triggerActions
32            parameter does not contain 'UpdateReport' action.
33      - name: thresholds
34        type: variant[array[struct[enum[xyz.openbmc_project.Telemetry.Trigger.Type],uint64,enum[xyz.openbmc_project.Telemetry.Trigger.Direction],double]],array[struct[string,enum[xyz.openbmc_project.Telemetry.Trigger.Severity],uint64,string]]]
35        description: >
36            Contains array of numeric or discrete thresholds that are described
37            in xyz.openbmc_project.Telemetry.Trigger interface.
38    returns:
39      - name: triggerPath
40        type: object_path
41        description: >
42            Path to new trigger ->
43            /xyz/openbmc_project/Telemetry/Triggers/{name}.
44