| Dhruvaraj Subhashchandran | d621780 | 2020-09-08 23:05:43 -0500 | [diff] [blame] | 1 | description: > |
| Patrick Williams | a134741 | 2022-12-06 10:56:22 -0600 | [diff] [blame^] | 2 | Implement to provide the progress on user requested activity. Objects which |
| 3 | implements this interface should implement xyz.openbmc_project.Object.Delete |
| 4 | to delete individual entries. The service hosting this interface should |
| 5 | clear the entries after some time or reaching some number of entries in |
| 6 | stable states like completed, failed or aborted. |
| Dhruvaraj Subhashchandran | d621780 | 2020-09-08 23:05:43 -0500 | [diff] [blame] | 7 | |
| 8 | properties: |
| 9 | - name: Status |
| 10 | type: enum[self.OperationStatus] |
| 11 | default: InProgress |
| 12 | description: > |
| 13 | Indicate the state of the operation, whether in progress, completed |
| 14 | aborted or failed. The default should be InProgress during the |
| 15 | implementation if no input is provided. |
| 16 | - name: StartTime |
| 17 | type: uint64 |
| 18 | description: > |
| Patrick Williams | a134741 | 2022-12-06 10:56:22 -0600 | [diff] [blame^] | 19 | Indicates when the request is created since the Epoch (1 Jan 1970 |
| 20 | 00:00:00 UTC), in microseconds. |
| Dhruvaraj Subhashchandran | d621780 | 2020-09-08 23:05:43 -0500 | [diff] [blame] | 21 | - name: CompletedTime |
| 22 | type: uint64 |
| 23 | description: > |
| Patrick Williams | a134741 | 2022-12-06 10:56:22 -0600 | [diff] [blame^] | 24 | Indicates when the state is completed since the Epoch (1 Jan 1970 |
| 25 | 00:00:00 UTC), in microseconds. |
| Dhruvaraj Subhashchandran | d621780 | 2020-09-08 23:05:43 -0500 | [diff] [blame] | 26 | |
| 27 | enumerations: |
| 28 | - name: OperationStatus |
| 29 | description: > |
| Patrick Williams | 8da396c | 2022-03-14 14:21:02 -0500 | [diff] [blame] | 30 | Status of the activity |
| Dhruvaraj Subhashchandran | d621780 | 2020-09-08 23:05:43 -0500 | [diff] [blame] | 31 | values: |
| Patrick Williams | 8da396c | 2022-03-14 14:21:02 -0500 | [diff] [blame] | 32 | - name: InProgress |
| 33 | description: > |
| 34 | Requested operation is in progress. |
| 35 | - name: Completed |
| 36 | description: > |
| 37 | The operation is completed. |
| 38 | - name: Failed |
| 39 | description: > |
| 40 | The operation encountered a failure. |
| 41 | - name: Aborted |
| 42 | description: > |
| 43 | The operation is aborted. |