xref: /openbmc/phosphor-dbus-interfaces/yaml/xyz/openbmc_project/State/Leak/DetectorGroup.interface.yaml (revision 4c5876f0f69c06b47c931e3224c1c34b126623b5) 
1description: >
2    Implement to provide attributes for leak detector group. This group
3    represents a collection of leak detectors that reports a unified status.
4
5properties:
6    - name: PrettyName
7      type: string
8      description: >
9          The human readable name of the leak detector group.
10      flags:
11          - readonly
12    - name: State
13      type: enum[xyz.openbmc_project.State.Leak.Detector.DetectorState]
14      description: >
15          This is the overall status of the group, which is determined by
16          aggregating the state from all member leak detectors.
17      flags:
18          - readonly
19
20associations:
21    - name: containing
22      description: >
23          The leak detector group can optionally implement the 'containing'
24          association to provide one or more links to leak detectors which it
25          contains.
26      reverse_name: contained_by
27      required_endpoint_interfaces:
28          - xyz.openbmc_project.State.Leak.Detector
29
30paths:
31    - namespace: /xyz/openbmc_project/state/leak
32      description: >
33          The root path for state of all leak objects.
34      segments:
35          - name: DetectorGroup
36            description: >
37                The leak detector group.
38            value: detectorgroup
39