xref: /openbmc/phosphor-dbus-interfaces/yaml/xyz/openbmc_project/Common/Progress.interface.yaml (revision a1347418307d31a94bd21f22897aa508df938dcf)
1b1b4d261SWilliam A. Kennington IIIdescription: >
2*a1347418SPatrick Williams    Implement to provide the progress on user requested activity. Objects which
3*a1347418SPatrick Williams    implements this interface should implement xyz.openbmc_project.Object.Delete
4*a1347418SPatrick Williams    to delete individual entries. The service hosting this interface should
5*a1347418SPatrick Williams    clear the entries after some time or reaching some number of entries in
6*a1347418SPatrick Williams    stable states like completed, failed or aborted.
7b1b4d261SWilliam A. Kennington III
8b1b4d261SWilliam A. Kennington IIIproperties:
9b1b4d261SWilliam A. Kennington III    - name: Status
10b1b4d261SWilliam A. Kennington III      type: enum[self.OperationStatus]
11b1b4d261SWilliam A. Kennington III      default: InProgress
12b1b4d261SWilliam A. Kennington III      description: >
13b1b4d261SWilliam A. Kennington III          Indicate the state of the operation, whether in progress, completed
14b1b4d261SWilliam A. Kennington III          aborted or failed. The default should be InProgress during the
15b1b4d261SWilliam A. Kennington III          implementation if no input is provided.
16b1b4d261SWilliam A. Kennington III    - name: StartTime
17b1b4d261SWilliam A. Kennington III      type: uint64
18b1b4d261SWilliam A. Kennington III      description: >
19*a1347418SPatrick Williams          Indicates when the request is created since the Epoch (1 Jan 1970
20*a1347418SPatrick Williams          00:00:00 UTC), in microseconds.
21b1b4d261SWilliam A. Kennington III    - name: CompletedTime
22b1b4d261SWilliam A. Kennington III      type: uint64
23b1b4d261SWilliam A. Kennington III      description: >
24*a1347418SPatrick Williams          Indicates when the state is completed since the Epoch (1 Jan 1970
25*a1347418SPatrick Williams          00:00:00 UTC), in microseconds.
26b1b4d261SWilliam A. Kennington III
27b1b4d261SWilliam A. Kennington IIIenumerations:
28b1b4d261SWilliam A. Kennington III    - name: OperationStatus
29b1b4d261SWilliam A. Kennington III      description: >
30b1b4d261SWilliam A. Kennington III          Status of the activity
31b1b4d261SWilliam A. Kennington III      values:
32b1b4d261SWilliam A. Kennington III          - name: InProgress
33b1b4d261SWilliam A. Kennington III            description: >
34b1b4d261SWilliam A. Kennington III                Requested operation is in progress.
35b1b4d261SWilliam A. Kennington III          - name: Completed
36b1b4d261SWilliam A. Kennington III            description: >
37b1b4d261SWilliam A. Kennington III                The operation is completed.
38b1b4d261SWilliam A. Kennington III          - name: Failed
39b1b4d261SWilliam A. Kennington III            description: >
40b1b4d261SWilliam A. Kennington III                The operation encountered a failure.
41b1b4d261SWilliam A. Kennington III          - name: Aborted
42b1b4d261SWilliam A. Kennington III            description: >
43b1b4d261SWilliam A. Kennington III                The operation is aborted.
44